phpcs - Fix error, "CONST keyword must be lowercase; expected const but found CONST"
[civicrm-core.git] / CRM / Core / BAO / Extension.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035
TO
5 +--------------------------------------------------------------------+
6 | Copyright (C) 2011 Marty Wright |
7 | Licensed to CiviCRM under the Academic Free License version 3.0. |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
10 | |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
19 | |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
27*/
28
29/**
30 *
31 * @package CRM
06b69b18 32 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
33 * $Id$
34 *
35 */
36
37/**
38 * This class contains functions for managing extensions
39 */
40class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension {
41
42 /**
c490a46a 43 * Fetch object based on array of properties
6a488035
TO
44 *
45 * @param array $params (reference ) an assoc array of name/value pairs
46 * @param array $defaults (reference ) an assoc array to hold the flattened values
47 *
c490a46a 48 * @return CRM_Core_BAO_LocationType object on success, null otherwise
6a488035
TO
49 * @access public
50 * @static
51 */
52 static function retrieve(&$params, &$defaults) {
53 $extension = new CRM_Core_DAO_Extension();
54 $extension->copyValues($params);
55 if ($extension->find(TRUE)) {
56 CRM_Core_DAO::storeValues($extension, $defaults);
57 return $extension;
58 }
59 return NULL;
60 }
61
62 /**
100fef9d 63 * Delete an extension
6a488035
TO
64 *
65 * @param int $id Id of the extension to be deleted.
66 *
67 * @return void
68 *
69 * @access public
70 * @static
71 */
72 static function del($id) {
73 $extension = new CRM_Core_DAO_Extension();
74 $extension->id = $id;
75 return $extension->delete();
76 }
77
78 /**
79 * Change the schema version of an extension
80 *
81 * @param $fullName string, the fully-qualified name (eg "com.example.myextension")
82 * @param $schemaVersion string
83 * @return void
84 */
85 static function setSchemaVersion($fullName, $schemaVersion) {
86 $sql = 'UPDATE civicrm_extension SET schema_version = %1 WHERE full_name = %2';
87 $params = array(
88 1 => array($schemaVersion, 'String'),
89 2 => array($fullName, 'String'),
90 );
91 return CRM_Core_DAO::executeQuery($sql, $params);
92 }
93
94 /**
95 * Determine the schema version of an extension
96 *
97 * @param $fullName string, the fully-qualified name (eg "com.example.myextension")
98 * @return string
99 */
100 static function getSchemaVersion($fullName) {
101 $sql = 'SELECT schema_version FROM civicrm_extension WHERE full_name = %1';
102 $params = array(
103 1 => array($fullName, 'String'),
104 );
105 return CRM_Core_DAO::singleValueQuery($sql, $params);
106 }
107
108}