From 2b37475d476ba66508442e90931e40e89e786ef0 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Fri, 9 Jan 2015 13:43:03 -0500 Subject: [PATCH] INFRA-132 - Fix comment spacing --- CRM/Activity/BAO/ActivityContact.php | 2 +- CRM/Admin/Form/Setting/Smtp.php | 2 +- CRM/Badge/BAO/Badge.php | 2 +- CRM/Campaign/BAO/Petition.php | 2 +- CRM/Case/BAO/Case.php | 5 +- CRM/Contact/BAO/ContactType.php | 14 ++--- CRM/Contact/BAO/GroupNesting.php | 52 ++++++++++++------- CRM/Contact/Form/Task/Label.php | 2 +- CRM/Contact/Form/Task/LabelCommon.php | 2 +- CRM/Core/BAO/Address.php | 2 +- CRM/Core/BAO/CustomField.php | 6 +-- CRM/Core/BAO/CustomQuery.php | 2 +- CRM/Core/BAO/EntityTag.php | 2 +- CRM/Core/BAO/UFField.php | 4 +- CRM/Core/Form.php | 2 +- CRM/Core/I18n.php | 14 ++--- CRM/Core/QuickForm/GroupMultiSelect.php | 2 +- CRM/Core/QuickForm/NestedAdvMultiSelect.php | 2 +- CRM/Core/Report/Excel.php | 2 +- CRM/Custom/Page/Group.php | 2 +- CRM/Event/BAO/Event.php | 2 +- CRM/Event/Badge.php | 4 +- CRM/Price/BAO/PriceField.php | 4 +- CRM/Price/BAO/PriceFieldValue.php | 4 +- CRM/Price/Page/Set.php | 2 +- CRM/Profile/Form/Edit.php | 2 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 4 +- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 4 +- CRM/Utils/ICalendar.php | 4 +- CRM/Utils/Rule.php | 6 +-- api/v3/ActivityContact.php | 2 +- api/v3/Address.php | 2 +- api/v3/ContributionSoft.php | 2 +- api/v3/Country.php | 2 +- api/v3/CustomGroup.php | 2 +- api/v3/CustomSearch.php | 2 +- api/v3/Email.php | 2 +- api/v3/Event.php | 2 +- api/v3/File.php | 2 +- api/v3/GroupContact.php | 2 +- api/v3/GroupNesting.php | 2 +- api/v3/GroupOrganization.php | 2 +- api/v3/Im.php | 2 +- api/v3/Job.php | 2 +- api/v3/LocationType.php | 2 +- api/v3/Membership.php | 2 +- api/v3/MembershipStatus.php | 2 +- api/v3/MembershipType.php | 2 +- api/v3/MessageTemplate.php | 2 +- api/v3/OptionValue.php | 2 +- api/v3/PaymentProcessor.php | 2 +- api/v3/Phone/Get.php | 2 +- api/v3/Relationship.php | 2 +- api/v3/ReportInstance.php | 2 +- api/v3/ReportTemplate.php | 6 +-- api/v3/Tag.php | 2 +- api/v3/Website.php | 2 +- .../phpunit/CiviTest/CiviSeleniumTestCase.php | 4 +- 58 files changed, 118 insertions(+), 103 deletions(-) diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 78f2453201..5f76c47624 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -148,7 +148,7 @@ AND civicrm_contact.is_deleted = 0 * [local_col_name] => "related_tablename:related_col_name" * * - * @return array|null + * @return array|null * array = if there are links defined for this table. * empty array - if there is a links.ini file, but no links on this table * null - if no links.ini exists for this database (hence try auto_links). diff --git a/CRM/Admin/Form/Setting/Smtp.php b/CRM/Admin/Form/Setting/Smtp.php index f6b282a2ac..8c87d325ba 100644 --- a/CRM/Admin/Form/Setting/Smtp.php +++ b/CRM/Admin/Form/Setting/Smtp.php @@ -205,7 +205,7 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { * @param array $fields * Posted values of the form. * - * @return array list of errors to be posted back to the form + * @return array list of errors to be posted back to the form * @static */ public static function formRule($fields) { diff --git a/CRM/Badge/BAO/Badge.php b/CRM/Badge/BAO/Badge.php index b3e111d2c4..b63f5a2ef9 100644 --- a/CRM/Badge/BAO/Badge.php +++ b/CRM/Badge/BAO/Badge.php @@ -50,7 +50,7 @@ class CRM_Badge_BAO_Badge { * @param array $layoutInfo * Associated array which contains meta data about format/layout. * - * @return void + * @return void */ public function createLabels(&$participants, &$layoutInfo) { $this->pdf = new CRM_Utils_PDF_Label($layoutInfo['format'], 'mm'); diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 1b36338d58..7055ce1550 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -466,7 +466,7 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; * @param object $tag * An object of a tag. * - * @return array $contactIds array of contact ids + * @return array $contactIds array of contact ids */ public function getEntitiesByTag($tag) { $contactIds = array(); diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index 4d245fc12e..da805b9dec 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -292,7 +292,7 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * @param int $activityId * Activity id. * - * @return case subject or null + * @return string|null * @static */ public static function getCaseSubject($activityId) { @@ -308,10 +308,9 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * Get the case type. * * @param int $caseId - * * @param string $colName * - * @return case type + * @return string case type * @static */ public static function getCaseType($caseId, $colName = 'title') { diff --git a/CRM/Contact/BAO/ContactType.php b/CRM/Contact/BAO/ContactType.php index 2529eb6146..a9c7063497 100644 --- a/CRM/Contact/BAO/ContactType.php +++ b/CRM/Contact/BAO/ContactType.php @@ -71,7 +71,7 @@ class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType { * * @param bool $all * - * @return array of basic contact types information. + * @return array of basic contact types information. * @static */ public static function &basicTypeInfo($all = FALSE) { @@ -117,7 +117,7 @@ WHERE parent_id IS NULL * * @param bool $all * - * @return array of basic contact types + * @return array of basic contact types * @static */ public static function basicTypes($all = FALSE) { @@ -150,7 +150,7 @@ WHERE parent_id IS NULL * @param bool $ignoreCache * @param bool $reset * - * @return array of sub type information + * @return array of sub type information * @static */ public static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) { @@ -219,7 +219,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param string $columnName * @param bool $ignoreCache * - * @return array of all subtypes OR list of subtypes associated to + * @return array of all subtypes OR list of subtypes associated to * a given basic contact type * @static */ @@ -261,7 +261,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * * @param bool $all * - * @return array of basic types + all subtypes. + * @return array of basic types + all subtypes. * @static */ public static function contactTypes($all = FALSE) { @@ -275,7 +275,7 @@ WHERE subtype.name IS NOT NULL AND subtype.parent_id IS NOT NULL {$ctWHERE} * @param bool $all * @param bool $reset * - * @return array of basic types + all subtypes. + * @return array of basic types + all subtypes. * @static */ public static function contactTypeInfo($all = FALSE, $reset = FALSE) { @@ -451,7 +451,7 @@ AND ( p.is_active = 1 OR p.id IS NULL ) * Contact subType. * @param bool $ignoreCache * - * @return boolean true if subType, false otherwise. + * @return boolean true if subType, false otherwise. * @static */ public static function isaSubType($subType, $ignoreCache = FALSE) { diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 04beb39952..0851fb5611 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -105,6 +105,9 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen $this->_alreadyStyled = FALSE; } + /** + * @return mixed + */ public function current() { if ($this->_styleLabels && $this->valid() && @@ -302,7 +305,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @param $childID * The id of the child group being removed. * - * @return void + * @return void * */ public static function remove($parentID, $childID) { @@ -319,7 +322,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @param int $childID * The id of the child group being removed. * - * @return void + * @return void * */ public static function removeAllParentForChild($childID) { @@ -337,7 +340,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @param $childID * The child id of the association. * - * @return boolean True if association is found, false otherwise. + * @return boolean + * True if association is found, false otherwise. * */ public static function isParentChild($parentID, $childID) { @@ -357,7 +361,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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. + * @return boolean + * True if 1 or more child groups are found, false otherwise. * */ public static function hasChildGroups($groupId) { @@ -378,8 +383,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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. - * + * @return boolean + * True if 1 or more parent groups are found, false otherwise. */ public static function hasParentGroups($groupId) { $dao = new CRM_Contact_DAO_GroupNesting(); @@ -400,7 +405,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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. + * @return boolean + * True if $checkGroupId points to a group that is a parent of one of the $groupIds groups, false otherwise. * */ public static function isParentGroup($groupIds, $checkGroupId) { @@ -432,7 +438,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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. + * @return boolean + * True if $checkGroupId points to a group that is a child of one of the $groupIds groups, false otherwise. * */ public static function isChildGroup($groupIds, $checkGroupId) { @@ -466,7 +473,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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. + * @return boolean + * True if $checkGroupId points to a group that is an ancestor of one of the $groupIds groups, false otherwise. * */ public static function isAncestorGroup($groupIds, $checkGroupId) { @@ -507,7 +515,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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. + * @return boolean + * True if $checkGroupId points to a group that is a descendent of one of the $groupIds groups, false otherwise. * */ public static function isDescendentGroup($groupIds, $checkGroupId) { @@ -547,7 +556,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param bool $includeSelf * - * @return array $groupIdArray List of groupIds that represent the requested group and its ancestors@access public + * @return array + * List of groupIds that represent the requested group and its ancestors@access public */ public static function getAncestorGroupIds($groupIds, $includeSelf = TRUE) { if (!is_array($groupIds)) { @@ -583,7 +593,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * An array of valid group ids (passed by reference). * * @param bool $includeSelf - * @return \An $groupArray List of ancestor groups@access public + * @return array + * List of ancestor groups@access public */ public static function getAncestorGroups($groupIds, $includeSelf = TRUE) { $groupIds = self::getAncestorGroupIds($groupIds, $includeSelf); @@ -597,7 +608,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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 + * @return array + * List of groupIds that represent the requested group and its children@access public */ public static function getChildGroupIds($groupIds) { if (!is_array($groupIds)) { @@ -619,7 +631,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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 + * @return array + * List of groupIds that represent the requested group and its parents@access public */ public static function getParentGroupIds($groupIds) { if (!is_array($groupIds)) { @@ -642,7 +655,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * 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 + * @return array + * List of groupIds that represent the requested group and its descendents@access public */ public static function getDescendentGroupIds($groupIds, $includeSelf = TRUE) { if (!is_array($groupIds)) { @@ -673,10 +687,11 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * Returns array of descendent groups of the specified group. * * @param array $groupIds - * An array of valid group ids (passed by reference). + * An array of valid group ids * * @param bool $includeSelf - * @return \An $groupArray List of descendent groups@access public + * @return array + * List of descendent groups@access public */ public static function getDescendentGroups($groupIds, $includeSelf = TRUE) { $groupIds = self::getDescendentGroupIds($groupIds, $includeSelf); @@ -690,7 +705,8 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * @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 + * @return array + * List of groupIds that represent the valid potential children of the group@access public */ public static function getPotentialChildGroupIds($groupId) { $groups = CRM_Contact_BAO_Group::getGroups(); diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index b2c55bc5bb..94fa4a677b 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -381,7 +381,7 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { * @param string $fileName * The name of the file to save the label in. * - * @return null + * @return null */ public function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') { $pdf = new CRM_Utils_PDF_Label($format, 'mm'); diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 121b17dd51..6cecd9a7b1 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -50,7 +50,7 @@ class CRM_Contact_Form_Task_LabelCommon { * @param string $fileName * The name of the file to save the label in. * - * @return null + * @return null */ public static function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') { $pdf = new CRM_Utils_PDF_Label($format, 'mm'); diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 5c326b85a9..7395289bc4 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -659,7 +659,7 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, /** * Get address sequence * - * @return array of address sequence. + * @return array of address sequence. */ public static function addressSequence() { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index eccf8d0b0d..3b8536e8a0 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -341,7 +341,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object DAO object on sucess, null otherwise * * @static */ @@ -1091,7 +1091,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param object $field * The field object. * - * @return boolean + * @return boolean * * @static * @@ -1130,7 +1130,7 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @param int $contactID * @param int $fieldID * - * @return string the display value + * @return string the display value * * @static */ diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index d6433e956f..f67e71ac35 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -558,7 +558,7 @@ SELECT label, value * * @param NULL * - * @return array array of strings + * @return array array of strings */ public function query() { $this->select(); diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index 441b8169ed..12593abd3c 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -273,7 +273,7 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * @param object $tag * An object of a tag. * - * @return array $entityIds array of entity ids + * @return array $entityIds array of entity ids */ public function getEntitiesByTag($tag) { $entityIds = array(); diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 9ad651613b..dd7b25f2a8 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -508,7 +508,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param int $ufGroupId * - * @return true for mix profile else false + * @return true for mix profile else false * @static */ public static function checkProfileType($ufGroupId) { @@ -705,7 +705,7 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * * @param $ctype * - * @return true for mix profile group else false + * @return true for mix profile group else false * @static */ public static function checkProfileGroupType($ctype) { diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 9ef41bc756..289d44afd8 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -393,7 +393,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Performs the server side validation * @since 1.0 - * @return boolean true if no error found + * @return boolean true if no error found * @throws HTML_QuickForm_Error */ public function validate() { diff --git a/CRM/Core/I18n.php b/CRM/Core/I18n.php index 1b581e29f7..6370f27f67 100644 --- a/CRM/Core/I18n.php +++ b/CRM/Core/I18n.php @@ -121,7 +121,7 @@ class CRM_Core_I18n { * @param bool $justEnabled * whether to return all languages or just the enabled ones. * - * @return array of code/language name mappings + * @return array of code/language name mappings */ public static function languages($justEnabled = FALSE) { static $all = NULL; @@ -176,7 +176,7 @@ class CRM_Core_I18n { * source string. * @param mixed arguments, can be passed in an array or through single variables * - * @return string modified string + * @return string modified string */ public function strarg($str) { $tr = array(); @@ -215,7 +215,7 @@ class CRM_Core_I18n { * @param array $params * the params of the translation (if any). * - * @return string the translated string + * @return string the translated string */ public function crm_translate($text, $params = array()) { if (isset($params['escape'])) { @@ -347,7 +347,7 @@ class CRM_Core_I18n { * @param string $string * this string should be translated. * - * @return string the translated string + * @return string the translated string */ public function translate($string) { return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string; @@ -361,7 +361,7 @@ class CRM_Core_I18n { * @param array $params * an array of additional parameters. * - * @return void + * @return void */ function localizeArray( &$array, @@ -386,7 +386,7 @@ class CRM_Core_I18n { * @param array $array * the array for localization (in place). * - * @return void + * @return void */ public function localizeTitles(&$array) { foreach ($array as $key => $value) { @@ -499,7 +499,7 @@ class CRM_Core_I18n { * @param $params * Array an array of additional parameters. * - * @return string the translated string + * @return string the translated string */ function ts($text, $params = array()) { static $config = NULL; diff --git a/CRM/Core/QuickForm/GroupMultiSelect.php b/CRM/Core/QuickForm/GroupMultiSelect.php index eb7b1c9c08..2bd502623c 100644 --- a/CRM/Core/QuickForm/GroupMultiSelect.php +++ b/CRM/Core/QuickForm/GroupMultiSelect.php @@ -37,7 +37,7 @@ class CRM_Core_QuickForm_GroupMultiSelect extends CRM_Core_QuickForm_NestedAdvMu /** * Returns the HTML generated for the advanced mutliple select component * - * @return string + * @return string * @since version 0.4.0 (2005-06-25) */ public function toHtml() { diff --git a/CRM/Core/QuickForm/NestedAdvMultiSelect.php b/CRM/Core/QuickForm/NestedAdvMultiSelect.php index 42c0a50f1f..92d488ee50 100644 --- a/CRM/Core/QuickForm/NestedAdvMultiSelect.php +++ b/CRM/Core/QuickForm/NestedAdvMultiSelect.php @@ -57,7 +57,7 @@ class CRM_Core_QuickForm_NestedAdvMultiSelect extends HTML_QuickForm_advmultisel * (optional) See function detail. * * @since version 1.5.0 (2009-02-15) - * @return PEAR_Error|NULL on error and TRUE on success + * @return PEAR_Error|NULL on error and TRUE on success * @throws PEAR_Error * @see loadArray() */ diff --git a/CRM/Core/Report/Excel.php b/CRM/Core/Report/Excel.php index d3dd8fab49..0ae0eca5f6 100644 --- a/CRM/Core/Report/Excel.php +++ b/CRM/Core/Report/Excel.php @@ -48,7 +48,7 @@ class CRM_Core_Report_Excel { * * @param bool $outputHeader * - * @return mixed empty if output is printed, else output + * @return mixed empty if output is printed, else output * * @static */ diff --git a/CRM/Custom/Page/Group.php b/CRM/Custom/Page/Group.php index b227a177e2..041ed6bc1c 100644 --- a/CRM/Custom/Page/Group.php +++ b/CRM/Custom/Page/Group.php @@ -55,7 +55,7 @@ class CRM_Custom_Page_Group extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array array of action links that we need to display for the browse screen */ public function &actionLinks() { // check if variable _actionsLinks is populated diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index afa289b6ec..6228854583 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -729,7 +729,7 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL * @param bool $onlyPublicInclude public events only, default TRUE. * Include public events only, default TRUE. * - * @return array $all array of all the events that are searched + * @return array $all array of all the events that are searched * @static */ static function &getCompleteInfo( diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index 5efaba68d6..0b9b59b21c 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -75,7 +75,7 @@ class CRM_Event_Badge { * * @param array $participants * - * @return null + * @return null */ public function run(&$participants) { // fetch the 1st participant, and take her event to retrieve its attributes @@ -176,7 +176,7 @@ class CRM_Event_Badge { * * @param array $participants * - * @return null + * @return null */ public function createLabels(&$participants) { diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index ff67088dc0..032b8d3997 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -192,7 +192,7 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object DAO object on sucess, null otherwise * * @static */ @@ -628,7 +628,7 @@ WHERE * @param int $id * Field Id. * - * @return boolean + * @return boolean * * @static * diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index a457e0beec..067b04517c 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -194,7 +194,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object DAO object on sucess, null otherwise * * @static */ @@ -227,7 +227,7 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * @param int $id * Id. * - * @return boolean + * @return boolean * * @static */ diff --git a/CRM/Price/Page/Set.php b/CRM/Price/Page/Set.php index 1773c0face..35b28d905f 100644 --- a/CRM/Price/Page/Set.php +++ b/CRM/Price/Page/Set.php @@ -55,7 +55,7 @@ class CRM_Price_Page_Set extends CRM_Core_Page { * * @param null * - * @return array array of action links that we need to display for the browse screen + * @return array array of action links that we need to display for the browse screen */ function &actionLinks() { // check if variable _actionsLinks is populated diff --git a/CRM/Profile/Form/Edit.php b/CRM/Profile/Form/Edit.php index de77131b0d..043d3369cf 100644 --- a/CRM/Profile/Form/Edit.php +++ b/CRM/Profile/Form/Edit.php @@ -313,7 +313,7 @@ SELECT module,is_reserved * This is a first version and will be tweaked over a period of time * * - * @return boolean true if no error found + * @return boolean true if no error found */ public function validate() { $errors = parent::validate(); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index e7205e95b7..a65e75dddd 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -178,7 +178,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object DAO object on sucess, null otherwise * * @static */ @@ -524,7 +524,7 @@ WHERE * @param int $id * Field Id. * - * @return boolean + * @return boolean * * @static * diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index 31cfd66b8f..b08e10726e 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -181,7 +181,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param bool $is_active * Value we want to set the is_active field. * - * @return Object DAO object on sucess, null otherwise + * @return Object DAO object on sucess, null otherwise * * @static */ @@ -215,7 +215,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param int $id * Id. * - * @return boolean + * @return boolean * * @static */ diff --git a/CRM/Utils/ICalendar.php b/CRM/Utils/ICalendar.php index f9d63c270f..86b070c52a 100644 --- a/CRM/Utils/ICalendar.php +++ b/CRM/Utils/ICalendar.php @@ -48,7 +48,7 @@ class CRM_Utils_ICalendar { * @param $text * Text to escape. * - * @return Escaped text + * @return Escaped text * */ public static function formatText($text) { @@ -70,7 +70,7 @@ class CRM_Utils_ICalendar { * * @param bool $gdata * - * @return Escaped date + * @return Escaped date */ public static function formatDate($date, $gdata = FALSE) { diff --git a/CRM/Utils/Rule.php b/CRM/Utils/Rule.php index ec0591c31a..faf3f7e85a 100644 --- a/CRM/Utils/Rule.php +++ b/CRM/Utils/Rule.php @@ -557,7 +557,7 @@ class CRM_Utils_Rule { * * @param array Uploaded file info (from $_FILES) * - * @return bool true if file has been uploaded, false otherwise + * @return bool true if file has been uploaded, false otherwise */ public static function asciiFile($elementValue) { if ((isset($elementValue['error']) && $elementValue['error'] == 0) || @@ -573,7 +573,7 @@ class CRM_Utils_Rule { * * @param array Uploaded file info (from $_FILES) * - * @return bool whether file has been uploaded properly and is now in UTF-8 + * @return bool whether file has been uploaded properly and is now in UTF-8 */ public static function utf8File($elementValue) { $success = FALSE; @@ -602,7 +602,7 @@ class CRM_Utils_Rule { * * @param array Uploaded file info (from $_FILES) * - * @return bool true if file has been uploaded, false otherwise + * @return bool true if file has been uploaded, false otherwise */ public static function htmlFile($elementValue) { if ((isset($elementValue['error']) && $elementValue['error'] == 0) || diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index 5d24f2c1f4..a82270e133 100644 --- a/api/v3/ActivityContact.php +++ b/api/v3/ActivityContact.php @@ -86,7 +86,7 @@ function civicrm_api3_activity_contact_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found tags else error + * @return array details of found tags else error * * @access public */ diff --git a/api/v3/Address.php b/api/v3/Address.php index 69aef9e8fb..72b23154e2 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -148,7 +148,7 @@ function civicrm_api3_address_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found addresses else error + * @return array details of found addresses else error * {@getfields address_get} * @access public */ diff --git a/api/v3/ContributionSoft.php b/api/v3/ContributionSoft.php index 112615e1f0..706c446d03 100644 --- a/api/v3/ContributionSoft.php +++ b/api/v3/ContributionSoft.php @@ -95,7 +95,7 @@ function civicrm_api3_contribution_soft_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result + * @return array api result * {@getfields contribution_soft_get} * @access public */ diff --git a/api/v3/Country.php b/api/v3/Country.php index f7577e0695..f12d1062b6 100644 --- a/api/v3/Country.php +++ b/api/v3/Country.php @@ -91,7 +91,7 @@ function civicrm_api3_country_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result array + * @return array api result array * {@getfields country_get} * @access public */ diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index 489f49391f..b3a31c92a8 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -60,7 +60,7 @@ * Array Associative array of property name/value pairs to insert in group. * {@getfields CustomGroup_create} * - * @return Newly create custom_group object + * @return Newly create custom_group object * @todo $params['extends'] is array format - is that std compatible * @access public */ diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index d4573923d7..0b64196ae7 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -10,7 +10,7 @@ * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array details of found Option Values * {@getfields OptionValue_get} * @access public */ diff --git a/api/v3/Email.php b/api/v3/Email.php index f2770457d8..017c2a1d27 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -93,7 +93,7 @@ function civicrm_api3_email_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result array + * @return array api result array * {@getfields email_get} * @access public */ diff --git a/api/v3/Event.php b/api/v3/Event.php index 92af27f2ea..50be6b1756 100644 --- a/api/v3/Event.php +++ b/api/v3/Event.php @@ -104,7 +104,7 @@ function _civicrm_api3_event_create_legacy_support_42(&$params) { * An associative array of name/value property values of civicrm_event. * {@getfields event_get} * - * @return Array of all found event property values. + * @return Array of all found event property values. * @access public * */ diff --git a/api/v3/File.php b/api/v3/File.php index d77fb756d5..2640805abb 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -85,7 +85,7 @@ function civicrm_api3_file_create($params) { * @param array $params * An associative array of name/value property values of civicrm_file. * - * @return Array of all found file object property values. + * @return Array of all found file object property values. * @access public */ function civicrm_api3_file_get($params) { diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index 95a48a79ba..eca18fec88 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -49,7 +49,7 @@ * Name value pair of contact information. * {@getfields GroupContact_get} * - * @return array list of groups, given contact subsribed to + * @return array list of groups, given contact subsribed to */ function civicrm_api3_group_contact_get($params) { diff --git a/api/v3/GroupNesting.php b/api/v3/GroupNesting.php index 797cd03f02..d886f7aaac 100644 --- a/api/v3/GroupNesting.php +++ b/api/v3/GroupNesting.php @@ -44,7 +44,7 @@ * An array containing at least child_group_id or parent_group_id. * {@getfields GroupNesting_get} * - * @return array list of group nesting records + * @return array list of group nesting records */ function civicrm_api3_group_nesting_get($params) { diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php index e084b80072..8d8d2f70bb 100644 --- a/api/v3/GroupOrganization.php +++ b/api/v3/GroupOrganization.php @@ -49,7 +49,7 @@ * {@getfields GroupOrganization_get} * @example GroupOrganizationGet.php * - * @return array list of groups, given contact subsribed to + * @return array list of groups, given contact subsribed to */ function civicrm_api3_group_organization_get($params) { return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params); diff --git a/api/v3/Im.php b/api/v3/Im.php index faf8ae427a..9a426e84a0 100644 --- a/api/v3/Im.php +++ b/api/v3/Im.php @@ -82,7 +82,7 @@ function civicrm_api3_im_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found IM + * @return array details of found IM * * @access public */ diff --git a/api/v3/Job.php b/api/v3/Job.php index fff53bc31c..77d6225551 100644 --- a/api/v3/Job.php +++ b/api/v3/Job.php @@ -74,7 +74,7 @@ function civicrm_api3_job_create($params) { /** * Retrieve one or more job * @param array input parameters - * @return array api result array + * @return array api result array * {@getfields email_get} * @access public */ diff --git a/api/v3/LocationType.php b/api/v3/LocationType.php index 169eace77a..aaa1aaa445 100644 --- a/api/v3/LocationType.php +++ b/api/v3/LocationType.php @@ -96,7 +96,7 @@ function civicrm_api3_location_type_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result + * @return array api result * {@getfields LocationType_get} * @access public */ diff --git a/api/v3/Membership.php b/api/v3/Membership.php index 180e78d926..a3ea022217 100644 --- a/api/v3/Membership.php +++ b/api/v3/Membership.php @@ -187,7 +187,7 @@ function _civicrm_api3_membership_get_spec(&$params) { * options affecting the desired results; has legacy support * for just passing the contact_id itself as the argument * - * @return Array of all found membership property values. + * @return Array of all found membership property values. * @access public * @todo needs some love - basically only a get for a given contact right now * {@getfields membership_get} diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index 675773d644..11211289e7 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -61,7 +61,7 @@ function civicrm_api3_membership_status_create($params) { * @param array $params * An associative array of name/value property values of civicrm_membership_status. * - * @return Array of all found membership status property values. + * @return Array of all found membership status property values. * {@getfields MembershipStatus_get} * @access public */ diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php index 91dae25620..0287161634 100644 --- a/api/v3/MembershipType.php +++ b/api/v3/MembershipType.php @@ -87,7 +87,7 @@ function _civicrm_api3_membership_type_create_spec(&$params) { * An associative array of name/value property values of civicrm_membership_type. * {getfields MembershipType_get} * - * @return Array of all found membership type property values. + * @return Array of all found membership type property values. * @access public */ function civicrm_api3_membership_type_get($params) { diff --git a/api/v3/MessageTemplate.php b/api/v3/MessageTemplate.php index ed1716b219..40fa83095e 100644 --- a/api/v3/MessageTemplate.php +++ b/api/v3/MessageTemplate.php @@ -83,7 +83,7 @@ function _civicrm_api3_message_template_get_spec(&$params) { * @param array $params * An associative array of name/value pairs. * - * @return array api result array + * @return array api result array * {@getfields message_template_get} * @access public */ diff --git a/api/v3/OptionValue.php b/api/v3/OptionValue.php index 6da326132b..c3120527cb 100644 --- a/api/v3/OptionValue.php +++ b/api/v3/OptionValue.php @@ -8,7 +8,7 @@ * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array details of found Option Values * {@getfields OptionValue_get} * @access public */ diff --git a/api/v3/PaymentProcessor.php b/api/v3/PaymentProcessor.php index 36b5b6ec9c..46735e660b 100644 --- a/api/v3/PaymentProcessor.php +++ b/api/v3/PaymentProcessor.php @@ -83,7 +83,7 @@ function civicrm_api3_payment_processor_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found PaymentProcessor + * @return array details of found PaymentProcessor * @access public */ function civicrm_api3_payment_processor_get($params) { diff --git a/api/v3/Phone/Get.php b/api/v3/Phone/Get.php index f5d4af72a7..4db68b1cd1 100644 --- a/api/v3/Phone/Get.php +++ b/api/v3/Phone/Get.php @@ -10,7 +10,7 @@ * @param array $params * An associative array of name/value pairs. * - * @return array details of found phones else error + * @return array details of found phones else error * @access public * This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php . */ diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index 2f6b159ace..2556d65084 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -107,7 +107,7 @@ function civicrm_api3_relationship_delete($params) { * - if you pass in contact_id - it just returns all relationships for 'contact_id' * - if you don't pass in contact_id then it does a filter on the relationship table (DAO based search) * - * @return Array API Result Array + * @return Array API Result Array * {@getfields relationship_get} * @example RelationshipGet.php * @access public diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php index 845aa640ec..7aa12b5543 100644 --- a/api/v3/ReportInstance.php +++ b/api/v3/ReportInstance.php @@ -6,7 +6,7 @@ * @param array $params * Input parameters. * - * @return array details of found instances + * @return array details of found instances * @access public */ function civicrm_api3_report_instance_get($params) { diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index ac5b66239d..77f42a4b30 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -10,7 +10,7 @@ * {@example OptionValueGet.php 0} * @example OptionValueGet.php * - * @return array details of found Option Values + * @return array details of found Option Values * {@getfields OptionValue_get} * @access public */ @@ -87,7 +87,7 @@ function civicrm_api3_report_template_delete($params) { * @param array $params * Input parameters. * - * @return array details of found instances + * @return array details of found instances * @access public */ function civicrm_api3_report_template_getrows($params) { @@ -164,7 +164,7 @@ function civicrm_api3_report_template_getstatistics($params) { * @param array $params * Input parameters. * - * @return array details of found instances + * @return array details of found instances * @access public */ function _civicrm_api3_report_template_getrows_spec(&$params) { diff --git a/api/v3/Tag.php b/api/v3/Tag.php index 16029000e6..f6943046ab 100644 --- a/api/v3/Tag.php +++ b/api/v3/Tag.php @@ -90,7 +90,7 @@ function civicrm_api3_tag_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found tags else error + * @return array details of found tags else error * {@getfields tag_get} * @access public */ diff --git a/api/v3/Website.php b/api/v3/Website.php index 96af33cfbc..7c21329525 100644 --- a/api/v3/Website.php +++ b/api/v3/Website.php @@ -108,7 +108,7 @@ function civicrm_api3_website_delete($params) { * @param array $params * An associative array of name/value pairs. * - * @return array details of found websites + * @return array details of found websites * * @access public */ diff --git a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php index 7c80964e1c..ee1879b92c 100644 --- a/tests/phpunit/CiviTest/CiviSeleniumTestCase.php +++ b/tests/phpunit/CiviTest/CiviSeleniumTestCase.php @@ -727,7 +727,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * @strings array array of strings or a single string * * @param $strings - * @return void + * @return void */ public function assertStringsPresent($strings) { foreach ((array) $strings as $string) { @@ -741,7 +741,7 @@ class CiviSeleniumTestCase extends PHPUnit_Extensions_SeleniumTestCase { * @url string url to parse or retrieve current url if null * * @param null $url - * @return array returns an associative array containing any of the various components + * @return array returns an associative array containing any of the various components * of the URL that are present. Querystring elements are returned in sub-array (elements.queryString) * http://php.net/manual/en/function.parse-url.php */ -- 2.25.1