X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FCore%2FBAO%2FPhone.php;h=b83e8ff917045bb25c377414d5b959f96e35b2c3;hb=76e7a76c36e82fca4901e87abf8f1afddf2384ef;hp=d1a80847e683c8b6bc969ab78fd2522240318e39;hpb=397d0aec7771968e6ad649229f9a72c9c0e9b12c;p=civicrm-core.git diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index d1a80847e6..b83e8ff917 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -38,13 +38,10 @@ */ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { - /* + /** * Create phone object - note that the create function calls 'add' but * has more business logic * - * @param array $params input parameters - */ - /** * @param array $params * * @return object @@ -68,10 +65,11 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { /** * Takes an associative array and adds phone * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * - * @return object CRM_Core_BAO_Phone object on success, null otherwise - * @static + * @return object + * CRM_Core_BAO_Phone object on success, null otherwise */ public static function add(&$params) { // Ensure mysql phone function exists @@ -94,8 +92,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * * @param array entityBlock input parameters to find object * - * @return array array of phone objects - * @static + * @return array + * array of phone objects */ public static function &getValues($entityBlock) { $getValues = CRM_Core_BAO_Block::getValues('phone', $entityBlock); @@ -105,14 +103,15 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { /** * Get all the phone numbers for a specified contact_id, with the primary being first * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * @param null $type * @param array $filters * - * @return array the array of phone ids which are potential numbers - * @static + * @return array + * the array of phone ids which are potential numbers */ public static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = array()) { if (!$id) { @@ -152,8 +151,8 @@ ORDER BY civicrm_phone.is_primary DESC, phone_id ASC "; ); $numbers = $values = array(); - $dao = CRM_Core_DAO::executeQuery($query, $params); - $count = 1; + $dao = CRM_Core_DAO::executeQuery($query, $params); + $count = 1; while ($dao->fetch()) { $values = array( 'locationType' => $dao->locationType, @@ -177,13 +176,14 @@ ORDER BY civicrm_phone.is_primary DESC, phone_id ASC "; /** * Get all the phone numbers for a specified location_block id, with the primary phone being first * - * @param array $entityElements the array containing entity_id and - * entity_table name + * @param array $entityElements + * The array containing entity_id and. + * entity_table name * * @param null $type * - * @return array the array of phone ids which are potential numbers - * @static + * @return array + * the array of phone ids which are potential numbers */ public static function allEntityPhones($entityElements, $type = NULL) { if (empty($entityElements)) { @@ -233,10 +233,10 @@ ORDER BY ph.is_primary DESC, phone_id ASC "; /** * Set NULL to phone, mapping, uffield * - * @param $optionId value of option to be deleted + * @param $optionId + * Value of option to be deleted. * - * return void - * @static + * @return void */ public static function setOptionToNull($optionId) { if (!$optionId) {