3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 --------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Page for displaying Campaigns
39 class CRM_Campaign_Page_DashBoard
extends CRM_Core_Page
{
42 * The action links that we need to display for the browse screen
46 private static $_campaignActionLinks;
47 private static $_surveyActionLinks;
48 private static $_petitionActionLinks;
51 * Get the action links for this page.
53 * @return array $_campaignActionLinks
56 function &campaignActionLinks() {
57 // check if variable _actionsLinks is populated
58 if (!isset(self
::$_campaignActionLinks)) {
59 $deleteExtra = ts('Are you sure you want to delete this Campaign?');
60 self
::$_campaignActionLinks = array(
61 CRM_Core_Action
::UPDATE
=> array(
63 'url' => 'civicrm/campaign/add',
64 'qs' => 'reset=1&action=update&id=%%id%%',
65 'title' => ts('Update Campaign'),
67 CRM_Core_Action
::DISABLE
=> array(
68 'name' => ts('Disable'),
69 'title' => ts('Disable Campaign'),
70 'ref' => 'crm-enable-disable',
72 CRM_Core_Action
::ENABLE
=> array(
73 'name' => ts('Enable'),
74 'title' => ts('Enable Campaign'),
75 'ref' => 'crm-enable-disable',
77 CRM_Core_Action
::DELETE
=> array(
78 'name' => ts('Delete'),
79 'url' => 'civicrm/campaign/add',
80 'qs' => 'action=delete&reset=1&id=%%id%%',
81 'title' => ts('Delete Campaign'),
86 return self
::$_campaignActionLinks;
92 function &surveyActionLinks() {
93 // check if variable _actionsLinks is populated
94 if (!isset(self
::$_surveyActionLinks)) {
95 self
::$_surveyActionLinks = array(
96 CRM_Core_Action
::UPDATE
=> array(
98 'url' => 'civicrm/survey/configure/main',
99 'qs' => 'action=update&id=%%id%%&reset=1',
100 'title' => ts('Update Survey'),
102 CRM_Core_Action
::DISABLE
=> array(
103 'name' => ts('Disable'),
104 'ref' => 'crm-enable-disable',
105 'title' => ts('Disable Survey'),
107 CRM_Core_Action
::ENABLE
=> array(
108 'name' => ts('Enable'),
109 'ref' => 'crm-enable-disable',
110 'title' => ts('Enable Survey'),
112 CRM_Core_Action
::DELETE
=> array(
113 'name' => ts('Delete'),
114 'url' => 'civicrm/survey/delete',
115 'qs' => 'id=%%id%%&reset=1',
116 'title' => ts('Delete Survey'),
121 return self
::$_surveyActionLinks;
127 function &petitionActionLinks() {
128 if (!isset(self
::$_petitionActionLinks)) {
129 self
::$_petitionActionLinks = self
::surveyActionLinks();
130 self
::$_petitionActionLinks[CRM_Core_Action
::UPDATE
] = array(
131 'name' => ts('Edit'),
132 'url' => 'civicrm/petition/add',
133 'qs' => 'action=update&id=%%id%%&reset=1',
134 'title' => ts('Update Petition'),
136 self
::$_petitionActionLinks[CRM_Core_Action
::DISABLE
] = array(
137 'name' => ts('Disable'),
138 'ref' => 'crm-enable-disable',
139 'title' => ts('Disable Petition'),
141 self
::$_petitionActionLinks[CRM_Core_Action
::ENABLE
] = array(
142 'name' => ts('Enable'),
143 'ref' => 'crm-enable-disable',
144 'title' => ts('Enable Petition'),
146 self
::$_petitionActionLinks[CRM_Core_Action
::DELETE
] = array(
147 'name' => ts('Delete'),
148 'url' => 'civicrm/petition/add',
149 'qs' => 'action=delete&id=%%id%%&reset=1',
150 'title' => ts('Delete Petition'),
152 self
::$_petitionActionLinks[CRM_Core_Action
::PROFILE
] = array(
153 'name' => ts('Sign'),
154 'url' => 'civicrm/petition/sign',
155 'qs' => 'sid=%%id%%&reset=1',
156 'title' => ts('Sign Petition'),
158 //CRM_Core_Action::PROFILE is used because there isn't a specific action for sign
160 self
::$_petitionActionLinks[CRM_Core_Action
::BROWSE
] = array(
161 'name' => ts('Signatures'),
162 'url' => 'civicrm/activity/search',
163 'qs' => 'survey=%%id%%&force=1',
164 'title' => ts('List the signatures'),
165 //CRM_Core_Action::PROFILE is used because there isn't a specific action for sign
169 return self
::$_petitionActionLinks;
175 function browseCampaign() {
176 // ensure valid javascript (these must have a value set)
177 $this->assign('searchParams', json_encode(NULL));
178 $this->assign('campaignTypes', json_encode(NULL));
179 $this->assign('campaignStatus', json_encode(NULL));
181 $this->assign('addCampaignUrl', CRM_Utils_System
::url('civicrm/campaign/add', 'reset=1&action=add'));
182 $campaignCount = CRM_Campaign_BAO_Campaign
::getCampaignCount();
183 //don't load find interface when no campaigns in db.
184 if (!$campaignCount) {
185 $this->assign('hasCampaigns', FALSE);
188 $this->assign('hasCampaigns', TRUE);
190 //build the ajaxify campaign search and selector.
191 $controller = new CRM_Core_Controller_Simple('CRM_Campaign_Form_Search_Campaign', ts('Search Campaigns'));
192 $controller->set('searchTab', 'campaign');
193 $controller->setEmbedded(TRUE);
194 $controller->process();
195 return $controller->run();
199 * @param array $params
203 public static function getCampaignSummary($params = array()) {
204 $campaignsData = array();
207 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaignSummary($params);
208 if (!empty($campaigns)) {
209 $config = CRM_Core_Config
::singleton();
210 $campaignType = CRM_Campaign_PseudoConstant
::campaignType();
211 $campaignStatus = CRM_Campaign_PseudoConstant
::campaignStatus();
213 'id', 'name', 'title', 'status_id', 'description',
214 'campaign_type_id', 'is_active', 'start_date', 'end_date',
216 foreach ($campaigns as $cmpid => $campaign) {
217 foreach ($properties as $prop) {
218 $campaignsData[$cmpid][$prop] = CRM_Utils_Array
::value($prop, $campaign);
220 $statusId = CRM_Utils_Array
::value('status_id', $campaign);
221 $campaignsData[$cmpid]['status'] = CRM_Utils_Array
::value($statusId, $campaignStatus);
222 $campaignsData[$cmpid]['campaign_id'] = $campaign['id'];
223 $campaignsData[$cmpid]['campaign_type'] = $campaignType[$campaign['campaign_type_id']];
225 $action = array_sum(array_keys(self
::campaignActionLinks()));
226 if ($campaign['is_active']) {
227 $action -= CRM_Core_Action
::ENABLE
;
230 $action -= CRM_Core_Action
::DISABLE
;
233 $isActive = ts('No');
234 if ($campaignsData[$cmpid]['is_active']) {
235 $isActive = ts('Yes');
237 $campaignsData[$cmpid]['isActive'] = $isActive;
239 if (!empty($campaignsData[$cmpid]['start_date'])) {
240 $campaignsData[$cmpid]['start_date'] = CRM_Utils_Date
::customFormat($campaignsData[$cmpid]['start_date'],
241 $config->dateformatFull
244 if (!empty($campaignsData[$cmpid]['end_date'])) {
245 $campaignsData[$cmpid]['end_date'] = CRM_Utils_Date
::customFormat($campaignsData[$cmpid]['end_date'],
246 $config->dateformatFull
249 $campaignsData[$cmpid]['action'] = CRM_Core_Action
::formLink(self
::campaignActionLinks(),
251 array('id' => $campaign['id']),
254 'campaign.dashboard.row',
261 return $campaignsData;
267 function browseSurvey() {
268 // ensure valid javascript - this must have a value set
269 $this->assign('searchParams', json_encode(NULL));
270 $this->assign('surveyTypes', json_encode(NULL));
271 $this->assign('surveyCampaigns', json_encode(NULL));
273 $this->assign('addSurveyUrl', CRM_Utils_System
::url('civicrm/survey/add', 'reset=1&action=add'));
275 $surveyCount = CRM_Campaign_BAO_Survey
::getSurveyCount();
276 //don't load find interface when no survey in db.
278 $this->assign('hasSurveys', FALSE);
281 $this->assign('hasSurveys', TRUE);
283 //build the ajaxify survey search and selector.
284 $controller = new CRM_Core_Controller_Simple('CRM_Campaign_Form_Search_Survey', ts('Search Survey'));
285 $controller->set('searchTab', 'survey');
286 $controller->setEmbedded(TRUE);
287 $controller->process();
288 return $controller->run();
292 * @param array $params
296 function getSurveySummary($params = array()) {
297 $surveysData = array();
300 $config = CRM_Core_Config
::singleton();
301 $surveys = CRM_Campaign_BAO_Survey
::getSurveySummary($params);
302 if (!empty($surveys)) {
303 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
304 $surveyType = CRM_Campaign_BAO_Survey
::getSurveyActivityType();
305 foreach ($surveys as $sid => $survey) {
306 $surveysData[$sid] = $survey;
307 $campaignId = CRM_Utils_Array
::value('campaign_id', $survey);
308 $surveysData[$sid]['campaign'] = CRM_Utils_Array
::value($campaignId, $campaigns);
309 $surveysData[$sid]['activity_type'] = $surveyType[$survey['activity_type_id']];
310 if (!empty($survey['release_frequency'])) {
311 $surveysData[$sid]['release_frequency'] = $survey['release_frequency'] . ' Day(s)';
314 $action = array_sum(array_keys(self
::surveyActionLinks($surveysData[$sid]['activity_type'])));
315 if ($survey['is_active']) {
316 $action -= CRM_Core_Action
::ENABLE
;
319 $action -= CRM_Core_Action
::DISABLE
;
322 $isActive = ts('No');
323 if ($surveysData[$sid]['is_active']) {
324 $isActive = ts('Yes');
326 $surveysData[$sid]['isActive'] = $isActive;
329 if ($surveysData[$sid]['is_default']) {
330 $isDefault = '<img src="' . $config->resourceBase
. 'i/check.gif" alt="' . ts('Default') . '" />';
332 $surveysData[$sid]['is_default'] = $isDefault;
334 if ($surveysData[$sid]['result_id']) {
335 $resultSet = '<a href= "javascript:displayResultSet( ' . $sid . ',' . "'" . $surveysData[$sid]['title'] . "'" . ', ' . $surveysData[$sid]['result_id'] . ' )" title="' . ts('view result set').'">' . ts('Result Set') . '</a>';
336 $surveysData[$sid]['result_id'] = $resultSet;
338 $resultUrl = CRM_Utils_System
::url("civicrm/survey/configure/results", "action=update&id={$sid}&reset=1");
339 $surveysData[$sid]['result_id'] = "<a href='{$resultUrl}' class='status-warning'>(" . ts('Incomplete. Click to configure result set.') . ')</a>';
341 $surveysData[$sid]['action'] = CRM_Core_Action
::formLink(self
::surveyActionLinks($surveysData[$sid]['activity_type']),
346 'survey.dashboard.row',
351 if (CRM_Utils_Array
::value('activity_type', $surveysData[$sid]) != 'Petition') {
352 $surveysData[$sid]['voterLinks'] = CRM_Campaign_BAO_Survey
::buildPermissionLinks($sid,
358 if ($reportID = CRM_Campaign_BAO_Survey
::getReportID($sid)) {
359 $url = CRM_Utils_System
::url("civicrm/report/instance/{$reportID}",'reset=1');
360 $surveysData[$sid]['title'] = "<a href='{$url}' title='View Survey Report'>{$surveysData[$sid]['title']}</a>";
368 function browsePetition() {
369 // ensure valid javascript - this must have a value set
370 $this->assign('searchParams', json_encode(NULL));
371 $this->assign('petitionCampaigns', json_encode(NULL));
373 $this->assign('addPetitionUrl', CRM_Utils_System
::url('civicrm/petition/add', 'reset=1&action=add'));
375 $petitionCount = CRM_Campaign_BAO_Petition
::getPetitionCount();
376 //don't load find interface when no petition in db.
377 if (!$petitionCount) {
378 $this->assign('hasPetitions', FALSE);
381 $this->assign('hasPetitions', TRUE);
383 //build the ajaxify petition search and selector.
384 $controller = new CRM_Core_Controller_Simple('CRM_Campaign_Form_Search_Petition', ts('Search Petition'));
385 $controller->set('searchTab', 'petition');
386 $controller->setEmbedded(TRUE);
387 $controller->process();
388 return $controller->run();
392 * @param array $params
396 function getPetitionSummary($params = array()) {
397 $config = CRM_Core_Config
::singleton();
398 $petitionsData = array();
401 $petitions = CRM_Campaign_BAO_Petition
::getPetitionSummary($params);
402 if (!empty($petitions)) {
403 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
404 $petitionType = CRM_Campaign_BAO_Survey
::getSurveyActivityType('label', TRUE);
405 foreach ($petitions as $pid => $petition) {
406 $petitionsData[$pid] = $petition;
407 $camapignId = CRM_Utils_Array
::value('campaign_id', $petition);
408 $petitionsData[$pid]['campaign'] = CRM_Utils_Array
::value($camapignId, $campaigns);
409 $petitionsData[$pid]['activity_type'] = $petitionType[$petition['activity_type_id']];
411 $action = array_sum(array_keys(self
::petitionActionLinks()));
413 if ($petition['is_active']) {
414 $action -= CRM_Core_Action
::ENABLE
;
417 $action -= CRM_Core_Action
::DISABLE
;
420 $isActive = ts('No');
421 if ($petitionsData[$pid]['is_active']) {
422 $isActive = ts('Yes');
424 $petitionsData[$pid]['isActive'] = $isActive;
426 if ($petitionsData[$pid]['is_default']) {
427 $isDefault = '<img src="' . $config->resourceBase
. 'i/check.gif" alt="' . ts('Default') . '" />';
429 $petitionsData[$pid]['is_default'] = $isDefault;
431 $petitionsData[$pid]['action'] = CRM_Core_Action
::formLink(self
::petitionActionLinks(),
436 'petition.dashboard.row',
443 return $petitionsData;
447 $this->_tabs
= array(
448 'campaign' => ts('Campaigns'),
449 'survey' => ts('Surveys'),
450 'petition' => ts('Petitions'),
453 $subPageType = CRM_Utils_Request
::retrieve('type', 'String', $this);
455 if (!isset($this->_tabs
[$subPageType])) {
456 CRM_Utils_System
::permissionDenied();
458 //load the data in tabs.
459 $this->{'browse' . ucfirst($subPageType)}();
460 $this->assign('subPageType', ucfirst($subPageType));
466 CRM_Core_Resources
::singleton()
467 ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js', 1, 'html-header')
468 ->addSetting(array('tabSettings' => array(
469 'active' => strtolower(CRM_Utils_Array
::value('subPage', $_GET, 'campaign')),
477 if (!CRM_Campaign_BAO_Campaign
::accessCampaign()) {
478 CRM_Utils_System
::permissionDenied();
483 return parent
::run();
486 function buildTabs() {
488 foreach ($this->_tabs
as $name => $title) {
489 $allTabs[$name] = array(
493 'link' => CRM_Utils_System
::url('civicrm/campaign', "reset=1&type=$name"),
496 $allTabs['campaign']['class'] = 'livePage';
497 $this->assign('tabHeader', $allTabs);