From 3bdf1f3a158a9fb8f69d5e63e9094cead626fe58 Mon Sep 17 00:00:00 2001 From: eileenmcnaughton Date: Thu, 22 Oct 2015 01:51:56 +0000 Subject: [PATCH] comment fixes wq! comment fixes f --- CRM/Admin/Form/PaymentProcessor.php | 1 + CRM/Case/ManagedEntities.php | 6 +- CRM/Contact/BAO/Query.php | 4 +- CRM/Contact/Form/Search/Interface.php | 4 +- CRM/Core/BAO/Setting.php | 11 ++- CRM/Core/Form.php | 47 ++++++++--- CRM/Core/Module.php | 5 ++ CRM/Core/Selector/API.php | 12 ++- CRM/Event/BAO/Event.php | 37 ++++----- CRM/Event/BAO/Participant.php | 21 +---- CRM/Event/BAO/Query.php | 2 - CRM/Event/Controller/Search.php | 4 + CRM/Event/Form/EventFees.php | 9 +-- CRM/Event/Form/ManageEvent.php | 18 +---- CRM/Event/Form/ManageEvent/Conference.php | 13 ++- CRM/Event/Form/ManageEvent/Delete.php | 10 +-- CRM/Event/Form/ManageEvent/EventInfo.php | 25 ++---- CRM/Event/Form/ManageEvent/Fee.php | 21 +---- CRM/Event/Form/ManageEvent/Location.php | 18 +---- CRM/Event/Form/ManageEvent/Registration.php | 13 +-- CRM/Event/Form/Registration.php | 79 +++++++++---------- CRM/Event/Form/Registration/Confirm.php | 38 ++++----- CRM/Event/Form/Registration/Register.php | 23 ++++-- CRM/Import/DataSource/CSV.php | 2 + CRM/Pledge/Controller/Search.php | 4 + CRM/Report/Form/Contact/Summary.php | 10 ++- CRM/SMS/Provider.php | 16 +++- CRM/UF/Page/Group.php | 4 +- CRM/Upgrade/Incremental/Base.php | 1 - CRM/Upgrade/Incremental/php/FourFive.php | 1 - CRM/Upgrade/Incremental/php/FourFour.php | 13 ++- CRM/Upgrade/Incremental/php/FourOne.php | 2 - CRM/Upgrade/Incremental/php/FourSeven.php | 5 +- CRM/Upgrade/Incremental/php/FourSix.php | 1 - CRM/Upgrade/Incremental/php/FourThree.php | 4 +- CRM/Upgrade/Incremental/php/FourTwo.php | 5 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 5 +- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 2 - CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 1 - .../Snapshot/V4p2/Price/DAO/FieldValue.php | 4 +- CRM/Utils/Network.php | 8 +- Civi/API/Event/Event.php | 3 + api/v3/Generic.php | 1 + api/v3/Generic/Getlist.php | 1 + tests/phpunit/WebTest/Utils/RedirectTest.php | 3 + 45 files changed, 242 insertions(+), 275 deletions(-) diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index 34d5f5d835..2884833fb1 100644 --- a/CRM/Admin/Form/PaymentProcessor.php +++ b/CRM/Admin/Form/PaymentProcessor.php @@ -370,6 +370,7 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { * @param bool $test */ public function updatePaymentProcessor(&$values, $domainID, $test) { + // @todo remove this function (some or all) in favour or CRM_Financial_BAO_PaymentProcessor::create. $dao = new CRM_Financial_DAO_PaymentProcessor(); $dao->id = $test ? $this->_testID : $this->_id; diff --git a/CRM/Case/ManagedEntities.php b/CRM/Case/ManagedEntities.php index 4cef93581c..e89ab51bfa 100644 --- a/CRM/Case/ManagedEntities.php +++ b/CRM/Case/ManagedEntities.php @@ -55,11 +55,13 @@ class CRM_Case_ManagedEntities { } /** - * Get a list of managed activity-types by searching CiviCase XML files + * Get a list of managed activity-types by searching CiviCase XML files. + * + * @param \CRM_Case_XMLRepository $xmlRepo + * @param \CRM_Core_ManagedEntities $me * * @return array * @see CRM_Utils_Hook::managed - * @throws CRM_Core_Exception */ public static function createManagedActivityTypes(CRM_Case_XMLRepository $xmlRepo, CRM_Core_ManagedEntities $me) { $result = array(); diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 5659fcd932..cc0c32fb06 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -5557,8 +5557,8 @@ AND displayRelType.is_active = 1 * depends on the operator and who's calling the query builder. * @param int $grouping * the index where to place the where clause. - * @param $selectValues - * The key value pairs for this element. This allows us to use this function for things besides option-value pairs. + * @param string $daoName + * DAO Name. * @param array $field * an array that contains various properties of the field identified by $name. * @param string $label diff --git a/CRM/Contact/Form/Search/Interface.php b/CRM/Contact/Form/Search/Interface.php index f2a2fba398..4899a4c0e4 100644 --- a/CRM/Contact/Form/Search/Interface.php +++ b/CRM/Contact/Form/Search/Interface.php @@ -48,7 +48,9 @@ interface CRM_Contact_Form_Search_Interface { public function buildTaskList(CRM_Core_Form_Search $form); /** - * Builds the quickform for this search + * Builds the quickform for this search. + * + * @param CRM_Core_Form $form */ public function buildForm(&$form); diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index b26de01920..9fe4525860 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -279,10 +279,15 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { } /** - * Validate & convert settings input + * Validate & convert settings input. * - * @value mixed value of the setting to be set - * @fieldSpec array Metadata for given field (drawn from the xml) + * @param mixed $value + * value of the setting to be set + * @param array $fieldSpec + * Metadata for given field (drawn from the xml) + * + * @return bool + * @throws \api_Exception */ public static function validateSetting(&$value, $fieldSpec) { if ($fieldSpec['type'] == 'String' && is_array($value)) { diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index 63ab7fb404..e85368b4c9 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -468,8 +468,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Core function that builds the form. We redefine this function - * here and expect all CRM forms to build their form in the function + * Core function that builds the form. + * + * We redefine this function here and expect all CRM forms to build their form in the function * buildQuickForm. */ public function buildForm() { @@ -523,7 +524,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Add default Next / Back buttons + * Add default Next / Back buttons. * * @param array $params * Array of associative arrays in the order in which the buttons should be @@ -623,7 +624,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter function for title. Should be over-ridden by derived class + * Getter function for title. + * + * Should be over-ridden by derived class. * * @return string */ @@ -872,8 +875,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Getter function for renderer. If renderer is not set - * create one and initialize it + * Getter function for renderer. + * + * If renderer is not set create one and initialize it. * * @return object */ @@ -908,8 +912,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * A wrapper for getTemplateFileName that includes calling the hook to - * prevent us from having to copy & paste the logic of calling the hook + * A wrapper for getTemplateFileName. + * + * This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook. */ public function getHookedTemplateFileName() { $pageTemplateFile = $this->getTemplateFileName(); @@ -918,8 +923,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { } /** - * Default extra tpl file basically just replaces .tpl with .extra.tpl - * i.e. we dont override + * Default extra tpl file basically just replaces .tpl with .extra.tpl. + * + * i.e. we do not override. * * @return string */ @@ -1759,6 +1765,17 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Add a currency and money element to the form. + * + * @param string $name + * @param string $label + * @param bool $required + * @param null $attributes + * @param bool $addCurrency + * @param string $currencyName + * @param null $defaultCurrency + * @param bool $freezeCurrency + * + * @return \HTML_QuickForm_Element */ public function addMoney( $name, @@ -1920,7 +1937,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Helper function to verify that required fields have been filled. + * * Typically called within the scope of a FormRule function + * + * @param array $fields + * @param array $values + * @param array $errors */ public static function validateMandatoryFields($fields, $values, &$errors) { foreach ($fields as $name => $fld) { @@ -1991,6 +2013,11 @@ class CRM_Core_Form extends HTML_QuickForm_Page { return is_numeric($userID) ? $userID : NULL; } + /** + * Get the contact id that the form is being submitted for. + * + * @return int|NULL + */ public function getContactID() { return $this->setContactID(); } diff --git a/CRM/Core/Module.php b/CRM/Core/Module.php index 634c300013..861c41f7f3 100644 --- a/CRM/Core/Module.php +++ b/CRM/Core/Module.php @@ -58,6 +58,11 @@ class CRM_Core_Module { /** * Get a list of all known modules. + * + * @param bool $fresh + * Force new results? + * + * @return array */ public static function getAll($fresh = FALSE) { static $result; diff --git a/CRM/Core/Selector/API.php b/CRM/Core/Selector/API.php index cbdd6ed2e9..382236e82a 100644 --- a/CRM/Core/Selector/API.php +++ b/CRM/Core/Selector/API.php @@ -33,15 +33,14 @@ * list display, pagination, sorting and export in multiple formats (CSV is * supported right now, XML support will be added as and when needed * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ interface CRM_Core_Selector_API { /** + * Get pager parameters. + * * Based on the action, the GET variables and the session state * it adds various key => value pairs to the params array including * @@ -55,8 +54,6 @@ interface CRM_Core_Selector_API { * The action being performed. * @param array $params * The array that the pagerParams will be inserted into. - * - * @return void */ public function getPagerParams($action, &$params); @@ -72,7 +69,8 @@ interface CRM_Core_Selector_API { public function &getSortOrder($action); /** - * Returns the column headers as an array of tuples: + * Returns the column headers as an array of tuples. + * * (name, sortName (key to the sort array)) * * @param string $action @@ -116,7 +114,7 @@ interface CRM_Core_Selector_API { public function &getRows($action, $offset, $rowCount, $sort, $type = NULL); /** - * Return the template (.tpl) filename + * Return the template (.tpl) filename. * * @param string $action * The action being performed. diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index ce6cf4646d..0e1feb7ff2 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -29,8 +29,6 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { @@ -222,10 +220,11 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Delete the location block associated with an event, - * if not being used by any other event. + * Delete the location block associated with an event. + * + * Function checks that it is not being used by any other event. * - * @param $locBlockId + * @param int $locBlockId * Location block id to be deleted. * @param int $eventId * Event with which loc block is associated. @@ -246,7 +245,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { } /** - * Get current/future Events + * Get current/future Events. * * @param int $all * 0 returns current and future events. @@ -321,7 +320,6 @@ WHERE ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )"; /** * Get events Summary. * - * * @return array * Array of event summary values */ @@ -911,8 +909,9 @@ WHERE civicrm_event.is_active = 1 } /** - * make a copy of a Event, including - * all the fields in the event Wizard + * Make a copy of a Event. + * + * Include all the fields in the event Wizard. * * @param int $id * The event id to copy. @@ -1030,8 +1029,9 @@ WHERE civicrm_event.is_active = 1 } /** - * This is sometimes called in a loop (during event search) - * hence we cache the values to prevent repeated calls to the db + * This is sometimes called in a loop (during event search). + * + * We cache the values to prevent repeated calls to the db. */ public static function isMonetary($id) { static $isMonetary = array(); @@ -1045,8 +1045,9 @@ WHERE civicrm_event.is_active = 1 } /** - * This is sometimes called in a loop (during event search) - * hence we cache the values to prevent repeated calls to the db + * This is sometimes called in a loop (during event search). + * + * We cache the values to prevent repeated calls to the db. */ public static function usesPriceSet($id) { static $usesPriceSet = array(); @@ -1057,15 +1058,13 @@ WHERE civicrm_event.is_active = 1 } /** - * Process that send e-mails + * Send e-mails. * * @param int $contactID - * @param $values + * @param array $values * @param int $participantId * @param bool $isTest * @param bool $returnMessageText - * - * @return void */ public static function sendMail($contactID, &$values, $participantId, $isTest = FALSE, $returnMessageText = FALSE) { @@ -1260,8 +1259,6 @@ WHERE civicrm_event.is_active = 1 * @param $isTest * @param bool $isCustomProfile * @param array $participantParams - * - * @return void */ public static function buildCustomDisplay( $id, @@ -1447,8 +1444,6 @@ WHERE civicrm_event.is_active = 1 * Formatted array of key value. * * @param array $profileFields - * - * @return void */ public static function displayProfile(&$params, $gid, &$groupTitle, &$values, &$profileFields = array()) { if ($gid) { diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 941aeb6766..ebc1ff95a8 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -27,12 +27,8 @@ */ /** - * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { @@ -817,8 +813,6 @@ WHERE civicrm_participant.id = {$participantId} * (reference) the default values, some of which need to be resolved. * @param bool $reverse * True if we want to resolve the values in the reverse direction (value -> name). - * - * @return void */ public static function resolveDefaults(&$defaults, $reverse = FALSE) { self::lookupValue($defaults, 'event', CRM_Event_PseudoConstant::event(), $reverse); @@ -827,8 +821,7 @@ WHERE civicrm_participant.id = {$participantId} } /** - * convert associative array names to values - * and vice-versa. + * Convert associative array names to values and vice-versa. * * This function is used by both the web form layer and the api. Note that * the api needs the name => value conversion, also the view layer typically @@ -856,12 +849,12 @@ WHERE civicrm_participant.id = {$participantId} } /** - * Delete the record that are associated with this participation. + * Delete the records that are associated with this participation. * * @param int $id * Id of the participation to delete. * - * @return void + * @return \CRM_Event_DAO_Participant */ public static function deleteParticipant($id) { CRM_Utils_Hook::pre('delete', 'Participant', $id, CRM_Core_DAO::$_nullArray); @@ -967,10 +960,7 @@ WHERE civicrm_participant.id = {$participantId} * separated string before using fee_level in view mode. * * @param string $eventLevel - * Event_leval string from db. - * - * - * @return void + * Event_level string from db. */ public static function fixEventLevel(&$eventLevel) { if ((substr($eventLevel, 0, 1) == CRM_Core_DAO::VALUE_SEPARATOR) && @@ -1185,9 +1175,6 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ * @param int $statusId * Status id for participant. * @param bool $updateRegisterDate - * - * @return void - * */ public static function updateStatus($participantIds, $statusId, $updateRegisterDate = FALSE) { if (!is_array($participantIds) || empty($participantIds) || !$statusId) { diff --git a/CRM/Event/BAO/Query.php b/CRM/Event/BAO/Query.php index 05328b5c33..29188e95bc 100644 --- a/CRM/Event/BAO/Query.php +++ b/CRM/Event/BAO/Query.php @@ -58,8 +58,6 @@ class CRM_Event_BAO_Query { * Build select for CiviEvent. * * @param $query - * - * @return void */ public static function select(&$query) { if (($query->_mode & CRM_Contact_BAO_Query::MODE_EVENT) || diff --git a/CRM/Event/Controller/Search.php b/CRM/Event/Controller/Search.php index 7bbcf6da98..bd2c5e0c06 100644 --- a/CRM/Event/Controller/Search.php +++ b/CRM/Event/Controller/Search.php @@ -48,6 +48,10 @@ class CRM_Event_Controller_Search extends CRM_Core_Controller { /** * Class constructor. + * + * @param string $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php index 7c9ed4aa1b..92dc9a4b16 100644 --- a/CRM/Event/Form/EventFees.php +++ b/CRM/Event/Form/EventFees.php @@ -43,8 +43,6 @@ class CRM_Event_Form_EventFees { * Set variables up before form is built. * * @param CRM_Core_Form $form - * - * @return void */ public static function preProcess(&$form) { //as when call come from register.php @@ -69,10 +67,7 @@ class CRM_Event_Form_EventFees { * This function sets the default values for the form in edit/view mode * the default values are retrieved from the database * - * * @param CRM_Core_Form $form - * - * @return void */ public static function setDefaultValues(&$form) { $defaults = array(); @@ -259,7 +254,7 @@ class CRM_Event_Form_EventFees { * @param int $eventID * @param bool $includeQtyZero * - * @return void + * @return array */ public static function setDefaultPriceSet($participantID, $eventID = NULL, $includeQtyZero = TRUE) { $defaults = array(); @@ -342,8 +337,6 @@ SELECT id, html_type * Build the form object. * * @param CRM_Core_Form $form - * - * @return void */ public static function buildQuickForm(&$form) { if ($form->_eventId) { diff --git a/CRM/Event/Form/ManageEvent.php b/CRM/Event/Form/ManageEvent.php index a1a1cc2981..d759c0f4a1 100644 --- a/CRM/Event/Form/ManageEvent.php +++ b/CRM/Event/Form/ManageEvent.php @@ -26,21 +26,17 @@ */ /** - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing Event - * + * This class generates form components for processing Event. */ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { /** - * The id of the event we are proceessing. + * The id of the event we are processing. * * @var int */ @@ -103,8 +99,6 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $config = CRM_Core_Config::singleton(); @@ -256,11 +250,9 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * - * @return void + * For edit/view mode the default values are retrieved from the database. */ public function setDefaultValues() { $defaults = array(); @@ -287,8 +279,6 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $session = CRM_Core_Session::singleton(); diff --git a/CRM/Event/Form/ManageEvent/Conference.php b/CRM/Event/Form/ManageEvent/Conference.php index f45d19630f..3547739399 100644 --- a/CRM/Event/Form/ManageEvent/Conference.php +++ b/CRM/Event/Form/ManageEvent/Conference.php @@ -29,13 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Conference Slots - * + * This class generates form components for Conference Slots. */ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent { @@ -45,8 +42,7 @@ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent { public $_action; /** - * - * @return void + * Build quick form. */ public function buildQuickForm() { $slots = CRM_Core_OptionGroup::values('conference_slot'); @@ -70,6 +66,9 @@ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent { parent::buildQuickForm(); } + /** + * Post process form. + */ public function postProcess() { $params = $this->exportValues(); @@ -80,7 +79,7 @@ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent { } /** - * Return a descriptive name for the page, used in wizard header + * Return a descriptive name for the page, used in wizard header. * * @return string */ diff --git a/CRM/Event/Form/ManageEvent/Delete.php b/CRM/Event/Form/ManageEvent/Delete.php index 3be445512d..bfd8d416c7 100644 --- a/CRM/Event/Form/ManageEvent/Delete.php +++ b/CRM/Event/Form/ManageEvent/Delete.php @@ -29,12 +29,10 @@ * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class is to build the form for Deleting Group + * This class is to build the form for Deleting Group. */ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { @@ -47,8 +45,6 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -67,8 +63,6 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { $this->assign('title', $this->_title); @@ -89,8 +83,6 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent { /** * Process the form when submitted. - * - * @return void */ public function postProcess() { $participant = new CRM_Event_DAO_Participant(); diff --git a/CRM/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index 98f9faa27c..1e210b94ce 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -26,17 +26,12 @@ */ /** - * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing Event - * + * This class generates form components for processing Event. */ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { @@ -47,8 +42,6 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -78,11 +71,9 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * - * @return void + * For edit/view mode he default values are retrieved from the database. */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); @@ -130,8 +121,6 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { //need to assign custom data type and subtype to the template @@ -247,9 +236,6 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $params = $this->controller->exportValues($this->_name); @@ -311,7 +297,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * Return a descriptive name for the page, used in wizard header + * Return a descriptive name for the page, used in wizard header. * * @return string */ @@ -320,8 +306,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { } /** - * Retrieve event template custom data values. - * and set as default values for current new event. + * Retrieve event template custom data values and set as default values for current new event. * * @param int $templateId * Event template id. diff --git a/CRM/Event/Form/ManageEvent/Fee.php b/CRM/Event/Form/ManageEvent/Fee.php index f0c53a30c4..55123f9f81 100644 --- a/CRM/Event/Form/ManageEvent/Fee.php +++ b/CRM/Event/Form/ManageEvent/Fee.php @@ -26,16 +26,12 @@ */ /** - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for Event Fees - * + * This class generates form components for Event Fees. */ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { @@ -61,19 +57,15 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { parent::preProcess(); } /** - * Set default values for the form. For edit/view mode - * the default values are retrieved from the database - * + * Set default values for the form. * - * @return void + * For edit/view mode the default values are retrieved from the database. */ public function setDefaultValues() { $parentDefaults = parent::setDefaultValues(); @@ -247,8 +239,6 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { /** * Build the form object. - * - * @return void */ public function buildQuickForm() { @@ -400,9 +390,6 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Event_Form_ManageEvent_Fee', 'formRule')); @@ -557,8 +544,6 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { /** * Process the form. - * - * @return void */ public function postProcess() { $eventTitle = ''; diff --git a/CRM/Event/Form/ManageEvent/Location.php b/CRM/Event/Form/ManageEvent/Location.php index 75d08a2a73..04cc5b0945 100644 --- a/CRM/Event/Form/ManageEvent/Location.php +++ b/CRM/Event/Form/ManageEvent/Location.php @@ -69,8 +69,6 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { parent::preProcess(); @@ -95,11 +93,9 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { } /** - * 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; @@ -126,9 +122,6 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { /** * Add local and global form rules. - * - * - * @return void */ public function addRules() { $this->addFormRule(array('CRM_Event_Form_ManageEvent_Location', 'formRule')); @@ -151,9 +144,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { } /** - * function to build location block. - * - * @return void + * Function to build location block. */ public function buildQuickForm() { //load form for child blocks @@ -214,9 +205,6 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { /** * Process the form submission. - * - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index 0c8ccbe3e1..f4c2d941b4 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -26,17 +26,12 @@ */ /** - * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing Event - * + * This class generates form components for processing Event. */ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent { @@ -52,8 +47,6 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Set variables up before form is built. - * - * @return void */ public function preProcess() { $this->_addProfileBottom = CRM_Utils_Array::value('addProfileBottom', $_GET, FALSE); @@ -90,10 +83,8 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Set default values for the form. - * the default values are retrieved from the database * - * - * @return void + * The default values are retrieved from the database. */ public function setDefaultValues() { if ($this->_addProfileBottom || $this->_addProfileBottomAdd) { diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index f600b1a181..a3f754bc9f 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -26,17 +26,12 @@ */ /** - * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing Event - * + * This class generates form components for processing Event. */ class CRM_Event_Form_Registration extends CRM_Core_Form { @@ -427,8 +422,6 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** * Assign the minimal set of variables to the template. - * - * @return void */ public function assignToTemplate() { //process only primary participant params @@ -531,8 +524,6 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { * @param int $id * @param string $name * @param bool $viewOnly - * - * @return void */ public function buildCustom($id, $name, $viewOnly = FALSE) { if ($id) { @@ -629,6 +620,8 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { } /** + * Initiate event fee. + * * @param CRM_Core_Form $form * @param int $eventID * @@ -712,8 +705,6 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { * @param int $contactID * @param null $contribution * @param null $payment - * - * @return void */ public function confirmPostProcess($contactID = NULL, $contribution = NULL, $payment = NULL) { // add/update contact information @@ -815,6 +806,7 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { * * @param CRM_Core_Form $form * @param int $contactID + * * @return \CRM_Event_BAO_Participant */ public static function addParticipant(&$form, $contactID) { @@ -915,19 +907,15 @@ WHERE v.option_group_id = g.id return $participant; } - /* Calculate the total participant count as per params. - * - * @param array $params - * User params. - * - * @return $totalCount total participant count. - */ /** + * Calculate the total participant count as per params. + * * @param CRM_Core_Form $form * @param array $params + * User params. * @param bool $skipCurrent * - * @return int|string + * @return int */ public static function getParticipantCount(&$form, $params, $skipCurrent = FALSE) { $totalCount = 0; @@ -1012,21 +1000,17 @@ WHERE v.option_group_id = g.id return $totalCount; } - /* Format user submitted price set params. + /** + * Format user submitted price set params. + * * Convert price set each param as an array. * + * @param CRM_Core_Form $form * @param array $params * An array of user submitted params. * - * * @return array - * , formatted price set params. - */ - /** - * @param CRM_Core_Form $form - * @param array $params - * - * @return mixed + * Formatted price set params. */ public static function formatPriceSetParams(&$form, $params) { if (!is_array($params) || empty($params)) { @@ -1063,20 +1047,16 @@ WHERE v.option_group_id = g.id return $params; } - /* Calculate total count for each price set options. - * those are currently selected by user. - * - * @param $form - * Form object. + /** + * Calculate total count for each price set options. * + * - currently selected by user. * - * @return array - * , array of each option w/ count total. - */ - /** - * @param $form + * @param CRM_Core_Form $form + * Form object. * * @return array + * array of each option w/ count total. */ public static function getPriceSetOptionCount(&$form) { $params = $form->get('params'); @@ -1144,6 +1124,8 @@ WHERE v.option_group_id = g.id } /** + * Check if template file exists. + * * @param string $suffix * * @return null|string @@ -1165,6 +1147,8 @@ WHERE v.option_group_id = g.id } /** + * Get template file name. + * * @return null|string */ public function getTemplateFileName() { @@ -1173,6 +1157,8 @@ WHERE v.option_group_id = g.id } /** + * Override extra template name. + * * @return null|string */ public function overrideExtraTemplateFileName() { @@ -1184,7 +1170,7 @@ WHERE v.option_group_id = g.id * Reset values for all options those are full. * * @param array $optionFullIds - * @param $form + * @param CRM_Core_Form $form */ public static function resetElementValue($optionFullIds = array(), &$form) { if (!is_array($optionFullIds) || @@ -1253,6 +1239,8 @@ WHERE v.option_group_id = g.id } /** + * Reset submitted value. + * * @param string $elementName * @param array $optionIds * @param CRM_Core_form $form @@ -1298,8 +1286,9 @@ WHERE v.option_group_id = g.id } /** - * Validate price set submitted params for price option limit, - * as well as user should select at least one price field option. + * Validate price set submitted params for price option limit. + * + * User should select at least one price field option. * * @param CRM_Core_Form $form * @param array $params @@ -1433,7 +1422,9 @@ WHERE v.option_group_id = g.id } /** - * set the first participant ID if not set, CRM-10032 + * Set the first participant ID if not set. + * + * CRM-10032. * * @param int $participantID */ @@ -1458,6 +1449,8 @@ WHERE v.option_group_id = g.id } /** + * Check if event is valid. + * * @todo - combine this with CRM_Event_BAO_Event::validRegistrationRequest * (probably extract relevant values here & call that with them & handle bounces & redirects here -as * those belong in the form layer) diff --git a/CRM/Event/Form/Registration/Confirm.php b/CRM/Event/Form/Registration/Confirm.php index 052533502f..f32a03cc70 100644 --- a/CRM/Event/Form/Registration/Confirm.php +++ b/CRM/Event/Form/Registration/Confirm.php @@ -26,17 +26,12 @@ */ /** - * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 - * $Id$ - * */ /** - * This class generates form components for processing Event - * + * This class generates form components for processing Event. */ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { @@ -58,7 +53,6 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { * Set variables up before form is built. */ public function preProcess() { - parent::preProcess(); // lineItem isn't set until Register postProcess @@ -187,8 +181,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * Overwrite action, since we are only showing elements in frozen mode - * no help display needed + * Overwrite action, since we are only showing elements in frozen mode no help display needed. * * @return int */ @@ -388,9 +381,11 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * @param $fields - * @param $files - * @param $self + * Apply form rule. + * + * @param array $fields + * @param array $files + * @param CRM_Core_Form $self * * @return array|bool */ @@ -805,7 +800,8 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { $participantNum = NULL; $participantNum = $participantID; if ($participantID == $registerByID) { - $participantNum = 0; // is primary particpant + // This is the is primary participant. + $participantNum = 0; } else { if ($participantNum = array_search('participant', $copyParticipantCountLines)) { @@ -955,12 +951,12 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { * * @param CRM_Core_Form $form * @param array $params - * @param $result + * @param array $result * @param int $contactID * @param bool $pending * @param bool $isAdditionalAmount * - * @return void + * @return \CRM_Contribute_BAO_Contribution */ public static function processContribution( &$form, $params, $result, $contactID, @@ -1061,10 +1057,8 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { * Fix the Location Fields. * * @param array $params - * @param $fields + * @param array $fields * @param CRM_Core_Form $form - * - * @return void */ public static function fixLocationFields(&$params, &$fields, &$form) { if (!empty($form->_fields)) { @@ -1110,10 +1104,10 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { * * @param int $contactID * @param array $params - * @param $fields + * @param array $fields * @param CRM_Core_Form $form * - * @return void + * @return int */ public static function updateContactFields($contactID, $params, $fields, &$form) { //add the contact to group, if add to group is selected for a @@ -1205,7 +1199,9 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { } /** - * @param $form + * Assign Profiles. + * + * @param CRM_Core_Form $form */ public static function assignProfiles(&$form) { $participantParams = $form->_params; diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 5c0f9055d9..988190f01c 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -26,14 +26,12 @@ */ /** - * - * * @package CRM * @copyright CiviCRM LLC (c) 2004-2015 */ /** - * This class generates form components for processing Event + * This class generates form components for processing Event. */ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { @@ -48,11 +46,17 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { protected $_waitlistMsg = NULL; protected $_requireApprovalMsg = NULL; + /** + * Deprecated parameter that we hope to remove. + * + * @var bool + */ public $_quickConfig = NULL; /** - * Allow developer to use hook_civicrm_buildForm() - * to override the registration dupe check + * Skip duplicate check. + * + * This can be set using hook_civicrm_buildForm() to override the registration dupe check. * CRM-7604 */ public $_skipDupeRegistrationCheck = FALSE; @@ -60,12 +64,17 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { public $_paymentProcessorID; /** + * Show fee block or not. + * * @var boolean determines if fee block should be shown or hidden */ public $_noFees; /** - * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl + * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). + * + * This is rendered via billingBlock.tpl. + * * @var array */ public $_paymentFields = array(); @@ -266,6 +275,8 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /** * Build the form object. + * + * @return void */ public function buildQuickForm() { // build profiles first so that we can determine address fields etc diff --git a/CRM/Import/DataSource/CSV.php b/CRM/Import/DataSource/CSV.php index 54218d7fa1..3960d1fc63 100644 --- a/CRM/Import/DataSource/CSV.php +++ b/CRM/Import/DataSource/CSV.php @@ -46,6 +46,8 @@ class CRM_Import_DataSource_CSV extends CRM_Import_DataSource { /** * Set variables up before form is built. + * + * @param CRM_Core_Form $form */ public function preProcess(&$form) { } diff --git a/CRM/Pledge/Controller/Search.php b/CRM/Pledge/Controller/Search.php index 2bfd9e2f88..01342697b4 100644 --- a/CRM/Pledge/Controller/Search.php +++ b/CRM/Pledge/Controller/Search.php @@ -45,6 +45,10 @@ class CRM_Pledge_Controller_Search extends CRM_Core_Controller { /** * Class constructor. + * + * @param string $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { diff --git a/CRM/Report/Form/Contact/Summary.php b/CRM/Report/Form/Contact/Summary.php index 8e8eff4654..d496b526f4 100644 --- a/CRM/Report/Form/Contact/Summary.php +++ b/CRM/Report/Form/Contact/Summary.php @@ -273,7 +273,15 @@ class CRM_Report_Form_Contact_Summary extends CRM_Report_Form { } /** - * @param $rows + * Initialise basic row. + * + * @param array $rows + * + * @param bool $entryFound + * @param array $row + * @param int $rowId + * @param int $rowNum + * @param array $types * * @return bool */ diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index 1b73fc7f09..ce9d2788fc 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -92,7 +92,15 @@ abstract class CRM_SMS_Provider { abstract public function send($recipients, $header, $message, $dncID = NULL); /** - * Return message text. Child class could override this function to have better control over the message being sent. + * Return message text. + * + * Child class could override this function to have better control over the message being sent. + * + * @param string $message + * @param int $contactID + * @param array $contactDetails + * + * @return string */ public function getMessage($message, $contactID, $contactDetails) { $html = $message->getHTMLBody(); @@ -102,8 +110,10 @@ abstract class CRM_SMS_Provider { } /** - * @param $fields - * @param $additionalDetails + * Get recipient details. + * + * @param array $fields + * @param array $additionalDetails * * @return mixed */ diff --git a/CRM/UF/Page/Group.php b/CRM/UF/Page/Group.php index 55a4823e23..d3ab1a54ca 100644 --- a/CRM/UF/Page/Group.php +++ b/CRM/UF/Page/Group.php @@ -379,9 +379,7 @@ class CRM_UF_Page_Group extends CRM_Core_Page { * @param int $id * Uf group id. * - * @param $action - * - * @return void + * @param int $action */ public function preview($id, $action) { $controller = new CRM_Core_Controller_Simple('CRM_UF_Form_Preview', ts('CiviCRM Profile Group Preview'), NULL); diff --git a/CRM/Upgrade/Incremental/Base.php b/CRM/Upgrade/Incremental/Base.php index d4eb3113e7..5b19b3b20c 100644 --- a/CRM/Upgrade/Incremental/Base.php +++ b/CRM/Upgrade/Incremental/Base.php @@ -63,7 +63,6 @@ class CRM_Upgrade_Incremental_Base { * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { } diff --git a/CRM/Upgrade/Incremental/php/FourFive.php b/CRM/Upgrade/Incremental/php/FourFive.php index 44bdf3bdf1..d9fef968e1 100755 --- a/CRM/Upgrade/Incremental/php/FourFive.php +++ b/CRM/Upgrade/Incremental/php/FourFive.php @@ -37,7 +37,6 @@ class CRM_Upgrade_Incremental_php_FourFive extends CRM_Upgrade_Incremental_Base * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { if ($rev == '4.5.alpha1') { diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index 3b68ed460e..080a15ece4 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -40,9 +40,7 @@ class CRM_Upgrade_Incremental_php_FourFour extends CRM_Upgrade_Incremental_Base * @param $preUpgradeMessage * @param string $rev * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'. - * @param null $currentVer - * - * @return void + * @param string $currentVer */ public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { if ($rev == '4.4.beta1') { @@ -68,7 +66,6 @@ class CRM_Upgrade_Incremental_php_FourFour extends CRM_Upgrade_Incremental_Base * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { if ($rev == '4.4.1') { @@ -352,11 +349,11 @@ ALTER TABLE civicrm_dashboard } /** - * @param $rev - * @param $originalVer - * @param $latestVer + * Upgrade script for 4.4.7. * - * @return void + * @param string $rev + * @param string $originalVer + * @param string $latestVer */ public function upgrade_4_4_7($rev, $originalVer, $latestVer) { // For WordPress/Joomla(?), cleanup broken image_URL from 4.4.6 upgrades - https://issues.civicrm.org/jira/browse/CRM-14971 diff --git a/CRM/Upgrade/Incremental/php/FourOne.php b/CRM/Upgrade/Incremental/php/FourOne.php index ba9ede212e..d5bbd49ebb 100644 --- a/CRM/Upgrade/Incremental/php/FourOne.php +++ b/CRM/Upgrade/Incremental/php/FourOne.php @@ -60,8 +60,6 @@ class CRM_Upgrade_Incremental_php_FourOne { * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { if ($rev == '4.1.alpha1') { diff --git a/CRM/Upgrade/Incremental/php/FourSeven.php b/CRM/Upgrade/Incremental/php/FourSeven.php index 1b986b1b57..06734d693f 100644 --- a/CRM/Upgrade/Incremental/php/FourSeven.php +++ b/CRM/Upgrade/Incremental/php/FourSeven.php @@ -35,12 +35,10 @@ class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base * Note: This function is called iteratively for each upcoming * revision to the database. * - * @param $preUpgradeMessage + * @param string $preUpgradeMessage * @param string $rev * a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'. * @param null $currentVer - * - * @return void */ public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { if ($rev == '4.7.alpha1') { @@ -70,7 +68,6 @@ class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { if ($rev == '4.7.alpha1') { diff --git a/CRM/Upgrade/Incremental/php/FourSix.php b/CRM/Upgrade/Incremental/php/FourSix.php index 6d88270366..2c1f3113b2 100644 --- a/CRM/Upgrade/Incremental/php/FourSix.php +++ b/CRM/Upgrade/Incremental/php/FourSix.php @@ -37,7 +37,6 @@ class CRM_Upgrade_Incremental_php_FourSix extends CRM_Upgrade_Incremental_Base { * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { if ($rev == '4.6.alpha1') { diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index ffcbb9ba5c..30e5379f49 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -36,12 +36,12 @@ class CRM_Upgrade_Incremental_php_FourThree extends CRM_Upgrade_Incremental_Base * Note: This function is called iteratively for each upcoming * revision to the database. * - * @param $preUpgradeMessage + * @param string $preUpgradeMessage * @param string $rev * a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'. * @param null $currentVer * - * @return void|bool + * @return bool */ public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { if ($rev == '4.3.beta3') { diff --git a/CRM/Upgrade/Incremental/php/FourTwo.php b/CRM/Upgrade/Incremental/php/FourTwo.php index 2954d3fb80..53769370e5 100644 --- a/CRM/Upgrade/Incremental/php/FourTwo.php +++ b/CRM/Upgrade/Incremental/php/FourTwo.php @@ -38,12 +38,12 @@ class CRM_Upgrade_Incremental_php_FourTwo extends CRM_Upgrade_Incremental_Base { * Note: This function is called iteratively for each upcoming * revision to the database. * - * @param $preUpgradeMessage + * @param string $preUpgradeMessage * @param string $rev * a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'. * @param null $currentVer * - * @return void + * @return bool */ public function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { if ($rev == '4.2.alpha1') { @@ -139,7 +139,6 @@ INNER JOIN civicrm_price_set cps ON cps.id = cpf.price_set_id AND cps.name <>'de * alterable. * @param string $rev * an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs. - * @return void */ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) { if ($rev == '4.2.beta5') { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php index 3d24ceb988..66b8d444a7 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -180,10 +180,7 @@ WHERE %2.id = %1"; * to the price set used for particular event * @param array $values * Reference to the values array(. - * this is - * lineItem array) - * - * @return void + * this is lineItem array) */ public static function format($fid, &$params, &$fields, &$values) { if (empty($params["price_{$fid}"])) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index 653f0b5eec..b053763d84 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -764,8 +764,6 @@ WHERE id = %1"; * Build the price set form. * * @param CRM_Core_Form $form - * - * @return void */ public static function buildPriceSet(&$form) { $priceSetId = $form->get('priceSetId'); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index 36febeb338..ffcd7cdcfe 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -427,7 +427,6 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { * * @param array $values * (reference) the array up for enhancing. - * @return void */ public static function addDisplayEnums(&$values) { $enumFields = &Snapshot_v4p2_Price_DAO_Field::getEnums(); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php index f869239629..df11370340 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php @@ -281,7 +281,9 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { } /** - * returns the list of fields that can be imported. + * Returns the list of fields that can be imported. + * + * @param bool $prefix * * @return array */ diff --git a/CRM/Utils/Network.php b/CRM/Utils/Network.php index a2c7b0f7ea..2027df7e68 100644 --- a/CRM/Utils/Network.php +++ b/CRM/Utils/Network.php @@ -64,7 +64,13 @@ class CRM_Utils_Network { } /** - * Check whether a TCP service is available on $host and $port + * Check whether a TCP service is available on $host and $port. + * + * @param string $host + * @param string $port + * @param string $serverConnectionTimeOut + * + * @return bool */ public static function checkService($host, $port, $serverConnectionTimeOut) { $old_error_reporting = error_reporting(); diff --git a/Civi/API/Event/Event.php b/Civi/API/Event/Event.php index ca8adbd557..36c09215b5 100644 --- a/Civi/API/Event/Event.php +++ b/Civi/API/Event/Event.php @@ -57,6 +57,7 @@ class Event extends \Symfony\Component\EventDispatcher\Event { * The API responsible for executing the request. * @param array $apiRequest * The full description of the API request. + * @param \Civi\API\Kernel $apiKernel */ public function __construct($apiProvider, $apiRequest, $apiKernel) { $this->apiKernel = $apiKernel; @@ -65,6 +66,8 @@ class Event extends \Symfony\Component\EventDispatcher\Event { } /** + * Get api kernel. + * * @return \Civi\API\Kernel */ public function getApiKernel() { diff --git a/api/v3/Generic.php b/api/v3/Generic.php index 090970a584..d8f35dd467 100644 --- a/api/v3/Generic.php +++ b/api/v3/Generic.php @@ -350,6 +350,7 @@ function civicrm_api3_generic_getvalue($apiRequest) { * Get count of contact references. * * @param array $params + * @param array $apiRequest */ function _civicrm_api3_generic_getrefcount_spec(&$params, $apiRequest) { $params['id']['api.required'] = 1; diff --git a/api/v3/Generic/Getlist.php b/api/v3/Generic/Getlist.php index 20134c1578..683fb44c24 100644 --- a/api/v3/Generic/Getlist.php +++ b/api/v3/Generic/Getlist.php @@ -80,6 +80,7 @@ function civicrm_api3_generic_getList($apiRequest) { * @param string $entity * @param array $request * @param array $apiDefaults + * @param array $fields */ function _civicrm_api3_generic_getList_defaults($entity, &$request, $apiDefaults, $fields) { $config = CRM_Core_Config::singleton(); diff --git a/tests/phpunit/WebTest/Utils/RedirectTest.php b/tests/phpunit/WebTest/Utils/RedirectTest.php index 003a2d2281..39d5df94d0 100644 --- a/tests/phpunit/WebTest/Utils/RedirectTest.php +++ b/tests/phpunit/WebTest/Utils/RedirectTest.php @@ -80,7 +80,10 @@ class WebTest_Utils_RedirectTest extends CiviUnitTestCase { } /** + * Try redirect. * + * @param string $input_url + * @param string $expected_url */ private function tryRedirect($input_url, $expected_url) { // file_put_contents('php://stderr', $input_url . "\n", FILE_APPEND); -- 2.25.1