CRM/Campaign/Page/DashBoard.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  --------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Page for displaying Campaigns
  38  */
  39 class CRM_Campaign_Page_DashBoard extends CRM_Core_Page {
  40
  41   /**
  42    * The action links that we need to display for the browse screen
  43    *
  44    * @var array
  45    */
  46   private static $_campaignActionLinks;
  47   private static $_surveyActionLinks;
  48   private static $_petitionActionLinks;
  49
  50   /**
  51    * Get the action links for this page.
  52    *
  53    * @return array $_campaignActionLinks
  54    *
  55    */
  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(
  62           'name' => ts('Edit'),
  63           'url' => 'civicrm/campaign/add',
  64           'qs' => 'reset=1&action=update&id=%%id%%',
  65           'title' => ts('Update Campaign'),
  66         ),
  67         CRM_Core_Action::DISABLE => array(
  68           'name' => ts('Disable'),
  69           'title' => ts('Disable Campaign'),
  70           'ref' => 'crm-enable-disable',
  71         ),
  72         CRM_Core_Action::ENABLE => array(
  73           'name' => ts('Enable'),
  74           'title' => ts('Enable Campaign'),
  75           'ref' => 'crm-enable-disable',
  76         ),
  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'),
  82         ),
  83       );
  84     }
  85
  86     return self::$_campaignActionLinks;
  87   }
  88
  89   /**
  90    * @return array
  91    */
  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(
  97           'name' => ts('Edit'),
  98           'url' => 'civicrm/survey/configure/main',
  99           'qs' => 'action=update&id=%%id%%&reset=1',
 100           'title' => ts('Update Survey'),
 101         ),
 102         CRM_Core_Action::DISABLE => array(
 103           'name' => ts('Disable'),
 104           'ref' => 'crm-enable-disable',
 105           'title' => ts('Disable Survey'),
 106         ),
 107         CRM_Core_Action::ENABLE => array(
 108           'name' => ts('Enable'),
 109           'ref' => 'crm-enable-disable',
 110           'title' => ts('Enable Survey'),
 111         ),
 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'),
 117         ),
 118       );
 119     }
 120
 121     return self::$_surveyActionLinks;
 122   }
 123
 124   /**
 125    * @return array
 126    */
 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'),
 135       );
 136       self::$_petitionActionLinks[CRM_Core_Action::DISABLE] = array(
 137         'name' => ts('Disable'),
 138         'ref' => 'crm-enable-disable',
 139         'title' => ts('Disable Petition'),
 140       );
 141       self::$_petitionActionLinks[CRM_Core_Action::ENABLE] = array(
 142         'name' => ts('Enable'),
 143         'ref' => 'crm-enable-disable',
 144         'title' => ts('Enable Petition'),
 145       );
 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'),
 151       );
 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'),
 157         'fe' => TRUE,
 158       //CRM_Core_Action::PROFILE is used because there isn't a specific action for sign
 159       );
 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
 166       );
 167     }
 168
 169     return self::$_petitionActionLinks;
 170   }
 171
 172   /**
 173    * @return mixed
 174    */
 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));
 180
 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);
 186       return;
 187     }
 188     $this->assign('hasCampaigns', TRUE);
 189
 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();
 196   }
 197
 198   /**
 199    * @param array $params
 200    *
 201    * @return array
 202    */
 203   public static function getCampaignSummary($params = array(
 204     )) {
 205     $campaignsData = array();
 206
 207     //get the campaigns.
 208     $campaigns = CRM_Campaign_BAO_Campaign::getCampaignSummary($params);
 209     if (!empty($campaigns)) {
 210       $config         = CRM_Core_Config::singleton();
 211       $campaignType   = CRM_Campaign_PseudoConstant::campaignType();
 212       $campaignStatus = CRM_Campaign_PseudoConstant::campaignStatus();
 213       $properties     = array(
 214         'id', 'name', 'title', 'status_id', 'description',
 215         'campaign_type_id', 'is_active', 'start_date', 'end_date',
 216       );
 217       foreach ($campaigns as $cmpid => $campaign) {
 218         foreach ($properties as $prop) {
 219           $campaignsData[$cmpid][$prop] = CRM_Utils_Array::value($prop, $campaign);
 220         }
 221         $statusId = CRM_Utils_Array::value('status_id', $campaign);
 222         $campaignsData[$cmpid]['status'] = CRM_Utils_Array::value($statusId, $campaignStatus);
 223         $campaignsData[$cmpid]['campaign_id'] = $campaign['id'];
 224         $campaignsData[$cmpid]['campaign_type'] = $campaignType[$campaign['campaign_type_id']];
 225
 226         $action = array_sum(array_keys(self::campaignActionLinks()));
 227         if ($campaign['is_active']) {
 228           $action -= CRM_Core_Action::ENABLE;
 229         }
 230         else {
 231           $action -= CRM_Core_Action::DISABLE;
 232         }
 233
 234         $isActive = ts('No');
 235         if ($campaignsData[$cmpid]['is_active']) {
 236           $isActive = ts('Yes');
 237         }
 238         $campaignsData[$cmpid]['isActive'] = $isActive;
 239
 240         if (!empty($campaignsData[$cmpid]['start_date'])) {
 241           $campaignsData[$cmpid]['start_date'] = CRM_Utils_Date::customFormat($campaignsData[$cmpid]['start_date'],
 242             $config->dateformatFull
 243           );
 244         }
 245         if (!empty($campaignsData[$cmpid]['end_date'])) {
 246           $campaignsData[$cmpid]['end_date'] = CRM_Utils_Date::customFormat($campaignsData[$cmpid]['end_date'],
 247             $config->dateformatFull
 248           );
 249         }
 250         $campaignsData[$cmpid]['action'] = CRM_Core_Action::formLink(self::campaignActionLinks(),
 251           $action,
 252           array('id' => $campaign['id']),
 253           ts('more'),
 254           FALSE,
 255           'campaign.dashboard.row',
 256           'Campaign',
 257           $campaign['id']
 258         );
 259       }
 260     }
 261
 262     return $campaignsData;
 263   }
 264
 265   /**
 266    * @return mixed
 267    */
 268   function browseSurvey() {
 269     // ensure valid javascript - this must have a value set
 270     $this->assign('searchParams', json_encode(NULL));
 271     $this->assign('surveyTypes', json_encode(NULL));
 272     $this->assign('surveyCampaigns', json_encode(NULL));
 273
 274     $this->assign('addSurveyUrl', CRM_Utils_System::url('civicrm/survey/add', 'reset=1&action=add'));
 275
 276     $surveyCount = CRM_Campaign_BAO_Survey::getSurveyCount();
 277     //don't load find interface when no survey in db.
 278     if (!$surveyCount) {
 279       $this->assign('hasSurveys', FALSE);
 280       return;
 281     }
 282     $this->assign('hasSurveys', TRUE);
 283
 284     //build the ajaxify survey search and selector.
 285     $controller = new CRM_Core_Controller_Simple('CRM_Campaign_Form_Search_Survey', ts('Search Survey'));
 286     $controller->set('searchTab', 'survey');
 287     $controller->setEmbedded(TRUE);
 288     $controller->process();
 289     return $controller->run();
 290   }
 291
 292   /**
 293    * @param array $params
 294    *
 295    * @return array
 296    */
 297   function getSurveySummary($params = array(
 298     )) {
 299     $surveysData = array();
 300
 301     //get the survey.
 302     $config = CRM_Core_Config::singleton();
 303     $surveys = CRM_Campaign_BAO_Survey::getSurveySummary($params);
 304     if (!empty($surveys)) {
 305       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 306       $surveyType = CRM_Campaign_BAO_Survey::getSurveyActivityType();
 307       foreach ($surveys as $sid => $survey) {
 308         $surveysData[$sid] = $survey;
 309         $campaignId = CRM_Utils_Array::value('campaign_id', $survey);
 310         $surveysData[$sid]['campaign'] = CRM_Utils_Array::value($campaignId, $campaigns);
 311         $surveysData[$sid]['activity_type'] = $surveyType[$survey['activity_type_id']];
 312         if (!empty($survey['release_frequency'])) {
 313           $surveysData[$sid]['release_frequency'] = $survey['release_frequency'] . ' Day(s)';
 314         }
 315
 316         $action = array_sum(array_keys(self::surveyActionLinks($surveysData[$sid]['activity_type'])));
 317         if ($survey['is_active']) {
 318           $action -= CRM_Core_Action::ENABLE;
 319         }
 320         else {
 321           $action -= CRM_Core_Action::DISABLE;
 322         }
 323
 324         $isActive = ts('No');
 325         if ($surveysData[$sid]['is_active']) {
 326           $isActive = ts('Yes');
 327         }
 328         $surveysData[$sid]['isActive'] = $isActive;
 329
 330         $isDefault = NULL;
 331         if ($surveysData[$sid]['is_default']) {
 332           $isDefault = '<img src="' . $config->resourceBase . 'i/check.gif" alt="' . ts('Default') . '" />';
 333         }
 334         $surveysData[$sid]['is_default'] = $isDefault;
 335
 336         if ($surveysData[$sid]['result_id']) {
 337           $resultSet = '<a href= "javascript:displayResultSet( ' . $sid . ',' . "'" . $surveysData[$sid]['title'] . "'" . ', ' . $surveysData[$sid]['result_id'] . ' )" title="' . ts('view result set').'">' . ts('Result Set') . '</a>';
 338           $surveysData[$sid]['result_id'] = $resultSet;
 339         } else {
 340           $resultUrl = CRM_Utils_System::url("civicrm/survey/configure/results", "action=update&id={$sid}&reset=1");
 341           $surveysData[$sid]['result_id'] = "<a href='{$resultUrl}' class='status-warning'>(" . ts('Incomplete. Click to configure result set.') . ')</a>';
 342         }
 343         $surveysData[$sid]['action'] = CRM_Core_Action::formLink(self::surveyActionLinks($surveysData[$sid]['activity_type']),
 344           $action,
 345           array('id' => $sid),
 346           ts('more'),
 347           FALSE,
 348           'survey.dashboard.row',
 349           'Survey',
 350           $sid
 351         );
 352
 353         if (CRM_Utils_Array::value('activity_type', $surveysData[$sid]) != 'Petition') {
 354           $surveysData[$sid]['voterLinks'] = CRM_Campaign_BAO_Survey::buildPermissionLinks($sid,
 355             TRUE,
 356             ts('more')
 357           );
 358         }
 359
 360         if ($reportID = CRM_Campaign_BAO_Survey::getReportID($sid)) {
 361           $url = CRM_Utils_System::url("civicrm/report/instance/{$reportID}",'reset=1');
 362           $surveysData[$sid]['title'] = "<a href='{$url}' title='View Survey Report'>{$surveysData[$sid]['title']}</a>";
 363         }
 364       }
 365     }
 366
 367     return $surveysData;
 368   }
 369
 370   function browsePetition() {
 371     // ensure valid javascript - this must have a value set
 372     $this->assign('searchParams', json_encode(NULL));
 373     $this->assign('petitionCampaigns', json_encode(NULL));
 374
 375     $this->assign('addPetitionUrl', CRM_Utils_System::url('civicrm/petition/add', 'reset=1&action=add'));
 376
 377     $petitionCount = CRM_Campaign_BAO_Petition::getPetitionCount();
 378     //don't load find interface when no petition in db.
 379     if (!$petitionCount) {
 380       $this->assign('hasPetitions', FALSE);
 381       return;
 382     }
 383     $this->assign('hasPetitions', TRUE);
 384
 385     //build the ajaxify petition search and selector.
 386     $controller = new CRM_Core_Controller_Simple('CRM_Campaign_Form_Search_Petition', ts('Search Petition'));
 387     $controller->set('searchTab', 'petition');
 388     $controller->setEmbedded(TRUE);
 389     $controller->process();
 390     return $controller->run();
 391   }
 392
 393   /**
 394    * @param array $params
 395    *
 396    * @return array
 397    */
 398   function getPetitionSummary($params = array(
 399     )) {
 400     $config = CRM_Core_Config::singleton();
 401     $petitionsData = array();
 402
 403     //get the petitions.
 404     $petitions = CRM_Campaign_BAO_Petition::getPetitionSummary($params);
 405     if (!empty($petitions)) {
 406       $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 407       $petitionType = CRM_Campaign_BAO_Survey::getSurveyActivityType('label', TRUE);
 408       foreach ($petitions as $pid => $petition) {
 409         $petitionsData[$pid] = $petition;
 410         $camapignId = CRM_Utils_Array::value('campaign_id', $petition);
 411         $petitionsData[$pid]['campaign'] = CRM_Utils_Array::value($camapignId, $campaigns);
 412         $petitionsData[$pid]['activity_type'] = $petitionType[$petition['activity_type_id']];
 413
 414         $action = array_sum(array_keys(self::petitionActionLinks()));
 415
 416         if ($petition['is_active']) {
 417           $action -= CRM_Core_Action::ENABLE;
 418         }
 419         else {
 420           $action -= CRM_Core_Action::DISABLE;
 421         }
 422
 423         $isActive = ts('No');
 424         if ($petitionsData[$pid]['is_active']) {
 425           $isActive = ts('Yes');
 426         }
 427         $petitionsData[$pid]['isActive'] = $isActive;
 428         $isDefault = NULL;
 429         if ($petitionsData[$pid]['is_default']) {
 430           $isDefault = '<img src="' . $config->resourceBase . 'i/check.gif" alt="' . ts('Default') . '" />';
 431         }
 432         $petitionsData[$pid]['is_default'] = $isDefault;
 433
 434         $petitionsData[$pid]['action'] = CRM_Core_Action::formLink(self::petitionActionLinks(),
 435           $action,
 436           array('id' => $pid),
 437           ts('more'),
 438           FALSE,
 439           'petition.dashboard.row',
 440           'Petition',
 441           $pid
 442         );
 443       }
 444     }
 445
 446     return $petitionsData;
 447   }
 448
 449   function browse() {
 450     $this->_tabs = array(
 451       'campaign' => ts('Campaigns'),
 452       'survey' => ts('Surveys'),
 453       'petition' => ts('Petitions'),
 454     );
 455
 456     $subPageType = CRM_Utils_Request::retrieve('type', 'String', $this);
 457     if ($subPageType) {
 458       if (!isset($this->_tabs[$subPageType])) {
 459         CRM_Utils_System::permissionDenied();
 460       }
 461       //load the data in tabs.
 462       $this->{'browse' . ucfirst($subPageType)}();
 463       $this->assign('subPageType', ucfirst($subPageType));
 464     }
 465     else {
 466       //build the tabs.
 467       $this->buildTabs();
 468     }
 469     CRM_Core_Resources::singleton()
 470       ->addScriptFile('civicrm', 'templates/CRM/common/TabHeader.js', 1, 'html-header')
 471       ->addSetting(array('tabSettings' => array(
 472         'active' => strtolower(CRM_Utils_Array::value('subPage', $_GET, 'campaign')),
 473       )));
 474   }
 475
 476   /**
 477    * @return string
 478    */
 479   function run() {
 480     if (!CRM_Campaign_BAO_Campaign::accessCampaign()) {
 481       CRM_Utils_System::permissionDenied();
 482     }
 483
 484     $this->browse();
 485
 486     return parent::run();
 487   }
 488
 489   function buildTabs() {
 490     $allTabs = array();
 491     foreach ($this->_tabs as $name => $title) {
 492       $allTabs[$name] = array(
 493         'title' => $title,
 494         'valid' => TRUE,
 495         'active' => TRUE,
 496         'link' => CRM_Utils_System::url('civicrm/campaign', "reset=1&type=$name"),
 497       );
 498     }
 499     $this->assign('tabHeader', $allTabs);
 500   }
 501 }
 502