From 5a409b503d3d12e55c4734e88d046971e640f3bd Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Tue, 1 Sep 2015 00:04:52 +1200 Subject: [PATCH] more comment fixes --- CRM/Contact/Form/Edit/Individual.php | 11 ++----- CRM/Contact/Form/Edit/Lock.php | 9 ++---- CRM/Contact/Form/Edit/Notes.php | 7 ++--- CRM/Contact/Form/Edit/OpenID.php | 6 +--- CRM/Contact/Form/Edit/Organization.php | 11 ++----- CRM/Contact/Form/Edit/Phone.php | 3 +- CRM/Contact/Form/Edit/Website.php | 6 +--- CRM/Contact/Form/GroupContact.php | 13 ++++----- CRM/Contact/Form/Inline.php | 13 ++------- CRM/Contact/Form/Inline/Address.php | 12 +++----- .../Form/Inline/CommunicationPreferences.php | 8 +---- CRM/Contact/Form/Inline/ContactInfo.php | 8 +---- CRM/Contact/Form/Inline/ContactName.php | 8 +---- CRM/Contact/Form/Inline/CustomData.php | 8 +---- CRM/Contact/Form/Inline/Demographics.php | 8 +---- CRM/Contact/Form/Inline/Email.php | 8 +---- CRM/Contact/Form/Inline/IM.php | 8 +---- CRM/Contact/Form/Inline/Lock.php | 11 ++----- CRM/Contact/Form/Inline/OpenID.php | 8 +---- CRM/Contact/Form/Inline/Phone.php | 8 +---- CRM/Contact/Form/Inline/Website.php | 8 +---- CRM/Contact/Form/Location.php | 6 ---- CRM/Contact/Form/Merge.php | 6 +--- CRM/Contact/Form/ProfileContact.php | 4 --- CRM/Contact/Form/RelatedContact.php | 1 - CRM/Contact/Form/Search.php | 12 -------- CRM/Contact/Form/Search/Advanced.php | 29 ++++--------------- CRM/Contact/Form/Search/Basic.php | 26 +++-------------- CRM/Contact/Form/Search/Builder.php | 17 +++-------- CRM/Contact/Form/Search/Criteria.php | 13 ++------- CRM/Contact/Form/Search/Custom.php | 15 ++-------- .../Form/Search/Custom/ActivitySearch.php | 9 ++---- CRM/Contact/Form/Search/Custom/Base.php | 6 ++-- CRM/Contact/Form/Search/Custom/Basic.php | 16 ++++------ .../Form/Search/Custom/ContribSYBNT.php | 4 +-- .../Search/Custom/ContributionAggregate.php | 8 +++-- CRM/Contact/Form/Search/Custom/DateAdded.php | 6 ++-- .../Form/Search/Custom/EventAggregate.php | 6 ++-- CRM/Contact/Form/Search/Custom/FullText.php | 6 ++-- .../Custom/FullText/AbstractPartialQuery.php | 2 -- .../Form/Search/Custom/FullText/Activity.php | 3 +- .../Form/Search/Custom/FullText/Case.php | 2 -- .../Form/Search/Custom/FullText/Contact.php | 4 +-- .../Search/Custom/FullText/Contribution.php | 4 +-- .../Search/Custom/FullText/Membership.php | 5 ++-- .../Search/Custom/FullText/Participant.php | 5 ++-- CRM/Contact/Form/Search/Custom/Group.php | 18 +++++++++--- .../Form/Search/Custom/MultipleValues.php | 6 ++-- .../Form/Search/Custom/PostalMailing.php | 6 ++-- CRM/Contact/Form/Search/Custom/PriceSet.php | 6 ++-- CRM/Contact/Form/Search/Custom/Proximity.php | 6 ++-- .../Form/Search/Custom/RandomSegment.php | 6 ++-- CRM/Contact/Form/Search/Custom/Sample.php | 8 +++-- .../Form/Search/Custom/TagContributions.php | 6 ++-- .../Form/Search/Custom/ZipCodeRange.php | 6 ++-- CRM/Contact/Form/Search/Interface.php | 2 -- CRM/Contact/Form/Task.php | 3 +- CRM/Contact/Form/Task/AddToGroup.php | 18 ++---------- CRM/Contact/Form/Task/AddToOrganization.php | 4 +-- CRM/Contact/Form/Task/AddToTag.php | 16 ++++------ CRM/Contact/Form/Task/AlterPreferences.php | 8 ----- CRM/Contact/Form/Task/Batch.php | 13 ++------- CRM/Contact/Form/Task/Delete.php | 16 ++-------- 63 files changed, 150 insertions(+), 395 deletions(-) diff --git a/CRM/Contact/Form/Edit/Individual.php b/CRM/Contact/Form/Edit/Individual.php index 4e7925f42d..9db0633cb5 100644 --- a/CRM/Contact/Form/Edit/Individual.php +++ b/CRM/Contact/Form/Edit/Individual.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_Individual { /** - * This function provides the HTML form elements that are specific - * to the Individual Contact Type + * This function provides the HTML form elements that are specific to the Individual Contact Type. * * @param CRM_Core_Form $form * Form object. * @param int $inlineEditMode * ( 1 for contact summary. * 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/Lock.php b/CRM/Contact/Form/Edit/Lock.php index 9768e68c3e..6ee89261e2 100644 --- a/CRM/Contact/Form/Edit/Lock.php +++ b/CRM/Contact/Form/Edit/Lock.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Auxiliary class to provide support for locking (and ignoring locks on) - * contact records. + * Auxiliary class to provide support for locking (and ignoring locks on) contact records. */ class CRM_Contact_Form_Edit_Lock { @@ -44,15 +41,13 @@ class CRM_Contact_Form_Edit_Lock { * * @param CRM_Core_Form $form * Form object. - * - * @return void */ public static function buildQuickForm(&$form) { $form->addField('modified_date', array('type' => 'hidden', 'id' => 'modified_date', 'label' => '')); } /** - * Ensure that modified_date hasn't changed in the underlying DB + * Ensure that modified_date has not changed in the underlying DB. * * @param array $fields * The input form values. diff --git a/CRM/Contact/Form/Edit/Notes.php b/CRM/Contact/Form/Edit/Notes.php index 775a4397e3..409ed0dbea 100644 --- a/CRM/Contact/Form/Edit/Notes.php +++ b/CRM/Contact/Form/Edit/Notes.php @@ -29,16 +29,13 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Edit_Notes { /** - * build form elements. - * params object $form object of the form + * Build form elements. * - * @param $form + * @param CRM_Core_Form $form */ public static function buildQuickForm(&$form) { $form->applyFilter('__ALL__', 'trim'); diff --git a/CRM/Contact/Form/Edit/OpenID.php b/CRM/Contact/Form/Edit/OpenID.php index fead77b58f..b73f38c85b 100644 --- a/CRM/Contact/Form/Edit/OpenID.php +++ b/CRM/Contact/Form/Edit/OpenID.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an OpenID object + * Form helper class for an OpenID object. */ class CRM_Contact_Form_Edit_OpenID { @@ -47,8 +45,6 @@ class CRM_Contact_Form_Edit_OpenID { * Block number to build. * @param bool $blockEdit * Is it block edit. - * - * @return void */ public static function buildQuickForm(&$form, $blockCount = NULL, $blockEdit = FALSE) { if (!$blockCount) { diff --git a/CRM/Contact/Form/Edit/Organization.php b/CRM/Contact/Form/Edit/Organization.php index fcf3bf7ab6..5c7bd3c973 100644 --- a/CRM/Contact/Form/Edit/Organization.php +++ b/CRM/Contact/Form/Edit/Organization.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_Organization { /** - * This function provides the HTML form elements that are specific - * to the Organization Contact Type + * This function provides the HTML form elements that are specific to the Organization Contact Type. * * @param CRM_Core_Form $form * Form object. * @param int $inlineEditMode * ( 1 for contact summary. * 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/Phone.php b/CRM/Contact/Form/Edit/Phone.php index b465832b1e..a081122ecd 100644 --- a/CRM/Contact/Form/Edit/Phone.php +++ b/CRM/Contact/Form/Edit/Phone.php @@ -29,11 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** - * form helper class for a phone object + * Form helper class for a phone object. */ class CRM_Contact_Form_Edit_Phone { diff --git a/CRM/Contact/Form/Edit/Website.php b/CRM/Contact/Form/Edit/Website.php index 8ff02a18a2..576ca7d2c7 100644 --- a/CRM/Contact/Form/Edit/Website.php +++ b/CRM/Contact/Form/Edit/Website.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Website object + * Form helper class for an Website object. */ class CRM_Contact_Form_Edit_Website { @@ -45,8 +43,6 @@ class CRM_Contact_Form_Edit_Website { * Reference to the form object. * @param int $blockCount * Block number to build. - * - * @return void */ public static function buildQuickForm(&$form, $blockCount = NULL) { if (!$blockCount) { diff --git a/CRM/Contact/Form/GroupContact.php b/CRM/Contact/Form/GroupContact.php index c55fc4994d..64e83e772c 100644 --- a/CRM/Contact/Form/GroupContact.php +++ b/CRM/Contact/Form/GroupContact.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for groupContact - * + * This class generates form components for groupContact. */ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { @@ -67,6 +64,9 @@ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { return 'create'; } + /** + * Pre process form. + */ public function preProcess() { $this->_contactId = $this->get('contactId'); $this->_groupContactId = $this->get('groupContactId'); @@ -75,8 +75,6 @@ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { // get the list of all the groups @@ -129,8 +127,7 @@ class CRM_Contact_Form_GroupContact extends CRM_Core_Form { } /** - * - * @return void + * Post process form. */ public function postProcess() { $contactID = array($this->_contactId); diff --git a/CRM/Contact/Form/Inline.php b/CRM/Contact/Form/Inline.php index 4aa5b2db01..bc5add2d28 100644 --- a/CRM/Contact/Form/Inline.php +++ b/CRM/Contact/Form/Inline.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Parent class for inline contact forms + * Parent class for inline contact forms. */ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { @@ -94,8 +92,6 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { /** * Common form elements. - * - * @return void */ public function buildQuickForm() { CRM_Contact_Form_Inline_Lock::buildQuickForm($this, $this->_contactId); @@ -116,8 +112,6 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { /** * Override default cancel action. - * - * @return void */ public function cancelAction() { $response = array('status' => 'cancel'); @@ -140,8 +134,6 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { /** * Add entry to log table. - * - * @return void */ protected function log() { CRM_Core_BAO_Log::register($this->_contactId, @@ -152,9 +144,8 @@ abstract class CRM_Contact_Form_Inline extends CRM_Core_Form { /** * Common function for all inline contact edit forms. - * Prepares ajaxResponse * - * @return void + * Prepares ajaxResponse */ protected function response() { $this->ajaxResponse = array_merge( diff --git a/CRM/Contact/Form/Inline/Address.php b/CRM/Contact/Form/Inline/Address.php index cd4a693377..c6abfbfe47 100644 --- a/CRM/Contact/Form/Inline/Address.php +++ b/CRM/Contact/Form/Inline/Address.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for address section + * Form helper class for address section. */ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { @@ -64,9 +62,11 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { public $_addressId; /** + * Class constructor. + * * Since we are using same class / code to generate multiple instances * of address block, we need to generate unique form name for each, - * hence calling parent contructor + * hence calling parent constructor */ public function __construct() { $locBlockNo = CRM_Utils_Request::retrieve('locno', 'Positive', CRM_Core_DAO::$_nullObject, TRUE, NULL, $_REQUEST); @@ -121,8 +121,6 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { /** * Build the form object elements for an address object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -160,8 +158,6 @@ class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/CommunicationPreferences.php b/CRM/Contact/Form/Inline/CommunicationPreferences.php index e7fded5ce6..fe5bc1a13d 100644 --- a/CRM/Contact/Form/Inline/CommunicationPreferences.php +++ b/CRM/Contact/Form/Inline/CommunicationPreferences.php @@ -29,19 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for communication preferences inline edit section + * Form helper class for communication preferences inline edit section. */ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_Inline { /** * Build the form object elements for communication preferences. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -81,8 +77,6 @@ class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_ /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/ContactInfo.php b/CRM/Contact/Form/Inline/ContactInfo.php index 246b66ce20..9ed6b74597 100644 --- a/CRM/Contact/Form/Inline/ContactInfo.php +++ b/CRM/Contact/Form/Inline/ContactInfo.php @@ -29,19 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for contact info section + * Form helper class for contact info section. */ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { /** * Build the form object elements. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -62,8 +58,6 @@ class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/ContactName.php b/CRM/Contact/Form/Inline/ContactName.php index 484eb98f5c..00b5c9bd75 100644 --- a/CRM/Contact/Form/Inline/ContactName.php +++ b/CRM/Contact/Form/Inline/ContactName.php @@ -29,19 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for contact name section + * Form helper class for contact name section. */ class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline { /** * Build the form object elements. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -78,8 +74,6 @@ class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/CustomData.php b/CRM/Contact/Form/Inline/CustomData.php index 11f6c4661b..18e6dc1c7c 100644 --- a/CRM/Contact/Form/Inline/CustomData.php +++ b/CRM/Contact/Form/Inline/CustomData.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for custom data section + * Form helper class for custom data section. */ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { @@ -69,8 +67,6 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { /** * Build the form object elements for custom data. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -88,8 +84,6 @@ class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { // Process / save custom data diff --git a/CRM/Contact/Form/Inline/Demographics.php b/CRM/Contact/Form/Inline/Demographics.php index 15aacae95e..9be0cc7166 100644 --- a/CRM/Contact/Form/Inline/Demographics.php +++ b/CRM/Contact/Form/Inline/Demographics.php @@ -29,19 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for demographics section + * Form helper class for demographics section. */ class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline { /** * Build the form object elements. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -50,8 +46,6 @@ class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/Email.php b/CRM/Contact/Form/Inline/Email.php index 4385946184..8f4ddfabe4 100644 --- a/CRM/Contact/Form/Inline/Email.php +++ b/CRM/Contact/Form/Inline/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_Inline_Email extends CRM_Contact_Form_Inline { @@ -79,8 +77,6 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { /** * Build the form object elements for an email object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -173,8 +169,6 @@ class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/IM.php b/CRM/Contact/Form/Inline/IM.php index db17a2876b..6282894704 100644 --- a/CRM/Contact/Form/Inline/IM.php +++ b/CRM/Contact/Form/Inline/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_Inline_IM extends CRM_Contact_Form_Inline { @@ -63,8 +61,6 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { /** * Build the form object elements for im object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -155,8 +151,6 @@ class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 06c29150fa..1c367c3216 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * Auxiliary class to provide support for locking (and ignoring locks on) - * contact records. + * Auxiliary class to provide support for locking (and ignoring locks on) contact records. */ class CRM_Contact_Form_Inline_Lock { @@ -45,8 +42,6 @@ class CRM_Contact_Form_Inline_Lock { * @param CRM_Core_Form $form * Form object. * @param int $contactID - * - * @return void */ public static function buildQuickForm(&$form, $contactID) { // We provide a value for oplock_ts to client, but JS uses it carefully @@ -63,7 +58,7 @@ class CRM_Contact_Form_Inline_Lock { } /** - * Ensure that oplock_ts hasn't changed in the underlying DB + * Ensure that oplock_ts hasn't changed in the underlying DB. * * @param array $fields * The input form values. @@ -89,7 +84,7 @@ class CRM_Contact_Form_Inline_Lock { } /** - * Return any post-save data + * Return any post-save data. * * @param int $contactID * diff --git a/CRM/Contact/Form/Inline/OpenID.php b/CRM/Contact/Form/Inline/OpenID.php index 81987882e0..bf53a7d112 100644 --- a/CRM/Contact/Form/Inline/OpenID.php +++ b/CRM/Contact/Form/Inline/OpenID.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an OpenID object + * Form helper class for an OpenID object. */ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { @@ -63,8 +61,6 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { /** * Build the form object elements for openID object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -155,8 +151,6 @@ class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/Phone.php b/CRM/Contact/Form/Inline/Phone.php index 57fcc78c0e..f33f8fd97d 100644 --- a/CRM/Contact/Form/Inline/Phone.php +++ b/CRM/Contact/Form/Inline/Phone.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Phone object + * Form helper class for an Phone object. */ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { @@ -63,8 +61,6 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { /** * Build the form object elements for phone object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -156,8 +152,6 @@ class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Inline/Website.php b/CRM/Contact/Form/Inline/Website.php index 2265e20cbf..c75d05b495 100644 --- a/CRM/Contact/Form/Inline/Website.php +++ b/CRM/Contact/Form/Inline/Website.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * form helper class for an Website object + * Form helper class for an Website object, */ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { @@ -62,8 +60,6 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { /** * Build the form object elements for website object. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -116,8 +112,6 @@ class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline { /** * Process the form. - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Contact/Form/Location.php b/CRM/Contact/Form/Location.php index 442f166b34..260d072ccb 100644 --- a/CRM/Contact/Form/Location.php +++ b/CRM/Contact/Form/Location.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Location { @@ -38,8 +36,6 @@ class CRM_Contact_Form_Location { * Set variables up before form is built. * * @param CRM_Core_Form $form - * - * @return void */ public static function preProcess(&$form) { $form->_addBlockName = CRM_Utils_Request::retrieve('block', 'String', CRM_Core_DAO::$_nullObject); @@ -77,8 +73,6 @@ class CRM_Contact_Form_Location { * Build the form object. * * @param CRM_Core_Form $form - * - * @return void */ public static function buildQuickForm(&$form) { // required for subsequent AJAX requests. diff --git a/CRM/Contact/Form/Merge.php b/CRM/Contact/Form/Merge.php index d5afeb9575..375eef8570 100644 --- a/CRM/Contact/Form/Merge.php +++ b/CRM/Contact/Form/Merge.php @@ -29,14 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ -require_once 'api/api.php'; - /** - * Class CRM_Contact_Form_Merge + * Class CRM_Contact_Form_Merge. */ class CRM_Contact_Form_Merge extends CRM_Core_Form { // the id of the contact that tere's a duplicate for; this one will diff --git a/CRM/Contact/Form/ProfileContact.php b/CRM/Contact/Form/ProfileContact.php index 79bd68b52b..a196bff0a6 100644 --- a/CRM/Contact/Form/ProfileContact.php +++ b/CRM/Contact/Form/ProfileContact.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_ProfileContact { @@ -40,8 +38,6 @@ class CRM_Contact_Form_ProfileContact { * Set variables up before form is built. * * @param CRM_Core_Form $form - * - * @return void */ public static function preProcess(&$form) { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Contact/Form/RelatedContact.php b/CRM/Contact/Form/RelatedContact.php index c4ce3c9420..0ecca9b304 100644 --- a/CRM/Contact/Form/RelatedContact.php +++ b/CRM/Contact/Form/RelatedContact.php @@ -29,7 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** diff --git a/CRM/Contact/Form/Search.php b/CRM/Contact/Form/Search.php index 84dc434b4c..0d25630417 100644 --- a/CRM/Contact/Form/Search.php +++ b/CRM/Contact/Form/Search.php @@ -29,12 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * Files required */ /** @@ -349,8 +343,6 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { /** * Build the common elements between the search/advanced form. - * - * @return void */ public function buildQuickForm() { parent::buildQuickForm(); @@ -494,8 +486,6 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { // set the various class variables @@ -755,8 +745,6 @@ class CRM_Contact_Form_Search extends CRM_Core_Form_Search { /** * Common post processing. - * - * @return void */ public function postProcess() { /* diff --git a/CRM/Contact/Form/Search/Advanced.php b/CRM/Contact/Form/Search/Advanced.php index db0b74df2a..6d400e79c6 100644 --- a/CRM/Contact/Form/Search/Advanced.php +++ b/CRM/Contact/Form/Search/Advanced.php @@ -29,23 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * Files required */ /** - * advanced search, extends basic search + * Advanced search, extends basic search. */ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->set('searchFormName', 'Advanced'); @@ -58,9 +50,6 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->set('context', 'advanced'); @@ -87,7 +76,6 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { ); //check if there are any custom data searchable fields - $groupDetails = array(); $extends = array_merge(array('Contact', 'Individual', 'Household', 'Organization'), CRM_Contact_BAO_ContactType::subTypes() ); @@ -223,17 +211,13 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { * The post processing of the form gets done here. * * Key things done during post processing are - * - check for reset or next request. if present, skip post procesing. + * - check for reset or next request. if present, skip post processing. * - now check if user requested running a saved search, if so, then * the form values associated with the saved search are used for searching. - * - if user has done a submit with new values the regular post submissing is + * - if user has done a submit with new values the regular post submitting is * done. * The processing consists of using a Selector / Controller framework for getting the * search results. - * - * @param - * - * @return void */ public function postProcess() { $this->set('isAdvanced', '1'); @@ -331,11 +315,10 @@ class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { } /** - * Normalize the form values to make it look similar to the advanced form values - * this prevents a ton of work downstream and allows us to use the same code for - * multiple purposes (queries, save/edit etc) + * Normalize the form values to make it look similar to the advanced form values. * - * @return void + * This prevents a ton of work downstream and allows us to use the same code for + * multiple purposes (queries, save/edit etc) */ public function normalizeFormValues() { $contactType = CRM_Utils_Array::value('contact_type', $this->_formValues); diff --git a/CRM/Contact/Form/Search/Basic.php b/CRM/Contact/Form/Search/Basic.php index 9387d6b08b..2519f9af44 100644 --- a/CRM/Contact/Form/Search/Basic.php +++ b/CRM/Contact/Form/Search/Basic.php @@ -29,17 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * - */ - -/** - * Files required */ /** - * Base Search / View form for *all* listing of multiple - * contacts + * Base Search / View form for *all* listing of multiple contacts. */ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { @@ -52,9 +45,6 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { // text for sort_name or email criteria @@ -139,9 +129,6 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Contact_Form_Search_Basic', 'formRule')); @@ -149,8 +136,6 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { /** * Processing needed for buildForm and later. - * - * @return void */ public function preProcess() { $this->set('searchFormName', 'Basic'); @@ -167,8 +152,6 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { /** * This method is called for processing a submitted search form. - * - * @return void */ public function postProcess() { $this->set('isAdvanced', '0'); @@ -216,11 +199,10 @@ class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search { } /** - * Normalize the form values to make it look similar to the advanced form values - * this prevents a ton of work downstream and allows us to use the same code for - * multiple purposes (queries, save/edit etc) + * Normalize the form values to make it look similar to the advanced form values. * - * @return void + * This prevents a ton of work downstream and allows us to use the same code for + * multiple purposes (queries, save/edit etc) */ public function normalizeFormValues() { $contactType = CRM_Utils_Array::value('contact_type', $this->_formValues); diff --git a/CRM/Contact/Form/Search/Builder.php b/CRM/Contact/Form/Search/Builder.php index d1b6c9b6ae..259748a132 100644 --- a/CRM/Contact/Form/Search/Builder.php +++ b/CRM/Contact/Form/Search/Builder.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class if for search builder processing + * This class is for search builder processing. */ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { @@ -54,8 +52,6 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** * Build the form object. - * - * @return void */ public function preProcess() { $this->set('searchFormName', 'Builder'); @@ -124,9 +120,6 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Contact_Form_Search_Builder', 'formRule'), $this); @@ -135,9 +128,9 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** * Global validation rules for the form. * - * @param $values - * @param $files - * @param $self + * @param array $values + * @param array $files + * @param CRM_Core_Form $self * * @return array * list of errors to be posted back to the form @@ -334,8 +327,6 @@ class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { /** * Process the uploaded file. - * - * @return void */ public function postProcess() { $this->set('isAdvanced', '2'); diff --git a/CRM/Contact/Form/Search/Criteria.php b/CRM/Contact/Form/Search/Criteria.php index 91e8e90065..a0dc548a3d 100644 --- a/CRM/Contact/Form/Search/Criteria.php +++ b/CRM/Contact/Form/Search/Criteria.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Criteria { /** @@ -522,13 +520,9 @@ class CRM_Contact_Form_Search_Criteria { } /** - * Generate the custom Data Fields based - * on the is_searchable - * + * Generate the custom Data Fields based for those with is_searchable = 1. * - * @param $form - * - * @return void + * @param CRM_Contact_Form_Search $form */ public static function custom(&$form) { $form->add('hidden', 'hidden_custom', 1); @@ -545,7 +539,6 @@ class CRM_Contact_Form_Search_Criteria { $_groupTitle[$key] = $group['name']; CRM_Core_ShowHideBlocks::links($form, $group['name'], '', ''); - $groupId = $group['id']; foreach ($group['fields'] as $field) { $fieldId = $field['id']; $elementName = 'custom_' . $fieldId; @@ -557,8 +550,6 @@ class CRM_Contact_Form_Search_Criteria { ); } } - - //TODO: validate for only one state if prox_distance isset } /** diff --git a/CRM/Contact/Form/Search/Custom.php b/CRM/Contact/Form/Search/Custom.php index 65a553fb80..a0fe82d91a 100644 --- a/CRM/Contact/Form/Search/Custom.php +++ b/CRM/Contact/Form/Search/Custom.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search { @@ -94,17 +92,11 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search { } /** - * This virtual function is used to set the default values of - * various form elements - * - * access public + * Set the default values of various form elements. * * @return array * reference to the array of default values */ - /** - * @return array - */ public function setDefaultValues() { if (method_exists($this->_customSearchClass, 'setDefaultValues')) { return $this->_customClass->setDefaultValues(); @@ -172,13 +164,10 @@ class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search { } /** - * Return a descriptive name for the page, used in wizard header + * Return a descriptive name for the page, used in wizard header. * * @return string */ - /** - * @return string - */ public function getTitle() { return ts('Custom Search'); } diff --git a/CRM/Contact/Form/Search/Custom/ActivitySearch.php b/CRM/Contact/Form/Search/Custom/ActivitySearch.php index 9ad5d82286..8bb4e81062 100644 --- a/CRM/Contact/Form/Search/Custom/ActivitySearch.php +++ b/CRM/Contact/Form/Search/Custom/ActivitySearch.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_ActivitySearch extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -39,10 +37,9 @@ class CRM_Contact_Form_Search_Custom_ActivitySearch extends CRM_Contact_Form_Sea protected $_aclWhere = NULL; /** - * @param $formValues - */ - /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_formValues = $formValues; diff --git a/CRM/Contact/Form/Search/Custom/Base.php b/CRM/Contact/Form/Search/Custom/Base.php index e347bf04a2..8f2a909663 100644 --- a/CRM/Contact/Form/Search/Custom/Base.php +++ b/CRM/Contact/Form/Search/Custom/Base.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_Base { @@ -41,7 +39,9 @@ class CRM_Contact_Form_Search_Custom_Base { protected $_stateID; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_formValues = &$formValues; diff --git a/CRM/Contact/Form/Search/Custom/Basic.php b/CRM/Contact/Form/Search/Custom/Basic.php index 4a3fab3047..f4fedf458f 100644 --- a/CRM/Contact/Form/Search/Custom/Basic.php +++ b/CRM/Contact/Form/Search/Custom/Basic.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -39,10 +37,9 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo protected $_aclWhere = NULL; /** - * @param $formValues - */ - /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); @@ -89,11 +86,10 @@ class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custo } /** - * Normalize the form values to make it look similar to the advanced form values - * this prevents a ton of work downstream and allows us to use the same code for - * multiple purposes (queries, save/edit etc) + * Normalize the form values to make it look similar to the advanced form values. * - * @return void + * This prevents a ton of work downstream and allows us to use the same code for + * multiple purposes (queries, save/edit etc) */ public function normalize() { $contactType = CRM_Utils_Array::value('contact_type', $this->_formValues); diff --git a/CRM/Contact/Form/Search/Custom/ContribSYBNT.php b/CRM/Contact/Form/Search/Custom/ContribSYBNT.php index 3236149eca..e3621e77b7 100644 --- a/CRM/Contact/Form/Search/Custom/ContribSYBNT.php +++ b/CRM/Contact/Form/Search/Custom/ContribSYBNT.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_ContribSYBNT extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -40,6 +38,8 @@ class CRM_Contact_Form_Search_Custom_ContribSYBNT extends CRM_Contact_Form_Searc public $_permissionedComponent; /** + * Class constructor. + * * @param $formValues */ public function __construct(&$formValues) { diff --git a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php index 699c9093f0..a2597cc0b4 100644 --- a/CRM/Contact/Form/Search/Custom/ContributionAggregate.php +++ b/CRM/Contact/Form/Search/Custom/ContributionAggregate.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_ContributionAggregate extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -40,7 +38,9 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate extends CRM_Contact_F public $_permissionedComponent; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_formValues = $formValues; @@ -58,6 +58,8 @@ class CRM_Contact_Form_Search_Custom_ContributionAggregate extends CRM_Contact_F } /** + * Build form. + * * @param CRM_Core_Form $form */ public function buildForm(&$form) { diff --git a/CRM/Contact/Form/Search/Custom/DateAdded.php b/CRM/Contact/Form/Search/Custom/DateAdded.php index 0a7eacfd3f..c457efa5d5 100644 --- a/CRM/Contact/Form/Search/Custom/DateAdded.php +++ b/CRM/Contact/Form/Search/Custom/DateAdded.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -39,7 +37,9 @@ class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_C protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); diff --git a/CRM/Contact/Form/Search/Custom/EventAggregate.php b/CRM/Contact/Form/Search/Custom/EventAggregate.php index 5dfb8b9509..5a65d9ec78 100644 --- a/CRM/Contact/Form/Search/Custom/EventAggregate.php +++ b/CRM/Contact/Form/Search/Custom/EventAggregate.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -40,7 +38,9 @@ class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Sea public $_permissionedComponent; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_formValues = $formValues; diff --git a/CRM/Contact/Form/Search/Custom/FullText.php b/CRM/Contact/Form/Search/Custom/FullText.php index 22907cfb11..ee587bbbeb 100644 --- a/CRM/Contact/Form/Search/Custom/FullText.php +++ b/CRM/Contact/Form/Search/Custom/FullText.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -76,7 +74,9 @@ class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Cu protected $_foundRows = array(); /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_partialQueries = array( diff --git a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php index 433aaedc16..5d8ac48661 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php +++ b/CRM/Contact/Form/Search/Custom/FullText/AbstractPartialQuery.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ abstract class CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { diff --git a/CRM/Contact/Form/Search/Custom/FullText/Activity.php b/CRM/Contact/Form/Search/Custom/FullText/Activity.php index 02ff7178e4..acd1c57c45 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Activity.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Activity.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { @@ -66,6 +64,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_ /** * @param string $queryText * @param string $entityIDTableName + * * @return array * list tables/queries (for runQueries) */ diff --git a/CRM/Contact/Form/Search/Custom/FullText/Case.php b/CRM/Contact/Form/Search/Custom/FullText/Case.php index 14ef5e130a..99e6c340f7 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Case.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Case.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText_Case extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php index 149d6e982e..e0d2950ac1 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { @@ -42,6 +40,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_S } /** + * Check if search is permitted. + * * @return bool */ public function isActive() { diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php index f59154a1e9..ee7a2ad41d 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contribution.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contribution.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { @@ -42,6 +40,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_F } /** + * Check if search is permitted. + * * @return bool */ public function isActive() { diff --git a/CRM/Contact/Form/Search/Custom/FullText/Membership.php b/CRM/Contact/Form/Search/Custom/FullText/Membership.php index 573664d8d6..357c2e3adb 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Membership.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Membership.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { @@ -42,6 +40,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For } /** + * Check if search is permitted. + * * @return bool */ public function isActive() { @@ -68,6 +68,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_For * * @param string $queryText * @param string $entityIDTableName + * * @return array * list tables/queries (for runQueries) */ diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php index 060e5390a3..43d758483d 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery { @@ -42,6 +40,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Fo } /** + * Check if user has permission. + * * @return bool */ public function isActive() { @@ -68,6 +68,7 @@ class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Fo * * @param string $queryText * @param string $entityIDTableName + * * @return array * list tables/queries (for runQueries) */ diff --git a/CRM/Contact/Form/Search/Custom/Group.php b/CRM/Contact/Form/Search/Custom/Group.php index 2d437dfceb..2900468923 100644 --- a/CRM/Contact/Form/Search/Custom/Group.php +++ b/CRM/Contact/Form/Search/Custom/Group.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_Group extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -44,7 +42,9 @@ class CRM_Contact_Form_Search_Custom_Group extends CRM_Contact_Form_Search_Custo protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_formValues = $formValues; @@ -611,6 +611,8 @@ WHERE gcc.group_id = {$ssGroup->id} } /** + * Define columns. + * * @return array */ public function &columns() { @@ -618,6 +620,8 @@ WHERE gcc.group_id = {$ssGroup->id} } /** + * Get summary. + * * @return NULL */ public function summary() { @@ -625,6 +629,8 @@ WHERE gcc.group_id = {$ssGroup->id} } /** + * Get template file. + * * @return string */ public function templateFile() { @@ -632,7 +638,9 @@ WHERE gcc.group_id = {$ssGroup->id} } /** - * @param $title + * Set title on search. + * + * @param string $title */ public function setTitle($title) { if ($title) { @@ -644,6 +652,8 @@ WHERE gcc.group_id = {$ssGroup->id} } /** + * Build ACL clause. + * * @param string $tableAlias */ public function buildACLClause($tableAlias = 'contact') { diff --git a/CRM/Contact/Form/Search/Custom/MultipleValues.php b/CRM/Contact/Form/Search/Custom/MultipleValues.php index e86a79ed66..e3ea1e1ae9 100644 --- a/CRM/Contact/Form/Search/Custom/MultipleValues.php +++ b/CRM/Contact/Form/Search/Custom/MultipleValues.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -41,7 +39,9 @@ class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Sea protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); diff --git a/CRM/Contact/Form/Search/Custom/PostalMailing.php b/CRM/Contact/Form/Search/Custom/PostalMailing.php index 85693bf341..dc19943c87 100644 --- a/CRM/Contact/Form/Search/Custom/PostalMailing.php +++ b/CRM/Contact/Form/Search/Custom/PostalMailing.php @@ -29,14 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { protected $_aclFrom = NULL; protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); diff --git a/CRM/Contact/Form/Search/Custom/PriceSet.php b/CRM/Contact/Form/Search/Custom/PriceSet.php index c48da94307..bde740e950 100644 --- a/CRM/Contact/Form/Search/Custom/PriceSet.php +++ b/CRM/Contact/Form/Search/Custom/PriceSet.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_PriceSet extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -41,7 +39,9 @@ class CRM_Contact_Form_Search_Custom_PriceSet extends CRM_Contact_Form_Search_Cu public $_permissionedComponent; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); diff --git a/CRM/Contact/Form/Search/Custom/Proximity.php b/CRM/Contact/Form/Search/Custom/Proximity.php index af394bc9b0..d854c078e6 100644 --- a/CRM/Contact/Form/Search/Custom/Proximity.php +++ b/CRM/Contact/Form/Search/Custom/Proximity.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -41,7 +39,9 @@ class CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_C protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues * * @throws Exception */ diff --git a/CRM/Contact/Form/Search/Custom/RandomSegment.php b/CRM/Contact/Form/Search/Custom/RandomSegment.php index 89dc49280f..2d55f9e8bf 100644 --- a/CRM/Contact/Form/Search/Custom/RandomSegment.php +++ b/CRM/Contact/Form/Search/Custom/RandomSegment.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -39,7 +37,9 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); diff --git a/CRM/Contact/Form/Search/Custom/Sample.php b/CRM/Contact/Form/Search/Custom/Sample.php index 3bac4131a8..32b9cdc1bb 100644 --- a/CRM/Contact/Form/Search/Custom/Sample.php +++ b/CRM/Contact/Form/Search/Custom/Sample.php @@ -29,14 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { protected $_aclFrom = NULL; protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); @@ -59,6 +59,8 @@ class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Cust } /** + * Build form. + * * @param CRM_Core_Form $form */ public function buildForm(&$form) { diff --git a/CRM/Contact/Form/Search/Custom/TagContributions.php b/CRM/Contact/Form/Search/Custom/TagContributions.php index ad7caa8d8a..193774f065 100644 --- a/CRM/Contact/Form/Search/Custom/TagContributions.php +++ b/CRM/Contact/Form/Search/Custom/TagContributions.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_TagContributions extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { @@ -40,7 +38,9 @@ class CRM_Contact_Form_Search_Custom_TagContributions extends CRM_Contact_Form_S public $_permissionedComponent; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { $this->_formValues = $formValues; diff --git a/CRM/Contact/Form/Search/Custom/ZipCodeRange.php b/CRM/Contact/Form/Search/Custom/ZipCodeRange.php index 7469145514..b7331a6664 100644 --- a/CRM/Contact/Form/Search/Custom/ZipCodeRange.php +++ b/CRM/Contact/Form/Search/Custom/ZipCodeRange.php @@ -29,14 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface { protected $_aclFrom = NULL; protected $_aclWhere = NULL; /** - * @param $formValues + * Class constructor. + * + * @param array $formValues */ public function __construct(&$formValues) { parent::__construct($formValues); diff --git a/CRM/Contact/Form/Search/Interface.php b/CRM/Contact/Form/Search/Interface.php index dbaaa34955..f2a2fba398 100644 --- a/CRM/Contact/Form/Search/Interface.php +++ b/CRM/Contact/Form/Search/Interface.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ interface CRM_Contact_Form_Search_Interface { diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php index 4b552296c7..0730907297 100644 --- a/CRM/Contact/Form/Task.php +++ b/CRM/Contact/Form/Task.php @@ -29,11 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ */ /** - * This class generates form components for search-result tasks + * This class generates form components for search-result tasks. */ class CRM_Contact_Form_Task extends CRM_Core_Form { diff --git a/CRM/Contact/Form/Task/AddToGroup.php b/CRM/Contact/Form/Task/AddToGroup.php index 9c7ac98dd7..29b4f883ed 100644 --- a/CRM/Contact/Form/Task/AddToGroup.php +++ b/CRM/Contact/Form/Task/AddToGroup.php @@ -29,13 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to group - * contacts. This class provides functionality for the actual + * This class provides the functionality to group contacts. + * + * This class provides functionality for the actual * addition of contacts to groups. */ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { @@ -63,8 +62,6 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { // initialize the task and row fields @@ -76,9 +73,6 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { @@ -166,9 +160,6 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Contact_Form_task_AddToGroup', 'formRule')); @@ -197,9 +188,6 @@ class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues(); diff --git a/CRM/Contact/Form/Task/AddToOrganization.php b/CRM/Contact/Form/Task/AddToOrganization.php index b7c795bfde..d1eb806a43 100644 --- a/CRM/Contact/Form/Task/AddToOrganization.php +++ b/CRM/Contact/Form/Task/AddToOrganization.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to add contact(s) to Organization + * This class provides the functionality to add contact(s) to Organization. */ class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task_AddToParentClass { diff --git a/CRM/Contact/Form/Task/AddToTag.php b/CRM/Contact/Form/Task/AddToTag.php index 946235d5c7..99437277a6 100644 --- a/CRM/Contact/Form/Task/AddToTag.php +++ b/CRM/Contact/Form/Task/AddToTag.php @@ -29,14 +29,14 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to delete a group of - * contacts. This class provides functionality for the actual - * addition of contacts to groups. + * This class provides the functionality to delete a group of contacts. + * + * This class provides functionality for the actual addition of contacts to groups. + * + * Wow is that copy & paste gone wrong or what? What does this class do? Anyone, anyone. */ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { @@ -56,9 +56,6 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { // add select for tag @@ -94,9 +91,6 @@ class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { //get the submitted values in an array diff --git a/CRM/Contact/Form/Task/AlterPreferences.php b/CRM/Contact/Form/Task/AlterPreferences.php index c1949bb102..49aabe86a1 100644 --- a/CRM/Contact/Form/Task/AlterPreferences.php +++ b/CRM/Contact/Form/Task/AlterPreferences.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -41,9 +39,6 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { // add select for preferences @@ -95,9 +90,6 @@ class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { //get the submitted values in an array diff --git a/CRM/Contact/Form/Task/Batch.php b/CRM/Contact/Form/Task/Batch.php index 2ec51c6cfd..66de385ece 100644 --- a/CRM/Contact/Form/Task/Batch.php +++ b/CRM/Contact/Form/Task/Batch.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality for batch profile update + * This class provides the functionality for batch profile update. */ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { @@ -67,8 +65,6 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { // initialize the task and row fields @@ -77,9 +73,6 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $ufGroupId = $this->get('ufGroupId'); @@ -220,9 +213,6 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $params = $this->exportValues(); @@ -264,6 +254,7 @@ class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task { /** * Parse street address. + * * @param array $contactValues * Contact values. * @param CRM_Core_Form $form diff --git a/CRM/Contact/Form/Task/Delete.php b/CRM/Contact/Form/Task/Delete.php index efa85b4e41..1603f81180 100644 --- a/CRM/Contact/Form/Task/Delete.php +++ b/CRM/Contact/Form/Task/Delete.php @@ -29,14 +29,12 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to delete a group of - * contacts. This class provides functionality for the actual - * deletion. + * This class provides the functionality to delete a group of contacts. + * + * This class provides functionality for the actual deletion. */ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { @@ -55,8 +53,6 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { @@ -148,9 +144,6 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $label = $this->_restore ? ts('Restore Contact(s)') : ts('Delete Contact(s)'); @@ -202,9 +195,6 @@ class CRM_Contact_Form_Task_Delete extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $session = CRM_Core_Session::singleton(); -- 2.25.1