From: Coleman Watts Date: Fri, 9 Jan 2015 16:00:52 +0000 (-0500) Subject: INFRA-132 - @param type fixes X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=5a4f674292060ff1f07ec653e2ec4bf915f6f6ef;p=civicrm-core.git INFRA-132 - @param type fixes --- diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index c7b43a3214..e3524ec18f 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -2053,8 +2053,8 @@ AND cl.modified_id = c.id /** * Create a follow up a given activity * - * @param $activityId - * Int activity id of parent activity. + * @param int $activityId + * activity id of parent activity. * @param array $params * * @return $this|null|object diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 682945e88e..c3045e67b3 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -341,8 +341,8 @@ SELECT survey.id as id, /** * Get Surveys custom groups * - * @param $surveyTypes - * Array an array of survey type id. + * @param array $surveyTypes + * an array of survey type id. * * @return array * @static diff --git a/CRM/Contact/BAO/Contact/Utils.php b/CRM/Contact/BAO/Contact/Utils.php index 45ae2c083d..0b99c67c98 100644 --- a/CRM/Contact/BAO/Contact/Utils.php +++ b/CRM/Contact/BAO/Contact/Utils.php @@ -484,12 +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 string $contactType + * contact type. * @param int $countryID * @param int $stateID - * @param $title - * String fieldset title. + * @param string $title + * fieldset title. * * @static */ diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 4ebd3a618b..2bb9288ff5 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -244,10 +244,9 @@ 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 array $groupID + * @param bool $processed + * Whether the cache data was recently modified. */ public static function updateCacheTime($groupID, $processed) { // only update cache entry if we had any values @@ -279,10 +278,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 int $groupID + * the groupID to delete cache entries, NULL for all groups. + * @param bool $onceOnly + * run the function exactly once for all groups. * * @return void * @static diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 172f9a6bee..04beb39952 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -395,8 +395,8 @@ 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 array $groupIds + * 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). * @@ -427,8 +427,8 @@ 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 array $groupIds + * 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). * @@ -461,8 +461,8 @@ 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 array $groupIds + * 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). * @@ -502,8 +502,8 @@ 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 array $groupIds + * 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). * @@ -542,7 +542,7 @@ 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 + * @param array $groupIds * An array of valid group ids (passed by reference). * * @param bool $includeSelf @@ -579,7 +579,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of ancestor groups of the specified group. * - * @param $groupIds + * @param array $groupIds * An array of valid group ids (passed by reference). * * @param bool $includeSelf @@ -594,7 +594,7 @@ 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 + * @param array $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 @@ -616,7 +616,7 @@ 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 + * @param array $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 @@ -638,7 +638,7 @@ 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 + * @param array $groupIds * An array of valid group ids (passed by reference). * * @param bool $includeSelf @@ -672,7 +672,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen /** * Returns array of descendent groups of the specified group. * - * @param $groupIds + * @param array $groupIds * An array of valid group ids (passed by reference). * * @param bool $includeSelf diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index b54075d001..385764563c 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -5365,22 +5365,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 string $name + * the name of the field. + * @param string $op + * the sql operator, this function should handle ALL SQL operators. + * @param string $value + * depends on the operator and who's calling the query builder. + * @param int $grouping + * 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 array $field + * an array that contains various properties of the field identified by $name. + * @param string $label + * The label for this field element. + * @param string $dataType + * The data type for this element. * @param bool $useIDsOnly * * @return void adds the where clause and qill to the query object diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 328a12f0f0..43ee06e48d 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -1277,12 +1277,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 int $contactId + * contact id. + * @param array $params + * array of values submitted by POST. + * @param array $ids + * array of ids. * @param \const|\which $action which action called this function * * @param bool $active @@ -1575,11 +1575,11 @@ WHERE id IN ( {$contacts} ) /** * Return list of permissioned employer for a given contact. * - * @param $contactID - * Int contact id whose employers. + * @param int $contactID + * contact id whose employers. * are to be found. - * @param $name - * String employers sort name. + * @param string $name + * employers sort name. * * @static * @@ -1599,12 +1599,11 @@ 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 int $contactID + * contact id whose permissioned contacts are to be found. + * @param string $relTypeId + * one or more relationship type id's. + * @param string $name * * @static * diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index c79406edaf..e0cb1c9fbc 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -1192,8 +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 array $params + * of key value consist of address blocks. * * @return array $parseSuccess as array of sucess/fails for each address block@static */ @@ -1278,7 +1278,7 @@ 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 + * @param array $parseResult * An array of address blk instance and its status. * * @return null|string $statusMsg string status message for all address blocks.@static @@ -1309,8 +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 int $number + * number to convert in to ordinal number. * * @return ordinal number for given number. * @static @@ -1346,8 +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 array $deceasedParams + * having contact id and deceased value. * * @return null|string $updateMembershipMsg string status message for updated membership. */ diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index 61bcf5364b..4ae3e984e3 100644 --- a/CRM/Contact/Form/Search/Advanced.php +++ b/CRM/Contact/Form/Search/Advanced.php @@ -388,8 +388,7 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { /** * Normalize default values for multiselect plugins * - * @param $defaults - * Array. + * @param array $defaults * @return array */ public function normalizeDefaultValues(&$defaults) { diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index d356898256..453070cbd1 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -1694,13 +1694,12 @@ 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 array $params + * reference to an array containing all the. * values for import - * @param $onDuplicate - * Int. - * @param $cid - * Int contact id. + * @param int $onDuplicate + * @param int $cid + * contact id. */ public function formatParams(&$params, $onDuplicate, $cid) { if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) { diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 2a7515d19e..2c83e42c0e 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -2399,8 +2399,7 @@ WHERE contribution_id = %1 "; * * @param $values * @param $input - * @param $template - * CRM_Core_SMARTY. + * @param CRM_Core_SMARTY $template * @param bool $recur * @param bool $returnMessageText * diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php index 6eac14fc75..3043185c89 100644 --- a/CRM/Contribute/Form/Contribution.php +++ b/CRM/Contribute/Form/Contribution.php @@ -1509,8 +1509,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP /** * @param $submittedValues * @param $config - * @param $session - * CRM_Core_Session. + * @param CRM_Core_Session $session * @param $lineItem * * @throws CRM_Core_Exception diff --git a/CRM/Contribute/Form/Contribution/Confirm.php b/CRM/Contribute/Form/Contribution/Confirm.php index b1e1be6db5..8a0f7f8c83 100644 --- a/CRM/Contribute/Form/Contribution/Confirm.php +++ b/CRM/Contribute/Form/Contribution/Confirm.php @@ -1624,14 +1624,14 @@ class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_Contr /** * Add on behalf of organization and it's location * - * @param $behalfOrganization - * Array array of organization info. - * @param $contactID - * Int individual contact id. One. + * @param array $behalfOrganization + * array of organization info. + * @param int $contactID + * individual contact id. One. * who is doing the process of signup / contribution. * - * @param $values - * Array form values array. + * @param array $values + * form values array. * @param array $params * @param null $fields * diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index c077771d7b..95c7c45915 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -1158,8 +1158,7 @@ ORDER BY civicrm_custom_group.weight, * If there are custom-groups which only apply to certain subtypes, * those WILL be included. * - * @param $entityType - * String. + * @param string $entityType * * @return CRM_Core_DAO_CustomGroup */ @@ -1244,8 +1243,8 @@ ORDER BY civicrm_custom_group.weight, * * @param $group * Object the DAO custom group object. - * @param $force - * Boolean whether to force the deletion, even if there are custom fields. + * @param bool $force + * whether to force the deletion, even if there are custom fields. * * @return boolean false if field exists for this group, true if group gets deleted. * diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index 179abf99ab..5bb4b39c1d 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -110,14 +110,14 @@ class CRM_Core_BAO_CustomOption { * Returns the option label for a custom field with a specific value. Handles all * custom field data and html types * - * @param $fieldId - * Int the custom field ID. + * @param int $fieldId + * the custom field ID. * @pram $value string the value (typically from the DB) of this custom field * @param $value - * @param $htmlType - * String the html type of the field (optional). - * @param $dataType - * String the data type of the field (optional). + * @param string $htmlType + * the html type of the field (optional). + * @param string $dataType + * the data type of the field (optional). * * @return string the label to display for this custom field * @static diff --git a/CRM/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index bc785846a9..09155244de 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -79,10 +79,9 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** * Change the schema version of an extension * - * @param $fullName - * String, the fully-qualified name (eg "com.example.myextension"). - * @param $schemaVersion - * String. + * @param string $fullName + * the fully-qualified name (eg "com.example.myextension"). + * @param string $schemaVersion * @return void */ public static function setSchemaVersion($fullName, $schemaVersion) { @@ -97,8 +96,8 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** * Determine the schema version of an extension * - * @param $fullName - * String, the fully-qualified name (eg "com.example.myextension"). + * @param string $fullName + * the fully-qualified name (eg "com.example.myextension"). * @return string */ public static function getSchemaVersion($fullName) { diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index 5538b9282d..ab1165c369 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -463,12 +463,12 @@ AND CEF.entity_id = %2"; * Return a clean url string and the number of attachment for a * given entityTable, entityID * - * @param $entityTable - * String The entityTable to which the file is attached. - * @param $entityID - * Int The id of the object in the above entityTable. - * @param $separator - * String The string separator where to implode the urls. + * @param string $entityTable + * The entityTable to which the file is attached. + * @param int $entityID + * The id of the object in the above entityTable. + * @param string $separator + * The string separator where to implode the urls. * * @return array An array with 2 elements. The string and the number of attachments * @static @@ -652,11 +652,11 @@ AND CEF.entity_id = %2"; /** * Display paper icon for a file attachment -- CRM-13624 * - * @param $entityTable - * String The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity". + * @param string $entityTable + * The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity". * If you have the ID of a specific row in civicrm_file, use $entityTable='*' - * @param $entityID - * Int The id of the object in the above entityTable. + * @param int $entityID + * The id of the object in the above entityTable. * * @return array|NULL list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL * diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index 14d409a344..574046997f 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -194,10 +194,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Check Duplicate Mapping Name * - * @param $nameField - * String mapping Name. - * @param $mapTypeId - * String mapping Type. + * @param string $nameField + * mapping Name. + * @param string $mapTypeId + * mapping Type. * * @return boolean */ diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 9a68eae56f..1be9ede08b 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -149,9 +149,9 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { /** * Calculate navigation weight * - * @param $parentID + * @param int $parentID * Parent_id of a menu. - * @param $menuID + * @param int $menuID * Menu id. * * @return int $weight string@static diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index 8a704f0fa3..f33d6edfcb 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -419,8 +419,8 @@ AND domain_id = %4 /** * Update the email value for the contact and user profile * - * @param $contactId - * Int Contact ID of the user. + * @param int $contactId + * Contact ID of the user. * @param $emailAddress * Email to be modified for the user. * diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index ccaf9c6700..404bd0f4ce 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -187,10 +187,10 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { /** * Singleton function used to manage this object. * - * @param $loadFromDB - * Boolean whether to load from the database. - * @param $force - * Boolean whether to force a reconstruction. + * @param bool $loadFromDB + * whether to load from the database. + * @param bool $force + * whether to force a reconstruction. * * @return CRM_Core_Config * @static diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index ea17f58470..3fb5362345 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -1534,10 +1534,9 @@ SELECT contact_id /** * Escape a list of strings for use with "WHERE X IN (...)" queries. * - * @param $strings - * Array. - * @param $default - * String the value to use if $strings has no elements. + * @param array $strings + * @param string $default + * the value to use if $strings has no elements. * @return string eg "abc","def","ghi" */ public static function escapeStrings($strings, $default = NULL) { @@ -1812,8 +1811,8 @@ SELECT contact_id * Build a list of triggers via hook and add them to (err, reconcile them * with) the database. * - * @param $tableName - * String the specific table requiring a rebuild; or NULL to rebuild all tables. + * @param string $tableName + * the specific table requiring a rebuild; or NULL to rebuild all tables. * @param bool $force * * @see CRM-9716 @@ -1856,8 +1855,8 @@ SELECT contact_id /** * Wrapper function to drop triggers * - * @param $tableName - * String the specific table requiring a rebuild; or NULL to rebuild all tables. + * @param string $tableName + * the specific table requiring a rebuild; or NULL to rebuild all tables. */ public static function dropTriggers($tableName = NULL) { $info = array(); @@ -1870,10 +1869,10 @@ SELECT contact_id } /** - * @param $info - * Array per hook_civicrm_triggerInfo. - * @param $onlyTableName - * String the specific table requiring a rebuild; or NULL to rebuild all tables. + * @param array $info + * per hook_civicrm_triggerInfo. + * @param string $onlyTableName + * the specific table requiring a rebuild; or NULL to rebuild all tables. */ public static function createTriggers(&$info, $onlyTableName = NULL) { // Validate info array, should probably raise errors? @@ -2203,12 +2202,12 @@ SELECT contact_id * * @param string $fieldName * Name of fields. - * @param $filter - * Array filter to be applied indexed by operator. - * @param $type - * String type of field (not actually used - nor in api @todo ). - * @param $alias - * String alternative field name ('as') @todo- not actually used. + * @param array $filter + * filter to be applied indexed by operator. + * @param string $type + * type of field (not actually used - nor in api @todo ). + * @param string $alias + * alternative field name ('as') @todo- not actually used. * @param bool $returnSanitisedArray * Return a sanitised array instead of a clause. * this is primarily so we can add filters @ the api level to the Query object based fields diff --git a/CRM/Core/I18n.php b/CRM/Core/I18n.php index ee83f8bb75..1b581e29f7 100644 --- a/CRM/Core/I18n.php +++ b/CRM/Core/I18n.php @@ -55,8 +55,8 @@ class CRM_Core_I18n { /** * A locale-based constructor that shouldn't be called from outside of this class (use singleton() instead). * - * @param $locale - * String the base of this certain object's existence. + * @param string $locale + * the base of this certain object's existence. * * @return \CRM_Core_I18n */ @@ -118,8 +118,8 @@ class CRM_Core_I18n { /** * Return languages available in this instance of CiviCRM. * - * @param $justEnabled - * Boolean whether to return all languages or just the enabled ones. + * @param bool $justEnabled + * whether to return all languages or just the enabled ones. * * @return array of code/language name mappings */ @@ -172,8 +172,8 @@ class CRM_Core_I18n { /** * Replace arguments in a string with their values. Arguments are represented by % followed by their number. * - * @param $str - * String source string. + * @param string $str + * source string. * @param mixed arguments, can be passed in an array or through single variables * * @return string modified string @@ -210,10 +210,10 @@ class CRM_Core_I18n { * - count - The item count for plural mode (3rd parameter of ngettext()) * - context - gettext context of that string (for homonym handling) * - * @param $text - * String the original string. - * @param $params - * Array the params of the translation (if any). + * @param string $text + * the original string. + * @param array $params + * the params of the translation (if any). * * @return string the translated string */ @@ -344,8 +344,8 @@ class CRM_Core_I18n { /** * Translate a string to the current locale. * - * @param $string - * String this string should be translated. + * @param string $string + * this string should be translated. * * @return string the translated string */ @@ -356,10 +356,10 @@ class CRM_Core_I18n { /** * Localize (destructively) array values. * - * @param $array - * Array the array for localization (in place). - * @param $params - * Array an array of additional parameters. + * @param array $array + * the array for localization (in place). + * @param array $params + * an array of additional parameters. * * @return void */ @@ -383,8 +383,8 @@ class CRM_Core_I18n { /** * Localize (destructively) array elements with keys of 'title'. * - * @param $array - * Array the array for localization (in place). + * @param array $array + * the array for localization (in place). * * @return void */ diff --git a/CRM/Core/I18n/Schema.php b/CRM/Core/I18n/Schema.php index ddabc94a28..1e7426eaed 100644 --- a/CRM/Core/I18n/Schema.php +++ b/CRM/Core/I18n/Schema.php @@ -60,8 +60,8 @@ class CRM_Core_I18n_Schema { * Switch database from single-lang to multi (by adding * the first language and dropping the original columns). * - * @param $locale - * String the first locale to create (migrate to). + * @param string $locale + * the first locale to create (migrate to). * * @return void */ @@ -115,8 +115,8 @@ class CRM_Core_I18n_Schema { * Switch database from multi-lang back to single (by dropping * additional columns and views and retaining only the selected locale). * - * @param $retain - * String the locale to retain. + * @param string $retain + * the locale to retain. * * @return void */ @@ -155,12 +155,12 @@ class CRM_Core_I18n_Schema { /** * Switch a given table from multi-lang to single (by retaining only the selected locale). * - * @param $retain - * String the locale to retain. - * @param $table - * String the table containing the column. - * @param $class - * String schema structure class to use to recreate indices. + * @param string $retain + * the locale to retain. + * @param string $table + * the table containing the column. + * @param string $class + * schema structure class to use to recreate indices. * * @param array $triggers * @@ -240,10 +240,10 @@ class CRM_Core_I18n_Schema { * Add a new locale to a multi-lang db, setting * its values to the current default locale. * - * @param $locale - * String the new locale to add. - * @param $source - * String the locale to copy from. + * @param string $locale + * the new locale to add. + * @param string $source + * the locale to copy from. * * @return void */ @@ -299,10 +299,10 @@ class CRM_Core_I18n_Schema { /** * Rebuild multilingual indices, views and triggers (useful for upgrades) * - * @param $locales - * Array locales to be rebuilt. - * @param $version - * String version of schema structure to use. + * @param array $locales + * locales to be rebuilt. + * @param string $version + * version of schema structure to use. * * @return void */ @@ -365,8 +365,8 @@ class CRM_Core_I18n_Schema { /** * Rewrite SQL query to use views to access tables with localized columns. * - * @param $query - * String the query for rewrite. + * @param string $query + * the query for rewrite. * * @return string the rewritten query */ @@ -436,12 +436,12 @@ class CRM_Core_I18n_Schema { /** * CREATE INDEX queries for a given locale and table * - * @param $locale - * String locale for which the queries should be created (null to create original indices). - * @param $table - * String table for which the queries should be created. - * @param $class - * String schema structure class to use. + * @param string $locale + * locale for which the queries should be created (null to create original indices). + * @param string $table + * table for which the queries should be created. + * @param string $class + * schema structure class to use. * * @return array array of CREATE INDEX queries */ @@ -478,14 +478,14 @@ class CRM_Core_I18n_Schema { /** * CREATE VIEW query for a given locale and table * - * @param $locale - * String locale of the view. - * @param $table - * String table of the view. + * @param string $locale + * locale of the view. + * @param string $table + * table of the view. * @param CRM_Core_DAO $dao * A DAO object to run DESCRIBE queries. - * @param $class - * String schema structure class to use. + * @param string $class + * schema structure class to use. * * @return array array of CREATE INDEX queries */ diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index ca4deb4f27..a0935dcf28 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -129,8 +129,8 @@ class CRM_Core_ManagedEntities { * Create, update, and delete entities declared by an active module * * @param \CRM_Core_Module|string $module string - * @param $todos - * Array $name => array(). + * @param array $todos + * $name => array(). */ public function reconcileEnabledModule(CRM_Core_Module $module, $todos) { $dao = new CRM_Core_DAO_Managed(); diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index 93e0993345..da62d5ea6c 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -92,25 +92,25 @@ class CRM_Core_OptionGroup { * (radio, select, checkbox etc). OptionGroups for most cases have the * 'label' in the label colum and the 'id' or 'name' in the value column * - * @param $name - * String name of the option group. - * @param $flip - * Boolean results are return in id => label format if false. + * @param string $name + * name of the option group. + * @param bool $flip + * results are return in id => label format if false. * if true, the results are reversed - * @param $grouping - * Boolean if true, return the value in 'grouping' column. - * @param $localize - * Boolean if true, localize the results before returning. - * @param $condition - * String add another condition to the sql query. - * @param $labelColumnName - * String the column to use for 'label'. - * @param $onlyActive - * Boolean return only the action option values. - * @param $fresh - * Boolean ignore cache entries and go back to DB. - * @param $keyColumnName - * String the column to use for 'key'. + * @param bool $grouping + * if true, return the value in 'grouping' column. + * @param bool $localize + * if true, localize the results before returning. + * @param string $condition + * add another condition to the sql query. + * @param string $labelColumnName + * the column to use for 'label'. + * @param bool $onlyActive + * return only the action option values. + * @param bool $fresh + * ignore cache entries and go back to DB. + * @param string $keyColumnName + * the column to use for 'key'. * * @return array the values as specified by the above params * @static @@ -204,22 +204,21 @@ WHERE v.option_group_id = g.id * (radio, select, checkbox etc). OptionGroups for most cases have the * 'label' in the label colum and the 'id' or 'name' in the value column * - * @param $id - * Integer id of the option group. - * @param $flip - * Boolean results are return in id => label format if false. - * if true, the results are reversed - * @param $grouping - * Boolean if true, return the value in 'grouping' column. - * @param $localize - * Boolean if true, localize the results before returning. - * @param $labelColumnName - * String the column to use for 'label'. - * + * @param int $id + * id of the option group. + * @param bool $flip + * results are return in id => label format if false. + * if true, the results are reversed + * @param bool $grouping + * if true, return the value in 'grouping' column. + * @param bool $localize + * if true, localize the results before returning. + * @param string $labelColumnName + * the column to use for 'label'. * @param bool $onlyActive * @param bool $fresh * - * @return array the values as specified by the above params + * @return array of values as specified by the above params * @static * @void */ @@ -262,16 +261,15 @@ WHERE v.option_group_id = g.id * * @param array $params * Reference array of values submitted by the form. Based on. - * $flip, creates new elements in $params for each field in - * the $names array. - * If $flip = false, adds root field name => title - * If $flip = true, adds actual field name => id + * $flip, creates new elements in $params for each field in + * the $names array. + * If $flip = false, adds root field name => title + * If $flip = true, adds actual field name => id * * @param array $names * Reference array of fieldnames we want transformed. - * Array key = 'postName' (field name submitted by form in $params). - * Array value = array( - 'newName' => $newName, 'groupName' => $groupName). + * Array key = 'postName' (field name submitted by form in $params). + * Array value = array('newName' => $newName, 'groupName' => $groupName). * * * @param bool $flip diff --git a/CRM/Core/Payment/AuthorizeNetIPN.php b/CRM/Core/Payment/AuthorizeNetIPN.php index 01b3769400..f861495524 100644 --- a/CRM/Core/Payment/AuthorizeNetIPN.php +++ b/CRM/Core/Payment/AuthorizeNetIPN.php @@ -37,8 +37,8 @@ class CRM_Core_Payment_AuthorizeNetIPN extends CRM_Core_Payment_BaseIPN { /** * Constructor function * - * @param $inputData - * Array contents of HTTP REQUEST. + * @param array $inputData + * contents of HTTP REQUEST. * * @throws CRM_Core_Exception */ diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index d0c84142b3..a1a10e4fe0 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -260,7 +260,7 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * Helper function to convert XML string to multi-dimension array. * - * @param $xml + * @param string $xml * an XML string. * * @return array An array of the result with following keys: @@ -297,8 +297,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { return $result; } - // private helper for xml_parse_into_assoc, to recusively parsing the result /** + * Private helper for xml_parse_into_assoc, to recusively parsing the result * @param $input * @param int $depth * diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index d478d2db16..ba5844af16 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -1677,8 +1677,7 @@ ORDER BY name"; * Given a state ID return the country ID, this allows * us to populate forms and values for downstream code * - * @param $stateID - * Int. + * @param int $stateID * * @return int the country id that the state belongs to * @static @@ -1838,8 +1837,8 @@ WHERE id = %1 /** * Fetch the list of active extensions of type 'module' * - * @param $fresh - * Bool whether to forcibly reload extensions list from canonical store. + * @param bool $fresh + * Whether to forcibly reload extensions list from canonical store. * @static * * @return array - array(array('prefix' => $, 'file' => $)) diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index 417b1ecaa1..c920250e03 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -84,7 +84,7 @@ class CRM_Core_Region { * Note: This function does not perform any extra encoding of markup, script code, or etc. If * you're passing in user-data, you must clean it yourself. * - * @param $snippet + * @param array $snippet * Array; keys:. * - type: string (auto-detected for markup, template, callback, script, scriptUrl, jquery, style, styleUrl) * - name: string, optional diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 8430d009dd..97f03f5d84 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -102,8 +102,8 @@ class CRM_Core_Resources { /** * Get or set the single instance of CRM_Core_Resources * - * @param $instance - * CRM_Core_Resources, new copy of the manager. + * @param CRM_Core_Resources $instance + * New copy of the manager. * @return CRM_Core_Resources */ static public function singleton(CRM_Core_Resources $instance = NULL) { @@ -152,14 +152,14 @@ class CRM_Core_Resources { /** * Add a JavaScript file to the current page using