From 30c4e065d07e4ef1e0e312bd4545bb714a8e6dd1 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Sat, 24 May 2014 14:39:28 +1200 Subject: [PATCH] CRM/Campaign add missing comments --- CRM/Campaign/BAO/Campaign.php | 15 ++++++++-- CRM/Campaign/BAO/Petition.php | 15 ++++++++++ CRM/Campaign/BAO/Query.php | 36 ++++++++++++++++++++++++ CRM/Campaign/BAO/Survey.php | 5 ++++ CRM/Campaign/Form/Petition/Signature.php | 12 ++++++++ CRM/Campaign/Form/Search.php | 3 ++ CRM/Campaign/Form/Survey.php | 3 ++ CRM/Campaign/Form/Survey/TabHeader.php | 23 +++++++++++++++ CRM/Campaign/Form/Task/Interview.php | 5 ++++ CRM/Campaign/Form/Task/Reserve.php | 5 ++++ CRM/Campaign/Info.php | 26 +++++++++++++++++ CRM/Campaign/Page/Campaign.php | 3 ++ CRM/Campaign/Page/DashBoard.php | 24 ++++++++++++++++ CRM/Campaign/Page/Petition.php | 3 ++ CRM/Campaign/Page/Petition/Confirm.php | 4 +++ CRM/Campaign/Page/Petition/ThankYou.php | 3 ++ CRM/Campaign/Page/Survey.php | 6 ++++ CRM/Campaign/Page/Vote.php | 6 ++++ CRM/Campaign/Selector/Search.php | 6 ++++ 19 files changed, 200 insertions(+), 3 deletions(-) diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 89e071e14e..edb5b538ae 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -289,9 +289,9 @@ Order By camp.title"; return $validCampaigns[$cacheKey]; } - /* + /** * Is CiviCampaign enabled. - * + * @return bool */ public static function isCampaignEnable() { static $isEnable = NULL; @@ -512,6 +512,9 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) return CRM_Core_DAO::setFieldValue('CRM_Campaign_DAO_Campaign', $id, 'is_active', $is_active); } + /** + * @return bool + */ static function accessCampaign() { static $allow = NULL; @@ -532,6 +535,10 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) * and assign needful info to templates. * */ + /** + * @param $form + * @param null $connectedCampaignId + */ public static function addCampaign(&$form, $connectedCampaignId = NULL) { //some forms do set default and freeze. $appendDates = TRUE; @@ -608,10 +615,12 @@ INNER JOIN civicrm_group grp ON ( grp.id = campgrp.entity_id ) $form->assign('campaignInfo', $campaignInfo); } - /* + /** * Add campaign in compoent search. * and assign needful info to templates. * + * @param $form + * @param string $elementName */ public static function addCampaignInComponentSearch(&$form, $elementName = 'campaign_id') { $campaignInfo = array(); diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index 7f2f5dc8de..0863962d24 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -33,6 +33,9 @@ * */ class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey { + /** + * + */ function __construct() { parent::__construct(); // expire cookie in one day @@ -225,6 +228,13 @@ SELECT petition.id as id, return $activity; } + /** + * @param $activity_id + * @param $contact_id + * @param $petition_id + * + * @return bool + */ function confirmSignature($activity_id, $contact_id, $petition_id) { // change activity status to completed (status_id = 2) // I wonder why do we need contact_id when we have activity_id anyway? [chastell] @@ -345,6 +355,11 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; } + /** + * @param null $surveyId + * + * @return array + */ public static function getSurveyInfo($surveyId = NULL) { $surveyInfo = array(); diff --git a/CRM/Campaign/BAO/Query.php b/CRM/Campaign/BAO/Query.php index b216bbaf23..5b4d84124f 100755 --- a/CRM/Campaign/BAO/Query.php +++ b/CRM/Campaign/BAO/Query.php @@ -144,6 +144,9 @@ class CRM_Campaign_BAO_Query { $query->_whereTables['civicrm_campaign'] = 1; } + /** + * @param $query + */ static function where(&$query) { //get survey clause in force, //only when we have survey id. @@ -161,6 +164,10 @@ class CRM_Campaign_BAO_Query { } } + /** + * @param $values + * @param $query + */ static function whereClauseSingle(&$values, &$query) { //get survey clause in force, //only when we have survey id. @@ -207,6 +214,13 @@ class CRM_Campaign_BAO_Query { } } + /** + * @param $name + * @param $mode + * @param $side + * + * @return null|string + */ static function from($name, $mode, $side) { $from = NULL; //get survey clause in force, @@ -251,6 +265,12 @@ civicrm_activity_assignment.record_type_id = $assigneeID ) "; return $from; } + /** + * @param $mode + * @param bool $includeCustomFields + * + * @return array|null + */ static function defaultReturnProperties($mode, $includeCustomFields = TRUE ) { @@ -285,9 +305,20 @@ civicrm_activity_assignment.record_type_id = $assigneeID ) "; return $properties; } + /** + * @param $tables + */ static function tableNames(&$tables) {} + + /** + * @param $row + * @param $id + */ static function searchAction(&$row, $id) {} + /** + * @param $tables + */ static function info(&$tables) { //get survey clause in force, //only when we have survey id. @@ -423,6 +454,11 @@ INNER JOIN civicrm_custom_group grp on fld.custom_group_id = grp.id * @return $voterClause as a string * @static */ + /** + * @param $params + * + * @return array + */ static public function voterClause($params) { $voterClause = array(); $fromClause = $whereClause = NULL; diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index 143ccd7edf..14e0b71c11 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -885,6 +885,11 @@ INNER JOIN civicrm_contact contact_a ON ( activityTarget.contact_id = contact_a return CRM_Utils_Array::value($surveyId, $ufIds); } + /** + * @param $surveyId + * + * @return mixed + */ public Static function getReportID($surveyId) { static $reportIds = array(); diff --git a/CRM/Campaign/Form/Petition/Signature.php b/CRM/Campaign/Form/Petition/Signature.php index 4131c44085..205ad1edc0 100644 --- a/CRM/Campaign/Form/Petition/Signature.php +++ b/CRM/Campaign/Form/Petition/Signature.php @@ -140,6 +140,9 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { protected $_defaults = NULL; + /** + * + */ function __construct() { parent::__construct(); // this property used by civicrm_fb module and if true, forces thank you email to be sent @@ -148,6 +151,9 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { $this->forceEmailConfirmed['email'] = ''; } + /** + * @return mixed + */ function getContactID() { $tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this); @@ -670,6 +676,9 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } } + /** + * @return string + */ function getTemplateFileName() { if (isset($this->thankyou)) { return ('CRM/Campaign/Page/Petition/ThankYou.tpl'); @@ -679,6 +688,9 @@ class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form { } // check if user has already signed this petition + /** + * @param $params + */ function redirectIfSigned($params) { $signature = $this->bao->checkSignature($this->_surveyId, $this->_contactId); //TODO: error case when more than one signature found for this petition and this contact diff --git a/CRM/Campaign/Form/Search.php b/CRM/Campaign/Form/Search.php index 4636d2b12e..677d4525e1 100755 --- a/CRM/Campaign/Form/Search.php +++ b/CRM/Campaign/Form/Search.php @@ -516,6 +516,9 @@ class CRM_Campaign_Form_Search extends CRM_Core_Form_Search { $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this); } + /** + * @return array + */ function voterClause() { $params = array('campaign_search_voter_for' => $this->_operation); diff --git a/CRM/Campaign/Form/Survey.php b/CRM/Campaign/Form/Survey.php index b3d21d07d3..07f7274774 100644 --- a/CRM/Campaign/Form/Survey.php +++ b/CRM/Campaign/Form/Survey.php @@ -171,6 +171,9 @@ class CRM_Campaign_Form_Survey extends CRM_Core_Form { } } + /** + * @return string + */ function getTemplateFileName() { if ($this->controller->getPrint() || $this->getVar('_surveyId') <= 0 ) { return parent::getTemplateFileName(); diff --git a/CRM/Campaign/Form/Survey/TabHeader.php b/CRM/Campaign/Form/Survey/TabHeader.php index 3431fe8c2e..0c7f4d7bdc 100644 --- a/CRM/Campaign/Form/Survey/TabHeader.php +++ b/CRM/Campaign/Form/Survey/TabHeader.php @@ -38,6 +38,11 @@ */ class CRM_Campaign_Form_Survey_TabHeader { + /** + * @param $form + * + * @return array + */ static function build(&$form) { $tabs = $form->get('tabHeader'); if (!$tabs || empty($_GET['reset'])) { @@ -53,6 +58,11 @@ class CRM_Campaign_Form_Survey_TabHeader { return $tabs; } + /** + * @param $form + * + * @return array + */ static function process(&$form) { if ($form->getVar('_surveyId') <= 0) { return NULL; @@ -109,11 +119,19 @@ class CRM_Campaign_Form_Survey_TabHeader { return $tabs; } + /** + * @param $form + */ static function reset(&$form) { $tabs = self::process($form); $form->set('tabHeader', $tabs); } + /** + * @param $tabs + * + * @return int|string + */ static function getCurrentTab($tabs) { static $current = FALSE; @@ -134,6 +152,11 @@ class CRM_Campaign_Form_Survey_TabHeader { return $current; } + /** + * @param $form + * + * @return int|string + */ static function getNextTab(&$form) { static $next = FALSE; if ($next) diff --git a/CRM/Campaign/Form/Task/Interview.php b/CRM/Campaign/Form/Task/Interview.php index e665084256..61fbb2994a 100755 --- a/CRM/Campaign/Form/Task/Interview.php +++ b/CRM/Campaign/Form/Task/Interview.php @@ -469,6 +469,11 @@ WHERE {$clause} return; } + /** + * @param $params + * + * @return mixed + */ static function registerInterview($params) { $activityId = CRM_Utils_Array::value('activity_id', $params); $surveyTypeId = CRM_Utils_Array::value('activity_type_id', $params); diff --git a/CRM/Campaign/Form/Task/Reserve.php b/CRM/Campaign/Form/Task/Reserve.php index ff519ce89e..87e5087058 100644 --- a/CRM/Campaign/Form/Task/Reserve.php +++ b/CRM/Campaign/Form/Task/Reserve.php @@ -303,6 +303,11 @@ class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task { } } + /** + * @param $contactIds + * + * @return array + */ private function _addRespondentToGroup($contactIds) { $groupAdditions = array(); if (empty($contactIds)) { diff --git a/CRM/Campaign/Info.php b/CRM/Campaign/Info.php index 9995c2fbde..bbdb234d45 100644 --- a/CRM/Campaign/Info.php +++ b/CRM/Campaign/Info.php @@ -41,6 +41,9 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { protected $keyword = 'campaign'; // docs inherited from interface + /** + * @return array + */ public function getInfo() { return array( 'name' => 'CiviCampaign', @@ -53,6 +56,11 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { // docs inherited from interface + /** + * @param bool $getAllUnconditionally + * + * @return array + */ public function getPermissions($getAllUnconditionally = FALSE) { return array( 'administer CiviCampaign', @@ -67,34 +75,52 @@ class CRM_Campaign_Info extends CRM_Core_Component_Info { // docs inherited from interface + /** + * @return null + */ public function getUserDashboardElement() { // no dashboard element for this component return NULL; } + /** + * @return null + */ public function getUserDashboardObject() { // no dashboard element for this component return NULL; } // docs inherited from interface + /** + * @return null + */ public function registerTab() { // this component doesn't use contact record tabs return NULL; } // docs inherited from interface + /** + * @return null + */ public function registerAdvancedSearchPane() { // this component doesn't use advanced search return NULL; } // docs inherited from interface + /** + * @return null + */ public function getActivityTypes() { return NULL; } // add shortcut to Create New + /** + * @param $shortCuts + */ public function creatNewShortcut(&$shortCuts) { if (CRM_Core_Permission::check('manage campaign') || CRM_Core_Permission::check('administer CiviCampaign') diff --git a/CRM/Campaign/Page/Campaign.php b/CRM/Campaign/Page/Campaign.php index 2ce0b5d501..b9eaf71b8a 100644 --- a/CRM/Campaign/Page/Campaign.php +++ b/CRM/Campaign/Page/Campaign.php @@ -124,6 +124,9 @@ class CRM_Campaign_Page_Campaign extends CRM_Core_Page { $this->assign('addCampaignUrl', CRM_Utils_System::url('civicrm/campaign/add', 'reset=1&action=add')); } + /** + * @return string + */ function run() { if (!CRM_Core_Permission::check('administer CiviCampaign')) { CRM_Utils_System::permissionDenied(); diff --git a/CRM/Campaign/Page/DashBoard.php b/CRM/Campaign/Page/DashBoard.php index 207acd1ce3..b2dd8e1cee 100644 --- a/CRM/Campaign/Page/DashBoard.php +++ b/CRM/Campaign/Page/DashBoard.php @@ -86,6 +86,9 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { return self::$_campaignActionLinks; } + /** + * @return array + */ function &surveyActionLinks() { // check if variable _actionsLinks is populated if (!isset(self::$_surveyActionLinks)) { @@ -118,6 +121,9 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { return self::$_surveyActionLinks; } + /** + * @return array + */ function &petitionActionLinks() { if (!isset(self::$_petitionActionLinks)) { self::$_petitionActionLinks = self::surveyActionLinks(); @@ -186,6 +192,11 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { return $controller->run(); } + /** + * @param array $params + * + * @return array + */ public static function getCampaignSummary($params = array( )) { $campaignsData = array(); @@ -272,6 +283,11 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { return $controller->run(); } + /** + * @param array $params + * + * @return array + */ function getSurveySummary($params = array( )) { $surveysData = array(); @@ -368,6 +384,11 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { return $controller->run(); } + /** + * @param array $params + * + * @return array + */ function getPetitionSummary($params = array( )) { $config = CRM_Core_Config::singleton(); @@ -446,6 +467,9 @@ class CRM_Campaign_Page_DashBoard extends CRM_Core_Page { ))); } + /** + * @return string + */ function run() { if (!CRM_Campaign_BAO_Campaign::accessCampaign()) { CRM_Utils_System::permissionDenied(); diff --git a/CRM/Campaign/Page/Petition.php b/CRM/Campaign/Page/Petition.php index 876d961556..c8ffcb4414 100644 --- a/CRM/Campaign/Page/Petition.php +++ b/CRM/Campaign/Page/Petition.php @@ -47,6 +47,9 @@ class CRM_Campaign_Page_Petition extends CRM_Core_Page { $this->assign('signatures', $signatures); } + /** + * @return string + */ function run() { $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 0 diff --git a/CRM/Campaign/Page/Petition/Confirm.php b/CRM/Campaign/Page/Petition/Confirm.php index 1ae146c23e..665fad7c41 100644 --- a/CRM/Campaign/Page/Petition/Confirm.php +++ b/CRM/Campaign/Page/Petition/Confirm.php @@ -33,6 +33,10 @@ * */ class CRM_Campaign_Page_Petition_Confirm extends CRM_Core_Page { + /** + * @return string + * @throws Exception + */ function run() { $contact_id = CRM_Utils_Request::retrieve('cid', 'Integer', CRM_Core_DAO::$_nullObject); $subscribe_id = CRM_Utils_Request::retrieve('sid', 'Integer', CRM_Core_DAO::$_nullObject); diff --git a/CRM/Campaign/Page/Petition/ThankYou.php b/CRM/Campaign/Page/Petition/ThankYou.php index e7b692bed6..e38a2d785d 100644 --- a/CRM/Campaign/Page/Petition/ThankYou.php +++ b/CRM/Campaign/Page/Petition/ThankYou.php @@ -33,6 +33,9 @@ * */ class CRM_Campaign_Page_Petition_ThankYou extends CRM_Core_Page { + /** + * @return string + */ function run() { $id = CRM_Utils_Request::retrieve('id', 'Positive', $this); $petition_id = CRM_Utils_Request::retrieve('pid', 'Positive', $this); diff --git a/CRM/Campaign/Page/Survey.php b/CRM/Campaign/Page/Survey.php index 8dea493725..390e19604d 100644 --- a/CRM/Campaign/Page/Survey.php +++ b/CRM/Campaign/Page/Survey.php @@ -42,6 +42,9 @@ class CRM_Campaign_Page_Survey extends CRM_Core_Page { private static $_actionLinks; + /** + * @return array + */ function &actionLinks() { // check if variable _actionsLinks is populated if (!isset(self::$_actionLinks)) { @@ -113,6 +116,9 @@ class CRM_Campaign_Page_Survey extends CRM_Core_Page { $this->assign('addSurveyUrl', CRM_Utils_System::url('civicrm/survey/add', 'reset=1&action=add')); } + /** + * @return string + */ function run() { if (!CRM_Campaign_BAO_Campaign::accessCampaign()) { CRM_Utils_System::permissionDenied(); diff --git a/CRM/Campaign/Page/Vote.php b/CRM/Campaign/Page/Vote.php index 48faf8e20a..7457cf8641 100644 --- a/CRM/Campaign/Page/Vote.php +++ b/CRM/Campaign/Page/Vote.php @@ -40,6 +40,9 @@ class CRM_Campaign_Page_Vote extends CRM_Core_Page { private $_surveyId; private $_interviewerId; + /** + * @return mixed + */ function reserve() { //build ajax voter search and selector. $controller = new CRM_Core_Controller_Simple('CRM_Campaign_Form_Gotv', ts('Reserve Respondents')); @@ -93,6 +96,9 @@ class CRM_Campaign_Page_Vote extends CRM_Core_Page { ))); } + /** + * @return string + */ function run() { $this->browse(); diff --git a/CRM/Campaign/Selector/Search.php b/CRM/Campaign/Selector/Search.php index 07a355654b..31ea9e3244 100755 --- a/CRM/Campaign/Selector/Search.php +++ b/CRM/Campaign/Selector/Search.php @@ -273,6 +273,9 @@ class CRM_Campaign_Selector_Search extends CRM_Core_Selector_Base implements CRM return $rows; } + /** + * @param $sort + */ function buildPrevNextCache($sort) { //for prev/next pagination $crmPID = CRM_Utils_Request::retrieve('crmPID', 'Integer', CRM_Core_DAO::$_nullObject); @@ -360,6 +363,9 @@ FROM {$from} return self::$_columnHeaders; } + /** + * @return string + */ function &getQuery() { return $this->_query; } -- 2.25.1