From c037736a2c41844e38ebefbc739824f436439e6c Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Mon, 31 Aug 2015 23:44:26 +1200 Subject: [PATCH] comment fixes --- CRM/Contact/BAO/Query.php | 158 +++++++----------- CRM/Contact/BAO/Query/Hook.php | 10 +- CRM/Contact/BAO/Query/Interface.php | 2 - CRM/Contact/BAO/RelationshipType.php | 2 - CRM/Contact/BAO/SavedSearch.php | 7 +- CRM/Contact/BAO/SearchCustom.php | 4 +- CRM/Contact/BAO/SubscriptionHistory.php | 12 +- CRM/Contact/Controller/Search.php | 5 +- CRM/Contact/Form/Contact.php | 17 +- CRM/Contact/Form/CustomData.php | 16 +- CRM/Contact/Form/DedupeFind.php | 10 +- CRM/Contact/Form/DedupeRules.php | 12 +- CRM/Contact/Form/Domain.php | 11 +- CRM/Contact/Form/Edit/Address.php | 20 +-- .../Form/Edit/CommunicationPreferences.php | 25 +-- CRM/Contact/Form/Edit/CustomData.php | 12 +- CRM/Contact/Form/Edit/Demographics.php | 10 +- CRM/Contact/Form/Edit/Email.php | 6 +- CRM/Contact/Form/Edit/Household.php | 11 +- CRM/Contact/Form/Edit/IM.php | 6 +- 20 files changed, 104 insertions(+), 252 deletions(-) diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 30bcb57642..b76df23b01 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -923,10 +923,7 @@ class CRM_Contact_BAO_Query { } /** - * If the return Properties are set in a hierarchy, traverse the hierarchy to get - * the return values - * - * @return void + * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values. */ public function addHierarchicalElements() { if (empty($this->_returnProperties['location'])) { @@ -1257,10 +1254,7 @@ class CRM_Contact_BAO_Query { } /** - * If the return Properties are set in a hierarchy, traverse the hierarchy to get - * the return values - * - * @return void + * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values. */ public function addMultipleElements() { if (empty($this->_returnProperties['website'])) { @@ -1407,12 +1401,14 @@ class CRM_Contact_BAO_Query { } /** + * Get where values from the parameters. + * * @param string $name - * @param $grouping + * @param mixed $grouping * - * @return null + * @return mixed */ - public function &getWhereValues($name, $grouping) { + public function getWhereValues($name, $grouping) { $result = NULL; foreach ($this->_params as $values) { if ($values[0] == $name && $values[3] == $grouping) { @@ -1424,9 +1420,11 @@ class CRM_Contact_BAO_Query { } /** - * @param $relative - * @param $from - * @param $to + * Fix date values. + * + * @param bool $relative + * @param string $from + * @param string $to */ public static function fixDateValues($relative, &$from, &$to) { if ($relative) { @@ -1435,7 +1433,9 @@ class CRM_Contact_BAO_Query { } /** - * @param $formValues + * Convert form values to array for this object. + * + * @param array $formValues * @param int $wildcard * @param bool $useEquals * @@ -1506,8 +1506,10 @@ class CRM_Contact_BAO_Query { } /** + * Fix values from query from/to something no-one cared enough to document. + * * @param int $id - * @param $values + * @param array $values * @param int $wildcard * @param bool $useEquals * @@ -1515,7 +1517,7 @@ class CRM_Contact_BAO_Query { * * @return array|null */ - public static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) { + public static function fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) { // skip a few search variables static $skipWhere = NULL; static $likeNames = NULL; @@ -1614,7 +1616,9 @@ class CRM_Contact_BAO_Query { } /** - * @param $values + * Get the where clause for a single field. + * + * @param array $values */ public function whereClauseSingle(&$values) { // do not process custom fields or prefixed contact ids or component params @@ -1856,8 +1860,7 @@ class CRM_Contact_BAO_Query { } /** - * Given a list of conditions in params generate the required. - * where clause + * Given a list of conditions in params generate the required where clause. * * @return string */ @@ -1886,7 +1889,7 @@ class CRM_Contact_BAO_Query { } if ($this->_customQuery) { - // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info. + // Added following if condition to avoid the wrong value display for 'my account' / any UF info. // Hope it wont affect the other part of civicrm.. if it does please remove it. if (!empty($this->_customQuery->_where)) { $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where); @@ -1923,7 +1926,9 @@ class CRM_Contact_BAO_Query { } /** - * @param $values + * Generate where clause for any parameters not already handled. + * + * @param array $values * * @throws Exception */ @@ -2651,9 +2656,7 @@ class CRM_Contact_BAO_Query { /** * WHERE / QILL clause for deleted_contacts * - * @param $values - * - * @return void + * @param array $values */ public function deletedContacts($values) { list($_, $_, $value, $grouping, $_) = $values; @@ -2667,8 +2670,6 @@ class CRM_Contact_BAO_Query { * Where / qill clause for contact_type * * @param $values - * - * @return void */ public function contactType(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -2734,8 +2735,6 @@ class CRM_Contact_BAO_Query { * Where / qill clause for contact_sub_type * * @param $values - * - * @return void */ public function contactSubType(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -2781,8 +2780,6 @@ class CRM_Contact_BAO_Query { * Where / qill clause for groups * * @param $values - * - * @return void */ public function group(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -2944,8 +2941,6 @@ WHERE $smartGroupClause * Where / qill clause for cms users * * @param $values - * - * @return void */ public function ufUser(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -2966,9 +2961,7 @@ WHERE $smartGroupClause /** * All tag search specific. * - * @param $values - * - * @return void + * @param array $values */ public function tagSearch(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3030,9 +3023,7 @@ WHERE $smartGroupClause /** * Where / qill clause for tag * - * @param $values - * - * @return void + * @param array $values */ public function tag(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3112,9 +3103,7 @@ WHERE $smartGroupClause /** * Where/qill clause for notes * - * @param $values - * - * @return void + * @param array $values */ public function notes(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3188,9 +3177,7 @@ WHERE $smartGroupClause /** * Where / qill clause for sort_name * - * @param $values - * - * @return void + * @param array $values */ public function sortName(&$values) { list($fieldName, $op, $value, $grouping, $wildcard) = $values; @@ -3287,9 +3274,7 @@ WHERE $smartGroupClause /** * Where / qill clause for email * - * @param $values - * - * @return void + * @param array $values */ public function email(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3329,9 +3314,7 @@ WHERE $smartGroupClause /** * Where / qill clause for phone number * - * @param $values - * - * @return void + * @param array $values */ public function phone_numeric(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3351,9 +3334,7 @@ WHERE $smartGroupClause /** * Where / qill clause for phone type/location * - * @param $values - * - * @return void + * @param array $values */ public function phone_option_group($values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3366,11 +3347,9 @@ WHERE $smartGroupClause } /** - * Where / qill clause for street_address + * Where / qill clause for street_address. * - * @param $values - * - * @return void + * @param array $values */ public function street_address(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3400,11 +3379,9 @@ WHERE $smartGroupClause } /** - * Where / qill clause for street_unit - * - * @param $values + * Where / qill clause for street_unit. * - * @return void + * @param array $values */ public function street_number(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3434,11 +3411,9 @@ WHERE $smartGroupClause } /** - * Where / qill clause for sorting by character - * - * @param $values + * Where / qill clause for sorting by character. * - * @return void + * @param array $values */ public function sortByCharacter(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3450,9 +3425,7 @@ WHERE $smartGroupClause } /** - * Where / qill clause for including contact ids - * - * @return void + * Where / qill clause for including contact ids. */ public function includeContactIDs() { if (!$this->_includeContactIds || empty($this->_params)) { @@ -3471,11 +3444,9 @@ WHERE $smartGroupClause } /** - * Where / qill clause for postal code - * - * @param $values + * Where / qill clause for postal code. * - * @return void + * @param array $values */ public function postalCode(&$values) { // skip if the fields dont have anything to do with postal_code @@ -3519,12 +3490,12 @@ WHERE $smartGroupClause } /** - * Where / qill clause for location type + * Where / qill clause for location type. * - * @param $values + * @param array $values * @param null $status * - * @return void + * @return string */ public function locationType(&$values, $status = NULL) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3638,12 +3609,12 @@ WHERE $smartGroupClause } /** - * Where / qill clause for county (if present) + * Where / qill clause for county (if present). * - * @param $values + * @param array $values * @param null $status * - * @return void + * @return string */ public function county(&$values, $status = NULL) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3707,12 +3678,12 @@ WHERE $smartGroupClause } /** - * Where / qill clause for state/province AND country (if present) + * Where / qill clause for state/province AND country (if present). * - * @param $values + * @param array $values * @param null $status * - * @return void + * @return string */ public function stateProvince(&$values, $status = NULL) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3801,11 +3772,9 @@ WHERE $smartGroupClause } /** - * Where / qill clause for change log - * - * @param $values + * Where / qill clause for change log. * - * @return void + * @param array $values */ public function changeLog(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -3985,11 +3954,9 @@ WHERE $smartGroupClause } /** - * Where / qill clause for relationship - * - * @param $values + * Where / qill clause for relationship. * - * @return void + * @param array $values */ public function relationship(&$values) { list($name, $op, $value, $grouping, $wildcard) = $values; @@ -4949,11 +4916,13 @@ SELECT COUNT( conts.total_amount ) as cancel_count, } /** - * @param $values + * Build query for a date field. + * + * @param array $values * @param string $tableName * @param string $fieldName * @param string $dbFieldName - * @param $fieldTitle + * @param string $fieldTitle * @param bool $appendTimeStamp */ public function dateQueryBuilder( @@ -5499,7 +5468,7 @@ AND displayRelType.is_active = 1 } /** - * Builds the necessary structures for all fields that are similar to option value lookups. + * Builds the necessary structures for all fields that are similar to option value look-ups. * * @param string $name * the name of the field. @@ -5518,9 +5487,6 @@ AND displayRelType.is_active = 1 * @param string $dataType * The data type for this element. * @param bool $useIDsOnly - * - * @return void - * adds the where clause and qill to the query object */ public function optionValueQuery( $name, diff --git a/CRM/Contact/BAO/Query/Hook.php b/CRM/Contact/BAO/Query/Hook.php index b4a96ac073..f40a79b6f6 100644 --- a/CRM/Contact/BAO/Query/Hook.php +++ b/CRM/Contact/BAO/Query/Hook.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Delegate query functions based on hook system + * Delegate query functions based on hook system. */ class CRM_Contact_BAO_Query_Hook { @@ -57,7 +55,7 @@ class CRM_Contact_BAO_Query_Hook { } /** - * Get or build the list of search objects (via hook) + * Get or build the list of search objects (via hook). * * @return array * Array of CRM_Contact_BAO_Query_Interface objects @@ -93,7 +91,9 @@ class CRM_Contact_BAO_Query_Hook { } /** - * @param $query + * Alter search query. + * + * @param string $query * @param string $fnName */ public function alterSearchQuery(&$query, $fnName) { diff --git a/CRM/Contact/BAO/Query/Interface.php b/CRM/Contact/BAO/Query/Interface.php index 1fcf41eb49..f3c9c41fdb 100644 --- a/CRM/Contact/BAO/Query/Interface.php +++ b/CRM/Contact/BAO/Query/Interface.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index 585d60b5d4..703b0807bf 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType { diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index 657a27082d..b89446ee24 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Business object for Saved searches - * + * Business object for Saved searches. */ class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch { /** * Class constructor. - * - * @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch */ public function __construct() { parent::__construct(); diff --git a/CRM/Contact/BAO/SearchCustom.php b/CRM/Contact/BAO/SearchCustom.php index 6a39381a4e..203a170d2b 100644 --- a/CRM/Contact/BAO/SearchCustom.php +++ b/CRM/Contact/BAO/SearchCustom.php @@ -29,12 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_BAO_SearchCustom { /** + * Get details. + * * @param int $csID * @param int $ssID * @param int $gID diff --git a/CRM/Contact/BAO/SubscriptionHistory.php b/CRM/Contact/BAO/SubscriptionHistory.php index 146acb31ea..7ea942ffe4 100644 --- a/CRM/Contact/BAO/SubscriptionHistory.php +++ b/CRM/Contact/BAO/SubscriptionHistory.php @@ -29,20 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * BAO object for crm_email table + * BAO object for crm_email table. */ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory { /** * Class constructor. - * - * @return \CRM_Contact_DAO_SubscriptionHistory - */ - /** */ public function __construct() { parent::__construct(); @@ -66,12 +60,10 @@ class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHi } /** - * Erase a contact's subscription history records + * Erase a contact's subscription history records. * * @param int $id * The contact id. - * - * @return void */ public static function deleteContact($id) { $history = new CRM_Contact_BAO_SubscriptionHistory(); diff --git a/CRM/Contact/Controller/Search.php b/CRM/Contact/Controller/Search.php index 47bb988abd..e066f45133 100644 --- a/CRM/Contact/Controller/Search.php +++ b/CRM/Contact/Controller/Search.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,8 +39,7 @@ * * Typically the first form will display the search criteria and it's results * - * The second form is used to process search results with the asscociated actions - * + * The second form is used to process search results with the associated actions. */ class CRM_Contact_Controller_Search extends CRM_Core_Controller { diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 2283c49779..be31f190e3 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -143,8 +141,6 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add'); @@ -404,15 +400,12 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * - * @return void + * Note that in edit/view mode the default values are retrieved from the database */ public function setDefaultValues() { $defaults = $this->_values; - $params = array(); if ($this->_action & CRM_Core_Action::ADD) { if (array_key_exists('TagsAndGroups', $this->_editOptions)) { @@ -572,7 +565,6 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * add the rules (mainly global rules) for form. * All local rules are added near the element * - * @return void * @see valid_date */ public function addRules() { @@ -738,8 +730,6 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //load form for child blocks @@ -866,9 +856,6 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Form submission of new/edit contact is processed. - * - * - * @return void */ public function postProcess() { // check if dedupe button, if so return. diff --git a/CRM/Contact/Form/CustomData.php b/CRM/Contact/Form/CustomData.php index b8f8d516bf..1ab2cb1785 100644 --- a/CRM/Contact/Form/CustomData.php +++ b/CRM/Contact/Form/CustomData.php @@ -29,17 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for custom data + * This class generates form components for custom data. * * It delegates the work to lower level subclasses and integrates the changes * back in. It also uses a lot of functionality with the CRM API's, so any change * made here could potentially affect the API etc. Be careful, be aware, use unit tests. - * */ class CRM_Contact_Form_CustomData extends CRM_Core_Form { @@ -106,11 +103,7 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { /** * Pre processing work done here. * - * gets session variables for table name, id of entity in table, type of entity and stores them. - * - * @param - * - * @return void + * Gets session variables for table name, id of entity in table, type of entity and stores them. */ public function preProcess() { $this->_cdType = CRM_Utils_Array::value('type', $_GET); @@ -172,8 +165,6 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { if ($this->_cdType || $this->_multiRecordDisplay == 'single') { @@ -288,9 +279,6 @@ class CRM_Contact_Form_CustomData extends CRM_Core_Form { /** * Process the user submitted custom data values. - * - * - * @return void */ public function postProcess() { // Get the form values and groupTree diff --git a/CRM/Contact/Form/DedupeFind.php b/CRM/Contact/Form/DedupeFind.php index c1c3966d6f..a3c7a268ac 100644 --- a/CRM/Contact/Form/DedupeFind.php +++ b/CRM/Contact/Form/DedupeFind.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for DedupeRules - * + * This class generates form components for DedupeRules. */ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { @@ -48,8 +45,6 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -79,9 +74,6 @@ class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $values = $this->exportValues(); diff --git a/CRM/Contact/Form/DedupeRules.php b/CRM/Contact/Form/DedupeRules.php index 5f85f8c52a..9902739e1f 100644 --- a/CRM/Contact/Form/DedupeRules.php +++ b/CRM/Contact/Form/DedupeRules.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for DedupeRules - * + * This class generates form components for DedupeRules. */ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { const RULES_COUNT = 5; @@ -52,8 +49,6 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { /** * Pre processing. - * - * @return void */ public function preProcess() { // Ensure user has permission to be here @@ -101,8 +96,6 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addField('title', array('label' => ts('Rule Name')), TRUE); @@ -190,9 +183,6 @@ class CRM_Contact_Form_DedupeRules extends CRM_Admin_Form { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $values = $this->exportValues(); diff --git a/CRM/Contact/Form/Domain.php b/CRM/Contact/Form/Domain.php index 7f007118af..c44dcfede8 100644 --- a/CRM/Contact/Form/Domain.php +++ b/CRM/Contact/Form/Domain.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is to build the form for adding Group + * This class is to build the form for adding Group. */ class CRM_Contact_Form_Domain extends CRM_Core_Form { @@ -154,8 +152,6 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->addField('name', array('label' => ts('Organization Name')), TRUE); @@ -188,9 +184,6 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Contact_Form_Domain', 'formRule')); @@ -233,8 +226,6 @@ class CRM_Contact_Form_Domain extends CRM_Core_Form { /** * Process the form when submitted. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Edit/Address.php b/CRM/Contact/Form/Edit/Address.php index 05037eb0a4..efb187b519 100644 --- a/CRM/Contact/Form/Edit/Address.php +++ b/CRM/Contact/Form/Edit/Address.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is used to build address block + * This class is used to build address block. */ class CRM_Contact_Form_Edit_Address { @@ -48,9 +46,6 @@ class CRM_Contact_Form_Edit_Address { * False, if we want to skip the address sharing features. * @param bool $inlineEdit * True when edit used in inline edit. - * - * @return void - * */ public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharing = TRUE, $inlineEdit = FALSE) { // passing this via the session is AWFUL. we need to fix this @@ -241,13 +236,12 @@ class CRM_Contact_Form_Edit_Address { /** * Check for correct state / country mapping. * - * @param $fields - * @param $files - * @param $self + * @param array $fields + * @param array $files + * @param CRM_Core_Form $self * * @return array|bool * if no errors - * */ public static function formRule($fields, $files, $self) { $errors = array(); @@ -303,7 +297,6 @@ class CRM_Contact_Form_Edit_Address { * Defaults associated array. * @param CRM_Core_Form $form * Form object. - * */ public static function setDefaultValues(&$defaults, &$form) { $addressValues = array(); @@ -407,10 +400,11 @@ class CRM_Contact_Form_Edit_Address { } } - /** + * Store required custom data info. + * * @param CRM_Core_Form $form - * @param $groupTree + * @param array $groupTree */ public static function storeRequiredCustomDataInfo(&$form, $groupTree) { if (CRM_Utils_System::getClassName($form) == 'CRM_Contact_Form_Contact') { diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index 6ffcba0b76..d3e65e6b37 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -29,17 +29,16 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Communication Preferences object + * Form helper class for an Communication Preferences object. */ class CRM_Contact_Form_Edit_CommunicationPreferences { /** - * Greetings + * Greetings. + * * @var array */ static $greetings = array(); @@ -49,8 +48,6 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { * * @param CRM_Core_Form $form * Reference to the form object. - * - * @return void */ public static function buildQuickForm(&$form) { // since the pcm - preferred communication method is logically @@ -124,7 +121,7 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { * The input form values. * @param array $files * The uploaded files if any. - * @param $self + * @param CRM_Contact_Form_Edit_CommunicationPreferences $self * * @return bool|array * true if no errors, else array of errors @@ -145,14 +142,10 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { } /** - * Set default values for the form. Note that in edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * * @param CRM_Core_Form $form - * @param $defaults - * - * @return void + * @param array $defaults */ public static function setDefaultValues(&$form, &$defaults) { @@ -191,11 +184,9 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { } /** - * set array of greeting fields. - * - * @param $contactType + * Set array of greeting fields. * - * @return void + * @param string $contactType */ public static function getGreetingFields($contactType) { if (empty(self::$greetings[$contactType])) { diff --git a/CRM/Contact/Form/Edit/CustomData.php b/CRM/Contact/Form/Edit/CustomData.php index 29ce53225c..d6b0309458 100644 --- a/CRM/Contact/Form/Edit/CustomData.php +++ b/CRM/Contact/Form/Edit/CustomData.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Demographics object + *Form helper class for an Demographics object. */ class CRM_Contact_Form_Edit_CustomData { @@ -42,8 +40,6 @@ class CRM_Contact_Form_Edit_CustomData { * Build all the data structures needed to build the form. * * @param CRM_Core_Form $form - * - * @return void */ public static function preProcess(&$form) { $form->_type = CRM_Utils_Request::retrieve('type', 'String', CRM_Core_DAO::$_nullObject); @@ -70,8 +66,6 @@ class CRM_Contact_Form_Edit_CustomData { * * @param CRM_Core_Form $form * Reference to the form object. - * - * @return void */ public static function buildQuickForm(&$form) { if (!empty($form->_submitValues)) { @@ -105,9 +99,7 @@ class CRM_Contact_Form_Edit_CustomData { * * * @param CRM_Core_Form $form - * @param $defaults - * - * @return void + * @param array $defaults */ public static function setDefaultValues(&$form, &$defaults) { $defaults += CRM_Custom_Form_CustomData::setDefaultValues($form); diff --git a/CRM/Contact/Form/Edit/Demographics.php b/CRM/Contact/Form/Edit/Demographics.php index 7f2188a72f..144ba4ea0f 100644 --- a/CRM/Contact/Form/Edit/Demographics.php +++ b/CRM/Contact/Form/Edit/Demographics.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Demographics object + * Form helper class for an Demographics object. */ class CRM_Contact_Form_Edit_Demographics { @@ -43,8 +41,6 @@ class CRM_Contact_Form_Edit_Demographics { * * @param CRM_Core_Form $form * Reference to the form object. - * - * @return void */ public static function buildQuickForm(&$form) { $form->addField('gender_id', array('entity' => 'contact', 'type' => 'Radio', 'allowClear' => TRUE)); @@ -61,9 +57,7 @@ class CRM_Contact_Form_Edit_Demographics { * * * @param CRM_Core_Form $form - * @param $defaults - * - * @return void + * @param array $defaults */ public static function setDefaultValues(&$form, &$defaults) { } diff --git a/CRM/Contact/Form/Edit/Email.php b/CRM/Contact/Form/Edit/Email.php index 589d831c74..b5987b2d0b 100644 --- a/CRM/Contact/Form/Edit/Email.php +++ b/CRM/Contact/Form/Edit/Email.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Email object + * Form helper class for an Email object. */ class CRM_Contact_Form_Edit_Email { @@ -47,8 +45,6 @@ class CRM_Contact_Form_Edit_Email { * Block number to build. * @param bool $blockEdit * Is it block edit. - * - * @return void */ public static function buildQuickForm(&$form, $blockCount = NULL, $blockEdit = FALSE) { // passing this via the session is AWFUL. we need to fix this diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 6959c45bd8..74e165228e 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -29,28 +29,23 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Auxiliary class to provide support to the Contact Form class. Does this by implementing - * a small set of static methods + * Auxiliary class to provide support to the Contact Form class. * + * Does this by implementing a small set of static methods. */ class CRM_Contact_Form_Edit_Household { /** - * This function provides the HTML form elements that are specific. - * to the Household Contact Type + * 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. * top bar form and 2 for display name edit ) - * - * @return void */ public static function buildQuickForm(&$form, $inlineEditMode = NULL) { $form->applyFilter('__ALL__', 'trim'); diff --git a/CRM/Contact/Form/Edit/IM.php b/CRM/Contact/Form/Edit/IM.php index 6298b6319f..a801773716 100644 --- a/CRM/Contact/Form/Edit/IM.php +++ b/CRM/Contact/Form/Edit/IM.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an IM object + * Form helper class for an IM object. */ class CRM_Contact_Form_Edit_IM { @@ -47,8 +45,6 @@ class CRM_Contact_Form_Edit_IM { * Block number to build. * @param bool $blockEdit * Is it block edit. - * - * @return void */ public static function buildQuickForm(&$form, $blockCount = NULL, $blockEdit = FALSE) { if (!$blockCount) { -- 2.25.1