From 76e7a76c36e82fca4901e87abf8f1afddf2384ef Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Mon, 12 Jan 2015 21:13:48 -0500 Subject: [PATCH] INFRA-132 - Cleanup stray comments --- CRM/Activity/Page/UserDashboard.php | 4 +- CRM/Activity/StateMachine/Search.php | 5 +- CRM/Case/Audit/AuditConfig.php | 42 ++---- CRM/Case/Page/CaseDetails.php | 2 +- CRM/Case/Page/DashBoard.php | 2 +- CRM/Case/Page/Tab.php | 6 +- CRM/Contact/BAO/Relationship.php | 19 ++- CRM/Contact/Page/DedupeException.php | 2 +- CRM/Contact/Page/View/ContactSmartGroup.php | 4 +- CRM/Contact/Page/View/GroupContact.php | 6 +- CRM/Contact/Page/View/Log.php | 4 +- CRM/Contact/Page/View/Note.php | 6 +- CRM/Contact/Page/View/Relationship.php | 8 +- CRM/Contact/Page/View/Sunlight.php | 4 +- CRM/Contact/Page/View/Tag.php | 4 +- .../Page/View/UserDashBoard/GroupContact.php | 6 +- CRM/Contribute/Form/AdditionalInfo.php | 5 +- CRM/Contribute/Form/Task/Invoice.php | 16 +-- CRM/Contribute/Page/ContributionRecur.php | 2 +- CRM/Contribute/Page/DashBoard.php | 2 +- CRM/Contribute/Page/SubscriptionStatus.php | 2 +- CRM/Contribute/Page/Tab.php | 8 +- CRM/Contribute/Page/UserDashboard.php | 4 +- CRM/Core/BAO/Phone.php | 2 +- CRM/Core/BAO/UFMatch.php | 4 +- CRM/Core/Permission.php | 7 +- CRM/Core/SelectValues.php | 127 ++++++++++++++---- CRM/Event/BAO/Participant.php | 4 - CRM/Event/Page/DashBoard.php | 2 +- CRM/Event/Page/Tab.php | 10 +- CRM/Event/Page/UserDashboard.php | 4 +- CRM/Financial/BAO/PaymentProcessor.php | 12 +- CRM/Grant/Page/DashBoard.php | 2 +- CRM/Grant/Page/Tab.php | 8 +- CRM/Mailing/BAO/TrackableURL.php | 3 +- CRM/Mailing/Page/Tab.php | 4 +- CRM/Member/Page/DashBoard.php | 2 +- CRM/Member/Page/Tab.php | 15 ++- CRM/Member/Page/UserDashboard.php | 4 +- CRM/Pledge/Page/DashBoard.php | 2 +- CRM/Pledge/Page/Payment.php | 4 +- CRM/Pledge/Page/Tab.php | 8 +- CRM/Pledge/Page/UserDashboard.php | 4 +- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 4 +- .../Snapshot/V4p2/Price/DAO/FieldValue.php | 4 +- .../Snapshot/V4p2/Price/DAO/LineItem.php | 4 +- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php | 4 +- .../Snapshot/V4p2/Price/DAO/SetEntity.php | 4 +- CRM/Utils/Mail.php | 1 - 49 files changed, 224 insertions(+), 188 deletions(-) diff --git a/CRM/Activity/Page/UserDashboard.php b/CRM/Activity/Page/UserDashboard.php index 824540bbc8..04f1eb9b3c 100644 --- a/CRM/Activity/Page/UserDashboard.php +++ b/CRM/Activity/Page/UserDashboard.php @@ -41,7 +41,7 @@ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoar /** * List participations for the UF user * - * return null + * @return null */ public function listActivities() { @@ -68,7 +68,7 @@ class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoar * the main function that is called when the page * loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { parent::preProcess(); diff --git a/CRM/Activity/StateMachine/Search.php b/CRM/Activity/StateMachine/Search.php index 3525c17356..84a0752e38 100644 --- a/CRM/Activity/StateMachine/Search.php +++ b/CRM/Activity/StateMachine/Search.php @@ -43,7 +43,7 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { /** * Class constructor * @param object $controller - * @param \const|int $action + * @param int $action */ public function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -105,9 +105,6 @@ class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine { * beginning from the final state, but retain the same session * values * - * @return boolean - */ - /** * @return bool */ public function shouldReset() { diff --git a/CRM/Case/Audit/AuditConfig.php b/CRM/Case/Audit/AuditConfig.php index 4a2beeb9aa..03f28fe998 100644 --- a/CRM/Case/Audit/AuditConfig.php +++ b/CRM/Case/Audit/AuditConfig.php @@ -131,12 +131,9 @@ class CRM_Case_Audit_AuditConfig { } } - /* inRegion - * - * Check if label $n is explicitly listed in region $r in the config. - */ - /** + * Check if label $n is explicitly listed in region $r in the config. + * * @param $n * @param $r * @@ -151,12 +148,9 @@ class CRM_Case_Audit_AuditConfig { } } - /* includeInRegion - * - * Should field $n be included in region $r, taking into account exclusion rules. - */ - /** + * Should field $n be included in region $r, taking into account exclusion rules. + * * @param $n * @param $r * @@ -176,12 +170,9 @@ class CRM_Case_Audit_AuditConfig { return $add_it; } - /* includeTime - * - * Should the time component of field $n in region $r be displayed? - */ - /** + * Should the time component of field $n in region $r be displayed? + * * @param $n * @param $r * @@ -210,25 +201,19 @@ class CRM_Case_Audit_AuditConfig { return $retval; } - /* getRegions - * - * Return a list of all the regions in the config file. - */ - /** + * Return a list of all the regions in the config file. + * * @return array */ public function getRegions() { return array_keys($this->regionFieldList); } - /* sort - * + /** * Sort a group of fields for a given region according to the order in the config. * The array to be sorted should have elements that have a member with a key of 'label', and the value should be the field label. - */ - - /** + * * @param $f * @param $r */ @@ -242,13 +227,10 @@ class CRM_Case_Audit_AuditConfig { uasort($f, array(&$this, "compareFields")); } - /* compareFields - * + /** * This is intended to be called as a sort callback function, returning whether a field in a region comes before or after another one. * See also PHP's usort(). - */ - - /** + * * @param $a * @param $b * diff --git a/CRM/Case/Page/CaseDetails.php b/CRM/Case/Page/CaseDetails.php index 60e520ba40..f74113a8d0 100644 --- a/CRM/Case/Page/CaseDetails.php +++ b/CRM/Case/Page/CaseDetails.php @@ -38,7 +38,7 @@ class CRM_Case_Page_CaseDetails extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); diff --git a/CRM/Case/Page/DashBoard.php b/CRM/Case/Page/DashBoard.php index 892bffd7b1..2e8b94903d 100644 --- a/CRM/Case/Page/DashBoard.php +++ b/CRM/Case/Page/DashBoard.php @@ -107,7 +107,7 @@ class CRM_Case_Page_DashBoard extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Case/Page/Tab.php b/CRM/Case/Page/Tab.php index d76d17c880..f02272dc48 100644 --- a/CRM/Case/Page/Tab.php +++ b/CRM/Case/Page/Tab.php @@ -140,7 +140,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { @@ -163,7 +163,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { $config = CRM_Core_Config::singleton(); @@ -183,7 +183,7 @@ class CRM_Case_Page_Tab extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $contactID = CRM_Utils_Request::retrieve('cid', 'Positive', CRM_Core_DAO::$_nullArray); diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index 6dd71afc8a..fd3a24225d 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -896,9 +896,8 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * @param array $params * Array of extra values including relationship_type_id per api spec. * - * return string the query for this diretion - * * @return array + * [select, from, where] */ public static function makeURLClause($contactId, $status, $numRelationship, $count, $relationshipId, $direction, $params = array()) { $select = $from = $where = ''; @@ -1025,7 +1024,7 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) } /** - * This is the function to get the list of relationships + * Get a list of relationships * * @param int $contactId * Contact id. @@ -1035,19 +1034,17 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) * No of relationships to display (limit). * @param int $count * Get the no of relationships. - * $param int $relationshipId relationship id - * $param array $links the list of links to display - * $param int $permissionMask the permission mask to be applied for the actions - * $param boolean $permissionedContact to return only permissioned Contact - * $param array $params array of variables consistent with filters supported by the api - * return array $values relationship records * @param int $relationshipId - * @param null $links - * @param null $permissionMask + * @param array $links + * the list of links to display + * @param int $permissionMask + * the permission mask to be applied for the actions * @param bool $permissionedContact + * to return only permissioned Contact * @param array $params * * @return array|int + * relationship records */ static function getRelationship( $contactId = NULL, diff --git a/CRM/Contact/Page/DedupeException.php b/CRM/Contact/Page/DedupeException.php index db0e324281..649e0ff7a3 100644 --- a/CRM/Contact/Page/DedupeException.php +++ b/CRM/Contact/Page/DedupeException.php @@ -81,7 +81,7 @@ class CRM_Contact_Page_DedupeException extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/ContactSmartGroup.php b/CRM/Contact/Page/View/ContactSmartGroup.php index f72911e360..7ac5c0a5f4 100644 --- a/CRM/Contact/Page/View/ContactSmartGroup.php +++ b/CRM/Contact/Page/View/ContactSmartGroup.php @@ -42,7 +42,7 @@ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $in = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Added'); @@ -100,7 +100,7 @@ class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page { * when the page loads, it decides the which action has * to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index 01d5c7cdf1..10251a07e6 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -37,7 +37,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { @@ -74,7 +74,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { * * @param int $groupId * - * return null + * @return null */ public function edit($groupId = NULL) { $controller = new CRM_Core_Controller_Simple( @@ -119,7 +119,7 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { * when the page loads, it decides the which action has * to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/Log.php b/CRM/Contact/Page/View/Log.php index 3b8da83952..92740f1048 100644 --- a/CRM/Contact/Page/View/Log.php +++ b/CRM/Contact/Page/View/Log.php @@ -37,7 +37,7 @@ class CRM_Contact_Page_View_Log extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $loggingReport = CRM_Core_BAO_Log::useLoggingReport(); @@ -89,7 +89,7 @@ class CRM_Contact_Page_View_Log extends CRM_Core_Page { /** * the main function that is called when the page loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/Note.php b/CRM/Contact/Page/View/Note.php index f3039e474b..760a86a5b2 100644 --- a/CRM/Contact/Page/View/Note.php +++ b/CRM/Contact/Page/View/Note.php @@ -82,7 +82,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $note = new CRM_Core_DAO_Note(); @@ -161,7 +161,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action); @@ -215,7 +215,7 @@ class CRM_Contact_Page_View_Note extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/Relationship.php b/CRM/Contact/Page/View/Relationship.php index 5043d37f47..0e20b552f5 100644 --- a/CRM/Contact/Page/View/Relationship.php +++ b/CRM/Contact/Page/View/Relationship.php @@ -135,7 +135,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { // do nothing :) we are using datatable for rendering relationship selectors @@ -144,7 +144,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { $controller = new CRM_Core_Controller_Simple('CRM_Contact_Form_Relationship', ts('Contact Relationships'), $this->_action); @@ -201,7 +201,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); @@ -260,7 +260,7 @@ class CRM_Contact_Page_View_Relationship extends CRM_Core_Page { /** * called to delete the relationship of a contact * - * return null + * @return null */ public function delete() { // calls a function to delete relationship diff --git a/CRM/Contact/Page/View/Sunlight.php b/CRM/Contact/Page/View/Sunlight.php index 2d06487201..09b2d1148f 100644 --- a/CRM/Contact/Page/View/Sunlight.php +++ b/CRM/Contact/Page/View/Sunlight.php @@ -37,7 +37,7 @@ class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View { /** * called when action is browse * - * return null + * @return null */ public function browse() { // get the primary city, state and zip for the contact @@ -56,7 +56,7 @@ class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/Tag.php b/CRM/Contact/Page/View/Tag.php index b914a29ce7..dd9e83f736 100644 --- a/CRM/Contact/Page/View/Tag.php +++ b/CRM/Contact/Page/View/Tag.php @@ -37,7 +37,7 @@ class CRM_Contact_Page_View_Tag extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $controller = new CRM_Core_Controller_Simple('CRM_Tag_Form_Tag', ts('Contact Tags'), $this->_action); @@ -68,7 +68,7 @@ class CRM_Contact_Page_View_Tag extends CRM_Core_Page { * the main function that is called when the page loads * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php index 05a908ae0b..e8570e9201 100644 --- a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php +++ b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php @@ -37,7 +37,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ /** * called when action is browse * - * return null + * @return null */ public function browse() { $count = CRM_Contact_BAO_GroupContact::getContactGroup( @@ -79,7 +79,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ * * @param int $groupId * - * return null + * @return null */ public function edit($groupId = NULL) { $this->assign('edit', $this->_edit); @@ -132,7 +132,7 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->edit(); diff --git a/CRM/Contribute/Form/AdditionalInfo.php b/CRM/Contribute/Form/AdditionalInfo.php index 31ec73c698..6de4ee2693 100644 --- a/CRM/Contribute/Form/AdditionalInfo.php +++ b/CRM/Contribute/Form/AdditionalInfo.php @@ -330,13 +330,12 @@ class CRM_Contribute_Form_AdditionalInfo { /** * Send email receipt. * - * @form object of Contribution form. - * * @param CRM_Core_Form $form + * instance of Contribution form. * @param array $params * (reference ) an assoc array of name/value pairs. - * @$ccContribution boolen, is it credit card contribution. * @param bool $ccContribution + * is it credit card contribution. * * @return array */ diff --git a/CRM/Contribute/Form/Task/Invoice.php b/CRM/Contribute/Form/Task/Invoice.php index 3964720c61..b95eb6f031 100644 --- a/CRM/Contribute/Form/Task/Invoice.php +++ b/CRM/Contribute/Form/Task/Invoice.php @@ -232,8 +232,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * - * process the PDf and email with activity and attachment + * Process the PDf and email with activity and attachment * on click of Print Invoices * * @param array $contribIDs @@ -573,9 +572,7 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** - * - * This function is use for adding activity for - * Email Invoice and the PDF Invoice + * Add activity for Email Invoice and the PDF Invoice * * @param string $subject * Activity subject. @@ -623,16 +620,13 @@ class CRM_Contribute_Form_Task_Invoice extends CRM_Contribute_Form_Task { } /** + * Create the Invoice file in upload folder for attachment * - * This function is use for creating the Invoice file in upload folder - * for attachment - * - * @param $html + * @param string $html * Content for pdf in html format. * - * return $fileName of file which is in pdf format - * * @return string + * Name of file which is in pdf format */ static public function putFile($html) { require_once "packages/dompdf/dompdf_config.inc.php"; diff --git a/CRM/Contribute/Page/ContributionRecur.php b/CRM/Contribute/Page/ContributionRecur.php index 624f6faa96..e69a98a79f 100644 --- a/CRM/Contribute/Page/ContributionRecur.php +++ b/CRM/Contribute/Page/ContributionRecur.php @@ -94,7 +94,7 @@ class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contribute/Page/DashBoard.php b/CRM/Contribute/Page/DashBoard.php index 3a8030d3cd..518f9e909c 100644 --- a/CRM/Contribute/Page/DashBoard.php +++ b/CRM/Contribute/Page/DashBoard.php @@ -105,7 +105,7 @@ class CRM_Contribute_Page_DashBoard extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contribute/Page/SubscriptionStatus.php b/CRM/Contribute/Page/SubscriptionStatus.php index a691613d98..662b3cdce8 100644 --- a/CRM/Contribute/Page/SubscriptionStatus.php +++ b/CRM/Contribute/Page/SubscriptionStatus.php @@ -38,7 +38,7 @@ class CRM_Contribute_Page_SubscriptionStatus extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $task = CRM_Utils_Request::retrieve('task', 'String', CRM_Core_DAO::$_nullObject); diff --git a/CRM/Contribute/Page/Tab.php b/CRM/Contribute/Page/Tab.php index 8335bc3f85..1d1ba4f993 100644 --- a/CRM/Contribute/Page/Tab.php +++ b/CRM/Contribute/Page/Tab.php @@ -104,7 +104,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { // add annual contribution @@ -200,7 +200,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { /** * called when action is view * - * return null + * @return null */ public function view() { $controller = new CRM_Core_Controller_Simple( @@ -218,7 +218,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { // set https for offline cc transaction @@ -273,7 +273,7 @@ class CRM_Contribute_Page_Tab extends CRM_Core_Page { * the main function that is called when the page * loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Contribute/Page/UserDashboard.php b/CRM/Contribute/Page/UserDashboard.php index b403d2463e..d33b0a618e 100644 --- a/CRM/Contribute/Page/UserDashboard.php +++ b/CRM/Contribute/Page/UserDashboard.php @@ -37,7 +37,7 @@ class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBo /** * called when action is browse * - * return null + * @return null */ public function listContribution() { $controller = new CRM_Core_Controller_Simple( @@ -146,7 +146,7 @@ class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBo * the main function that is called when the page * loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings'); diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index 0eee6ce539..b83e8ff917 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -236,7 +236,7 @@ ORDER BY ph.is_primary DESC, phone_id ASC "; * @param $optionId * Value of option to be deleted. * - * return void + * @return void */ public static function setOptionToNull($optionId) { if (!$optionId) { diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index dc3dbd4b1d..a078186443 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -615,10 +615,8 @@ AND domain_id = %4 * @param int $ufID * Uf id. * - * return array $ufValues uf values. - * * - * * @return array + * uf values. */ public static function getUFValues($ufID = NULL) { if (!$ufID) { diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index 2aa52ba137..9b4ca59a07 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -673,7 +673,7 @@ class CRM_Core_Permission { * Validate user permission across * edit or view or with supportable acls. * - * return boolean true/false. + * @return boolean **/ public static function giveMeAllACLs() { if (CRM_Core_Permission::check('view all contacts') || @@ -712,9 +712,8 @@ class CRM_Core_Permission { * * @param string $permission * - * return string $componentName the name of component. - * - * @return int|null|string + * @return null|string + * the name of component. */ public static function getComponentName($permission) { $componentName = NULL; diff --git a/CRM/Core/SelectValues.php b/CRM/Core/SelectValues.php index 7cd219f62c..089bbb9150 100644 --- a/CRM/Core/SelectValues.php +++ b/CRM/Core/SelectValues.php @@ -39,6 +39,8 @@ class CRM_Core_SelectValues { /** * Preferred mail format + * + * @return array */ public static function pmf() { return array( @@ -50,6 +52,8 @@ class CRM_Core_SelectValues { /** * Privacy options + * + * @return array */ public static function privacy() { return array( @@ -64,6 +68,8 @@ class CRM_Core_SelectValues { /** * Various pre defined contact super types + * + * @return array */ public static function contactType() { static $contactType = NULL; @@ -75,6 +81,9 @@ class CRM_Core_SelectValues { /** * Various pre defined unit list + * + * @param string $unitType + * @return array */ public static function unitList($unitType = NULL) { $unitList = array( @@ -90,6 +99,8 @@ class CRM_Core_SelectValues { /** * Membership type unit + * + * @return array */ public static function membershipTypeUnitList() { return self::unitList('duration'); @@ -97,6 +108,8 @@ class CRM_Core_SelectValues { /** * Various pre defined period types + * + * @return array */ public static function periodType() { return array( @@ -107,6 +120,8 @@ class CRM_Core_SelectValues { /** * Various pre defined email selection methods + * + * @return array */ public static function emailSelectMethods() { return array( @@ -119,6 +134,8 @@ class CRM_Core_SelectValues { /** * Various pre defined member visibility options + * + * @return array */ public static function memberVisibility() { return array( @@ -129,6 +146,8 @@ class CRM_Core_SelectValues { /** * Member auto-renew options + * + * @return array */ public static function memberAutoRenew() { return array( @@ -140,6 +159,8 @@ class CRM_Core_SelectValues { /** * Various pre defined event dates + * + * @return array */ public static function eventDate() { return array( @@ -151,6 +172,8 @@ class CRM_Core_SelectValues { /** * Custom form field types + * + * @return array */ public static function customHtmlType() { return array( @@ -177,6 +200,8 @@ class CRM_Core_SelectValues { /** * Various pre defined extensions for dynamic properties and groups * + * @return array + * */ public static function customGroupExtends() { $customGroupExtends = array( @@ -205,6 +230,8 @@ class CRM_Core_SelectValues { /** * Styles for displaying the custom data group * + * @return array + * */ public static function customGroupStyle() { return array( @@ -217,6 +244,7 @@ class CRM_Core_SelectValues { /** * For displaying the uf group types * + * @return array */ public static function ufGroupTypes() { $ufGroupType = array( @@ -236,6 +264,8 @@ class CRM_Core_SelectValues { /** * The status of a contact within a group * + * @return array + * */ public static function groupContactStatus() { return array( @@ -247,6 +277,8 @@ class CRM_Core_SelectValues { /** * List of Group Types + * + * @return array */ public static function groupType() { return array( @@ -258,9 +290,10 @@ class CRM_Core_SelectValues { /** * Compose the parameters for a date select object * - * @param string|NULL $type the type of date - * @param string|NULL $format date format ( QF format) - * + * @param string|NULL $type + * the type of date + * @param string|NULL $format + * date format (QF format) * @param null $minOffset * @param null $maxOffset * @@ -268,7 +301,6 @@ class CRM_Core_SelectValues { * the date array */ public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL) { - $date = array( 'addEmptyOption' => TRUE, 'emptyOptionText' => ts('- select -'), @@ -310,6 +342,7 @@ class CRM_Core_SelectValues { /** * Values for UF form visibility options * + * @return array */ public static function ufVisibility() { return array( @@ -322,6 +355,7 @@ class CRM_Core_SelectValues { /** * Values for group form visibility options * + * @return array */ public static function groupVisibility() { return array( @@ -333,7 +367,7 @@ class CRM_Core_SelectValues { /** * Different type of Mailing Components * - * return array + * @return array */ public static function mailingComponents() { return array( @@ -351,7 +385,7 @@ class CRM_Core_SelectValues { /** * Get hours * - * + * @return array */ public function getHours() { $hours = array(); @@ -364,7 +398,7 @@ class CRM_Core_SelectValues { /** * Get minutes * - * + * @return array */ public function getMinutes() { $minutes = array(); @@ -403,8 +437,7 @@ class CRM_Core_SelectValues { } /** - * Get the Address Standardization Providers from available - * plugins + * Get the Address Standardization Providers from available plugins * * @return array * array of address standardization providers @@ -420,7 +453,7 @@ class CRM_Core_SelectValues { /** * Different type of Mailing Tokens * - * return array + * @return array */ public static function mailingTokens() { return array( @@ -446,7 +479,7 @@ class CRM_Core_SelectValues { /** * Different type of Activity Tokens * - * return array + * @return array */ public static function activityTokens() { return array( @@ -460,7 +493,7 @@ class CRM_Core_SelectValues { /** * Different type of Membership Tokens * - * return array + * @return array */ public static function membershipTokens() { return array( @@ -477,7 +510,7 @@ class CRM_Core_SelectValues { /** * Different type of Event Tokens * - * return array + * @return array */ public static function eventTokens() { return array( @@ -501,7 +534,7 @@ class CRM_Core_SelectValues { /** * Different type of Event Tokens * - * return array + * @return array */ public static function contributionTokens() { return array( @@ -534,7 +567,7 @@ class CRM_Core_SelectValues { /** * Different type of Contact Tokens * - * return array + * @return array */ public static function contactTokens() { static $tokens = NULL; @@ -609,7 +642,7 @@ class CRM_Core_SelectValues { /** * Different type of Participant Tokens * - * return array + * @return array */ public static function participantTokens() { static $tokens = NULL; @@ -650,7 +683,9 @@ class CRM_Core_SelectValues { } /** - * CiviCRM supported date input formats + * CiviCRM supported date input formats + * + * @return array */ public static function getDatePluginInputFormats() { $dateInputFormats = array( @@ -672,23 +707,25 @@ class CRM_Core_SelectValues { ); /* - Year greater than 2000 get wrong result for following format - echo date( 'Y-m-d', strtotime( '7 Nov, 2001') ); - echo date( 'Y-m-d', strtotime( '7 November, 2001') ); - Return current year - expected :: 2001-11-07 - output :: 2009-11-07 - However - echo date( 'Y-m-d', strtotime( 'Nov 7, 2001') ); - echo date( 'Y-m-d', strtotime( 'November 7, 2001') ); - gives proper result - */ + Year greater than 2000 get wrong result for following format + echo date( 'Y-m-d', strtotime( '7 Nov, 2001') ); + echo date( 'Y-m-d', strtotime( '7 November, 2001') ); + Return current year + expected :: 2001-11-07 + output :: 2009-11-07 + However + echo date( 'Y-m-d', strtotime( 'Nov 7, 2001') ); + echo date( 'Y-m-d', strtotime( 'November 7, 2001') ); + gives proper result + */ return $dateInputFormats; } /** * Map date plugin and actual format that is used by PHP + * + * @return array */ public static function datePluginToPHPFormats() { $dateInputFormats = array( @@ -713,6 +750,8 @@ class CRM_Core_SelectValues { /** * Time formats + * + * @return array */ public static function getTimeFormats() { return array( @@ -723,7 +762,11 @@ class CRM_Core_SelectValues { /** * Get numeric options + * + * @param int $start + * @param int $end * + * @return array */ public static function getNumericOptions($start = 0, $end = 10) { $numericOptions = array(); @@ -735,6 +778,8 @@ class CRM_Core_SelectValues { /** * Barcode types + * + * @return array */ public static function getBarcodeTypes() { return array( @@ -745,6 +790,8 @@ class CRM_Core_SelectValues { /** * Dedupe rule types + * + * @return array */ public static function getDedupeRuleTypes() { return array( @@ -756,6 +803,8 @@ class CRM_Core_SelectValues { /** * Campaign group types + * + * @return array */ public static function getCampaignGroupTypes() { return array( @@ -766,6 +815,8 @@ class CRM_Core_SelectValues { /** * Subscription history method + * + * @return array */ public static function getSubscriptionHistoryMethods() { return array( @@ -778,6 +829,8 @@ class CRM_Core_SelectValues { /** * Premium units + * + * @return array */ public static function getPremiumUnits() { return array( @@ -790,6 +843,8 @@ class CRM_Core_SelectValues { /** * Extension types + * + * @return array */ public static function getExtensionTypes() { return array( @@ -803,6 +858,8 @@ class CRM_Core_SelectValues { /** * Job frequency + * + * @return array */ public static function getJobFrequency() { return array( @@ -814,6 +871,8 @@ class CRM_Core_SelectValues { /** * Search builder operators + * + * @return array */ public static function getSearchBuilderOperators() { return array( @@ -838,6 +897,7 @@ class CRM_Core_SelectValues { /** * Profile group types * + * @return array */ public static function getProfileGroupType() { $profileGroupType = array( @@ -856,6 +916,8 @@ class CRM_Core_SelectValues { /** * Word replacement match type + * + * @return array */ public static function getWordReplacementMatchType() { return array( @@ -866,6 +928,8 @@ class CRM_Core_SelectValues { /** * Mailing group types + * + * @return array */ public static function getMailingGroupTypes() { return array( @@ -877,6 +941,8 @@ class CRM_Core_SelectValues { /** * Mailing Job Status + * + * @return array */ public static function getMailingJobStatus() { return array( @@ -888,6 +954,9 @@ class CRM_Core_SelectValues { ); } + /** + * @return array + */ public static function billingMode() { return array( CRM_Core_Payment::BILLING_MODE_FORM => 'form', @@ -898,6 +967,8 @@ class CRM_Core_SelectValues { /** * Frequency unit for schedule reminders + * + * @return array */ public static function getScheduleReminderFrequencyUnits() { //@todo update schema to refer to option group direct & remove this diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 4f34ffca4a..fb282d354f 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -1220,8 +1220,6 @@ UPDATE civicrm_participant * Update status id. * @param int $fromStatusId * From status id. - * - * return void * @param bool $returnResult * @param bool $skipCascadeRule * @@ -1461,8 +1459,6 @@ UPDATE civicrm_participant * @param string $mailType * (eg 'approval', 'confirm', 'expired' ). * - * return void - * * @return bool */ static function sendTransitionParticipantMail( diff --git a/CRM/Event/Page/DashBoard.php b/CRM/Event/Page/DashBoard.php index c10d80bba0..f6c1d100d2 100644 --- a/CRM/Event/Page/DashBoard.php +++ b/CRM/Event/Page/DashBoard.php @@ -74,7 +74,7 @@ class CRM_Event_Page_DashBoard extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Event/Page/Tab.php b/CRM/Event/Page/Tab.php index f5cd976faa..1cc1f3f996 100644 --- a/CRM/Event/Page/Tab.php +++ b/CRM/Event/Page/Tab.php @@ -40,7 +40,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $controller = new CRM_Core_Controller_Simple( @@ -72,7 +72,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { /** * called when action is view * - * return null + * @return null */ public function view() { // build associated contributions @@ -93,7 +93,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { // set https for offline cc transaction @@ -148,7 +148,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { /** * the main function that is called when the page loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); @@ -284,7 +284,7 @@ class CRM_Event_Page_Tab extends CRM_Core_Page { * used for the to show the associated * contribution for the participant * - * return null + * @return null */ public function associatedContribution() { if (CRM_Core_Permission::access('CiviContribute')) { diff --git a/CRM/Event/Page/UserDashboard.php b/CRM/Event/Page/UserDashboard.php index 5bd6e74e3d..b14799a9db 100644 --- a/CRM/Event/Page/UserDashboard.php +++ b/CRM/Event/Page/UserDashboard.php @@ -41,7 +41,7 @@ class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { /** * List participations for the UF user * - * return null + * @return null */ public function listParticipations() { $controller = new CRM_Core_Controller_Simple( @@ -63,7 +63,7 @@ class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard { * the main function that is called when the page * loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { parent::preProcess(); diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 1366ab75cd..eedcf0f643 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -303,15 +303,15 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces * @return array */ public static function getAllPaymentProcessors($mode, $reset = FALSE) { - /** + /* * $cacheKey = 'CRM_Financial_BAO_Payment_Processor_' . ($mode ? 'test' : 'all'); * if (!$reset) { - * $processors = CRM_Utils_Cache::singleton()->get($cacheKey); - * if (!empty($processors)) { - * return $processors; - * } + * $processors = CRM_Utils_Cache::singleton()->get($cacheKey); + * if (!empty($processors)) { + * return $processors; + * } * } - * */ + */ $retrievalParameters = array( 'is_active' => TRUE, 'options' => array('sort' => 'is_default DESC, name'), diff --git a/CRM/Grant/Page/DashBoard.php b/CRM/Grant/Page/DashBoard.php index d53f7c04cc..29429870a2 100644 --- a/CRM/Grant/Page/DashBoard.php +++ b/CRM/Grant/Page/DashBoard.php @@ -57,7 +57,7 @@ class CRM_Grant_Page_DashBoard extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Grant/Page/Tab.php b/CRM/Grant/Page/Tab.php index 0cd6e50f49..37e055ca3f 100644 --- a/CRM/Grant/Page/Tab.php +++ b/CRM/Grant/Page/Tab.php @@ -51,7 +51,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { /** * called when action is browse * - * return null + * @return null */ function browse() { $controller = new CRM_Core_Controller_Simple('CRM_Grant_Form_Search', ts('Grants'), $this->_action); @@ -72,7 +72,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { /** * called when action is view * - * return null + * @return null */ public function view() { $controller = new CRM_Core_Controller_Simple('CRM_Grant_Form_GrantView', 'View Grant', $this->_action); @@ -86,7 +86,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { /** * called when action is update or new * - * return null + * @return null */ public function edit() { $controller = new CRM_Core_Controller_Simple('CRM_Grant_Form_Grant', 'Create grant', $this->_action); @@ -132,7 +132,7 @@ class CRM_Grant_Page_Tab extends CRM_Contact_Page_View { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Mailing/BAO/TrackableURL.php b/CRM/Mailing/BAO/TrackableURL.php index bef5c53467..1b0be1768e 100644 --- a/CRM/Mailing/BAO/TrackableURL.php +++ b/CRM/Mailing/BAO/TrackableURL.php @@ -111,7 +111,8 @@ class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL { * @param $url * @param $mailing_id * - * return int Url id of the given url and mail + * @return int + * Url id of the given url and mail */ public static function getTrackerURLId($url, $mailing_id) { $tracker = new CRM_Mailing_BAO_TrackableURL(); diff --git a/CRM/Mailing/Page/Tab.php b/CRM/Mailing/Page/Tab.php index 197aff8cd4..c2352b1870 100644 --- a/CRM/Mailing/Page/Tab.php +++ b/CRM/Mailing/Page/Tab.php @@ -50,7 +50,7 @@ class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View { /** * called when action is browse * - * return null + * @return null */ public function browse() { } @@ -81,7 +81,7 @@ class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Member/Page/DashBoard.php b/CRM/Member/Page/DashBoard.php index 5e30567758..42fa50fd01 100644 --- a/CRM/Member/Page/DashBoard.php +++ b/CRM/Member/Page/DashBoard.php @@ -440,7 +440,7 @@ class CRM_Member_Page_DashBoard extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Member/Page/Tab.php b/CRM/Member/Page/Tab.php index 525f2b6529..6e9f766d92 100644 --- a/CRM/Member/Page/Tab.php +++ b/CRM/Member/Page/Tab.php @@ -48,7 +48,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $links = self::links('all', $this->_isPaymentProcessor, $this->_accessContribution); @@ -219,7 +219,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * called when action is view * - * return null + * @return null */ public function view() { $controller = new CRM_Core_Controller_Simple( @@ -237,7 +237,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { // set https for offline cc transaction @@ -310,7 +310,7 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * the main function that is called when the page loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); @@ -575,8 +575,11 @@ class CRM_Member_Page_Tab extends CRM_Core_Page { /** * used for the to show the associated * contribution for the membership - * @form array $form (ref.) an assoc array of name/value pairs - * return null + * + * @param int $contactId + * @param int $membershipId + * + * @return null */ public static function associatedContribution($contactId = NULL, $membershipId = NULL) { $controller = new CRM_Core_Controller_Simple( diff --git a/CRM/Member/Page/UserDashboard.php b/CRM/Member/Page/UserDashboard.php index eba8a18199..a53740f994 100644 --- a/CRM/Member/Page/UserDashboard.php +++ b/CRM/Member/Page/UserDashboard.php @@ -41,7 +41,7 @@ class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard /** * List memberships for the UF user * - * return null + * @return null */ public function listMemberships() { $membership = array(); @@ -96,7 +96,7 @@ class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard * the main function that is called when the page * loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { parent::preProcess(); diff --git a/CRM/Pledge/Page/DashBoard.php b/CRM/Pledge/Page/DashBoard.php index bb803326e6..d6d4d9edba 100644 --- a/CRM/Pledge/Page/DashBoard.php +++ b/CRM/Pledge/Page/DashBoard.php @@ -96,7 +96,7 @@ class CRM_Pledge_Page_DashBoard extends CRM_Core_Page { * the main function that is called when the page loads, * it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Pledge/Page/Payment.php b/CRM/Pledge/Page/Payment.php index 766ba55e9d..f9f744a0d0 100644 --- a/CRM/Pledge/Page/Payment.php +++ b/CRM/Pledge/Page/Payment.php @@ -37,7 +37,7 @@ class CRM_Pledge_Page_Payment extends CRM_Core_Page { /** * the main function that is called when the page loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); @@ -79,7 +79,7 @@ class CRM_Pledge_Page_Payment extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_Payment', diff --git a/CRM/Pledge/Page/Tab.php b/CRM/Pledge/Page/Tab.php index 563de86d56..f0480a0e5f 100644 --- a/CRM/Pledge/Page/Tab.php +++ b/CRM/Pledge/Page/Tab.php @@ -39,7 +39,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { /** * called when action is browse * - * return null + * @return null */ public function browse() { $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_Search', ts('Pledges'), $this->_action); @@ -66,7 +66,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { /** * called when action is view * - * return null + * @return null */ public function view() { $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_PledgeView', @@ -83,7 +83,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { /** * called when action is update or new * - * return null + * @return null */ public function edit() { $controller = new CRM_Core_Controller_Simple('CRM_Pledge_Form_Pledge', @@ -125,7 +125,7 @@ class CRM_Pledge_Page_Tab extends CRM_Core_Page { /** * the main function that is called when the page loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { $this->preProcess(); diff --git a/CRM/Pledge/Page/UserDashboard.php b/CRM/Pledge/Page/UserDashboard.php index fdd0ac563a..e26b2ad9d7 100644 --- a/CRM/Pledge/Page/UserDashboard.php +++ b/CRM/Pledge/Page/UserDashboard.php @@ -37,7 +37,7 @@ class CRM_Pledge_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard /** * called when action is browse * - * return null + * @return null */ public function listPledges() { $controller = new CRM_Core_Controller_Simple( @@ -72,7 +72,7 @@ class CRM_Pledge_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard * the main function that is called when the page * loads, it decides the which action has to be taken for the page. * - * return null + * @return null */ public function run() { parent::preProcess(); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index b0f7e4b29b..ed86b1d692 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -340,7 +340,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { /** * returns the list of fields that can be imported * - * return array + * @return array */ static function &import($prefix = FALSE) { if (!(self::$_import)) { @@ -363,7 +363,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO { /** * returns the list of fields that can be exported * - * return array + * @return array */ static function &export($prefix = FALSE) { if (!(self::$_export)) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php index 08b1d3530e..0cd702e29b 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php @@ -283,7 +283,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { /** * returns the list of fields that can be imported * - * return array + * @return array */ static function &import($prefix = FALSE) { if (!(self::$_import)) { @@ -306,7 +306,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO { /** * returns the list of fields that can be exported * - * return array + * @return array */ static function &export($prefix = FALSE) { if (!(self::$_export)) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php index 0646cf4e02..7c9d98e981 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php @@ -259,7 +259,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { /** * returns the list of fields that can be imported * - * return array + * @return array */ static function &import($prefix = FALSE) { if (!(self::$_import)) { @@ -282,7 +282,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO { /** * returns the list of fields that can be exported * - * return array + * @return array */ static function &export($prefix = FALSE) { if (!(self::$_export)) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php index e39722dffa..e828e12c3a 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php @@ -283,7 +283,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { /** * returns the list of fields that can be imported * - * return array + * @return array */ static function &import($prefix = FALSE) { if (!(self::$_import)) { @@ -306,7 +306,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO { /** * returns the list of fields that can be exported * - * return array + * @return array */ static function &export($prefix = FALSE) { if (!(self::$_export)) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php index 6020b3a4da..35de88c00c 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php @@ -184,7 +184,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { /** * returns the list of fields that can be imported * - * return array + * @return array */ static function &import($prefix = FALSE) { if (!(self::$_import)) { @@ -207,7 +207,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO { /** * returns the list of fields that can be exported * - * return array + * @return array */ static function &export($prefix = FALSE) { if (!(self::$_export)) { diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php index 116224e558..d076c10732 100644 --- a/CRM/Utils/Mail.php +++ b/CRM/Utils/Mail.php @@ -55,7 +55,6 @@ class CRM_Utils_Mail { * @param array $params * (by reference). * - * * @return boolean * true if a mail was sent, else false */ -- 2.25.1