From 2e2605fe44474eb861c337eeeedc1717b7bcc84f Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Mon, 2 Feb 2015 21:40:51 +1300 Subject: [PATCH] more comment fixes --- CRM/Activity/BAO/ActivityContact.php | 2 +- CRM/Activity/BAO/Query.php | 5 +-- CRM/Activity/Form/Search.php | 5 +-- CRM/Activity/Form/Task/Batch.php | 11 +----- CRM/Activity/Form/Task/Delete.php | 2 +- CRM/Activity/Form/Task/Print.php | 2 +- CRM/Activity/Import/Controller.php | 3 +- CRM/Activity/Import/Parser.php | 2 +- CRM/Activity/Selector/Search.php | 4 +-- CRM/Activity/StateMachine/Search.php | 5 +-- CRM/Activity/Task.php | 6 ++-- CRM/Contact/BAO/Contact.php | 3 ++ CRM/Contact/Controller/Search.php | 6 +++- CRM/Contact/Form/Edit/TagsAndGroups.php | 9 +++++ .../Form/Search/Custom/FullText/Activity.php | 9 +++++ .../Form/Search/Custom/FullText/Contact.php | 7 ++++ .../Search/Custom/FullText/Participant.php | 6 ++++ .../Form/Search/Custom/RandomSegment.php | 3 ++ CRM/Core/BAO/RecurringEntity.php | 15 ++++++-- CRM/Core/Form/RecurringEntity.php | 5 +++ CRM/Core/I18n/SchemaStructure_4_5_beta2.php | 10 ++++++ CRM/Core/ManagedEntities.php | 5 +++ CRM/Core/Payment/PayPalIPN.php | 5 +++ CRM/Core/StateMachine.php | 24 ++++++------- CRM/Event/PseudoConstant.php | 5 +++ CRM/Group/StateMachine.php | 5 ++- CRM/Member/Import/Controller.php | 6 +++- CRM/Member/StateMachine/Search.php | 7 ++-- CRM/PCP/Controller/PCP.php | 6 +++- CRM/Pledge/Page/Tab.php | 5 +++ CRM/Pledge/StateMachine/Search.php | 5 ++- CRM/Price/BAO/PriceField.php | 11 ++++-- CRM/Upgrade/Incremental/php/FourSix.php | 18 ++++++++-- CRM/Utils/PDF/Utils.php | 11 ++++++ CRM/Utils/QueryFormatter.php | 34 +++++++++++++++++++ .../Exception/MultipleActivityException.php | 5 +++ api/v3/Pledge.php | 3 ++ tests/phpunit/CiviTest/Custom.php | 9 +++-- 38 files changed, 222 insertions(+), 62 deletions(-) diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index 32ca64447d..20aae7cab8 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -47,7 +47,7 @@ class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact } /** - * Funtion to add activity contact + * Function to add activity contact. * * @param array $params * The values for this table: activity id, contact id, record type. diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index a24f4c02dd..0dd18450e6 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -30,16 +30,13 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ - * */ class CRM_Activity_BAO_Query { /** - * Build select for Case + * Build select for Case. * * @param $query - * - * @return void */ public static function select(&$query) { if (!empty($query->_returnProperties['activity_id'])) { diff --git a/CRM/Activity/Form/Search.php b/CRM/Activity/Form/Search.php index 9c30ef073f..3f08965337 100644 --- a/CRM/Activity/Form/Search.php +++ b/CRM/Activity/Form/Search.php @@ -191,12 +191,9 @@ class CRM_Activity_Form_Search extends CRM_Core_Form_Search { * 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 * done. + * * The processing consists of using a Selector / Controller framework for getting the * search results. - * - * @param - * - * @return void */ public function postProcess() { if ($this->_done) { diff --git a/CRM/Activity/Form/Task/Batch.php b/CRM/Activity/Form/Task/Batch.php index a60c9a7103..518f69e473 100755 --- a/CRM/Activity/Form/Task/Batch.php +++ b/CRM/Activity/Form/Task/Batch.php @@ -95,10 +95,7 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { } /** - * Build the form object - * - * - * @return void + * Build the form object. */ public function buildQuickForm() { $ufGroupId = $this->get('ufGroupId'); @@ -199,9 +196,6 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { /** * Set default values for the form. - * - * - * @return void */ public function setDefaultValues() { if (empty($this->_fields)) { @@ -219,9 +213,6 @@ class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task { /** * Process the form after the input has been submitted and validated - * - * - * @return void */ public function postProcess() { $params = $this->exportValues(); diff --git a/CRM/Activity/Form/Task/Delete.php b/CRM/Activity/Form/Task/Delete.php index d6ceb4de4d..1a29df0441 100755 --- a/CRM/Activity/Form/Task/Delete.php +++ b/CRM/Activity/Form/Task/Delete.php @@ -35,7 +35,7 @@ /** * This class provides the functionality to delete a group of - * Activites. This class provides functionality for the actual + * Activities. This class provides functionality for the actual * deletion. */ class CRM_Activity_Form_Task_Delete extends CRM_Activity_Form_Task { diff --git a/CRM/Activity/Form/Task/Print.php b/CRM/Activity/Form/Task/Print.php index ccadc7837c..9897bcd62a 100644 --- a/CRM/Activity/Form/Task/Print.php +++ b/CRM/Activity/Form/Task/Print.php @@ -39,7 +39,7 @@ class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task { /** - * Build all the data structures needed to build the form + * Build all the data structures needed to build the form. * * @return void */ diff --git a/CRM/Activity/Import/Controller.php b/CRM/Activity/Import/Controller.php index f61c104165..e5f821ea1c 100644 --- a/CRM/Activity/Import/Controller.php +++ b/CRM/Activity/Import/Controller.php @@ -35,7 +35,8 @@ class CRM_Activity_Import_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. + * * @param null $title * @param bool|int $action * @param bool $modal diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index 02e9257379..ee2659d490 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -46,7 +46,7 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { protected $_fileSize; /** - * Seperator being used + * Separator being used. */ protected $_seperator; diff --git a/CRM/Activity/Selector/Search.php b/CRM/Activity/Selector/Search.php index 296c51f37e..f86cabccc1 100644 --- a/CRM/Activity/Selector/Search.php +++ b/CRM/Activity/Selector/Search.php @@ -202,7 +202,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM /** * Returns total number of rows for the query. * - * @param + * @param string $action * * @return int * Total number of rows @@ -217,7 +217,7 @@ class CRM_Activity_Selector_Search extends CRM_Core_Selector_Base implements CRM } /** - * Returns all the rows in the given offset and rowCount + * Returns all the rows in the given offset and rowCount. * * @param string $action * The action being performed. diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index 49cf8febb5..345f04bc13 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -41,9 +41,10 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * Class constructor + * Class constructor. + * * @param object $controller - * @param int $action + * @param \const|int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Activity/Task.php b/CRM/Activity/Task.php index 24c7827723..9f6c5aeb62 100644 --- a/CRM/Activity/Task.php +++ b/CRM/Activity/Task.php @@ -29,13 +29,11 @@ * @package CRM * @copyright CiviCRM LLC (c) 2004-2014 * $Id$ - * */ /** - * class to represent the actions that can be performed on a group of contacts - * used by the search forms - * + * Class to represent the actions that can be performed on a group of contacts + * used by the search forms. */ class CRM_Activity_Task { const diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index febc0c2dd9..9915717882 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -3212,6 +3212,9 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * @see hook_civicrm_triggerInfo * @see CRM_Core_DAO::triggerRebuild * @see http://issues.civicrm.org/jira/browse/CRM-10554 + * + * @param $info + * @param null $tableName */ public static function triggerInfo(&$info, $tableName = NULL) { //during upgrade, first check for valid version and then create triggers diff --git a/CRM/Contact/Controller/Search.php b/CRM/Contact/Controller/Search.php index 1d893fe81a..dad7c7cddd 100644 --- a/CRM/Contact/Controller/Search.php +++ b/CRM/Contact/Controller/Search.php @@ -47,7 +47,11 @@ class CRM_Contact_Controller_Search extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. + * + * @param string $title + * @param bool $modal + * @param int|mixed|null $action */ public function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) { parent::__construct($title, $modal); diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index 32e98b18b8..80d7eb2b82 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -184,6 +184,15 @@ class CRM_Contact_Form_Edit_TagsAndGroups { $form->assign('tagGroup', $form->_tagGroup); } + /** + * Climb tree. + * + * @param $form + * @param $tree + * @param $elements + * + * @return mixed + */ public static function climbtree($form, $tree, &$elements) { foreach ($tree as $tagID => $varValue) { $tagAttribute = array( diff --git a/CRM/Contact/Form/Search/Custom/FullText/Activity.php b/CRM/Contact/Form/Search/Custom/FullText/Activity.php index a8e122111f..c261ff3bf6 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Activity.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Activity.php @@ -42,6 +42,8 @@ class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_ } /** + * Is search active for this user. + * * @return bool */ public function isActive() { @@ -123,6 +125,13 @@ AND (ca.is_deleted = 0 OR ca.is_deleted IS NULL) return $tables;; } + /** + * Move IDs. + * + * @param string $fromTable + * @param string $toTable + * @param int $limit + */ public function moveIDs($fromTable, $toTable, $limit) { $sql = " INSERT INTO {$toTable} diff --git a/CRM/Contact/Form/Search/Custom/FullText/Contact.php b/CRM/Contact/Form/Search/Custom/FullText/Contact.php index 85631655e7..4e19cfd93d 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Contact.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Contact.php @@ -135,6 +135,13 @@ GROUP BY et.entity_id return $tables; } + /** + * Move IDs. + * + * @param $fromTable + * @param $toTable + * @param $limit + */ public function moveIDs($fromTable, $toTable, $limit) { $sql = " INSERT INTO {$toTable} diff --git a/CRM/Contact/Form/Search/Custom/FullText/Participant.php b/CRM/Contact/Form/Search/Custom/FullText/Participant.php index 59e1f0b612..35665773f6 100644 --- a/CRM/Contact/Form/Search/Custom/FullText/Participant.php +++ b/CRM/Contact/Form/Search/Custom/FullText/Participant.php @@ -109,6 +109,12 @@ WHERE ({$this->matchText('civicrm_contact c', array('sort_name', 'display_n return $tables; } + /** + * Move IDs. + * @param string $fromTable + * @param string $toTable + * @param int $limit + */ public function moveIDs($fromTable, $toTable, $limit) { $sql = " INSERT INTO {$toTable} diff --git a/CRM/Contact/Form/Search/Custom/RandomSegment.php b/CRM/Contact/Form/Search/Custom/RandomSegment.php index 228f3729e9..30078110dd 100644 --- a/CRM/Contact/Form/Search/Custom/RandomSegment.php +++ b/CRM/Contact/Form/Search/Custom/RandomSegment.php @@ -372,6 +372,9 @@ class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Sear return $dao->N; } + /** + * Destructor function. + */ public function __destruct() { // the temporary tables are dropped automatically // so we don't do it here diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index 0b74ca82d1..95a4bdc4fd 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -128,20 +128,29 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { ), ); + /** + * Getter for status. + * + * @return string + */ public static function getStatus() { return self::$status; } + /** + * Setter for status. + * + * @param string $status + */ public static function setStatus($status) { self::$status = $status; } /** - * Save records in civicrm_recujrring_entity table + * Save records in civicrm_recurring_entity table. * * @param array $params - * Reference array contains the values submitted by the form . - * + * Reference array contains the values submitted by the form. * * @return object */ diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 8dbed40139..c202188193 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -150,6 +150,11 @@ class CRM_Core_Form_RecurringEntity { return $defaults; } + /** + * Build form. + * + * @param $form + */ public static function buildQuickForm(&$form) { if (self::$_entityTable) { $entityType = explode("_", self::$_entityTable); diff --git a/CRM/Core/I18n/SchemaStructure_4_5_beta2.php b/CRM/Core/I18n/SchemaStructure_4_5_beta2.php index 8131ac8d14..9fa762398f 100644 --- a/CRM/Core/I18n/SchemaStructure_4_5_beta2.php +++ b/CRM/Core/I18n/SchemaStructure_4_5_beta2.php @@ -192,6 +192,11 @@ class CRM_Core_I18n_SchemaStructure_4_5_beta2 { return $result; } + /** + * Get indices. + * + * @return array + */ public static function &indices() { static $result = NULL; if (!$result) { @@ -230,6 +235,11 @@ class CRM_Core_I18n_SchemaStructure_4_5_beta2 { return $result; } + /** + * Get tables. + * + * @return array + */ public static function &tables() { static $result = NULL; if (!$result) { diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index 16ac0ad2fd..66db51e959 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -345,6 +345,11 @@ class CRM_Core_ManagedEntities { } } + /** + * Get declarations. + * + * @return array|null + */ public function getDeclarations() { if ($this->declarations === NULL) { $this->declarations = array(); diff --git a/CRM/Core/Payment/PayPalIPN.php b/CRM/Core/Payment/PayPalIPN.php index 0d2996af73..ba1262ea8e 100644 --- a/CRM/Core/Payment/PayPalIPN.php +++ b/CRM/Core/Payment/PayPalIPN.php @@ -290,6 +290,11 @@ class CRM_Core_Payment_PayPalIPN extends CRM_Core_Payment_BaseIPN { $this->completeTransaction($input, $ids, $objects, $transaction, $recur); } + /** + * Main function. + * + * @return bool + */ public function main() { //@todo - this could be refactored like PayPalProIPN & a test could be added diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index 02517aabaf..d41330b956 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -100,7 +100,7 @@ class CRM_Core_StateMachine { } /** - * Getter for name + * Getter for name. * * @return string */ @@ -109,7 +109,7 @@ class CRM_Core_StateMachine { } /** - * Setter for name + * Setter for name. * * @param string $name * @@ -120,7 +120,9 @@ class CRM_Core_StateMachine { } /** - * Do a state transition jump. Currently only supported types are + * Do a state transition jump. + * + * Currently only supported types are * Next and Back. The other actions (Cancel, Done, Submit etc) do * not need the state machine to figure out where to go * @@ -171,7 +173,7 @@ class CRM_Core_StateMachine { } /** - * Helper function to add a State to the state machine + * Helper function to add a State to the state machine. * * @param string $name * The internal name. @@ -189,7 +191,7 @@ class CRM_Core_StateMachine { } /** - * Given a name find the corresponding state + * Given a name find the corresponding state. * * @param string $name * The state name. @@ -207,7 +209,7 @@ class CRM_Core_StateMachine { } /** - * Return the list of state objects + * Return the list of state objects. * * @return array * array of states in the state machine @@ -255,18 +257,12 @@ class CRM_Core_StateMachine { } /** - * AddSequentialStates: meta level function to create a simple - * wizard for a state machine that is completely sequential. + * Add sequential pages. * + * Meta level function to create a simple wizard for a state machine that is completely sequential. * * @param array $pages * (reference ) the array of page objects. - * - * @internal param array $states states is an array of arrays. Each element - * of the top level array describes a state. Each state description - * includes the name, the display name and the class name - * - * @return void */ public function addSequentialPages(&$pages) { $this->_pages = &$pages; diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index 9138c9ede0..4d5d14b3e5 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -156,6 +156,11 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { return self::$participantStatus[$index]; } + /** + * Get participant status class options. + * + * @return array + */ public static function participantStatusClassOptions() { return array( 'Positive' => ts('Positive'), diff --git a/CRM/Group/StateMachine.php b/CRM/Group/StateMachine.php index 0cf651290c..77e4448aaf 100644 --- a/CRM/Group/StateMachine.php +++ b/CRM/Group/StateMachine.php @@ -35,7 +35,10 @@ class CRM_Group_StateMachine extends CRM_Core_StateMachine { /** - * Class constructor + * 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/Member/Import/Controller.php b/CRM/Member/Import/Controller.php index f6e70a1b3a..5cf03f58a7 100644 --- a/CRM/Member/Import/Controller.php +++ b/CRM/Member/Import/Controller.php @@ -35,7 +35,11 @@ class CRM_Member_Import_Controller extends CRM_Core_Controller { /** - * Class constructor + * Class constructor. + * + * @param string $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/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php index c0aa52c0cb..b7397cfde9 100644 --- a/CRM/Member/StateMachine/Search.php +++ b/CRM/Member/StateMachine/Search.php @@ -42,7 +42,10 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * Class constructor + * Class constructor. + * + * @param object $controller + * @param \const|int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -91,7 +94,7 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { } /** - * Return the form name of the task + * Return the form name of the task. * * @return string */ diff --git a/CRM/PCP/Controller/PCP.php b/CRM/PCP/Controller/PCP.php index 7bd50976a2..a00486ca93 100644 --- a/CRM/PCP/Controller/PCP.php +++ b/CRM/PCP/Controller/PCP.php @@ -47,7 +47,11 @@ class CRM_PCP_Controller_PCP extends CRM_Core_Controller { /** - * Class constructor + * 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/Pledge/Page/Tab.php b/CRM/Pledge/Page/Tab.php index 9714348352..7b131f6335 100644 --- a/CRM/Pledge/Page/Tab.php +++ b/CRM/Pledge/Page/Tab.php @@ -154,6 +154,11 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { return parent::run(); } + /** + * Get context. + * + * @param $form + */ public static function setContext(&$form) { $context = CRM_Utils_Request::retrieve('context', 'String', $form, FALSE, 'search'); diff --git a/CRM/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php index a6b05372d1..74fe68e380 100644 --- a/CRM/Pledge/StateMachine/Search.php +++ b/CRM/Pledge/StateMachine/Search.php @@ -42,7 +42,10 @@ class CRM_Pledge_StateMachine_Search extends CRM_Core_StateMachine { protected $_task; /** - * Class constructor + * 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/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index b837aedd1f..dc7e7c0f44 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -190,13 +190,20 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * Value we want to set the is_active field. * * @return Object - * DAO object on sucess, null otherwise - * + * DAO object on success, null otherwise. */ public static function setIsActive($id, $is_active) { return CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceField', $id, 'is_active', $is_active); } + /** + * Freeze form if the event is full. + * + * @param $element + * @param $fieldOptions + * + * @return null + */ public static function freezeIfEnabled(&$element, $fieldOptions) { if (!empty($fieldOptions['is_full'])) { $element->freeze(); diff --git a/CRM/Upgrade/Incremental/php/FourSix.php b/CRM/Upgrade/Incremental/php/FourSix.php index 0e8a6a28d5..1b25a5309c 100644 --- a/CRM/Upgrade/Incremental/php/FourSix.php +++ b/CRM/Upgrade/Incremental/php/FourSix.php @@ -112,13 +112,25 @@ class CRM_Upgrade_Incremental_php_FourSix { $queue->createItem($task, array('weight' => -1)); } + /** + * Upgrade function. + * + * @param string $rev + */ function upgrade_4_6_alpha3($rev) { - // task to process sql + // Task to process sql. $this->addTask(ts('Add and update reference_date column for Schedule Reminders'), 'updateReferenceDate'); } - // CRM-15728, Add new column reference_date to civicrm_action_log in order to track - // actual action_start_date for membership entity for only those schedule reminders which are not repeatable + /** + * Add new column reference_date to civicrm_action_log in order to track. + * + * CRM-15728, actual action_start_date for membership entity for only those schedule reminders which are not repeatable + * + * @param \CRM_Queue_TaskContext $ctx + * + * @return bool + */ static function updateReferenceDate(CRM_Queue_TaskContext $ctx) { //Add column civicrm_action_log.reference_date if not exists $sql = "SELECT count(*) FROM information_schema.columns WHERE table_schema = database() AND table_name = 'civicrm_action_log' AND COLUMN_NAME = 'reference_date' "; diff --git a/CRM/Utils/PDF/Utils.php b/CRM/Utils/PDF/Utils.php index 0e9f00c6d8..cfb4de1f00 100644 --- a/CRM/Utils/PDF/Utils.php +++ b/CRM/Utils/PDF/Utils.php @@ -124,6 +124,17 @@ class CRM_Utils_PDF_Utils { } } + /** + * Convert html to tcpdf. + * + * @param $paper_size + * @param $orientation + * @param $margins + * @param $html + * @param $output + * @param $fileName + * @param $stationery_path + */ public static function _html2pdf_tcpdf($paper_size, $orientation, $margins, $html, $output, $fileName, $stationery_path) { // Documentation on the TCPDF library can be found at: http://www.tcpdf.org // This function also uses the FPDI library documented at: http://www.setasign.com/products/fpdi/about/ diff --git a/CRM/Utils/QueryFormatter.php b/CRM/Utils/QueryFormatter.php index 81023a58c0..14694b1cf2 100644 --- a/CRM/Utils/QueryFormatter.php +++ b/CRM/Utils/QueryFormatter.php @@ -144,6 +144,14 @@ class CRM_Utils_QueryFormatter { return $text; } + /** + * Format Fts. + * + * @param string $text + * @param $mode + * + * @return mixed + */ protected function _formatFts($text, $mode) { $result = NULL; @@ -187,6 +195,14 @@ class CRM_Utils_QueryFormatter { return $this->dedupeWildcards($result, '%'); } + /** + * Format FTS. + * + * @param string $text + * @param $mode + * + * @return mixed + */ protected function _formatFtsBool($text, $mode) { $result = NULL; @@ -238,6 +254,14 @@ class CRM_Utils_QueryFormatter { return $this->dedupeWildcards($result, '%'); } + /** + * Format like. + * + * @param $text + * @param $mode + * + * @return mixed + */ protected function _formatLike($text, $mode) { $result = NULL; @@ -309,6 +333,11 @@ class CRM_Utils_QueryFormatter { return $text; } + /** + * Get modes. + * + * @return array + */ public static function getModes() { return array( self::MODE_NONE, @@ -319,6 +348,11 @@ class CRM_Utils_QueryFormatter { ); } + /** + * Get languages. + * + * @return array + */ public static function getLanguages() { return array( self::LANG_SOLR, diff --git a/Civi/CCase/Exception/MultipleActivityException.php b/Civi/CCase/Exception/MultipleActivityException.php index da80ed3d22..9a23be272f 100644 --- a/Civi/CCase/Exception/MultipleActivityException.php +++ b/Civi/CCase/Exception/MultipleActivityException.php @@ -1,6 +1,11 @@