From 77c5b6193c63d17f0c16a20b4dd4aa3a0adf8d5b Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:07 -0800 Subject: [PATCH] INFRA-132 - CRM/Contact - Convert single-line @param to multi-line --- CRM/Contact/BAO/Contact.php | 191 ++++++++++++------ CRM/Contact/BAO/Contact/Location.php | 9 +- CRM/Contact/BAO/Contact/Permission.php | 15 +- CRM/Contact/BAO/Contact/Utils.php | 101 +++++---- CRM/Contact/BAO/ContactType.php | 57 ++++-- CRM/Contact/BAO/Group.php | 48 +++-- CRM/Contact/BAO/GroupContact.php | 83 +++++--- CRM/Contact/BAO/GroupContactCache.php | 41 ++-- CRM/Contact/BAO/GroupNesting.php | 72 ++++--- CRM/Contact/BAO/GroupOrganization.php | 15 +- CRM/Contact/BAO/Household.php | 6 +- CRM/Contact/BAO/Individual.php | 15 +- CRM/Contact/BAO/Query.php | 120 +++++++---- CRM/Contact/BAO/Query/Interface.php | 6 +- CRM/Contact/BAO/Relationship.php | 168 ++++++++++----- CRM/Contact/BAO/RelationshipType.php | 18 +- CRM/Contact/BAO/SavedSearch.php | 21 +- CRM/Contact/BAO/SubscriptionHistory.php | 6 +- CRM/Contact/Form/Contact.php | 33 ++- CRM/Contact/Form/DedupeRules.php | 3 +- CRM/Contact/Form/Domain.php | 3 +- CRM/Contact/Form/Edit/Address.php | 15 +- .../Form/Edit/CommunicationPreferences.php | 9 +- CRM/Contact/Form/Edit/CustomData.php | 3 +- CRM/Contact/Form/Edit/Demographics.php | 3 +- CRM/Contact/Form/Edit/Email.php | 9 +- CRM/Contact/Form/Edit/Household.php | 12 +- CRM/Contact/Form/Edit/IM.php | 9 +- CRM/Contact/Form/Edit/Individual.php | 12 +- CRM/Contact/Form/Edit/Lock.php | 9 +- CRM/Contact/Form/Edit/OpenID.php | 9 +- CRM/Contact/Form/Edit/Organization.php | 6 +- CRM/Contact/Form/Edit/Phone.php | 9 +- CRM/Contact/Form/Edit/TagsAndGroups.php | 33 ++- CRM/Contact/Form/Edit/Website.php | 6 +- CRM/Contact/Form/Inline/Email.php | 6 +- CRM/Contact/Form/Inline/IM.php | 6 +- CRM/Contact/Form/Inline/Lock.php | 9 +- CRM/Contact/Form/Inline/OpenID.php | 6 +- CRM/Contact/Form/Inline/Phone.php | 6 +- CRM/Contact/Form/Relationship.php | 3 +- CRM/Contact/Form/Search/Advanced.php | 3 +- .../Custom/FullText/AbstractPartialQuery.php | 18 +- CRM/Contact/Form/Task.php | 6 +- CRM/Contact/Form/Task/AddToHousehold.php | 3 +- CRM/Contact/Form/Task/Batch.php | 9 +- CRM/Contact/Form/Task/Delete.php | 9 +- CRM/Contact/Form/Task/EmailCommon.php | 6 +- CRM/Contact/Form/Task/Label.php | 9 +- CRM/Contact/Form/Task/LabelCommon.php | 16 +- CRM/Contact/Form/Task/Map.php | 3 +- CRM/Contact/Form/Task/PDFLetterCommon.php | 6 +- CRM/Contact/Form/Task/PickProfile.php | 3 +- CRM/Contact/Form/Task/ProximityCommon.php | 6 +- CRM/Contact/Form/Task/SMSCommon.php | 6 +- CRM/Contact/Import/Form/MapField.php | 3 +- CRM/Contact/Import/Form/Preview.php | 3 +- CRM/Contact/Import/Parser.php | 6 +- CRM/Contact/Import/Parser/Contact.php | 66 ++++-- CRM/Contact/Page/SavedSearch.php | 3 +- CRM/Contact/Page/View.php | 2 +- CRM/Contact/Page/View/GroupContact.php | 6 +- CRM/Contact/Selector.php | 41 ++-- CRM/Contact/Selector/Custom.php | 32 ++- CRM/Contact/StateMachine/Search.php | 3 +- CRM/Contact/Task.php | 3 +- 66 files changed, 981 insertions(+), 501 deletions(-) diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 6b4b2d42c1..96f461e1ba 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -108,7 +108,8 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * contact object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Contact_BAO_Contact object * @static @@ -265,9 +266,12 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { * * This function is invoked from within the web form layer and also from the api layer * - * @param array $params (reference ) an assoc array of name/value pairs - * @param boolean $fixAddress if we need to fix address - * @param boolean $invokeHooks if we need to invoke hooks + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param bool $fixAddress + * If we need to fix address. + * @param bool $invokeHooks + * If we need to invoke hooks. * * @param bool $skipDelete * @@ -463,7 +467,8 @@ class CRM_Contact_BAO_Contact extends CRM_Contact_DAO_Contact { /** * Get the display name and image of a contact * - * @param int $id the contactId + * @param int $id + * The contactId. * * @param bool $type * @@ -511,7 +516,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); } /** - * @param array $crudLinkSpec with keys: + * @param array $crudLinkSpec + * With keys:. * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW] * - entity_table: string, eg "civicrm_contact" * - entity_id: int @@ -549,8 +555,10 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); /** * Get the values for pseudoconstants for name->value and reverse. * - * @param array $defaults (reference) the default values, some of which need to be resolved. - * @param boolean $reverse true if we want to resolve the values in the reverse direction (value -> name) + * @param array $defaults + * (reference) the default values, some of which need to be resolved. + * @param bool $reverse + * True if we want to resolve the values in the reverse direction (value -> name). * * @return void * @static @@ -678,10 +686,13 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the name / value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the name / value pairs. * in a hierarchical manner - * @param boolean $microformat for location in microformat + * @param bool $microformat + * For location in microformat. * * @return CRM_Contact_BAO_Contact object * @static @@ -726,7 +737,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); /** * Get the display name of a contact * - * @param int $id id of the contact + * @param int $id + * Id of the contact. * * @return null|string display name of the contact if found * @static @@ -743,9 +755,12 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); /** * Delete a contact and all its associated records * - * @param int $id id of the contact to delete - * @param bool $restore whether to actually restore, not delete - * @param bool $skipUndelete whether to force contact delete or not + * @param int $id + * Id of the contact to delete. + * @param bool $restore + * Whether to actually restore, not delete. + * @param bool $skipUndelete + * Whether to force contact delete or not. * * @return boolean true if contact deleted, false otherwise * @static @@ -877,7 +892,8 @@ WHERE civicrm_contact.id = " . CRM_Utils_Type::escape($id, 'Integer'); /** * Delete the image of a contact * - * @param int $id id of the contact + * @param int $id + * Id of the contact. * * @return boolean true if contact image is deleted */ @@ -897,7 +913,8 @@ WHERE id={$id}; "; * Return relative path * @todo make this a method of $config->userSystem (i.e. UF classes) rather than a static function * - * @param string $absolutePath absolute path + * @param string $absolutePath + * Absolute path. * * @return String $relativePath Relative url of uploaded image */ @@ -933,9 +950,11 @@ WHERE id={$id}; "; /** * Return proportional height and width of the image * - * @param Integer $imageWidth width of image + * @param Integer $imageWidth + * Width of image. * - * @param Integer $imageHeight height of image + * @param Integer $imageHeight + * Height of image. * * @return Array thumb dimension of image */ @@ -963,9 +982,12 @@ WHERE id={$id}; "; * Validate type of contact image * * @param array $params - * @param String $imageIndex index of image field - * @param String $statusMsg status message to be set after operation - * @param string $opType type of operation like fatal, bounce etc + * @param String $imageIndex + * Index of image field. + * @param String $statusMsg + * Status message to be set after operation. + * @param string $opType + * Type of operation like fatal, bounce etc. * * @return boolean true if valid image extension */ @@ -1057,7 +1079,8 @@ WHERE id={$id}; "; /** * Get contact type for a contact. * - * @param int $id - id of the contact whose contact type is needed + * @param int $id + * Id of the contact whose contact type is needed. * * @return string contact_type if $id found else null "" * @@ -1072,7 +1095,8 @@ WHERE id={$id}; "; /** * Get contact sub type for a contact. * - * @param int $id - id of the contact whose contact sub type is needed + * @param int $id + * Id of the contact whose contact sub type is needed. * * @param null $implodeDelimiter * @@ -1098,7 +1122,8 @@ WHERE id={$id}; "; /** * Get pair of contact-type and sub-type for a contact. * - * @param int $id - id of the contact whose contact sub/contact type is needed + * @param int $id + * Id of the contact whose contact sub/contact type is needed. * * @return array * @@ -1135,10 +1160,14 @@ WHERE id={$id}; "; * scheme. Adding weight is super important * * @param int|string $contactType contact Type - * @param boolean $status status is used to manipulate first title - * @param boolean $showAll if true returns all fields (includes disabled fields) - * @param boolean $isProfile if its profile mode - * @param boolean $checkPermission if false, do not include permissioning clause (for custom data) + * @param bool $status + * Status is used to manipulate first title. + * @param bool $showAll + * If true returns all fields (includes disabled fields). + * @param bool $isProfile + * If its profile mode. + * @param bool $checkPermission + * If false, do not include permissioning clause (for custom data). * * @param bool $withMultiCustomFields * @@ -1328,9 +1357,12 @@ WHERE id={$id}; "; * currentlty we are using importable fields as exportable fields * * @param int|string $contactType contact Type - * @param boolean $status true while exporting primary contacts - * @param boolean $export true when used during export - * @param boolean $search true when used during search, might conflict with export param? + * @param bool $status + * True while exporting primary contacts. + * @param bool $export + * True when used during export. + * @param bool $search + * True when used during search, might conflict with export param?. * * @param bool $withMultiRecord * @@ -1563,8 +1595,10 @@ WHERE id={$id}; "; /** * Get the all contact details(Hierarchical) * - * @param int $contactId contact id - * @param array $fields fields array + * @param int $contactId + * Contact id. + * @param array $fields + * Fields array. * * @return $values array contains the contact details * @static @@ -1590,7 +1624,8 @@ WHERE id={$id}; "; * for query to use and crete the right sql * * @param $fields - * @param int $contactId contact id + * @param int $contactId + * Contact id. * * @return array a hierarchical property tree if appropriate * @static @@ -1722,7 +1757,8 @@ WHERE civicrm_contact.id = %1 "; /** * Get the display name, primary email and location type of a contact * - * @param int $id id of the contact + * @param int $id + * Id of the contact. * * @return array of display_name, email if found, do_not_email or (null,null,null) * @static @@ -1765,13 +1801,19 @@ ORDER BY civicrm_email.is_primary DESC"; /** * Add/edit/register contacts through profile. * - * @param array $params Array of profile fields to be edited/added. - * @param array $fields Array of fields from UFGroup - * @param int $contactID id of the contact to be edited/added. - * @param int $addToGroupID specifies the default group to which contact is added. - * @param int $ufGroupId uf group id (profile id) + * @param array $params + * Array of profile fields to be edited/added. + * @param array $fields + * Array of fields from UFGroup. + * @param int $contactID + * Id of the contact to be edited/added. + * @param int $addToGroupID + * Specifies the default group to which contact is added. + * @param int $ufGroupId + * Uf group id (profile id). * @param ctype - * @param boolean $visibility basically lets us know where this request is coming from + * @param bool $visibility + * Basically lets us know where this request is coming from. * if via a profile from web, we restrict what groups are changed * * @return int contact id created/edited @@ -2239,8 +2281,10 @@ ORDER BY civicrm_email.is_primary DESC"; * does not respect ACLs for now, which might need to be rectified at some * stage based on how its used * - * @param string $mail primary email address of the contact - * @param string $ctype contact type + * @param string $mail + * Primary email address of the contact. + * @param string $ctype + * Contact type. * * @return object $dao contact details * @static @@ -2291,8 +2335,10 @@ WHERE civicrm_email.email = %1 AND civicrm_contact.is_deleted=0"; /** * Find the contact details associated with an OpenID * - * @param string $openId openId of the contact - * @param string $ctype contact type + * @param string $openId + * OpenId of the contact. + * @param string $ctype + * Contact type. * * @return object $dao contact details * @static @@ -2328,7 +2374,8 @@ WHERE civicrm_openid.openid = %1"; /** * Funtion to get primary email of the contact * - * @param int $contactID contact id + * @param int $contactID + * Contact id. * * @return string $dao->email email address if present else null * @static @@ -2355,7 +2402,8 @@ LEFT JOIN civicrm_email ON ( civicrm_contact.id = civicrm_email.contact_id ) /** * Funtion to get primary OpenID of the contact * - * @param int $contactID contact id + * @param int $contactID + * Contact id. * * @return string $dao->openid OpenID if present else null * @static @@ -2383,8 +2431,10 @@ AND civicrm_openid.is_primary = 1"; * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. * * @return CRM_Contact_BAO_Contact|null the found object or null * @static @@ -2466,9 +2516,12 @@ AND civicrm_openid.is_primary = 1"; * Given the component name and returns * the count of participation of contact * - * @param string $component input component name - * @param integer $contactId input contact id - * @param string $tableName optional tableName if component is custom group + * @param string $component + * Input component name. + * @param int $contactId + * Input contact id. + * @param string $tableName + * Optional tableName if component is custom group. * * @return total number of count of occurence in database * @static @@ -2543,8 +2596,10 @@ AND civicrm_openid.is_primary = 1"; /** * Process greetings and cache * - * @param object $contact contact object after save - * @param boolean $useDefaults use default greeting values + * @param object $contact + * Contact object after save. + * @param bool $useDefaults + * Use default greeting values. * * @return void * @static @@ -2693,10 +2748,13 @@ AND civicrm_openid.is_primary = 1"; /** * Retrieve loc block ids w/ given condition. * - * @param int $contactId contact id. - * @param array $criteria key => value pair which should be + * @param int $contactId + * Contact id. + * @param array $criteria + * Key => value pair which should be. * fulfill by return record ids. - * @param string $condOperator operator use for grouping multiple conditions. + * @param string $condOperator + * Operator use for grouping multiple conditions. * * @return array $locBlockIds loc block ids which fulfill condition. * @static @@ -3006,8 +3064,10 @@ AND civicrm_openid.is_primary = 1"; * Retrieve display name of contact that address is shared * based on $masterAddressId or $contactId . * - * @param int $masterAddressId master id. - * @param int $contactId contact id. + * @param int $masterAddressId + * Master id. + * @param int $contactId + * Contact id. * * @return display name |null the found display name or null. * @static @@ -3176,7 +3236,8 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * Check if contact is being used in civicrm_domain * based on $contactId * - * @param int $contactId contact id. + * @param int $contactId + * Contact id. * * @return bool true if present else false. * @static @@ -3200,9 +3261,11 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow? * TODO: In context of chainselect, what to return if e.g. a country has no states? * - * @param String $fieldName - * @param String $context : @see CRM_Core_DAO::buildOptionsContext - * @param Array $props : whatever is known about this dao object + * @param string $fieldName + * @param string $context + * : @see CRM_Core_DAO::buildOptionsContext. + * @param array $props + * : whatever is known about this dao object. * * @return Array|bool */ diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index 1c71e5e257..435e2ca4a4 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -37,7 +37,8 @@ class CRM_Contact_BAO_Contact_Location { /** * Get the display name, primary email, location type and location id of a contact * - * @param int $id id of the contact + * @param int $id + * Id of the contact. * * @param bool $isPrimary * @param int $locationTypeID @@ -77,7 +78,8 @@ WHERE civicrm_contact.id = %1"; /** * Get the sms number and display name of a contact * - * @param int $id id of the contact + * @param int $id + * Id of the contact. * * @param null $type * @@ -114,7 +116,8 @@ LEFT JOIN civicrm_phone ON ( civicrm_phone.contact_id = civicrm_contact.id ) /** * Get the information to map a contact * - * @param array $ids the list of ids for which we want map info + * @param array $ids + * The list of ids for which we want map info. * $param int $locationTypeID * * @param int $locationTypeID diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 9f6498e33a..6b3d162984 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -37,7 +37,8 @@ class CRM_Contact_BAO_Contact_Permission { /** * Check if the logged in user has permissions for the operation type * - * @param int $id contact id + * @param int $id + * Contact id. * @param int|string $type the type of operation (view|edit) * * @return boolean true if the user has permission, false otherwise @@ -84,7 +85,8 @@ WHERE contact_a.id = %1 AND $permission"; * * @param int $userID * @param int|string $type the type of operation (view|edit) - * @param boolean $force should we force a recompute + * @param bool $force + * Should we force a recompute. * * @return void * @static @@ -150,7 +152,8 @@ ON DUPLICATE KEY UPDATE * Check if there are any contacts in cache table * * @param int|string $type the type of operation (view|edit) - * @param int $contactID contact id + * @param int $contactID + * Contact id. * * @return boolean * @static @@ -239,8 +242,10 @@ AND $operationClause LIMIT 1"; /** * Get the permission base on its relationship * - * @param int $selectedContactID contact id of selected contact - * @param int $contactID contact id of the current contact + * @param int $selectedContactID + * Contact id of selected contact. + * @param int $contactID + * Contact id of the current contact. * * @return bool true if logged in user has permission to view * selected contact record else false diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index e0964e61ac..53a67454fe 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -37,10 +37,14 @@ class CRM_Contact_BAO_Contact_Utils { /** * Given a contact type, get the contact image * - * @param string $contactType contact type - * @param boolean $urlOnly if we need to return only image url - * @param int $contactId contact id - * @param boolean $addProfileOverlay if profile overlay class should be added + * @param string $contactType + * Contact type. + * @param bool $urlOnly + * If we need to return only image url. + * @param int $contactId + * Contact id. + * @param bool $addProfileOverlay + * If profile overlay class should be added. * * @return string * @static @@ -113,7 +117,8 @@ class CRM_Contact_BAO_Contact_Utils { /** * Function check for mix contact ids(individual+household etc...) * - * @param array $contactIds array of contact ids + * @param array $contactIds + * Array of contact ids. * * @return boolen true or false true if mix contact array else fale * @@ -140,9 +145,12 @@ WHERE id IN ( $idString ) * Generate a checksum for a $entityId of type $entityType * * @param int $entityId - * @param int $ts timestamp that checksum was generated - * @param int $live life of this checksum in hours/ 'inf' for infinite - * @param string $hash contact hash, if sent, prevents a query in inner loop + * @param int $ts + * Timestamp that checksum was generated. + * @param int $live + * Life of this checksum in hours/ 'inf' for infinite. + * @param string $hash + * Contact hash, if sent, prevents a query in inner loop. * * @param string $entityType * @param null $hashSize @@ -211,8 +219,9 @@ WHERE id IN ( $idString ) /** * Make sure the checksum is valid for the passed in contactID * - * @param int $contactID - * @param string $inputCheck checksum to match against + * @param int $contactID + * @param string $inputCheck + * Checksum to match against. * * @return boolean true if valid, else false * @static @@ -244,7 +253,8 @@ WHERE id IN ( $idString ) /** * Get the count of contact loctions * - * @param int $contactId contact id + * @param int $contactId + * Contact id. * * @return int $locationCount max locations for the contact * @static @@ -270,8 +280,10 @@ UNION /** * Create Current employer relationship for a individual * - * @param int $contactID contact id of the individual - * @param $organization (id or name) + * @param int $contactID + * Contact id of the individual. + * @param $organization + * (id or name). * @param int $previousEmployerID * @param bool $newContact * @@ -346,10 +358,14 @@ UNION /** * Create related memberships for current employer * - * @param int $contactID contact id of the individual - * @param int $employerID contact id of the organization. - * @param array $relationshipParams relationship params. - * @param boolean $duplicate are we triggered existing relationship. + * @param int $contactID + * Contact id of the individual. + * @param int $employerID + * Contact id of the organization. + * @param array $relationshipParams + * Relationship params. + * @param bool $duplicate + * Are we triggered existing relationship. * * @param int $previousEmpID * @@ -385,7 +401,8 @@ UNION /** * Set current employer id and organization name * - * @param array $currentEmployerParams associated array of contact id and its employer id + * @param array $currentEmployerParams + * Associated array of contact id and its employer id. * */ public static function setCurrentEmployer($currentEmployerParams) { @@ -403,7 +420,8 @@ WHERE contact_a.id ={$contactId} AND contact_b.id={$orgId}; "; /** * Update cached current employer name * - * @param int $organizationId current employer id + * @param int $organizationId + * Current employer id. * */ public static function updateCurrentEmployer($organizationId) { @@ -417,8 +435,10 @@ WHERE contact_a.employer_id=contact_b.id AND contact_b.id={$organizationId}; "; /** * Clear cached current employer name * - * @param int $contactId contact id ( mostly individual contact id) - * @param int $employerId contact id ( mostly organization contact id) + * @param int $contactId + * Contact id ( mostly individual contact id). + * @param int $employerId + * Contact id ( mostly organization contact id). * */ public static function clearCurrentEmployer($contactId, $employerId = NULL) { @@ -464,10 +484,12 @@ WHERE id={$contactId}; "; * Build form for related contacts / on behalf of organization. * * @param CRM_Core_Form $form - * @param $contactType string contact type + * @param $contactType + * String contact type. * @param int $countryID * @param int $stateID - * @param $title string fieldset title + * @param $title + * String fieldset title. * * @static */ @@ -539,7 +561,8 @@ WHERE id={$contactId}; "; * Clear cache employer name and employer id * of all employee when employer get deleted. * - * @param int $employerId contact id of employer ( organization id ) + * @param int $employerId + * Contact id of employer ( organization id ). * */ public static function clearAllEmployee($employerId) { @@ -554,10 +577,12 @@ UPDATE civicrm_contact /** * Given an array of contact ids this function will return array with links to view contact page * - * @param array $contactIDs associated contact id's + * @param array $contactIDs + * Associated contact id's. * @param bool $addViewLink * @param bool $addEditLink - * @param int $originalId associated with the contact which is edited + * @param int $originalId + * Associated with the contact which is edited. * * * @return array $contactViewLinks returns array with links to contact view @@ -660,9 +685,11 @@ LEFT JOIN civicrm_email ce ON ( ce.contact_id=c.id AND ce.is_primary = 1 ) /** * This function retrieve component related contact information. * - * @param array $componentIds array of component Ids. + * @param array $componentIds + * Array of component Ids. * @param string $componentName - * @param array $returnProperties array of return elements. + * @param array $returnProperties + * Array of return elements. * * @return array $contactDetails array of contact info.@static */ @@ -787,7 +814,8 @@ Group By componentId"; * has same address as shared contact address. We copy the address so that search etc will be * much efficient. * - * @param array $address this is associated array which contains submitted form values + * @param array $address + * This is associated array which contains submitted form values. * * @return void * @static @@ -837,7 +865,8 @@ Group By componentId"; /** * Get the list of contact name give address associated array * - * @param array $addresses associated array of + * @param array $addresses + * Associated array of. * * @return array $contactNames associated array of contact names@static */ @@ -875,7 +904,8 @@ Group By componentId"; * caches, but are backing off from this with every release. Compromise between ease of coding versus * performance versus being accurate at that very instant * - * @param $contactID - the contactID that was edited / deleted + * @param $contactID + * The contactID that was edited / deleted. * * @return void * @static @@ -1047,8 +1077,10 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; /** * Fetch the default greeting for a given contact type * - * @param string $contactType contact type - * @param string $greetingType greeting type + * @param string $contactType + * Contact type. + * @param string $greetingType + * Greeting type. * * @return int or null */ @@ -1082,7 +1114,8 @@ WHERE id IN (" . implode(',', $contactIds) . ")"; * by the token substitution mechanism, * before Smarty is invoked. * - * @param string $templateString the greeting template string with contact tokens + Smarty syntax + * @param string $templateString + * The greeting template string with contact tokens + Smarty syntax. * * @param $contactDetails * @param int $contactID diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 76181fa440..eb3260b1ad 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -37,8 +37,10 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contact_BAO_ContactType object on success, null otherwise * @static @@ -142,7 +144,8 @@ WHERE parent_id IS NULL /** * Retrieve all subtypes Information. * - * @param array $contactType . + * @param array $contactType + * .. * @param bool $all * @param bool $ignoreCache * @param bool $reset @@ -210,7 +213,8 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * * retrieve all subtypes * - * @param array $contactType . + * @param array $contactType + * .. * @param bool $all * @param string $columnName * @param bool $ignoreCache @@ -232,7 +236,8 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * * retrieve subtype pairs with name as 'subtype-name' and 'label' as value * - * @param array $contactType . + * @param array $contactType + * .. * @param bool $all * @param string $labelPrefix * @param bool $ignoreCache @@ -441,7 +446,8 @@ AND ( p.is_active = 1 OR p.id IS NULL ) /** * Check if a given type is a subtype * - * @param string $subType contact subType. + * @param string $subType + * Contact subType. * @param bool $ignoreCache * * @return boolean true if subType, false otherwise. @@ -495,7 +501,8 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; /** * Suppress all subtypes present in given array. * - * @param array $subTypes contact subTypes + * @param array $subTypes + * Contact subTypes. * @param bool $ignoreCache * * @return array of suppressed subTypes. @@ -509,8 +516,10 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; /** * Verify if a given subtype is associated with a given basic contact type. * - * @param string $subType contact subType - * @param string $contactType contact Type + * @param string $subType + * Contact subType. + * @param string $contactType + * Contact Type. * @param bool $ignoreCache * @param string $columnName * @@ -566,7 +575,8 @@ WHERE subtype.name IN ('" . implode("','", $subType) . "' )"; /** * Delete Contact SubTypes * - * @param int $contactTypeId ID of the Contact Subtype to be deleted. + * @param int $contactTypeId + * ID of the Contact Subtype to be deleted. * * @return bool * @static @@ -618,7 +628,8 @@ WHERE name = %1"; /** * Add or update Contact SubTypes * - * @param array $params an assoc array of name/value pairs + * @param array $params + * An assoc array of name/value pairs. * * @return object * @static @@ -683,8 +694,10 @@ WHERE name = %1"; /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on success, null otherwise * @static @@ -720,8 +733,10 @@ WHERE name = %1"; * on the basis of custom data and relationship of specific subtype * currently used in contact/edit form amd in import validation * - * @param int $contactId contact id. - * @param string $subType subtype. + * @param int $contactId + * Contact id. + * @param string $subType + * Subtype. * * @return boolean true/false. * @static @@ -877,8 +892,10 @@ WHERE extends = %1 AND " . implode(" OR ", $subTypeClause); * This function currently works for contact subtypes only and could be later improved / genralized * to work for other subtypes as well. * - * @param int $gID - custom group id. - * @param array $subtypes - list of subtypes related to which entry is to be removed. + * @param int $gID + * Custom group id. + * @param array $subtypes + * List of subtypes related to which entry is to be removed. * * @return void */ @@ -913,8 +930,10 @@ WHERE ($subtypeClause)"; /** * Delete content / rows of a custom table specific entity-id for a given custom-group table. * - * @param int $customTable - custom table name. - * @param int $entityID - entity id. + * @param int $customTable + * Custom table name. + * @param int $entityID + * Entity id. * * @return void */ diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php index cb56c73178..8b27b05ac9 100644 --- a/CRM/Contact/BAO/Group.php +++ b/CRM/Contact/BAO/Group.php @@ -48,8 +48,10 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * of time. This is the inverse function of create. It also stores all the retrieved * values in the default array * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contact_BAO_Group object * @static @@ -69,7 +71,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * Delete the group and all the object that connect to * this group. Incredibly destructive * - * @param int $id group id + * @param int $id + * Group id. * * @return null * @static @@ -152,7 +155,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Get the count of a members in a group with the specific status * - * @param int $id group id + * @param int $id + * Group id. * @param enum|string $status status of members in group * * @param bool $countChildGroups @@ -220,8 +224,10 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Returns array of group object(s) matching a set of one or Group properties. * - * @param array $params Limits the set of groups returned. - * @param array $returnProperties Which properties should be included in the returned group objects. + * @param array $params + * Limits the set of groups returned. + * @param array $returnProperties + * Which properties should be included in the returned group objects. * (member_count should be last element.) * * @param null $sort @@ -300,7 +306,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Make sure that the user has permission to access this group * - * @param int $id the id of the object + * @param int $id + * The id of the object. * * @return string the permission that the user has (or null) * @static @@ -338,7 +345,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Create a new group * - * @param array $params Associative array of parameters + * @param array $params + * Associative array of parameters. * * @return object|null The new group BAO (if created) * @static @@ -519,7 +527,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Defines a new smart group * - * @param array $params Associative array of parameters + * @param array $params + * Associative array of parameters. * * @return object|null The new group BAO (if created) * @static @@ -546,8 +555,10 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $isActive value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $isActive + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static @@ -559,7 +570,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * Build the condition to retrieve groups. * - * @param string $groupType type of group(Access/Mailing) OR the key of the group + * @param string $groupType + * Type of group(Access/Mailing) OR the key of the group. * @param bool|\boolen $excludeHidden exclude hidden groups. * * @return string $condition @@ -632,7 +644,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { * This function create the hidden smart group when user perform * contact seach and want to send mailing to search contacts. * - * @param array $params ( reference ) an assoc array of name/value pairs + * @param array $params + * ( reference ) an assoc array of name/value pairs. * * @return array ( smartGroupId, ssId ) smart group id and saved search id * @static @@ -701,7 +714,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * This function is a wrapper for ajax group selector * - * @param array $params associated array for params record id. + * @param array $params + * Associated array for params record id. * * @return array $groupList associated array of group list * -rp = rowcount @@ -769,7 +783,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * This function to get list of groups * - * @param array $params associated array for params + * @param array $params + * Associated array for params. * * @return array */ @@ -971,7 +986,8 @@ class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group { /** * This function to get hierarchical list of groups (parent followed by children) * - * @param array $groupIDs array of group ids + * @param array $groupIDs + * Array of group ids. * * @param null $parents * @param string $spacer diff --git a/CRM/Contact/BAO/GroupContact.php b/CRM/Contact/BAO/GroupContact.php index 505f92cf23..865cf46aa7 100644 --- a/CRM/Contact/BAO/GroupContact.php +++ b/CRM/Contact/BAO/GroupContact.php @@ -48,7 +48,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * group object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Contact_BAO_Group object * @static @@ -70,7 +71,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Check if there is data to create the object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return boolean * @static @@ -88,8 +90,10 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. * * @return array (reference) the values that could be potentially assigned to smarty * @static @@ -116,8 +120,10 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Given an array of contact ids, add all the contacts to the group * - * @param array $contactIds the array of contact ids to be added - * @param int $groupId the id of the group + * @param array $contactIds + * The array of contact ids to be added. + * @param int $groupId + * The id of the group. * @param string $method * @param string $status * @param int $tracking @@ -163,8 +169,10 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Given an array of contact ids, remove all the contacts from the group * - * @param array $contactIds (reference ) the array of contact ids to be removed - * @param int $groupId the id of the group + * @param array $contactIds + * (reference ) the array of contact ids to be removed. + * @param int $groupId + * The id of the group. * * @param string $method * @param string $status @@ -263,7 +271,8 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Get list of all the groups and groups for a contact * - * @param int $contactId contact id + * @param int $contactId + * Contact id. * * @param bool $visibility * @@ -305,14 +314,20 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Get the list of groups for contact based on status of group membership * - * @param int $contactId contact id - * @param string $status state of membership - * @param int $numGroupContact number of groups for a contact that should be shown - * @param boolean $count true if we are interested only in the count - * @param boolean $ignorePermission true if we should ignore permissions for the current user + * @param int $contactId + * Contact id. + * @param string $status + * State of membership. + * @param int $numGroupContact + * Number of groups for a contact that should be shown. + * @param bool $count + * True if we are interested only in the count. + * @param bool $ignorePermission + * True if we should ignore permissions for the current user. * useful in profile where permissions are limited for the user. If left * at false only groups viewable by the current user are returned - * @param boolean $onlyPublicGroups true if we want to hide system groups + * @param bool $onlyPublicGroups + * True if we want to hide system groups. * * @param bool $excludeHidden * @@ -436,9 +451,12 @@ class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact { /** * Returns membership details of a contact for a group * - * @param int $contactId id of the contact - * @param int $groupID Id of a perticuler group - * @param string $method If we want the subscription history details for a specific method + * @param int $contactId + * Id of the contact. + * @param int $groupID + * Id of a perticuler group. + * @param string $method + * If we want the subscription history details for a specific method. * * @return object of group contact * @static @@ -477,7 +495,8 @@ SELECT * /** * Method to get Group Id * - * @param int $groupContactID Id of a perticuler group + * @param int $groupContactID + * Id of a perticuler group. * * * @return groupID @@ -495,8 +514,10 @@ SELECT * * contacts from the groups * * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $contactId contact id + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $contactId + * Contact id. * * @param bool $visibility * @param string $method @@ -581,8 +602,10 @@ SELECT * * Function merges the groups from otherContactID to mainContactID * along with subscription history * - * @param int $mainContactId contact id of main contact record. - * @param int $otherContactId contact id of record which is going to merge. + * @param int $mainContactId + * Contact id of main contact record. + * @param int $otherContactId + * Contact id of record which is going to merge. * * @see CRM_Dedupe_Merger::cpTables() * @@ -688,8 +711,10 @@ AND group_id IN ( $groupIDString ) /** * Given an array of contact ids, add all the contacts to the group * - * @param array $contactIDs the array of contact ids to be added - * @param int $groupID the id of the group + * @param array $contactIDs + * The array of contact ids to be added. + * @param int $groupID + * The id of the group. * @param string $method * @param string $status * @param null $tracking @@ -771,9 +796,11 @@ AND contact_id IN ( $contactStr ) * Get options for a given field. * @see CRM_Core_DAO::buildOptions * - * @param String $fieldName - * @param String $context : @see CRM_Core_DAO::buildOptionsContext - * @param Array $props : whatever is known about this dao object + * @param string $fieldName + * @param string $context + * : @see CRM_Core_DAO::buildOptionsContext. + * @param array $props + * : whatever is known about this dao object. * * @return Array|bool */ diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 0e7155f0d1..0e0675293c 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -40,7 +40,8 @@ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCach * Check to see if we have cache entries for this group * if not, regenerate, else return * - * @param $groupIDs of group that we are checking against + * @param $groupIDs + * Of group that we are checking against. * * @return boolean true if we did not regenerate, false if we did */ @@ -56,8 +57,10 @@ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCach * Common function that formulates the query to see which groups needs to be refreshed * based on their cache date and the smartGroupCacheTimeOut * - * @param string $groupIDClause the clause which limits which groups we need to evaluate - * @param boolean $includeHiddenGroups hidden groups are excluded by default + * @param string $groupIDClause + * The clause which limits which groups we need to evaluate. + * @param bool $includeHiddenGroups + * Hidden groups are excluded by default. * * @return string the sql query which lists the groups that need to be refreshed * @static @@ -93,8 +96,10 @@ AND ( g.cache_date IS NULL OR * in a locking scenario when some other process might have refreshed things underneath * this process * - * @param int $groupID the group ID - * @param boolean $includeHiddenGroups hidden groups are excluded by default + * @param int $groupID + * The group ID. + * @param bool $includeHiddenGroups + * Hidden groups are excluded by default. * * @return string the sql query which lists the groups that need to be refreshed * @static @@ -113,7 +118,8 @@ AND ( g.cache_date IS NULL OR * * @param int/array $groupID groupID of group that we are checking against * if empty, all groups are checked - * @param int $limit limits the number of groups we evaluate + * @param int $limit + * Limits the number of groups we evaluate. * * @return boolean true if we did not regenerate, false if we did */ @@ -238,8 +244,10 @@ AND g.refresh_date IS NULL /** * Change the cache_date * - * @param $groupID array(int) - * @param $processed bool, whether the cache data was recently modified + * @param $groupID + * Array(int). + * @param $processed + * Bool, whether the cache data was recently modified. */ public static function updateCacheTime($groupID, $processed) { // only update cache entry if we had any values @@ -271,8 +279,10 @@ WHERE id IN ( $groupIDs ) * cache date, i.e. the removal is not done if the group was recently * loaded into the cache. * - * @param $groupID int the groupID to delete cache entries, NULL for all groups - * @param $onceOnly boolean run the function exactly once for all groups. + * @param $groupID + * Int the groupID to delete cache entries, NULL for all groups. + * @param $onceOnly + * Boolean run the function exactly once for all groups. * * @return void * @static @@ -408,8 +418,10 @@ WHERE id = %1 /** * Load the smart group cache for a saved search * - * @param object $group - the smart group that needs to be loaded - * @param boolean $force - should we force a search through + * @param object $group + * The smart group that needs to be loaded. + * @param bool $force + * Should we force a search through. * */ public static function load(&$group, $force = FALSE) { @@ -591,8 +603,9 @@ AND civicrm_group_contact.group_id = $groupID "; * Note that this could potentially be a super slow function since * it ensure that all contact groups are loaded in the cache * - * @param int $contactID - * @param boolean $showHidden - hidden groups are shown only if this flag is set + * @param int $contactID + * @param bool $showHidden + * Hidden groups are shown only if this flag is set. * * @return array an array of groups that this contact belongs to */ diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index d6ad7f296e..1a27086e77 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -277,8 +277,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Adds a new child group identified by $childGroupId to the group * identified by $groupId * - * @param int $parentID id of the group to add the child to - * @param int $childID id of the new child group + * @param int $parentID + * Id of the group to add the child to. + * @param int $childID + * Id of the new child group. * * * @return void @@ -295,8 +297,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * identified by $groupId; does not delete child group, just the * association between the two * - * @param $parentID The id of the group to remove the child from - * @param $childID The id of the child group being removed + * @param $parentID + * The id of the group to remove the child from. + * @param $childID + * The id of the child group being removed. * * @return void * @@ -312,7 +316,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * identified by $groupId; does not delete child group, just the * association between the two * - * @param int $childID The id of the child group being removed + * @param int $childID + * The id of the child group being removed. * * @return void * @@ -327,8 +332,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if the association between parent and child is present, * false otherwise. * - * @param $parentID The parent id of the association - * @param $childID The child id of the association + * @param $parentID + * The parent id of the association. + * @param $childID + * The child id of the association. * * @return boolean True if association is found, false otherwise. * @@ -347,7 +354,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if if the given groupId has 1 or more child groups, * false otherwise. * - * @param $groupId The id of the group to check for child groups + * @param $groupId + * The id of the group to check for child groups. * * @return boolean True if 1 or more child groups are found, false otherwise. * @@ -367,7 +375,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if the given groupId has 1 or more parent groups, * false otherwise. * - * @param $groupId The id of the group to check for parent groups + * @param $groupId + * The id of the group to check for parent groups. * * @return boolean True if 1 or more parent groups are found, false otherwise. * @@ -386,8 +395,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if checkGroupId is a parent of one of the groups in * groupIds, false otherwise. * - * @param $groupIds Array of group ids (or one group id) to serve as the starting point - * @param $checkGroupId The group id to check if it is a parent of the $groupIds group(s) + * @param $groupIds + * Array of group ids (or one group id) to serve as the starting point. + * @param $checkGroupId + * The group id to check if it is a parent of the $groupIds group(s). * * @return boolean True if $checkGroupId points to a group that is a parent of one of the $groupIds groups, false otherwise. * @@ -416,8 +427,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if checkGroupId is a child of one of the groups in * groupIds, false otherwise. * - * @param $groupIds Array of group ids (or one group id) to serve as the starting point - * @param $checkGroupId The group id to check if it is a child of the $groupIds group(s) + * @param $groupIds + * Array of group ids (or one group id) to serve as the starting point. + * @param $checkGroupId + * The group id to check if it is a child of the $groupIds group(s). * * @return boolean True if $checkGroupId points to a group that is a child of one of the $groupIds groups, false otherwise. * @@ -448,8 +461,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if checkGroupId is an ancestor of one of the groups in * groupIds, false otherwise. * - * @param $groupIds Array of group ids (or one group id) to serve as the starting point - * @param $checkGroupId The group id to check if it is an ancestor of the $groupIds group(s) + * @param $groupIds + * Array of group ids (or one group id) to serve as the starting point. + * @param $checkGroupId + * The group id to check if it is an ancestor of the $groupIds group(s). * * @return boolean True if $checkGroupId points to a group that is an ancestor of one of the $groupIds groups, false otherwise. * @@ -487,8 +502,10 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns true if checkGroupId is a descendent of one of the groups in * groupIds, false otherwise. * - * @param $groupIds Array of group ids (or one group id) to serve as the starting point - * @param $checkGroupId The group id to check if it is a descendent of the $groupIds group(s) + * @param $groupIds + * Array of group ids (or one group id) to serve as the starting point. + * @param $checkGroupId + * The group id to check if it is a descendent of the $groupIds group(s). * * @return boolean True if $checkGroupId points to a group that is a descendent of one of the $groupIds groups, false otherwise. * @@ -525,7 +542,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of group ids of ancestor groups of the specified group. * - * @param $groupIds An array of valid group ids (passed by reference) + * @param $groupIds + * An array of valid group ids (passed by reference). * * @param bool $includeSelf * @@ -561,7 +579,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of ancestor groups of the specified group. * - * @param $groupIds An array of valid group ids (passed by reference) + * @param $groupIds + * An array of valid group ids (passed by reference). * * @param bool $includeSelf * @return \An $groupArray List of ancestor groups@access public @@ -575,7 +594,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of group ids of child groups of the specified group. * - * @param $groupIds An array of valid group ids (passed by reference) + * @param $groupIds + * An array of valid group ids (passed by reference). * * @return array $groupIdArray List of groupIds that represent the requested group and its children@access public */ @@ -596,7 +616,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of group ids of parent groups of the specified group. * - * @param $groupIds An array of valid group ids (passed by reference) + * @param $groupIds + * An array of valid group ids (passed by reference). * * @return array $groupIdArray List of groupIds that represent the requested group and its parents@access public */ @@ -617,7 +638,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of group ids of descendent groups of the specified group. * - * @param $groupIds An array of valid group ids (passed by reference) + * @param $groupIds + * An array of valid group ids (passed by reference). * * @param bool $includeSelf * @return array $groupIdArray List of groupIds that represent the requested group and its descendents@access public @@ -650,7 +672,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of descendent groups of the specified group. * - * @param $groupIds An array of valid group ids (passed by reference) + * @param $groupIds + * An array of valid group ids (passed by reference). * * @param bool $includeSelf * @return \An $groupArray List of descendent groups@access public @@ -664,7 +687,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of group ids of valid potential child groups of the specified group. * - * @param $groupId The group id to get valid potential children for + * @param $groupId + * The group id to get valid potential children for. * * @return array $groupIdArray List of groupIds that represent the valid potential children of the group@access public */ diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php index 42228113d1..3e91e678d8 100644 --- a/CRM/Contact/BAO/GroupOrganization.php +++ b/CRM/Contact/BAO/GroupOrganization.php @@ -44,7 +44,8 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio /** * Takes an associative array and creates a groupOrganization object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Contact_DAO_GroupOrganization * @static @@ -68,8 +69,10 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio /** * Format the params * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $formatedValues (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $formatedValues + * (reference ) an assoc array of name/value pairs. * * @return void * @static @@ -91,7 +94,8 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio /** * Check if there is data to create the object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return boolean * @static @@ -138,7 +142,8 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio /** * Delete Group Organization * - * @param int $groupOrganizationID group organization id that needs to be deleted + * @param int $groupOrganizationID + * Group organization id that needs to be deleted. * * @return mixed|null $results no of deleted group organization on success, false otherwise@access public */ diff --git a/CRM/Contact/BAO/Household.php b/CRM/Contact/BAO/Household.php index 1c50444dc3..75480da7b0 100644 --- a/CRM/Contact/BAO/Household.php +++ b/CRM/Contact/BAO/Household.php @@ -44,8 +44,10 @@ class CRM_Contact_BAO_Household extends CRM_Contact_DAO_Contact { /** * Update the household with primary contact id * - * @param integer $primaryContactId null if deleting primary contact - * @param integer $contactId contact id + * @param int $primaryContactId + * Null if deleting primary contact. + * @param int $contactId + * Contact id. * * @return Object DAO object on success * @static diff --git a/CRM/Contact/BAO/Individual.php b/CRM/Contact/BAO/Individual.php index 19a67969ea..5150e6bc86 100644 --- a/CRM/Contact/BAO/Individual.php +++ b/CRM/Contact/BAO/Individual.php @@ -46,8 +46,10 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { /** * Function is used to format the individual contact values * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $contact contact object + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $contact + * Contact object. * * @return CRM_Contact_BAO_Contact object * @static @@ -334,8 +336,10 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { /** * Regenerates display_name for contacts with given prefixes/suffixes * - * @param array $ids the array with the prefix/suffix id governing which contacts to regenerate - * @param int $action the action describing whether prefix/suffix was UPDATED or DELETED + * @param array $ids + * The array with the prefix/suffix id governing which contacts to regenerate. + * @param int $action + * The action describing whether prefix/suffix was UPDATED or DELETED. * * @return void */ @@ -392,7 +396,8 @@ class CRM_Contact_BAO_Individual extends CRM_Contact_DAO_Contact { /** * Check if there is data to create the object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return boolean * @static diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 4b766157c2..7d621b25c0 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -410,8 +410,8 @@ class CRM_Contact_BAO_Query { * @param array $params * @param array $returnProperties * @param array $fields - * @param boolean $includeContactIds - * @param boolean $strict + * @param bool $includeContactIds + * @param bool $strict * @param bool|int $mode - mode the search is operating on * * @param bool $skipPermission @@ -1261,10 +1261,10 @@ class CRM_Contact_BAO_Query { /** * Generate the query based on what type of query we need * - * @param boolean $count - * @param boolean $sortByChar - * @param boolean $groupContacts - * @param boolean $onlyDeleted + * @param bool $count + * @param bool $sortByChar + * @param bool $groupContacts + * @param bool $onlyDeleted * * @return array sql query parts as an array */ @@ -2326,7 +2326,7 @@ class CRM_Contact_BAO_Query { * @param array $fields * @param array $tables * @param $whereTables - * @param boolean $strict + * @param bool $strict * * @return string * @static @@ -2345,10 +2345,13 @@ class CRM_Contact_BAO_Query { /** * Create the from clause * - * @param array $tables tables that need to be included in this from clause + * @param array $tables + * Tables that need to be included in this from clause. * if null, return mimimal from clause (i.e. civicrm_contact) - * @param array $inner tables that should be inner-joined - * @param array $right tables that should be right-joined + * @param array $inner + * Tables that should be inner-joined. + * @param array $right + * Tables that should be right-joined. * * @param bool $primaryLocation * @param int $mode @@ -2848,7 +2851,7 @@ class CRM_Contact_BAO_Query { } /** - * @param array $groups + * @param array $groups * @param string $tableAlias * @param string $joinTable * @@ -4120,7 +4123,8 @@ civicrm_relationship.is_permission_a_b = 0 /** * Add start & end date criteria in * @param string $grouping - * @param array $where = array to add where clauses to, in case you are generating a temp table + * @param array $where + * = array to add where clauses to, in case you are generating a temp table. * not the main query. */ public function addRelationshipDateClauses($grouping, &$where){ @@ -4273,9 +4277,12 @@ civicrm_relationship.is_permission_a_b = 0 * @param string $sort * @param int $offset * @param int $row_count - * @param bool $smartGroupCache ?? update smart group cache? - * @param bool $count return count obnly - * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied + * @param bool $smartGroupCache + * ?? update smart group cache?. + * @param bool $count + * Return count obnly. + * @param bool $skipPermissions + * Should permissions be ignored or should the logged in user's permissions be applied. * * * @return array @@ -4360,17 +4367,27 @@ civicrm_relationship.is_permission_a_b = 0 /** * Create and query the db for an contact search * - * @param int $offset the offset for the query - * @param int $rowCount the number of rows to return - * @param string $sort the order by string - * @param boolean $count is this a count only query ? - * @param boolean $includeContactIds should we include contact ids? - * @param boolean $sortByChar if true returns the distinct array of first characters for search results - * @param boolean $groupContacts if true, return only the contact ids - * @param boolean $returnQuery should we return the query as a string - * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components) + * @param int $offset + * The offset for the query. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The order by string. + * @param bool $count + * Is this a count only query ?. + * @param bool $includeContactIds + * Should we include contact ids?. + * @param bool $sortByChar + * If true returns the distinct array of first characters for search results. + * @param bool $groupContacts + * If true, return only the contact ids. + * @param bool $returnQuery + * Should we return the query as a string. + * @param string $additionalWhereClause + * If the caller wants to further restrict the search (used for components). * @param null $sortOrder - * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load. + * @param string $additionalFromClause + * Should be clause with proper joins, effective to reduce where clause load. * * @param bool $skipOrderAndLimit * @@ -4558,9 +4575,9 @@ civicrm_relationship.is_permission_a_b = 0 * Fetch a list of contacts from the prev/next cache for displaying a search results page * * @param string $cacheKey - * @param int $offset - * @param int $rowCount - * @param bool $includeContactIds + * @param int $offset + * @param int $rowCount + * @param bool $includeContactIds * @return CRM_Core_DAO */ public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) { @@ -4585,8 +4602,10 @@ civicrm_relationship.is_permission_a_b = 0 * Note that these 2 params were in the code when extracted from another function * and a second round extraction would be to make them properties of the class * - * @param bool $onlyDeleted Only get deleted contacts - * @param bool $count Return Count only + * @param bool $onlyDeleted + * Only get deleted contacts. + * @param bool $count + * Return Count only. * * @return null */ @@ -5062,10 +5081,14 @@ SELECT COUNT( conts.total_amount ) as cancel_count, * builds the where Clause for the query * used for handling 'IS NULL'/'IS NOT NULL' operators * - * @param string $field fieldname - * @param string $op operator - * @param string $value value - * @param string $dataType data type of the field + * @param string $field + * Fieldname. + * @param string $op + * Operator. + * @param string $value + * Value. + * @param string $dataType + * Data type of the field. * * @return string where clause for the query */ @@ -5285,14 +5308,22 @@ AND displayRelType.is_active = 1 /** * Builds the necessary structures for all fields that are similar to option value lookups * - * @param $name string the name of the field - * @param $op string the sql operator, this function should handle ALL SQL operators - * @param $value string|integer|array depends on the operator and who's calling the query builder - * @param $grouping int the index where to place the where clause - * @param $selectValues the key value pairs for this element. This allows us to use this function for things besides option-value pairs - * @param $field array an array that contains various properties of the field identified by $name - * @param $label string The label for this field element - * @param $dataType string The data type for this element + * @param $name + * String the name of the field. + * @param $op + * String the sql operator, this function should handle ALL SQL operators. + * @param $value + * String|integer|array depends on the operator and who's calling the query builder. + * @param $grouping + * Int the index where to place the where clause. + * @param $selectValues + * The key value pairs for this element. This allows us to use this function for things besides option-value pairs. + * @param $field + * Array an array that contains various properties of the field identified by $name. + * @param $label + * String The label for this field element. + * @param $dataType + * String The data type for this element. * @param bool $useIDsOnly * * @return void adds the where clause and qill to the query object @@ -5370,7 +5401,8 @@ AND displayRelType.is_active = 1 * super nice js widgets to do the hard work * * @param string $string - * @param string $dataType the dataType we should check for the values, default integer + * @param string $dataType + * The dataType we should check for the values, default integer. * * @return bool|array if string does not match the patter * array of numeric values if string does match the pattern @@ -5484,7 +5516,7 @@ AND displayRelType.is_active = 1 /** * Include pseudo fields LEFT JOIN - * @param string|array $sort can be a object or string + * @param string|array $sort can be a object or string * * @return array */ diff --git a/CRM/Contact/BAO/Query/Interface.php b/CRM/Contact/BAO/Query/Interface.php index 009c419faa..76982e5d38 100644 --- a/CRM/Contact/BAO/Query/Interface.php +++ b/CRM/Contact/BAO/Query/Interface.php @@ -112,8 +112,10 @@ abstract class CRM_Contact_BAO_Query_Interface { * search field. This approach assumes that each field has a unique-name (ie that the field's * unique-name in the API matches the unique-name in the search-builder). * - * @param array $apiEntities list of entities whose options should be automatically scanned using API metadata - * @param array $fieldOptions keys are field unique-names; values describe how to lookup the options + * @param array $apiEntities + * List of entities whose options should be automatically scanned using API metadata. + * @param array $fieldOptions + * Keys are field unique-names; values describe how to lookup the options. * For boolean options, use value "yesno". For pseudoconstants/FKs, use the name of an API entity * from which the metadata of the field may be queried. (Yes - that is a mouthful.) * @void diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 9ade55cc50..bf3d1bce47 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -73,8 +73,10 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * For multiple a new variant of this function needs to be written and migrated to as this is a bit * nasty * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $ids + * The array that holds all the db ids. * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer * "we are moving away from the $ids param " * @@ -185,9 +187,12 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * This is the function that check/add if the relationship created is valid * - * @param array $params (reference ) an assoc array of name/value pairs - * @param integer $contactId this is contact id for adding relationship - * @param array $ids the array that holds all the db ids + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param int $contactId + * This is contact id for adding relationship. + * @param array $ids + * The array that holds all the db ids. * * @return CRM_Contact_BAO_Relationship * @static @@ -360,7 +365,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Check if there is data to create the object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return boolean * @static @@ -376,15 +382,22 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Get get list of relationship type based on the contact type. * - * @param int $contactId this is the contact id of the current contact. + * @param int $contactId + * This is the contact id of the current contact. * @param null $contactSuffix - * @param string $relationshipId the id of the existing relationship if any - * @param string $contactType contact type - * @param boolean $all if true returns relationship types in both the direction - * @param string $column name/label that going to retrieve from db. + * @param string $relationshipId + * The id of the existing relationship if any. + * @param string $contactType + * Contact type. + * @param bool $all + * If true returns relationship types in both the direction. + * @param string $column + * Name/label that going to retrieve from db. * @param bool $biDirectional - * @param string $contactSubType includes relationshiptypes between this subtype - * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType + * @param string $contactSubType + * Includes relationshiptypes between this subtype. + * @param bool $onlySubTypeRelationTypes + * If set only subtype which is passed by $contactSubType. * related relationshiptypes get return * * @static @@ -511,7 +524,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Delete the relationship * - * @param int $id relationship id + * @param int $id + * Relationship id. * * @return null * @@ -559,7 +573,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Disable/enable the relationship * - * @param int $id relationship id + * @param int $id + * Relationship id. * * @param $action * @@ -602,7 +617,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Delete the object records that are associated with this contact * - * @param int $contactId id of the contact to delete + * @param int $contactId + * Id of the contact to delete. * * @return void * @static @@ -622,7 +638,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Get the other contact in a relationship * - * @param int $id relationship id + * @param int $id + * Relationship id. * * $returns returns the contact ids in the realtionship * @@ -643,9 +660,12 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * Check if the relationship type selected between two contacts is correct * - * @param int $contact_a 1st contact id - * @param int $contact_b 2nd contact id - * @param int $relationshipTypeId relationship type id + * @param int $contact_a + * 1st contact id. + * @param int $contact_b + * 2nd contact id. + * @param int $relationshipTypeId + * Relationship type id. * * @return boolean true if it is valid relationship else false * @static @@ -683,9 +703,12 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * This function does the validtion for valid relationship * - * @param array $params this array contains the values there are subitted by the form - * @param array $ids the array that holds all the db ids - * @param integer $contactId this is contact id for adding relationship + * @param array $params + * This array contains the values there are subitted by the form. + * @param array $ids + * The array that holds all the db ids. + * @param int $contactId + * This is contact id for adding relationship. * * @return string @access public @@ -708,10 +731,14 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { /** * This function checks for duplicate relationship * - * @param array $params (reference ) an assoc array of name/value pairs - * @param integer $id this the id of the contact whom we are adding relationship - * @param integer $contactId this is contact id for adding relationship - * @param integer $relationshipId this is relationship id for the contact + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param int $id + * This the id of the contact whom we are adding relationship. + * @param int $contactId + * This is contact id for adding relationship. + * @param int $relationshipId + * This is relationship id for the contact. * * @return boolean true if record exists else false * @static @@ -784,8 +811,10 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @throws CiviCRM_API3_Exception * @return Object DAO object on success, null otherwise @@ -818,8 +847,10 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. * * @return array (reference) the values that could be potentially assigned to smarty * @static @@ -850,14 +881,20 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); /** * Helper function to form the sql for relationship retrieval * - * @param int $contactId contact id - * @param int $status (check const at top of file) - * @param int $numRelationship no of relationships to display (limit) - * @param int $count get the no of relationships + * @param int $contactId + * Contact id. + * @param int $status + * (check const at top of file). + * @param int $numRelationship + * No of relationships to display (limit). + * @param int $count + * Get the no of relationships. * $param int $relationshipId relationship id * @param int $relationshipId - * @param string $direction the direction we are interested in a_b or b_a - * @param array $params array of extra values including relationship_type_id per api spec + * @param string $direction + * The direction we are interested in a_b or b_a. + * @param array $params + * Array of extra values including relationship_type_id per api spec. * * return string the query for this diretion * @@ -991,10 +1028,14 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) /** * This is the function to get the list of relationships * - * @param int $contactId contact id - * @param int $status 1: Past 2: Disabled 3: Current - * @param int $numRelationship no of relationships to display (limit) - * @param int $count get the no of relationships + * @param int $contactId + * Contact id. + * @param int $status + * 1: Past 2: Disabled 3: Current. + * @param int $numRelationship + * No of relationships to display (limit). + * @param int $count + * Get the no of relationships. * $param int $relationshipId relationship id * $param array $links the list of links to display * $param int $permissionMask the permission mask to be applied for the actions @@ -1200,7 +1241,8 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) /** * Get get list of relationship type based on the target contact type. * - * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household) + * @param string $targetContactType + * It's valid contact tpye(may be Individual , Organization , Household). * * @return array - array reference of all relationship types with context to current contact type . * @@ -1226,9 +1268,12 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) * membership is is extedned by the same relationship type to that * of the existing relationship. * - * @param $contactId Int contact id - * @param $params array array of values submitted by POST - * @param $ids array array of ids + * @param $contactId + * Int contact id. + * @param $params + * Array array of values submitted by POST. + * @param $ids + * Array array of ids. * @param \const|\which $action which action called this function * * @param bool $active @@ -1490,7 +1535,8 @@ SELECT count(*) /** * Get Current Employer for Contact * - * @param $contactIds Contact Ids + * @param $contactIds + * Contact Ids. * * @return array $currentEmployer array of the current employer@static */ @@ -1516,9 +1562,11 @@ WHERE id IN ( {$contacts} ) /** * Return list of permissioned employer for a given contact. * - * @param $contactID int contact id whose employers + * @param $contactID + * Int contact id whose employers. * are to be found. - * @param $name string employers sort name + * @param $name + * String employers sort name. * * @static * @@ -1538,9 +1586,12 @@ WHERE id IN ( {$contacts} ) /** * Function to return list of permissioned contacts for a given contact and relationship type * - * @param $contactID int contact id whose permissioned contacts are to be found. - * @param $relTypeId string one or more relationship type id's - * @param $name string + * @param $contactID + * Int contact id whose permissioned contacts are to be found. + * @param $relTypeId + * String one or more relationship type id's. + * @param $name + * String. * * @static * @@ -1585,9 +1636,12 @@ AND cc.sort_name LIKE '%$name%'"; * Merge relationships from otherContact to mainContact * Called during contact merge operation * - * @param int $mainId contact id of main contact record. - * @param int $otherId contact id of record which is going to merge. - * @param array $sqls (reference) array of sql statements to append to. + * @param int $mainId + * Contact id of main contact record. + * @param int $otherId + * Contact id of record which is going to merge. + * @param array $sqls + * (reference) array of sql statements to append to. * * @see CRM_Dedupe_Merger::cpTables() * @@ -1647,7 +1701,8 @@ AND cc.sort_name LIKE '%$name%'"; * and to add clauses to limit the return to those relationships which COULD inherit a membership type * (as opposed to those who inherit a particular membership * - * @param array $params api input array + * @param array $params + * Api input array. * @param null $direction * * @return array @@ -1692,7 +1747,8 @@ AND cc.sort_name LIKE '%$name%'"; /** * This function is a wrapper for contact relationship selector * - * @param array $params associated array for params record id. + * @param array $params + * Associated array for params record id. * * @return array $contactRelationships associated array of contact relationships */ diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index d3b0309fb9..ec0bfcd626 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -44,8 +44,10 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contact_BAO_RelationshipType object * @static @@ -64,8 +66,10 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static @@ -77,8 +81,10 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType /** * Add the relationship type in the db * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $ids + * The array that holds all the db ids. * * @return CRM_Contact_DAO_RelationshipType * @static diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index 96adfce565..782b1f7c05 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -69,8 +69,10 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { * Takes a bunch of params that are needed to match certain criteria and * retrieves the relevant objects. * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Contact_BAO_SavedSearch * @static @@ -88,7 +90,8 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { /** * Given an id, extract the formValues of the saved search * - * @param int $id the id of the saved search + * @param int $id + * The id of the saved search. * * @return array the values of the posted saved search * @static @@ -149,9 +152,12 @@ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { /** * Get the where clause for a saved search * - * @param int $id saved search id - * @param array $tables (reference ) add the tables that are needed for the select clause - * @param array $whereTables (reference ) add the tables that are needed for the where clause + * @param int $id + * Saved search id. + * @param array $tables + * (reference ) add the tables that are needed for the select clause. + * @param array $whereTables + * (reference ) add the tables that are needed for the where clause. * * @return string the where clause for this saved search * @static @@ -262,7 +268,8 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ /** * Given an id, get the name of the saved search * - * @param int $id the id of the saved search + * @param int $id + * The id of the saved search. * * @param string $value * diff --git a/CRM/Contact/BAO/SubscriptionHistory.php b/CRM/Contact/BAO/SubscriptionHistory.php index 6aa669066c..60a7a1dae5 100644 --- a/CRM/Contact/BAO/SubscriptionHistory.php +++ b/CRM/Contact/BAO/SubscriptionHistory.php @@ -52,7 +52,8 @@ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHi /** * Create a new subscription history record * - * @param array $params Values for the new history record + * @param array $params + * Values for the new history record. * * @return object $history The new history object * @static @@ -68,7 +69,8 @@ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHi /** * Erase a contact's subscription history records * - * @param int $id The contact id + * @param int $id + * The contact id. * * @return void * @static diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 2efd276617..b157cde17d 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -581,9 +581,12 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form - * @param int $contactId contact id if doing update. + * @param array $fields + * Posted values of the form. + * @param array $errors + * List of errors to be posted back to the form. + * @param int $contactId + * Contact id if doing update. * * @return bool $primaryID email/openId@static */ @@ -1054,7 +1057,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Is there any real significant data in the hierarchical location array * - * @param array $fields the hierarchical value representation of this location + * @param array $fields + * The hierarchical value representation of this location. * * @return boolean true if data exists, false otherwise * @static @@ -1097,10 +1101,13 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * That checks for duplicate contacts * - * @param array $fields fields array which are submitted + * @param array $fields + * Fields array which are submitted. * @param $errors - * @param int $contactID contact id - * @param string $contactType contact type + * @param int $contactID + * Contact id. + * @param string $contactType + * Contact type. * */ public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) { @@ -1185,7 +1192,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * This function either parse street address in to child * elements or build street address from child elements. * - * @param $params array of key value consist of address blocks. + * @param $params + * Array of key value consist of address blocks. * * @return array $parseSuccess as array of sucess/fails for each address block@static */ @@ -1270,7 +1278,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * Check parse result and if some address block fails then this * function return the status message for all address blocks. * - * @param $parseResult an array of address blk instance and its status. + * @param $parseResult + * An array of address blk instance and its status. * * @return null|string $statusMsg string status message for all address blocks.@static */ @@ -1300,7 +1309,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * Convert normal number to ordinal number format. * like 1 => 1st, 2 => 2nd and so on... * - * @param $number int number to convert in to ordinal number. + * @param $number + * Int number to convert in to ordinal number. * * @return ordinal number for given number. * @static @@ -1336,7 +1346,8 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * Update membership status to deceased * function return the status message for updated membership. * - * @param $deceasedParams array having contact id and deceased value. + * @param $deceasedParams + * Array having contact id and deceased value. * * @return null|string $updateMembershipMsg string status message for updated membership. */ diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index 59da83f0a1..6814a9ea5e 100644 --- a/CRM/Contact/Form/DedupeRules.php +++ b/CRM/Contact/Form/DedupeRules.php @@ -142,7 +142,8 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @param $files * @param $self diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index 3ac6c92369..8e36aa10da 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -198,7 +198,8 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index f67e165fb5..e79f564500 100644 --- a/CRM/Contact/Form/Edit/Address.php +++ b/CRM/Contact/Form/Edit/Address.php @@ -42,9 +42,12 @@ class CRM_Contact_Form_Edit_Address { * Build form for address input fields * * @param CRM_Core_Form $form - * @param int $addressBlockCount - the index of the address array (if multiple addresses on a page) - * @param boolean $sharing - false, if we want to skip the address sharing features - * @param boolean $inlineEdit true when edit used in inline edit + * @param int $addressBlockCount + * The index of the address array (if multiple addresses on a page). + * @param bool $sharing + * False, if we want to skip the address sharing features. + * @param bool $inlineEdit + * True when edit used in inline edit. * * @return void * @@ -312,8 +315,10 @@ class CRM_Contact_Form_Edit_Address { /** * Set default values for address block * - * @param array $defaults defaults associated array - * @param CRM_Core_Form $form form object + * @param array $defaults + * Defaults associated array. + * @param CRM_Core_Form $form + * Form object. * * @static */ diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index 59d275b4e1..3343286fd1 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -48,7 +48,8 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { /** * Build the form object elements for Communication Preferences object * - * @param CRM_Core_Form $form reference to the form object + * @param CRM_Core_Form $form + * Reference to the form object. * * @return void * @static @@ -132,8 +133,10 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * @return true if no errors, else array of errors diff --git a/CRM/Contact/Form/Edit/CustomData.php b/CRM/Contact/Form/Edit/CustomData.php index ed521492dc..282d4dc1e3 100644 --- a/CRM/Contact/Form/Edit/CustomData.php +++ b/CRM/Contact/Form/Edit/CustomData.php @@ -68,7 +68,8 @@ class CRM_Contact_Form_Edit_CustomData { /** * Build the form object elements for CustomData object * - * @param CRM_Core_Form $form reference to the form object + * @param CRM_Core_Form $form + * Reference to the form object. * * @return void * @static diff --git a/CRM/Contact/Form/Edit/Demographics.php b/CRM/Contact/Form/Edit/Demographics.php index 9c5af87fea..3fe5715d69 100644 --- a/CRM/Contact/Form/Edit/Demographics.php +++ b/CRM/Contact/Form/Edit/Demographics.php @@ -41,7 +41,8 @@ class CRM_Contact_Form_Edit_Demographics { /** * Build the form object elements for Demographics object * - * @param CRM_Core_Form $form reference to the form object + * @param CRM_Core_Form $form + * Reference to the form object. * * @return void * @static diff --git a/CRM/Contact/Form/Edit/Email.php b/CRM/Contact/Form/Edit/Email.php index e99b635e69..003abdef41 100644 --- a/CRM/Contact/Form/Edit/Email.php +++ b/CRM/Contact/Form/Edit/Email.php @@ -41,9 +41,12 @@ class CRM_Contact_Form_Edit_Email { /** * Build the form object elements for an email object * - * @param CRM_Core_Form $form reference to the form object - * @param int $blockCount block number to build - * @param boolean $blockEdit is it block edit + * @param CRM_Core_Form $form + * Reference to the form object. + * @param int $blockCount + * Block number to build. + * @param bool $blockEdit + * Is it block edit. * * @return void * @static diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 4ad5751d20..acdee4b6a7 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -44,8 +44,10 @@ class CRM_Contact_Form_Edit_Household { * This function provides the HTML form elements that are specific * to the Household Contact Type * - * @param CRM_Core_Form $form form object - * @param int $inlineEditMode ( 1 for contact summary + * @param CRM_Core_Form $form + * Form object. + * @param int $inlineEditMode + * ( 1 for contact summary. * top bar form and 2 for display name edit ) * * @return void @@ -79,8 +81,10 @@ class CRM_Contact_Form_Edit_Household { /** * Add rule for household * - * @param array $fields array of form values - * @param array $files - unused + * @param array $fields + * Array of form values. + * @param array $files + * Unused. * @param int $contactID * * @return array|bool $error@static diff --git a/CRM/Contact/Form/Edit/IM.php b/CRM/Contact/Form/Edit/IM.php index 347e58da3c..32e0eae755 100644 --- a/CRM/Contact/Form/Edit/IM.php +++ b/CRM/Contact/Form/Edit/IM.php @@ -41,9 +41,12 @@ class CRM_Contact_Form_Edit_IM { /** * Build the form object elements for an IM object * - * @param CRM_Core_Form $form reference to the form object - * @param int $blockCount block number to build - * @param boolean $blockEdit is it block edit + * @param CRM_Core_Form $form + * Reference to the form object. + * @param int $blockCount + * Block number to build. + * @param bool $blockEdit + * Is it block edit. * * @return void * @static diff --git a/CRM/Contact/Form/Edit/Individual.php b/CRM/Contact/Form/Edit/Individual.php index cc4ccd1971..76987294b7 100644 --- a/CRM/Contact/Form/Edit/Individual.php +++ b/CRM/Contact/Form/Edit/Individual.php @@ -44,8 +44,10 @@ class CRM_Contact_Form_Edit_Individual { * This function provides the HTML form elements that are specific * to the Individual Contact Type * - * @param CRM_Core_Form $form form object - * @param int $inlineEditMode ( 1 for contact summary + * @param CRM_Core_Form $form + * Form object. + * @param int $inlineEditMode + * ( 1 for contact summary. * top bar form and 2 for display name edit ) * * @return void @@ -144,8 +146,10 @@ class CRM_Contact_Form_Edit_Individual { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param int $contactID * * @return true if no errors, else array of errors diff --git a/CRM/Contact/Form/Edit/Lock.php b/CRM/Contact/Form/Edit/Lock.php index fc304f9b07..0f6fe5861b 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -42,7 +42,8 @@ class CRM_Contact_Form_Edit_Lock { /** * Build the form object * - * @param CRM_Core_Form $form form object + * @param CRM_Core_Form $form + * Form object. * * @return void */ @@ -53,8 +54,10 @@ class CRM_Contact_Form_Edit_Lock { /** * Ensure that modified_date hasn't changed in the underlying DB * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param int $contactID * * @return true if no errors, else array of errors diff --git a/CRM/Contact/Form/Edit/OpenID.php b/CRM/Contact/Form/Edit/OpenID.php index 5fa1094320..4473bef0c0 100644 --- a/CRM/Contact/Form/Edit/OpenID.php +++ b/CRM/Contact/Form/Edit/OpenID.php @@ -41,9 +41,12 @@ class CRM_Contact_Form_Edit_OpenID { /** * Build the form object elements for an open id object * - * @param CRM_Core_Form $form reference to the form object - * @param int $blockCount block number to build - * @param boolean $blockEdit is it block edit + * @param CRM_Core_Form $form + * Reference to the form object. + * @param int $blockCount + * Block number to build. + * @param bool $blockEdit + * Is it block edit. * * @return void * @static diff --git a/CRM/Contact/Form/Edit/Organization.php b/CRM/Contact/Form/Edit/Organization.php index 543476c199..31429ca2be 100644 --- a/CRM/Contact/Form/Edit/Organization.php +++ b/CRM/Contact/Form/Edit/Organization.php @@ -44,8 +44,10 @@ class CRM_Contact_Form_Edit_Organization { * This function provides the HTML form elements that are specific * to the Organization Contact Type * - * @param CRM_Core_Form $form form object - * @param int $inlineEditMode ( 1 for contact summary + * @param CRM_Core_Form $form + * Form object. + * @param int $inlineEditMode + * ( 1 for contact summary. * top bar form and 2 for display name edit ) * * @return void diff --git a/CRM/Contact/Form/Edit/Phone.php b/CRM/Contact/Form/Edit/Phone.php index 72241f0122..3ee9b6d99e 100644 --- a/CRM/Contact/Form/Edit/Phone.php +++ b/CRM/Contact/Form/Edit/Phone.php @@ -41,9 +41,12 @@ class CRM_Contact_Form_Edit_Phone { /** * Build the form object elements for a phone object * - * @param CRM_Core_Form $form reference to the form object - * @param int $addressBlockCount block number to build - * @param boolean $blockEdit is it block edit + * @param CRM_Core_Form $form + * Reference to the form object. + * @param int $addressBlockCount + * Block number to build. + * @param bool $blockEdit + * Is it block edit. * * @return void * @static diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index 3c6086bee6..8c6cd87974 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -45,14 +45,21 @@ class CRM_Contact_Form_Edit_TagsAndGroups { * This function is to build form elements * params object $form object of the form * - * @param CRM_Core_Form $form the form object that we are operating on - * @param int $contactId contact id - * @param int $type what components are we interested in - * @param boolean $visibility visibility of the field + * @param CRM_Core_Form $form + * The form object that we are operating on. + * @param int $contactId + * Contact id. + * @param int $type + * What components are we interested in. + * @param bool $visibility + * Visibility of the field. * @param null $isRequired - * @param string $groupName if used for building group block - * @param string $tagName if used for building tag block - * @param string $fieldName this is used in batch profile(i.e to build multiple blocks) + * @param string $groupName + * If used for building group block. + * @param string $tagName + * If used for building tag block. + * @param string $fieldName + * This is used in batch profile(i.e to build multiple blocks). * * @param string $groupElementType * @@ -196,10 +203,14 @@ class CRM_Contact_Form_Edit_TagsAndGroups { /** * Set defaults for relevant form elements * - * @param int $id the contact id - * @param array $defaults the defaults array to store the values in - * @param int $type what components are we interested in - * @param string $fieldName this is used in batch profile(i.e to build multiple blocks) + * @param int $id + * The contact id. + * @param array $defaults + * The defaults array to store the values in. + * @param int $type + * What components are we interested in. + * @param string $fieldName + * This is used in batch profile(i.e to build multiple blocks). * * @param string $groupElementType * diff --git a/CRM/Contact/Form/Edit/Website.php b/CRM/Contact/Form/Edit/Website.php index 68a3b718b1..5b9c8cdec8 100644 --- a/CRM/Contact/Form/Edit/Website.php +++ b/CRM/Contact/Form/Edit/Website.php @@ -41,8 +41,10 @@ class CRM_Contact_Form_Edit_Website { /** * Build the form object elements for an Website object * - * @param CRM_Core_Form $form reference to the form object - * @param int $blockCount block number to build + * @param CRM_Core_Form $form + * Reference to the form object. + * @param int $blockCount + * Block number to build. * * @return void * @static diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 840d1bb52a..a6e623d564 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/Email.php @@ -98,8 +98,10 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { /** * Global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields + * Posted values of the form. + * @param array $errors + * List of errors to be posted back to the form. * * @return array $errors@static */ diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index 7bdc279025..bc583ea486 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/IM.php @@ -98,8 +98,10 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { /** * Global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields + * Posted values of the form. + * @param array $errors + * List of errors to be posted back to the form. * * @return array $errors@static */ diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 2599856318..daeb775ec3 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -42,7 +42,8 @@ class CRM_Contact_Form_Inline_Lock { /** * This function provides the HTML form elements * - * @param CRM_Core_Form $form form object + * @param CRM_Core_Form $form + * Form object. * @param int $contactID * * @return void @@ -64,8 +65,10 @@ class CRM_Contact_Form_Inline_Lock { /** * Ensure that oplock_ts hasn't changed in the underlying DB * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param int $contactID * * @return true if no errors, else array of errors diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index 88fe65676d..0f7bf65c33 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -98,8 +98,10 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { /** * Global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields + * Posted values of the form. + * @param array $errors + * List of errors to be posted back to the form. * * @return array $errors@static */ diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index cd1ff6b00d..9a61f729ca 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -98,8 +98,10 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { /** * Global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form + * @param array $fields + * Posted values of the form. + * @param array $errors + * List of errors to be posted back to the form. * * @return array $errors@static */ diff --git a/CRM/Contact/Form/Relationship.php b/CRM/Contact/Form/Relationship.php index 4a3ac7d5f1..561f3d164b 100644 --- a/CRM/Contact/Form/Relationship.php +++ b/CRM/Contact/Form/Relationship.php @@ -539,7 +539,8 @@ class CRM_Contact_Form_Relationship extends CRM_Core_Form { /** * Date validation * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return mixed true or array of errors * @static diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index 45ccf14938..d3d298332f 100644 --- a/CRM/Contact/Form/Search/Advanced.php +++ b/CRM/Contact/Form/Search/Advanced.php @@ -388,7 +388,8 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { /** * Normalize default values for multiselect plugins * - * @param $defaults array + * @param $defaults + * Array. * @return array */ public function normalizeDefaultValues(&$defaults) { diff --git a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php index 70481676ca..72c4d6e9c0 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php +++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php @@ -69,9 +69,12 @@ abstract class CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { * * TODO: Understand why $queryLimit and $detailLimit are different * - * @param string $queryText a string of text to search for - * @param string $entityIDTableName a temporary table into which we can write a list of all matching IDs - * @param string $detailTable a table into which we can write details about a page worth of matches + * @param string $queryText + * A string of text to search for. + * @param string $entityIDTableName + * A temporary table into which we can write a list of all matching IDs. + * @param string $detailTable + * A table into which we can write details about a page worth of matches. * @param array|NULL $queryLimit overall limit (applied when building $entityIDTableName) * NULL if no limit; or array(0 => $limit, 1 => $offset) * @param array|NULL $detailLimit final limit (applied when building $detailTable) @@ -119,7 +122,8 @@ AND cf.html_type IN ( 'Text', 'TextArea', 'RichTextEditor' ) /** * @param string $queryText - * @param array $tables a list of places to query. Keys may be: + * @param array $tables + * A list of places to query. Keys may be:. * - sql: an array of SQL queries to execute * - final: an array of SQL queries to execute at the end * - *: All other keys are treated as table names @@ -231,7 +235,8 @@ GROUP BY {$tableValues['id']} * Create a SQL expression for matching against a list of * text columns. * - * @param string $table eg "civicrm_note" or "civicrm_note mynote" + * @param string $table + * Eg "civicrm_note" or "civicrm_note mynote". * @param array|string $fullTextFields list of field names * @param string $queryText * @return string SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'" @@ -286,7 +291,8 @@ GROUP BY {$tableValues['id']} * * @param string $toTable * @param string $parentIdColumn - * @param array $files see return format of CRM_Core_FileSearchInterface::search + * @param array $files + * See return format of CRM_Core_FileSearchInterface::search. */ public function moveFileIDs($toTable, $parentIdColumn, $files) { if (empty($files)) { diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php index e39ad4d908..9329af659d 100644 --- a/CRM/Contact/Form/Task.php +++ b/CRM/Contact/Form/Task.php @@ -367,8 +367,10 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { * Simple shell that derived classes can call to add buttons to * the form with a customized title for the main Submit * - * @param string $title title of the main button - * @param string $nextType button type for the form after processing + * @param string $title + * Title of the main button. + * @param string $nextType + * Button type for the form after processing. * @param string $backType * @param bool $submitOnce * diff --git a/CRM/Contact/Form/Task/AddToHousehold.php b/CRM/Contact/Form/Task/AddToHousehold.php index ee9385538d..46cc716310 100644 --- a/CRM/Contact/Form/Task/AddToHousehold.php +++ b/CRM/Contact/Form/Task/AddToHousehold.php @@ -176,7 +176,8 @@ class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task { * This function is to get the result of the search for Add to * forms * * @param CRM_Core_Form $form - * @param array $params This contains elements for search criteria + * @param array $params + * This contains elements for search criteria. * * * @return void diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index 796ec41d13..2a9a9d9a1d 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -195,7 +195,8 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** * Global form rule * - * @param array $fields the input form values + * @param array $fields + * The input form values. * * @return true if no errors, else array of errors * @static @@ -262,8 +263,10 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** * Parse street address - * @param array $contactValues contact values - * @param CRM_Core_Form $form form object + * @param array $contactValues + * Contact values. + * @param CRM_Core_Form $form + * Form object. */ public static function parseStreetAddress(&$contactValues, &$form) { if (!is_array($contactValues) || !is_array($form->_fields)) { diff --git a/CRM/Contact/Form/Task/Delete.php b/CRM/Contact/Form/Task/Delete.php index 717ee9d801..08edbdace4 100644 --- a/CRM/Contact/Form/Task/Delete.php +++ b/CRM/Contact/Form/Task/Delete.php @@ -174,9 +174,12 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param object $self form object + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. + * @param object $self + * Form object. * * @return true if no errors, else array of errors * @static diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index d7d7b38b48..ee9ffebb44 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -318,9 +318,11 @@ class CRM_Contact_Form_Task_EmailCommon { /** * Form rule * - * @param array $fields the input form values + * @param array $fields + * The input form values. * @param array $dontCare - * @param array $self additional values form 'this' + * @param array $self + * Additional values form 'this'. * * @return true if no errors, else array of errors * diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index 213e7caca5..c911e0d925 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -374,9 +374,12 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { /** * Create labels (pdf) * - * @param array $contactRows assciated array of contact data - * @param string $format format in which labels needs to be printed - * @param string $fileName The name of the file to save the label in + * @param array $contactRows + * Assciated array of contact data. + * @param string $format + * Format in which labels needs to be printed. + * @param string $fileName + * The name of the file to save the label in. * * @return null */ diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 0cb432b837..df451d8a94 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -43,9 +43,12 @@ class CRM_Contact_Form_Task_LabelCommon { /** * Create labels (pdf) * - * @param array $contactRows assciated array of contact data - * @param string $format format in which labels needs to be printed - * @param string $fileName The name of the file to save the label in + * @param array $contactRows + * Assciated array of contact data. + * @param string $format + * Format in which labels needs to be printed. + * @param string $fileName + * The name of the file to save the label in. * * @return null */ @@ -72,10 +75,11 @@ class CRM_Contact_Form_Task_LabelCommon { * Get the rows for the labels * * @param $contactIDs - * @param integer $locationTypeID - * @param boolean $respectDoNotMail + * @param int $locationTypeID + * @param bool $respectDoNotMail * @param $mergeSameAddress - * @param bool $mergeSameHousehold UNUSED + * @param bool $mergeSameHousehold + * UNUSED. * * @return array of rows for labels */ diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 9c18f98c78..39cce26571 100644 --- a/CRM/Contact/Form/Task/Map.php +++ b/CRM/Contact/Form/Task/Map.php @@ -142,7 +142,8 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { * Assign smarty variables to the template that will be used by google api to plot the contacts * * @param $ids - * @param int $locationId location_id + * @param int $locationId + * Location_id. * @param $page * @param $addBreadCrumb * @param string $type diff --git a/CRM/Contact/Form/Task/PDFLetterCommon.php b/CRM/Contact/Form/Task/PDFLetterCommon.php index 68c721a65c..f97eeaa7bb 100644 --- a/CRM/Contact/Form/Task/PDFLetterCommon.php +++ b/CRM/Contact/Form/Task/PDFLetterCommon.php @@ -203,9 +203,11 @@ class CRM_Contact_Form_Task_PDFLetterCommon { /** * Form rule * - * @param array $fields the input form values + * @param array $fields + * The input form values. * @param array $dontCare - * @param array $self additional values form 'this' + * @param array $self + * Additional values form 'this'. * * @return true if no errors, else array of errors * diff --git a/CRM/Contact/Form/Task/PickProfile.php b/CRM/Contact/Form/Task/PickProfile.php index 6c1d2edf27..dd3422c3bb 100644 --- a/CRM/Contact/Form/Task/PickProfile.php +++ b/CRM/Contact/Form/Task/PickProfile.php @@ -136,7 +136,8 @@ class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Contact/Form/Task/ProximityCommon.php b/CRM/Contact/Form/Task/ProximityCommon.php index 4427db4f0e..6cf4017a4a 100644 --- a/CRM/Contact/Form/Task/ProximityCommon.php +++ b/CRM/Contact/Form/Task/ProximityCommon.php @@ -108,8 +108,10 @@ class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param CRM_Core_Form $form * * @return true if no errors, else array of errors diff --git a/CRM/Contact/Form/Task/SMSCommon.php b/CRM/Contact/Form/Task/SMSCommon.php index 2f7f09fda5..6d060f8b08 100644 --- a/CRM/Contact/Form/Task/SMSCommon.php +++ b/CRM/Contact/Form/Task/SMSCommon.php @@ -301,9 +301,11 @@ class CRM_Contact_Form_Task_SMSCommon { /** * Form rule * - * @param array $fields the input form values + * @param array $fields + * The input form values. * @param array $dontCare - * @param array $self additional values form 'this' + * @param array $self + * Additional values form 'this'. * * @return true if no errors, else array of errors * diff --git a/CRM/Contact/Import/Form/MapField.php b/CRM/Contact/Import/Form/MapField.php index 43fd932f6c..6ede1d1fae 100644 --- a/CRM/Contact/Import/Form/MapField.php +++ b/CRM/Contact/Import/Form/MapField.php @@ -620,7 +620,8 @@ class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Contact/Import/Form/Preview.php b/CRM/Contact/Import/Form/Preview.php index 7d562517e8..152cea52e0 100644 --- a/CRM/Contact/Import/Form/Preview.php +++ b/CRM/Contact/Import/Form/Preview.php @@ -188,7 +188,8 @@ class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @param $files * @param $self diff --git a/CRM/Contact/Import/Parser.php b/CRM/Contact/Import/Parser.php index 1a615ac720..7d8651aeca 100644 --- a/CRM/Contact/Import/Parser.php +++ b/CRM/Contact/Import/Parser.php @@ -451,7 +451,8 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { /** * Set IM Service Provider type fields * - * @param array $elements IM service provider type ids + * @param array $elements + * IM service provider type ids. * * @return void */ @@ -518,7 +519,8 @@ abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser { /** * Set IM Service Provider type fields for related contacts * - * @param array $elements IM service provider type ids of related contact + * @param array $elements + * IM service provider type ids of related contact. * * @return void */ diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index c5b536e606..1aa47bb11f 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -245,7 +245,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Handle the values in mapField mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean */ @@ -256,7 +257,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Handle the values in preview mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -267,7 +269,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Handle the values in summary mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -435,8 +438,10 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Handle the values in import mode * - * @param int $onDuplicate the code for what action to take on duplicates - * @param array $values the array of values belonging to this line + * @param int $onDuplicate + * The code for what action to take on duplicates. + * @param array $values + * The array of values belonging to this line. * * @param bool $doGeocodeAddress * @@ -1091,7 +1096,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * Check if an error in custom data * * @param array $params - * @param String $errorMessage A string containing all the error-fields. + * @param string $errorMessage + * A string containing all the error-fields. * * @param null $csType * @param null $relationships @@ -1278,7 +1284,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * eg value might be m/M, ma/MA, mal/MAL, male return 'Male' * but if value is 'maleabc' than return false * - * @param string $gender check this value across gender values. + * @param string $gender + * Check this value across gender values. * * retunr gender value / false * @@ -1310,7 +1317,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * Check if an error in Core( non-custom fields ) field * * @param array $params - * @param String $errorMessage A string containing all the error-fields. + * @param string $errorMessage + * A string containing all the error-fields. * */ public function isErrorInCoreData($params, &$errorMessage) { @@ -1598,8 +1606,10 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Build error-message containing error-fields * - * @param String $errorName A string containing error-field name. - * @param String $errorMessage A string containing all the error-fields, where the new errorName is concatenated. + * @param string $errorName + * A string containing error-field name. + * @param string $errorMessage + * A string containing all the error-fields, where the new errorName is concatenated. * * @static */ @@ -1677,10 +1687,13 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Format params for update and fill mode * - * @param $params array reference to an array containing all the + * @param $params + * Array reference to an array containing all the. * values for import - * @param $onDuplicate int - * @param $cid int contact id + * @param $onDuplicate + * Int. + * @param $cid + * Int contact id. */ public function formatParams(&$params, $onDuplicate, $cid) { if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) { @@ -1785,10 +1798,14 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Convert any given date string to default date array. * - * @param array $params has given date-format - * @param array $formatted store formatted date in this array - * @param int $dateType type of date - * @param string $dateParam index of params + * @param array $params + * Has given date-format. + * @param array $formatted + * Store formatted date in this array. + * @param int $dateType + * Type of date. + * @param string $dateParam + * Index of params. * @static */ public function formatCustomDate(&$params, &$formatted, $dateType, $dateParam) { @@ -1800,9 +1817,12 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Format common params data to proper format to store. * - * @param array $params contain record values. - * @param array $formatted array of formatted data. - * @param array $contactFields contact DAO fields. + * @param array $params + * Contain record values. + * @param array $formatted + * Array of formatted data. + * @param array $contactFields + * Contact DAO fields. * @static */ public function formatCommonData($params, &$formatted, &$contactFields) { @@ -2023,8 +2043,10 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Generate status and error message for unparsed street address records. * - * @param array $values the array of values belonging to each row - * @param array $statusFieldName store formatted date in this array + * @param array $values + * The array of values belonging to each row. + * @param array $statusFieldName + * Store formatted date in this array. * @param $returnCode * * @return int diff --git a/CRM/Contact/Page/SavedSearch.php b/CRM/Contact/Page/SavedSearch.php index 2f63b381ca..58d2a9efc6 100644 --- a/CRM/Contact/Page/SavedSearch.php +++ b/CRM/Contact/Page/SavedSearch.php @@ -50,7 +50,8 @@ class CRM_Contact_Page_SavedSearch extends CRM_Core_Page { /** * Delete a saved search. * - * @param int $id - id of saved search + * @param int $id + * Id of saved search. * * @return void * diff --git a/CRM/Contact/Page/View.php b/CRM/Contact/Page/View.php index 35a8f5be87..494c5f9111 100644 --- a/CRM/Contact/Page/View.php +++ b/CRM/Contact/Page/View.php @@ -345,7 +345,7 @@ class CRM_Contact_Page_View extends CRM_Core_Page { /** * Add urls for display in the actions menu * @param CRM_Core_Page $obj - * @param integer $cid + * @param int $cid */ public static function addUrls(&$obj, $cid) { $uid = CRM_Core_BAO_UFMatch::getUFId($cid); diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index 441374fdd2..55e1f07e4d 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -145,8 +145,10 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { /** * Remove/ rejoin the group * - * @param int $groupContactId id of crm_group_contact - * @param string $status this is the status that should be updated. + * @param int $groupContactId + * Id of crm_group_contact. + * @param string $status + * This is the status that should be updated. * * $access public * @param int $contactID diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index dcac1ec947..99ea33017a 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -129,8 +129,10 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se * Class constructor * * @param $customSearchClass - * @param array $formValues array of form values imported - * @param array $params array of parameters for query + * @param array $formValues + * Array of form values imported. + * @param array $params + * Array of parameters for query. * @param null $returnProperties * @param \const|int $action - action of search basic or advanced. * @@ -323,8 +325,10 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -494,11 +498,16 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -1034,10 +1043,13 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont /** * This function is called to rebuild prev next cache using full sql in case of core search ( excluding custom search) * - * @param int $start start for limit clause - * @param int $end end for limit clause + * @param int $start + * Start for limit clause. + * @param int $end + * End for limit clause. * @param CRM_Utils_Sort $sort - * @param string $cacheKey cache key + * @param string $cacheKey + * Cache key. * * @return void */ @@ -1067,7 +1079,7 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont * Given the current formValues, gets the query in local * language * - * @param array( + * @param array( reference) $formValues submitted formValues * * @return array $qill which contains an array of strings @@ -1082,7 +1094,8 @@ SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', cont /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Contact/Selector/Custom.php b/CRM/Contact/Selector/Custom.php index 15fe294802..4c591d6075 100644 --- a/CRM/Contact/Selector/Custom.php +++ b/CRM/Contact/Selector/Custom.php @@ -106,8 +106,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * Class constructor * * @param $customSearchClass - * @param array $formValues array of form values imported - * @param array $params array of parameters for query + * @param array $formValues + * Array of form values imported. + * @param array $params + * Array of parameters for query. * @param null $returnProperties * @param \const|int $action - action of search basic or advanced. * @@ -221,8 +223,10 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -263,11 +267,16 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return int the total number of rows for this action */ @@ -368,7 +377,7 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { * Given the current formValues, gets the query in local * language * - * @param array( + * @param array( reference) $formValues submitted formValues * * @return array $qill which contains an array of strings @@ -387,7 +396,8 @@ class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php index 595b4ea1aa..f4d212a8e1 100644 --- a/CRM/Contact/StateMachine/Search.php +++ b/CRM/Contact/StateMachine/Search.php @@ -86,7 +86,8 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { * to avoid using conditional state machine, much more efficient * and simpler * - * @param CRM_Core_Controller $controller the controller object + * @param CRM_Core_Controller $controller + * The controller object. * * @param string $formName * diff --git a/CRM/Contact/Task.php b/CRM/Contact/Task.php index c31def46d5..6a9204ea0b 100644 --- a/CRM/Contact/Task.php +++ b/CRM/Contact/Task.php @@ -313,7 +313,8 @@ class CRM_Contact_Task { * of the user * * @param int $permission - * @param bool $deletedContacts are these tasks for operating on deleted contacts? + * @param bool $deletedContacts + * Are these tasks for operating on deleted contacts?. * * @return array set of tasks that are valid for the user */ -- 2.25.1