X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FBAO%2FBlock.php;h=fcf9f3324b28301a0702a5fac466490f4505a4cf;hb=725b3de6f03330ab5e310f397fc0336fe551ec6f;hp=8aeb8063ae1de30bb356674105ad6e922e4a6b16;hpb=95ca1e4e775ce88e3f371abe8390a3526ba537e7;p=civicrm-core.git diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 8aeb8063ae..fcf9f3324b 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -1,7 +1,7 @@ array('email'), 'phone' => array('phone'), 'im' => array('name'), - 'openid' => array('openid') + 'openid' => array('openid'), ); /** * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param string $blockName name of the above object - * @param array $params input parameters to find object + * @param string $blockName + * Name of the above object. + * @param array $params + * Input parameters to find object. * - * @return array of $block objects. - * @access public - * @static + * @return array + * Array of $block objects. */ - static function &getValues($blockName, $params) { + public static function &getValues($blockName, $params) { if (empty($params)) { return NULL; } $BAOString = 'CRM_Core_BAO_' . $blockName; - $block = new $BAOString( ); + $block = new $BAOString(); $blocks = array(); if (!isset($params['entity_table'])) { @@ -82,9 +83,9 @@ class CRM_Core_BAO_Block { $count = 1; foreach ($blockIds as $blockId) { - $block = new $BAOString( ); - $block->id = $blockId['id']; - $getBlocks = self::retrieveBlock($block, $blockName); + $block = new $BAOString(); + $block->id = $blockId['id']; + $getBlocks = self::retrieveBlock($block, $blockName); $blocks[$count++] = array_pop($getBlocks); } } @@ -96,14 +97,15 @@ class CRM_Core_BAO_Block { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param Object $block typically a Phone|Email|IM|OpenID object - * @param string $blockName name of the above object + * @param Object $block + * Typically a Phone|Email|IM|OpenID object. + * @param string $blockName + * Name of the above object. * - * @return array of $block objects. - * @access public - * @static + * @return array + * Array of $block objects. */ - static function retrieveBlock(&$block, $blockName) { + public static function retrieveBlock(&$block, $blockName) { // we first get the primary location due to the order by clause $block->orderBy('is_primary desc, id'); $block->find(); @@ -124,16 +126,17 @@ class CRM_Core_BAO_Block { } /** - * Check if the current block object has any valid data + * Check if the current block object has any valid data. * - * @param array $blockFields array of fields that are of interest for this object - * @param array $params associated array of submitted fields + * @param array $blockFields + * Array of fields that are of interest for this object. + * @param array $params + * Associated array of submitted fields. * - * @return boolean true if the block has data, otherwise false - * @access public - * @static + * @return bool + * true if the block has data, otherwise false */ - static function dataExists($blockFields, &$params) { + public static function dataExists($blockFields, &$params) { foreach ($blockFields as $field) { if (CRM_Utils_System::isNull(CRM_Utils_Array::value($field, $params))) { return FALSE; @@ -143,16 +146,17 @@ class CRM_Core_BAO_Block { } /** - * Check if the current block exits + * Check if the current block exits. * - * @param string $blockName bloack name - * @param array $params associated array of submitted fields + * @param string $blockName + * Bloack name. + * @param array $params + * Associated array of submitted fields. * - * @return boolean true if the block exits, otherwise false - * @access public - * @static + * @return bool + * true if the block exits, otherwise false */ - static function blockExists($blockName, &$params) { + public static function blockExists($blockName, &$params) { // return if no data present if (empty($params[$blockName]) || !is_array($params[$blockName])) { return FALSE; @@ -162,20 +166,21 @@ class CRM_Core_BAO_Block { } /** - * Get all block ids for a contact + * Get all block ids for a contact. * - * @param string $blockName block name - * @param int $contactId contact id + * @param string $blockName + * Block name. + * @param int $contactId + * Contact id. * * @param null $entityElements * @param bool $updateBlankLocInfo * - * @return array $contactBlockIds formatted array of block ids + * @return array + * formatted array of block ids * - * @access public - * @static */ - static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) { + public static function getBlockIds($blockName, $contactId = NULL, $entityElements = NULL, $updateBlankLocInfo = FALSE) { $allBlocks = array(); $name = ucfirst($blockName); @@ -194,36 +199,37 @@ class CRM_Core_BAO_Block { // e.g $bao = new $baoString; // $bao->getAllBlocks() $baoFunction = 'all' . $name . 's'; - $allBlocks = $baoString::$baoFunction( $contactId, $updateBlankLocInfo ); + $allBlocks = $baoString::$baoFunction($contactId, $updateBlankLocInfo); } elseif (!empty($entityElements) && $blockName != 'openid') { $baoFunction = 'allEntity' . $name . 's'; - $allBlocks = $baoString::$baoFunction( $entityElements ); + $allBlocks = $baoString::$baoFunction($entityElements); } return $allBlocks; } /** - * Takes an associative array and creates a block + * Takes an associative array and creates a block. * - * @param string $blockName block name - * @param array $params (reference ) an assoc array of name/value pairs + * @param string $blockName + * Block name. + * @param array $params + * (reference ) an assoc array of name/value pairs. * @param null $entity * @param int $contactId * - * @return object CRM_Core_BAO_Block object on success, null otherwise - * @access public - * @static + * @return object + * CRM_Core_BAO_Block object on success, null otherwise */ - static function create($blockName, &$params, $entity = NULL, $contactId = NULL) { + public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) { if (!self::blockExists($blockName, $params)) { return NULL; } - $name = ucfirst($blockName); - $contactId = NULL; - $isPrimary = $isBilling = TRUE; + $name = ucfirst($blockName); + $contactId = NULL; + $isPrimary = $isBilling = TRUE; $entityElements = $blocks = array(); if ($entity) { @@ -269,7 +275,7 @@ class CRM_Core_BAO_Block { } if ($resetPrimaryId) { $baoString = 'CRM_Core_BAO_' . $blockName; - $block = new $baoString( ); + $block = new $baoString(); $block->selectAdd(); $block->selectAdd("id, is_primary"); $block->id = $resetPrimaryId; @@ -369,7 +375,7 @@ class CRM_Core_BAO_Block { $blockFields = array_merge($value, $contactFields); $baoString = 'CRM_Core_BAO_' . $name; - $blocks[] = $baoString::add( $blockFields ); + $blocks[] = $baoString::add($blockFields); } // we need to delete blocks that were deleted during update @@ -386,15 +392,16 @@ class CRM_Core_BAO_Block { } /** - * Delete block + * Delete block. * - * @param string $blockName block name - * @param int $params associates array + * @param string $blockName + * Block name. + * @param int $params + * Associates array. * * @return void - * @static */ - static function blockDelete($blockName, $params) { + public static function blockDelete($blockName, $params) { $name = ucfirst($blockName); if ($blockName == 'im') { $name = 'IM'; @@ -404,12 +411,11 @@ class CRM_Core_BAO_Block { } $baoString = 'CRM_Core_DAO_' . $name; - $block = new $baoString( ); + $block = new $baoString(); $block->copyValues($params); - /* - * CRM-11006 add call to pre and post hook for delete action - */ + + // CRM-11006 add call to pre and post hook for delete action CRM_Utils_Hook::pre('delete', $name, $block->id, CRM_Core_DAO::$_nullArray); $block->delete(); CRM_Utils_Hook::post('delete', $name, $block->id, $block); @@ -433,7 +439,6 @@ class CRM_Core_BAO_Block { * @param $class * * @throws API_Exception - * @static */ public static function handlePrimary(&$params, $class) { $table = CRM_Core_DAO_AllCoreTables::getTableForClass($class); @@ -460,7 +465,7 @@ class CRM_Core_BAO_Block { $sql = "UPDATE $table SET is_primary = 0 WHERE contact_id = %1"; $sqlParams = array(1 => array($contactId, 'Integer')); // we don't want to create unecessary entries in the log_ tables so exclude the one we are working on - if(!empty($params['id'])){ + if (!empty($params['id'])) { $sql .= " AND id <> %2"; $sqlParams[2] = array($params['id'], 'Integer'); } @@ -483,7 +488,7 @@ class CRM_Core_BAO_Block { * is_primary to 1 * CRM-10451 */ - if ( $existingEntities->N == 1 && $existingEntities->id == CRM_Utils_Array::value( 'id', $params ) ) { + if ($existingEntities->N == 1 && $existingEntities->id == CRM_Utils_Array::value('id', $params)) { $params['is_primary'] = 1; return; } @@ -500,23 +505,22 @@ class CRM_Core_BAO_Block { } /** - * Sort location array so primary element is first + * Sort location array so primary element is first. * * @param array $locations - * */ - static function sortPrimaryFirst(&$locations){ + public static function sortPrimaryFirst(&$locations) { uasort($locations, 'self::primaryComparison'); } -/** - * compare 2 locations to see which should go first based on is_primary - * (sort function for sortPrimaryFirst) - * @param array $location1 - * @param array $location2 - * @return number - */ - static function primaryComparison($location1, $location2){ + /** + * compare 2 locations to see which should go first based on is_primary + * (sort function for sortPrimaryFirst) + * @param array $location1 + * @param array $location2 + * @return int + */ + public static function primaryComparison($location1, $location2) { $l1 = CRM_Utils_Array::value('is_primary', $location1); $l2 = CRM_Utils_Array::value('is_primary', $location2); if ($l1 == $l2) { @@ -524,5 +528,5 @@ class CRM_Core_BAO_Block { } return ($l1 < $l2) ? -1 : 1; } -} +}