CRM/Extension/Manager/Report.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * This class stores logic for managing CiviCRM extensions.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2015
  33  */
  34 class CRM_Extension_Manager_Report extends CRM_Extension_Manager_Base {
  35
  36   const REPORT_GROUP_NAME = 'report_template';
  37
  38   public function __construct() {
  39     parent::__construct(TRUE);
  40     $this->groupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
  41       self::REPORT_GROUP_NAME, 'id', 'name'
  42     );
  43   }
  44
  45   /**
  46    * @param CRM_Extension_Info $info
  47    *
  48    * @throws Exception
  49    */
  50   public function onPreInstall(CRM_Extension_Info $info) {
  51     $customReports = $this->getCustomReportsByName();
  52     if (array_key_exists($info->key, $customReports)) {
  53       CRM_Core_Error::fatal('This report is already registered.');
  54     }
  55
  56     if ($info->typeInfo['component'] === 'Contact') {
  57       $compId = 'null';
  58     }
  59     else {
  60       $comp = CRM_Core_Component::get($info->typeInfo['component']);
  61       $compId = $comp->componentID;
  62     }
  63     if (empty($compId)) {
  64       CRM_Core_Error::fatal("Component for which you're trying to install the extension (" . $info->typeInfo['component'] . ") is currently disabled.");
  65     }
  66     $weight = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue',
  67       array('option_group_id' => $this->groupId)
  68     );
  69     $ids = array();
  70     $params = array(
  71       'label' => $info->label . ' (' . $info->key . ')',
  72       'value' => $info->typeInfo['reportUrl'],
  73       'name' => $info->key,
  74       'weight' => $weight,
  75       'description' => $info->label . ' (' . $info->key . ')',
  76       'component_id' => $compId,
  77       'option_group_id' => $this->groupId,
  78       'is_active' => 1,
  79     );
  80
  81     $optionValue = CRM_Core_BAO_OptionValue::add($params, $ids);
  82   }
  83
  84   /**
  85    * @param CRM_Extension_Info $info
  86    *
  87    * @return bool
  88    */
  89   public function onPreUninstall(CRM_Extension_Info $info) {
  90
  91     //        if( !array_key_exists( $info->key, $this->customReports ) ) {
  92     //            CRM_Core_Error::fatal( 'This report is not registered.' );
  93     //        }
  94
  95     $customReports = $this->getCustomReportsByName();
  96     $cr = $this->getCustomReportsById();
  97     $id = $cr[$customReports[$info->key]];
  98     $optionValue = CRM_Core_BAO_OptionValue::del($id);
  99
 100     return $optionValue ? TRUE : FALSE;
 101   }
 102
 103   /**
 104    * @param CRM_Extension_Info $info
 105    */
 106   public function onPreDisable(CRM_Extension_Info $info) {
 107     $customReports = $this->getCustomReportsByName();
 108     $cr = $this->getCustomReportsById();
 109     $id = $cr[$customReports[$info->key]];
 110     $optionValue = CRM_Core_BAO_OptionValue::setIsActive($id, 0);
 111   }
 112
 113   /**
 114    * @param CRM_Extension_Info $info
 115    */
 116   public function onPreEnable(CRM_Extension_Info $info) {
 117     $customReports = $this->getCustomReportsByName();
 118     $cr = $this->getCustomReportsById();
 119     $id = $cr[$customReports[$info->key]];
 120     $optionValue = CRM_Core_BAO_OptionValue::setIsActive($id, 1);
 121   }
 122
 123   /**
 124    * @return array
 125    */
 126   public function getCustomReportsByName() {
 127     return CRM_Core_OptionGroup::values(self::REPORT_GROUP_NAME, TRUE, FALSE, FALSE, NULL, 'name', FALSE, TRUE);
 128   }
 129
 130   /**
 131    * @return array
 132    */
 133   public function getCustomReportsById() {
 134     return CRM_Core_OptionGroup::values(self::REPORT_GROUP_NAME, FALSE, FALSE, FALSE, NULL, 'id', FALSE, TRUE);
 135   }
 136
 137 }