3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
29 * This class stores logic for managing CiviCRM extensions.
32 * @copyright CiviCRM LLC (c) 2004-2019
34 class CRM_Extension_Manager_Report
extends CRM_Extension_Manager_Base
{
36 const REPORT_GROUP_NAME
= 'report_template';
39 * CRM_Extension_Manager_Report constructor.
41 public function __construct() {
42 parent
::__construct(TRUE);
43 $this->groupId
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
44 self
::REPORT_GROUP_NAME
, 'id', 'name'
49 * @param CRM_Extension_Info $info
53 public function onPreInstall(CRM_Extension_Info
$info) {
54 $customReports = $this->getCustomReportsByName();
55 if (array_key_exists($info->key
, $customReports)) {
56 CRM_Core_Error
::fatal('This report is already registered.');
59 if ($info->typeInfo
['component'] === 'Contact') {
63 $comp = CRM_Core_Component
::get($info->typeInfo
['component']);
64 $compId = $comp->componentID
;
67 CRM_Core_Error
::fatal("Component for which you're trying to install the extension (" . $info->typeInfo
['component'] . ") is currently disabled.");
69 $weight = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
70 ['option_group_id' => $this->groupId
]
74 'label' => $info->label
. ' (' . $info->key
. ')',
75 'value' => $info->typeInfo
['reportUrl'],
78 'description' => $info->label
. ' (' . $info->key
. ')',
79 'component_id' => $compId,
80 'option_group_id' => $this->groupId
,
84 $optionValue = CRM_Core_BAO_OptionValue
::add($params, $ids);
88 * @param CRM_Extension_Info $info
92 public function onPreUninstall(CRM_Extension_Info
$info) {
94 // if( !array_key_exists( $info->key, $this->customReports ) ) {
95 // CRM_Core_Error::fatal( 'This report is not registered.' );
98 $customReports = $this->getCustomReportsByName();
99 $cr = $this->getCustomReportsById();
100 $id = $cr[$customReports[$info->key
]];
101 $optionValue = CRM_Core_BAO_OptionValue
::del($id);
103 return $optionValue ?
TRUE : FALSE;
107 * @param CRM_Extension_Info $info
109 public function onPreDisable(CRM_Extension_Info
$info) {
110 $customReports = $this->getCustomReportsByName();
111 $cr = $this->getCustomReportsById();
112 $id = $cr[$customReports[$info->key
]];
113 $optionValue = CRM_Core_BAO_OptionValue
::setIsActive($id, 0);
117 * @param CRM_Extension_Info $info
119 public function onPreEnable(CRM_Extension_Info
$info) {
120 $customReports = $this->getCustomReportsByName();
121 $cr = $this->getCustomReportsById();
122 $id = $cr[$customReports[$info->key
]];
123 $optionValue = CRM_Core_BAO_OptionValue
::setIsActive($id, 1);
129 public function getCustomReportsByName() {
130 return CRM_Core_OptionGroup
::values(self
::REPORT_GROUP_NAME
, TRUE, FALSE, FALSE, NULL, 'name', FALSE, TRUE);
136 public function getCustomReportsById() {
137 return CRM_Core_OptionGroup
::values(self
::REPORT_GROUP_NAME
, FALSE, FALSE, FALSE, NULL, 'id', FALSE, TRUE);