From 00252851362ea1d1373ac5075624c89359b9427c Mon Sep 17 00:00:00 2001 From: eileenmcnaugton Date: Tue, 1 Sep 2015 00:29:35 +1200 Subject: [PATCH] comment fixes --- CRM/Contact/Form/Task/Email.php | 18 ++++-------------- CRM/Contact/Form/Task/EmailCommon.php | 8 -------- CRM/Contact/Form/Task/HookSample.php | 15 +++------------ CRM/Contact/Form/Task/Label.php | 17 +++-------------- CRM/Contact/Form/Task/LabelCommon.php | 11 +++-------- CRM/Contact/Form/Task/Map.php | 19 +++---------------- CRM/Contact/Form/Task/Map/Event.php | 11 +---------- CRM/Contact/Form/Task/Merge.php | 5 ----- CRM/Contact/Form/Task/PDF.php | 21 ++------------------- 9 files changed, 19 insertions(+), 106 deletions(-) diff --git a/CRM/Contact/Form/Task/Email.php b/CRM/Contact/Form/Task/Email.php index bd6cd14a4a..de2f0fe079 100644 --- a/CRM/Contact/Form/Task/Email.php +++ b/CRM/Contact/Form/Task/Email.php @@ -29,19 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to email a group of - * contacts. + * This class provides the functionality to email a group of contacts. */ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { /** - * Are we operating in "single mode", i.e. sending email to one - * specific contact? + * Are we operating in "single mode". + * + * Single mode means sending email to one specific contact. * * @var boolean */ @@ -94,8 +92,6 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { // store case id if present @@ -149,9 +145,6 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -163,9 +156,6 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { CRM_Contact_Form_Task_EmailCommon::postProcess($this); diff --git a/CRM/Contact/Form/Task/EmailCommon.php b/CRM/Contact/Form/Task/EmailCommon.php index 539a51e561..0f64c32a06 100644 --- a/CRM/Contact/Form/Task/EmailCommon.php +++ b/CRM/Contact/Form/Task/EmailCommon.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -132,10 +130,7 @@ class CRM_Contact_Form_Task_EmailCommon { /** * Build the form object. * - * * @param CRM_Core_Form $form - * - * @return void */ public static function buildQuickForm(&$form) { $toArray = $ccArray = $bccArray = array(); @@ -395,10 +390,7 @@ class CRM_Contact_Form_Task_EmailCommon { /** * Process the form after the input has been submitted and validated. * - * * @param CRM_Core_Form $form - * - * @return void */ public static function postProcess(&$form) { if (count($form->_contactIds) > self::MAX_EMAILS_KILL_SWITCH) { diff --git a/CRM/Contact/Form/Task/HookSample.php b/CRM/Contact/Form/Task/HookSample.php index e54703dee0..d3ec87f17c 100644 --- a/CRM/Contact/Form/Task/HookSample.php +++ b/CRM/Contact/Form/Task/HookSample.php @@ -29,20 +29,17 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to save a search + * This class provides the functionality to save a search. + * * Saved Searches are used for saving frequently used queries */ class CRM_Contact_Form_Task_HookSample extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -72,10 +69,7 @@ AND c.id IN ( $contactIDs )"; } /** - * Build the form object - it consists of - * - * - * @return void + * Build the form object. */ public function buildQuickForm() { $this->addDefaultButtons(ts('Back to Search'), 'done'); @@ -83,9 +77,6 @@ AND c.id IN ( $contactIDs )"; /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { } diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index a99e65d5c8..6ea5c7fa04 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class helps to print the labels for contacts - * + * This class helps to print the labels for contacts. */ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $this->set('contactIds', $this->_contactIds); @@ -51,9 +46,6 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { CRM_Utils_System::setTitle(ts('Make Mailing Labels')); @@ -106,9 +98,6 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { $fv = $this->controller->exportValues($this->_name); @@ -380,10 +369,10 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { } /** - * Create labels (pdf) + * Create labels (pdf). * * @param array $contactRows - * Assciated array of contact data. + * Associated array of contact data. * @param string $format * Format in which labels needs to be printed. * @param string $fileName diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 72538cf2a8..992b7e17ad 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -29,27 +29,22 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the common functionality for sending email to - * one or a group of contact ids. This class is reused by all the search - * components in CiviCRM (since they all have send email as a task) + * This class provides the common functionality for sending email to one or a group of contact ids. */ class CRM_Contact_Form_Task_LabelCommon { /** - * Create labels (pdf) + * Create labels (pdf). * * @param array $contactRows - * Assciated array of contact data. + * Associated array of contact data. * @param string $format * Format in which labels needs to be printed. * @param string $fileName * The name of the file to save the label in. - * */ public static function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') { $pdf = new CRM_Utils_PDF_Label($format, 'mm'); diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 920872a0c0..e1fef1f906 100644 --- a/CRM/Contact/Form/Task/Map.php +++ b/CRM/Contact/Form/Task/Map.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** @@ -50,8 +48,6 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $cid = CRM_Utils_Request::retrieve('cid', 'Positive', @@ -115,9 +111,6 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { $this->addButtons(array( @@ -132,9 +125,6 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { } @@ -142,15 +132,12 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { /** * Assign smarty variables to the template that will be used by google api to plot the contacts. * - * @param $ids + * @param array $ids * @param int $locationId * Location_id. - * @param $page - * @param $addBreadCrumb + * @param CRM_Core_Page $page + * @param bool $addBreadCrumb * @param string $type - * - * @return void - * the location of the file we have created */ public static function createMapXML($ids, $locationId, &$page, $addBreadCrumb, $type = 'Contact') { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Contact/Form/Task/Map/Event.php b/CRM/Contact/Form/Task/Map/Event.php index 23d0f4e16e..955d893d3d 100644 --- a/CRM/Contact/Form/Task/Map/Event.php +++ b/CRM/Contact/Form/Task/Map/Event.php @@ -29,21 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id: Event.php 45499 2013-02-08 12:31:05Z kurund $ - * */ /** - * This class provides the functionality to map - * the address for group of - * contacts. + * This class provides the functionality to map the address for group of contacts. */ class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { $ids = CRM_Utils_Request::retrieve('eid', 'Positive', @@ -63,9 +57,6 @@ class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map { * * @return string */ - /** - * @return string - */ public function getTemplateFileName() { return 'CRM/Contact/Form/Task/Map.tpl'; } diff --git a/CRM/Contact/Form/Task/Merge.php b/CRM/Contact/Form/Task/Merge.php index dcc545898e..75af081847 100644 --- a/CRM/Contact/Form/Task/Merge.php +++ b/CRM/Contact/Form/Task/Merge.php @@ -29,20 +29,15 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** * This class provides the functionality to Merge Contacts. - * */ class CRM_Contact_Form_Task_Merge extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { parent::preProcess(); diff --git a/CRM/Contact/Form/Task/PDF.php b/CRM/Contact/Form/Task/PDF.php index fccbfea8c9..0267aa6a50 100644 --- a/CRM/Contact/Form/Task/PDF.php +++ b/CRM/Contact/Form/Task/PDF.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class provides the functionality to create PDF letter for a group of - * contacts or a single contact. + * This class provides the functionality to create PDF letter for a group of contacts or a single contact. */ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { @@ -54,8 +51,6 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { /** * Build all the data structures needed to build the form. - * - * @return void */ public function preProcess() { @@ -87,13 +82,7 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { } /** - * Set default values for the form. Relationship that in edit/view action - * the default values are retrieved from the database - * - * - * @return void - */ - /** + * Set default values for the form. */ public function setDefaultValues() { $defaults = array(); @@ -108,9 +97,6 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { /** * Build the form object. - * - * - * @return void */ public function buildQuickForm() { //enable form element @@ -120,9 +106,6 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task { /** * Process the form after the input has been submitted and validated. - * - * - * @return void */ public function postProcess() { CRM_Contact_Form_Task_PDFLetterCommon::postProcess($this); -- 2.25.1