CRM/Campaign/BAO/Campaign.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign {
  18
  19   /**
  20    * Takes an associative array and creates a campaign object.
  21    *
  22    * the function extract all the params it needs to initialize the create a
  23    * contact object. the params array could contain additional unused name/value
  24    * pairs
  25    *
  26    * @param array $params
  27    *   (reference ) an assoc array of name/value pairs.
  28    *
  29    * @return CRM_Campaign_DAO_Campaign
  30    */
  31   public static function create(&$params) {
  32     if (empty($params)) {
  33       return NULL;
  34     }
  35
  36     if (empty($params['id'])) {
  37
  38       if (empty($params['created_id'])) {
  39         $session = CRM_Core_Session::singleton();
  40         $params['created_id'] = $session->get('userID');
  41       }
  42
  43       if (empty($params['created_date'])) {
  44         $params['created_date'] = date('YmdHis');
  45       }
  46
  47       if (empty($params['name'])) {
  48         $params['name'] = CRM_Utils_String::titleToVar($params['title'], 64);
  49       }
  50
  51       CRM_Utils_Hook::pre('create', 'Campaign', NULL, $params);
  52     }
  53     else {
  54       CRM_Utils_Hook::pre('edit', 'Campaign', $params['id'], $params);
  55     }
  56
  57     $campaign = new CRM_Campaign_DAO_Campaign();
  58     $campaign->copyValues($params);
  59     $campaign->save();
  60
  61     if (!empty($params['id'])) {
  62       CRM_Utils_Hook::post('edit', 'Campaign', $campaign->id, $campaign);
  63     }
  64     else {
  65       CRM_Utils_Hook::post('create', 'Campaign', $campaign->id, $campaign);
  66     }
  67
  68     /* Create the campaign group record */
  69
  70     $groupTableName = CRM_Contact_BAO_Group::getTableName();
  71
  72     if (isset($params['groups']) && !empty($params['groups']['include']) && is_array($params['groups']['include'])) {
  73       foreach ($params['groups']['include'] as $entityId) {
  74         $dao = new CRM_Campaign_DAO_CampaignGroup();
  75         $dao->campaign_id = $campaign->id;
  76         $dao->entity_table = $groupTableName;
  77         $dao->entity_id = $entityId;
  78         $dao->group_type = 'Include';
  79         $dao->save();
  80       }
  81     }
  82
  83     //store custom data
  84     if (!empty($params['custom']) &&
  85       is_array($params['custom'])
  86     ) {
  87       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_campaign', $campaign->id);
  88     }
  89
  90     return $campaign;
  91   }
  92
  93   /**
  94    * Delete the campaign.
  95    *
  96    * @param int $id
  97    *   Id of the campaign.
  98    *
  99    * @return bool|mixed
 100    */
 101   public static function del($id) {
 102     if (!$id) {
 103       return FALSE;
 104     }
 105
 106     CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray);
 107
 108     $dao = new CRM_Campaign_DAO_Campaign();
 109     $dao->id = $id;
 110     $result = $dao->delete();
 111
 112     CRM_Utils_Hook::post('delete', 'Campaign', $id, $dao);
 113
 114     return $result;
 115   }
 116
 117   /**
 118    * Retrieve DB object based on input parameters.
 119    *
 120    * It also stores all the retrieved values in the default array.
 121    *
 122    * @param array $params
 123    *   (reference ) an assoc array of name/value pairs.
 124    * @param array $defaults
 125    *   (reference ) an assoc array to hold the flattened values.
 126    *
 127    * @return \CRM_Campaign_DAO_Campaign|null
 128    */
 129   public static function retrieve(&$params, &$defaults) {
 130     $campaign = new CRM_Campaign_DAO_Campaign();
 131
 132     $campaign->copyValues($params);
 133
 134     if ($campaign->find(TRUE)) {
 135       CRM_Core_DAO::storeValues($campaign, $defaults);
 136       return $campaign;
 137     }
 138     return NULL;
 139   }
 140
 141   /**
 142    * Return the all eligible campaigns w/ cache.
 143    *
 144    * @param int $includeId
 145    *   Lets inlcude this campaign by force.
 146    * @param int $excludeId
 147    *   Do not include this campaign.
 148    * @param bool $onlyActive
 149    *   Consider only active campaigns.
 150    *
 151    * @param bool $onlyCurrent
 152    * @param bool $appendDatesToTitle
 153    * @param bool $forceAll
 154    *
 155    * @return mixed
 156    *   $campaigns a set of campaigns.
 157    */
 158   public static function getCampaigns(
 159     $includeId = NULL,
 160     $excludeId = NULL,
 161     $onlyActive = TRUE,
 162     $onlyCurrent = TRUE,
 163     $appendDatesToTitle = FALSE,
 164     $forceAll = FALSE
 165   ) {
 166     static $campaigns;
 167     $cacheKey = 0;
 168     $cacheKeyParams = [
 169       'includeId',
 170       'excludeId',
 171       'onlyActive',
 172       'onlyCurrent',
 173       'appendDatesToTitle',
 174       'forceAll',
 175     ];
 176     foreach ($cacheKeyParams as $param) {
 177       $cacheParam = $$param;
 178       if (!$cacheParam) {
 179         $cacheParam = 0;
 180       }
 181       $cacheKey .= '_' . $cacheParam;
 182     }
 183
 184     if (!isset($campaigns[$cacheKey])) {
 185       $where = ['( camp.title IS NOT NULL )'];
 186       if ($excludeId) {
 187         $where[] = "( camp.id != $excludeId )";
 188       }
 189       if ($onlyActive) {
 190         $where[] = '( camp.is_active = 1 )';
 191       }
 192       if ($onlyCurrent) {
 193         $where[] = '( camp.end_date IS NULL OR camp.end_date >= NOW() )';
 194       }
 195       $whereClause = implode(' AND ', $where);
 196       if ($includeId) {
 197         $whereClause .= " OR ( camp.id = $includeId )";
 198       }
 199
 200       //lets force all.
 201       if ($forceAll) {
 202         $whereClause = '( 1 )';
 203       }
 204
 205       $query = "
 206   SELECT  camp.id,
 207           camp.title,
 208           camp.start_date,
 209           camp.end_date
 210     FROM  civicrm_campaign camp
 211    WHERE  {$whereClause}
 212 Order By  camp.title";
 213
 214       $campaign = CRM_Core_DAO::executeQuery($query);
 215       $campaigns[$cacheKey] = [];
 216       $config = CRM_Core_Config::singleton();
 217
 218       while ($campaign->fetch()) {
 219         $title = $campaign->title;
 220         if ($appendDatesToTitle) {
 221           $dates = [];
 222           foreach (['start_date', 'end_date'] as $date) {
 223             if ($campaign->$date) {
 224               $dates[] = CRM_Utils_Date::customFormat($campaign->$date, $config->dateformatFull);
 225             }
 226           }
 227           if (!empty($dates)) {
 228             $title .= ' (' . implode('-', $dates) . ')';
 229           }
 230         }
 231         $campaigns[$cacheKey][$campaign->id] = $title;
 232       }
 233     }
 234
 235     return $campaigns[$cacheKey];
 236   }
 237
 238   /**
 239    * Wrapper to self::getCampaigns( )
 240    * w/ permissions and component check.
 241    *
 242    * @param int $includeId
 243    * @param int $excludeId
 244    * @param bool $onlyActive
 245    * @param bool $onlyCurrent
 246    * @param bool $appendDatesToTitle
 247    * @param bool $forceAll
 248    * @param bool $doCheckForComponent
 249    * @param bool $doCheckForPermissions
 250    *
 251    * @return mixed
 252    */
 253   public static function getPermissionedCampaigns(
 254     $includeId = NULL,
 255     $excludeId = NULL,
 256     $onlyActive = TRUE,
 257     $onlyCurrent = TRUE,
 258     $appendDatesToTitle = FALSE,
 259     $forceAll = FALSE,
 260     $doCheckForComponent = TRUE,
 261     $doCheckForPermissions = TRUE
 262   ) {
 263     $cacheKey = 0;
 264     $cachekeyParams = [
 265       'includeId',
 266       'excludeId',
 267       'onlyActive',
 268       'onlyCurrent',
 269       'appendDatesToTitle',
 270       'doCheckForComponent',
 271       'doCheckForPermissions',
 272       'forceAll',
 273     ];
 274     foreach ($cachekeyParams as $param) {
 275       $cacheKeyParam = $$param;
 276       if (!$cacheKeyParam) {
 277         $cacheKeyParam = 0;
 278       }
 279       $cacheKey .= '_' . $cacheKeyParam;
 280     }
 281
 282     static $validCampaigns;
 283     if (!isset($validCampaigns[$cacheKey])) {
 284       $isValid = TRUE;
 285       $campaigns = [
 286         'campaigns' => [],
 287         'hasAccessCampaign' => FALSE,
 288         'isCampaignEnabled' => FALSE,
 289       ];
 290
 291       //do check for component.
 292       if ($doCheckForComponent) {
 293         $campaigns['isCampaignEnabled'] = $isValid = self::isCampaignEnable();
 294       }
 295
 296       //do check for permissions.
 297       if ($doCheckForPermissions) {
 298         $campaigns['hasAccessCampaign'] = $isValid = self::accessCampaign();
 299       }
 300
 301       //finally retrieve campaigns from db.
 302       if ($isValid) {
 303         $campaigns['campaigns'] = self::getCampaigns($includeId,
 304           $excludeId,
 305           $onlyActive,
 306           $onlyCurrent,
 307           $appendDatesToTitle,
 308           $forceAll
 309         );
 310       }
 311
 312       //store in cache.
 313       $validCampaigns[$cacheKey] = $campaigns;
 314     }
 315
 316     return $validCampaigns[$cacheKey];
 317   }
 318
 319   /**
 320    * Is CiviCampaign enabled.
 321    * @return bool
 322    */
 323   public static function isCampaignEnable() {
 324     static $isEnable = NULL;
 325
 326     if (!isset($isEnable)) {
 327       $isEnable = FALSE;
 328       $config = CRM_Core_Config::singleton();
 329       if (in_array('CiviCampaign', $config->enableComponents)) {
 330         $isEnable = TRUE;
 331       }
 332     }
 333
 334     return $isEnable;
 335   }
 336
 337   /**
 338    * Retrieve campaigns for dashboard.
 339    *
 340    * @param array $params
 341    * @param bool $onlyCount
 342    *
 343    * @return array|int
 344    */
 345   public static function getCampaignSummary($params = [], $onlyCount = FALSE) {
 346     $campaigns = [];
 347
 348     //build the limit and order clause.
 349     $limitClause = $orderByClause = $lookupTableJoins = NULL;
 350     if (!$onlyCount) {
 351       $sortParams = [
 352         'sort' => 'start_date',
 353         'offset' => 0,
 354         'rowCount' => 10,
 355         'sortOrder' => 'desc',
 356       ];
 357       foreach ($sortParams as $name => $default) {
 358         if (!empty($params[$name])) {
 359           $sortParams[$name] = $params[$name];
 360         }
 361       }
 362
 363       //need to lookup tables.
 364       $orderOnCampaignTable = TRUE;
 365       if ($sortParams['sort'] == 'status') {
 366         $orderOnCampaignTable = FALSE;
 367         $lookupTableJoins = "
 368  LEFT JOIN civicrm_option_value status ON ( status.value = campaign.status_id OR campaign.status_id IS NULL )
 369 INNER JOIN civicrm_option_group grp ON ( status.option_group_id = grp.id AND grp.name = 'campaign_status' )";
 370         $orderByClause = "ORDER BY status.label {$sortParams['sortOrder']}";
 371       }
 372       elseif ($sortParams['sort'] == 'campaign_type') {
 373         $orderOnCampaignTable = FALSE;
 374         $lookupTableJoins = "
 375  LEFT JOIN civicrm_option_value campaign_type ON ( campaign_type.value = campaign.campaign_type_id
 376                                                    OR campaign.campaign_type_id IS NULL )
 377 INNER JOIN civicrm_option_group grp ON ( campaign_type.option_group_id = grp.id AND grp.name = 'campaign_type' )";
 378         $orderByClause = "ORDER BY campaign_type.label {$sortParams['sortOrder']}";
 379       }
 380       elseif ($sortParams['sort'] == 'isActive') {
 381         $sortParams['sort'] = 'is_active';
 382       }
 383       if ($orderOnCampaignTable) {
 384         $orderByClause = "ORDER BY campaign.{$sortParams['sort']} {$sortParams['sortOrder']}";
 385       }
 386       $limitClause = "LIMIT {$sortParams['offset']}, {$sortParams['rowCount']}";
 387     }
 388
 389     //build the where clause.
 390     $queryParams = $where = [];
 391     if (!empty($params['id'])) {
 392       $where[] = "( campaign.id = %1 )";
 393       $queryParams[1] = [$params['id'], 'Positive'];
 394     }
 395     if (!empty($params['name'])) {
 396       $where[] = "( campaign.name LIKE %2 )";
 397       $queryParams[2] = ['%' . trim($params['name']) . '%', 'String'];
 398     }
 399     if (!empty($params['title'])) {
 400       $where[] = "( campaign.title LIKE %3 )";
 401       $queryParams[3] = ['%' . trim($params['title']) . '%', 'String'];
 402     }
 403     if (!empty($params['start_date'])) {
 404       $startDate = CRM_Utils_Date::processDate($params['start_date']);
 405       $where[] = "( campaign.start_date >= %4 OR campaign.start_date IS NULL )";
 406       $queryParams[4] = [$startDate, 'String'];
 407     }
 408     if (!empty($params['end_date'])) {
 409       $endDate = CRM_Utils_Date::processDate($params['end_date'], '235959');
 410       $where[] = "( campaign.end_date <= %5 OR campaign.end_date IS NULL )";
 411       $queryParams[5] = [$endDate, 'String'];
 412     }
 413     if (!empty($params['description'])) {
 414       $where[] = "( campaign.description LIKE %6 )";
 415       $queryParams[6] = ['%' . trim($params['description']) . '%', 'String'];
 416     }
 417     if (!empty($params['campaign_type_id'])) {
 418       $typeId = $params['campaign_type_id'];
 419       if (is_array($params['campaign_type_id'])) {
 420         $typeId = implode(' , ', $params['campaign_type_id']);
 421       }
 422       $where[] = "( campaign.campaign_type_id IN ( {$typeId} ) )";
 423     }
 424     if (!empty($params['status_id'])) {
 425       $statusId = $params['status_id'];
 426       if (is_array($params['status_id'])) {
 427         $statusId = implode(' , ', $params['status_id']);
 428       }
 429       $where[] = "( campaign.status_id IN ( {$statusId} ) )";
 430     }
 431     if (array_key_exists('is_active', $params)) {
 432       $active = "( campaign.is_active = 1 )";
 433       if (!empty($params['is_active'])) {
 434         $active = "( campaign.is_active = 0 OR campaign.is_active IS NULL )";
 435       }
 436       $where[] = $active;
 437     }
 438     $whereClause = NULL;
 439     if (!empty($where)) {
 440       $whereClause = ' WHERE ' . implode(" \nAND ", $where);
 441     }
 442
 443     $properties = [
 444       'id',
 445       'name',
 446       'title',
 447       'start_date',
 448       'end_date',
 449       'status_id',
 450       'is_active',
 451       'description',
 452       'campaign_type_id',
 453     ];
 454
 455     $selectClause = '
 456 SELECT  campaign.id               as id,
 457         campaign.name             as name,
 458         campaign.title            as title,
 459         campaign.is_active        as is_active,
 460         campaign.status_id        as status_id,
 461         campaign.end_date         as end_date,
 462         campaign.start_date       as start_date,
 463         campaign.description      as description,
 464         campaign.campaign_type_id as campaign_type_id';
 465     if ($onlyCount) {
 466       $selectClause = 'SELECT COUNT(*)';
 467     }
 468     $fromClause = 'FROM  civicrm_campaign campaign';
 469
 470     $query = "{$selectClause} {$fromClause} {$lookupTableJoins} {$whereClause} {$orderByClause} {$limitClause}";
 471
 472     //in case of only count.
 473     if ($onlyCount) {
 474       return (int) CRM_Core_DAO::singleValueQuery($query, $queryParams);
 475     }
 476
 477     $campaign = CRM_Core_DAO::executeQuery($query, $queryParams);
 478     while ($campaign->fetch()) {
 479       foreach ($properties as $property) {
 480         $campaigns[$campaign->id][$property] = $campaign->$property;
 481       }
 482     }
 483
 484     return $campaigns;
 485   }
 486
 487   /**
 488    * Get the campaign count.
 489    *
 490    */
 491   public static function getCampaignCount() {
 492     return (int) CRM_Core_DAO::singleValueQuery('SELECT COUNT(*) FROM civicrm_campaign');
 493   }
 494
 495   /**
 496    * Get Campaigns groups.
 497    *
 498    * @param int $campaignId
 499    *   Campaign id.
 500    *
 501    * @return array
 502    */
 503   public static function getCampaignGroups($campaignId) {
 504     static $campaignGroups;
 505     if (!$campaignId) {
 506       return [];
 507     }
 508
 509     if (!isset($campaignGroups[$campaignId])) {
 510       $campaignGroups[$campaignId] = [];
 511
 512       $query = "
 513     SELECT  grp.title, grp.id
 514       FROM  civicrm_campaign_group campgrp
 515 INNER JOIN  civicrm_group grp ON ( grp.id = campgrp.entity_id )
 516      WHERE  campgrp.group_type = 'Include'
 517        AND  campgrp.entity_table = 'civicrm_group'
 518        AND  campgrp.campaign_id = %1";
 519
 520       $groups = CRM_Core_DAO::executeQuery($query, [1 => [$campaignId, 'Positive']]);
 521       while ($groups->fetch()) {
 522         $campaignGroups[$campaignId][$groups->id] = $groups->title;
 523       }
 524     }
 525
 526     return $campaignGroups[$campaignId];
 527   }
 528
 529   /**
 530    * Update the is_active flag in the db.
 531    *
 532    * @param int $id
 533    *   Id of the database record.
 534    * @param bool $is_active
 535    *   Value we want to set the is_active field.
 536    *
 537    * @return bool
 538    *   true if we found and updated the object, else false
 539    */
 540   public static function setIsActive($id, $is_active) {
 541     return CRM_Core_DAO::setFieldValue('CRM_Campaign_DAO_Campaign', $id, 'is_active', $is_active);
 542   }
 543
 544   /**
 545    * @return bool
 546    */
 547   public static function accessCampaign() {
 548     static $allow = NULL;
 549
 550     if (!isset($allow)) {
 551       $allow = FALSE;
 552       if (CRM_Core_Permission::check('manage campaign') ||
 553         CRM_Core_Permission::check('administer CiviCampaign')
 554       ) {
 555         $allow = TRUE;
 556       }
 557     }
 558
 559     return $allow;
 560   }
 561
 562   /**
 563    * Add select element for campaign
 564    * and assign needful info to templates.
 565    *
 566    * @param CRM_Core_Form $form
 567    * @param int $connectedCampaignId
 568    */
 569   public static function addCampaign(&$form, $connectedCampaignId = NULL) {
 570     //some forms do set default and freeze.
 571     $appendDates = TRUE;
 572     if ($form->get('action') & CRM_Core_Action::VIEW) {
 573       $appendDates = FALSE;
 574     }
 575
 576     $campaignDetails = self::getPermissionedCampaigns($connectedCampaignId, NULL, TRUE, TRUE, $appendDates);
 577     $fields = ['campaigns', 'hasAccessCampaign', 'isCampaignEnabled'];
 578     foreach ($fields as $fld) {
 579       $$fld = CRM_Utils_Array::value($fld, $campaignDetails);
 580     }
 581
 582     $showAddCampaign = FALSE;
 583     if ($connectedCampaignId || ($isCampaignEnabled && $hasAccessCampaign)) {
 584       $showAddCampaign = TRUE;
 585       $campaign = $form->addEntityRef('campaign_id', ts('Campaign'), [
 586         'entity' => 'Campaign',
 587         'create' => TRUE,
 588         'select' => ['minimumInputLength' => 0],
 589       ]);
 590       //lets freeze when user does not has access or campaign is disabled.
 591       if (!$isCampaignEnabled || !$hasAccessCampaign) {
 592         $campaign->freeze();
 593       }
 594     }
 595
 596     //carry this info to templates.
 597     $infoFields = [
 598       'showAddCampaign',
 599       'hasAccessCampaign',
 600       'isCampaignEnabled',
 601     ];
 602     foreach ($infoFields as $fld) {
 603       $campaignInfo[$fld] = $$fld;
 604     }
 605     $form->assign('campaignInfo', $campaignInfo);
 606   }
 607
 608   /**
 609    * Add campaign in component search.
 610    * and assign needful info to templates.
 611    *
 612    * @param CRM_Core_Form $form
 613    * @param string $elementName
 614    */
 615   public static function addCampaignInComponentSearch(&$form, $elementName = 'campaign_id') {
 616     $campaignInfo = [];
 617     $campaignDetails = self::getPermissionedCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 618     $fields = ['campaigns', 'hasAccessCampaign', 'isCampaignEnabled'];
 619     foreach ($fields as $fld) {
 620       $$fld = CRM_Utils_Array::value($fld, $campaignDetails);
 621     }
 622     $showCampaignInSearch = FALSE;
 623     if ($isCampaignEnabled && $hasAccessCampaign && !empty($campaigns)) {
 624       //get the current campaign only.
 625       $currentCampaigns = self::getCampaigns(NULL, NULL, FALSE);
 626       $pastCampaigns = array_diff($campaigns, $currentCampaigns);
 627       $allCampaigns = [];
 628       if (!empty($currentCampaigns)) {
 629         $allCampaigns = ['crm_optgroup_current_campaign' => ts('Current Campaigns')] + $currentCampaigns;
 630       }
 631       if (!empty($pastCampaigns)) {
 632         $allCampaigns += ['crm_optgroup_past_campaign' => ts('Past Campaigns')] + $pastCampaigns;
 633       }
 634
 635       $showCampaignInSearch = TRUE;
 636       $form->add('select', $elementName, ts('Campaigns'), $allCampaigns, FALSE,
 637         ['id' => 'campaigns', 'multiple' => 'multiple', 'class' => 'crm-select2']
 638       );
 639     }
 640     $infoFields = [
 641       'elementName',
 642       'hasAccessCampaign',
 643       'isCampaignEnabled',
 644       'showCampaignInSearch',
 645     ];
 646     foreach ($infoFields as $fld) {
 647       $campaignInfo[$fld] = $$fld;
 648     }
 649     $form->assign('campaignInfo', $campaignInfo);
 650   }
 651
 652   /**
 653    * @return array
 654    */
 655   public static function getEntityRefFilters() {
 656     return [
 657       ['key' => 'campaign_type_id', 'value' => ts('Campaign Type')],
 658       ['key' => 'status_id', 'value' => ts('Status')],
 659       [
 660         'key' => 'start_date',
 661         'value' => ts('Start Date'),
 662         'options' => [
 663           ['key' => '{">":"now"}', 'value' => ts('Upcoming')],
 664           [
 665             'key' => '{"BETWEEN":["now - 3 month","now"]}',
 666             'value' => ts('Past 3 Months'),
 667           ],
 668           [
 669             'key' => '{"BETWEEN":["now - 6 month","now"]}',
 670             'value' => ts('Past 6 Months'),
 671           ],
 672           [
 673             'key' => '{"BETWEEN":["now - 1 year","now"]}',
 674             'value' => ts('Past Year'),
 675           ],
 676         ],
 677       ],
 678       [
 679         'key' => 'end_date',
 680         'value' => ts('End Date'),
 681         'options' => [
 682           ['key' => '{">":"now"}', 'value' => ts('In the future')],
 683           ['key' => '{"<":"now"}', 'value' => ts('In the past')],
 684           ['key' => '{"IS NULL":"1"}', 'value' => ts('Not set')],
 685         ],
 686       ],
 687     ];
 688   }
 689
 690   /**
 691    * Links to create new campaigns from entityRef widget
 692    *
 693    * @return array|bool
 694    */
 695   public static function getEntityRefCreateLinks() {
 696     if (CRM_Core_Permission::check([['administer CiviCampaign', 'manage campaign']])) {
 697       return [
 698         [
 699           'label' => ts('New Campaign'),
 700           'url' => CRM_Utils_System::url('civicrm/campaign/add', "reset=1",
 701             NULL, NULL, FALSE, FALSE, TRUE),
 702           'type' => 'Campaign',
 703         ],
 704       ];
 705     }
 706     return FALSE;
 707   }
 708
 709 }