From ca87146b384db57a8c7d19f93a48657cab1987b8 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 15:57:11 +1300 Subject: [PATCH] comment fixes --- CRM/Core/InnoDBIndexer.php | 16 +++++++++++----- CRM/Core/Payment/PaymentExpress.php | 2 -- CRM/Event/Cart/BAO/EventInCart.php | 5 ++++- CRM/Event/Form/Registration/Confirm.php | 7 +++++++ CRM/Event/Import/Controller.php | 4 ++++ CRM/Event/StateMachine/Search.php | 3 +++ CRM/Export/BAO/Export.php | 7 +++++++ CRM/Grant/StateMachine/Search.php | 3 +++ CRM/Group/Controller.php | 4 ++++ CRM/PCP/Form/PCPAccount.php | 4 +--- 10 files changed, 44 insertions(+), 11 deletions(-) diff --git a/CRM/Core/InnoDBIndexer.php b/CRM/Core/InnoDBIndexer.php index 7751aa5632..c677414a6d 100644 --- a/CRM/Core/InnoDBIndexer.php +++ b/CRM/Core/InnoDBIndexer.php @@ -127,7 +127,6 @@ class CRM_Core_InnoDBIndexer { * we have a static list of tables. */ public function fixSchemaDifferences() { - // foreach ($this->indices as $tableName => $ign) { $todoSqls = $this->reconcileIndexSqls($tableName); foreach ($todoSqls as $todoSql) { @@ -137,7 +136,7 @@ class CRM_Core_InnoDBIndexer { } /** - * Determine if an index is expected to exist + * Determine if an index is expected to exist. * * @param string $table * @param array $fields @@ -198,6 +197,7 @@ class CRM_Core_InnoDBIndexer { * FTS index. * * @param $table + * * @return array * (string $indexName => string $sql) */ @@ -213,9 +213,10 @@ class CRM_Core_InnoDBIndexer { } /** - * Generate a "DROP INDEX" statement for each existing FTS index + * Generate a "DROP INDEX" statement for each existing FTS index. * * @param string $table + * * @return array * (string $idxName => string $sql) */ @@ -232,7 +233,8 @@ class CRM_Core_InnoDBIndexer { * Construct a set of SQL statements which will create (or preserve) * required indices and destroy unneeded indices. * - * @param $table + * @param string $table + * * @return array */ public function reconcileIndexSqls($table) { @@ -260,7 +262,7 @@ class CRM_Core_InnoDBIndexer { } /** - * Put the indices into a normalized format + * Put the indices into a normalized format. * * @param $indices * @return array @@ -277,6 +279,8 @@ class CRM_Core_InnoDBIndexer { } /** + * Setter for isActive. + * * @param bool $isActive */ public function setActive($isActive) { @@ -284,6 +288,8 @@ class CRM_Core_InnoDBIndexer { } /** + * Getter for isActive. + * * @return bool */ public function getActive() { diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index ad7244aab7..0aba51b29e 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -128,8 +128,6 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { * * @param array $params * Assoc array of input parameters for this transaction. - * - * @return array|void */ public function doDirectPayment(&$params) { CRM_Core_Error::fatal(ts('This function is not implemented')); diff --git a/CRM/Event/Cart/BAO/EventInCart.php b/CRM/Event/Cart/BAO/EventInCart.php index 26d5721b74..457b12dcac 100644 --- a/CRM/Event/Cart/BAO/EventInCart.php +++ b/CRM/Event/Cart/BAO/EventInCart.php @@ -11,12 +11,15 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl public $participants = array(); /** + * Class constructor. */ public function __construct() { parent::__construct(); } /** + * Add participant to cart. + * * @param $participant */ public function add_participant($participant) { @@ -66,7 +69,7 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl foreach (array_keys($contacts_to_delete) as $contact_id) { CRM_Contact_BAO_Contact::deleteContact($contact_id); } - parent::delete(); + return parent::delete(); } /** diff --git a/CRM/Event/Form/Registration/Confirm.php b/CRM/Event/Form/Registration/Confirm.php index 0d087a8051..89b83cda24 100644 --- a/CRM/Event/Form/Registration/Confirm.php +++ b/CRM/Event/Form/Registration/Confirm.php @@ -393,6 +393,13 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration { $this->addFormRule(array('CRM_Event_Form_Registration_Confirm', 'formRule'), $this); } + /** + * @param $fields + * @param $files + * @param $self + * + * @return array|bool + */ public static function formRule($fields, $files, $self) { $errors = array(); $eventFull = CRM_Event_BAO_Participant::eventFull($self->_eventId, FALSE, CRM_Utils_Array::value('has_waitlist', $self->_values['event'])); diff --git a/CRM/Event/Import/Controller.php b/CRM/Event/Import/Controller.php index 8ed7be39f9..3917f4e6ad 100644 --- a/CRM/Event/Import/Controller.php +++ b/CRM/Event/Import/Controller.php @@ -36,6 +36,10 @@ class CRM_Event_Import_Controller extends CRM_Core_Controller { /** * Class constructor + * + * @param null $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/Event/StateMachine/Search.php b/CRM/Event/StateMachine/Search.php index 89e56c6a49..0df32088fc 100644 --- a/CRM/Event/StateMachine/Search.php +++ b/CRM/Event/StateMachine/Search.php @@ -43,6 +43,9 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { /** * Class constructor + * + * @param object $controller + * @param \const|int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index d991ee3b01..e01ec0eba8 100644 --- a/CRM/Export/BAO/Export.php +++ b/CRM/Export/BAO/Export.php @@ -1958,6 +1958,9 @@ LIMIT $offset, $limit /** * Manipulate header rows for relationship fields + * + * @param $headerRows + * @param $contactRelationshipTypes */ public static function manipulateHeaderRows(&$headerRows, $contactRelationshipTypes) { foreach ($headerRows as & $header) { @@ -1972,6 +1975,10 @@ LIMIT $offset, $limit /** * Exclude contacts who are deceased, have "Do not mail" privacy setting, * or have no street address + * @param $exportTempTable + * @param $headerRows + * @param $sqlColumns + * @param $exportParams */ public static function postalMailingFormat($exportTempTable, &$headerRows, &$sqlColumns, $exportParams) { $whereClause = array(); diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php index 6e6a596110..ba2c64548a 100644 --- a/CRM/Grant/StateMachine/Search.php +++ b/CRM/Grant/StateMachine/Search.php @@ -43,6 +43,9 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { /** * Class constructor + * + * @param object $controller + * @param \const|int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Group/Controller.php b/CRM/Group/Controller.php index 657ca23dc0..d84a32dfed 100644 --- a/CRM/Group/Controller.php +++ b/CRM/Group/Controller.php @@ -36,6 +36,10 @@ class CRM_Group_Controller extends CRM_Core_Controller { /** * Class constructor + * + * @param null $title + * @param bool|int $action + * @param bool $modal */ public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) { parent::__construct($title, $modal); diff --git a/CRM/PCP/Form/PCPAccount.php b/CRM/PCP/Form/PCPAccount.php index 1621a3375f..08f96e7440 100644 --- a/CRM/PCP/Form/PCPAccount.php +++ b/CRM/PCP/Form/PCPAccount.php @@ -34,15 +34,13 @@ */ /** - * This class generates form components for processing a ontribution - * + * This class generates form components for processing a contribution. */ class CRM_PCP_Form_PCPAccount extends CRM_Core_Form { /** * Variable defined for Contribution Page Id */ - public $_pageId = NULL; public $_id = NULL; public $_component = NULL; -- 2.25.1