3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
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. |
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. |
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. |
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 +--------------------------------------------------------------------+
32 * @copyright CiviCRM LLC (c) 2004-2014
38 * This class contains functions for managing extensions
40 class CRM_Core_BAO_Extension
extends CRM_Core_DAO_Extension
{
43 * Takes a bunch of params that are needed to match certain criteria and
44 * retrieves the relevant objects. Typically the valid params are only
45 * contact_id. We'll tweak this function to be more full featured over a period
46 * of time. This is the inverse function of create. It also stores all the retrieved
47 * values in the default array
49 * @param array $params (reference ) an assoc array of name/value pairs
50 * @param array $defaults (reference ) an assoc array to hold the flattened values
52 * @return object CRM_Core_BAO_LocationType object on success, null otherwise
56 static function retrieve(&$params, &$defaults) {
57 $extension = new CRM_Core_DAO_Extension();
58 $extension->copyValues($params);
59 if ($extension->find(TRUE)) {
60 CRM_Core_DAO
::storeValues($extension, $defaults);
67 * Function to delete an extension
69 * @param int $id Id of the extension to be deleted.
76 static function del($id) {
77 $extension = new CRM_Core_DAO_Extension();
79 return $extension->delete();
83 * Change the schema version of an extension
85 * @param $fullName string, the fully-qualified name (eg "com.example.myextension")
86 * @param $schemaVersion string
89 static function setSchemaVersion($fullName, $schemaVersion) {
90 $sql = 'UPDATE civicrm_extension SET schema_version = %1 WHERE full_name = %2';
92 1 => array($schemaVersion, 'String'),
93 2 => array($fullName, 'String'),
95 return CRM_Core_DAO
::executeQuery($sql, $params);
99 * Determine the schema version of an extension
101 * @param $fullName string, the fully-qualified name (eg "com.example.myextension")
104 static function getSchemaVersion($fullName) {
105 $sql = 'SELECT schema_version FROM civicrm_extension WHERE full_name = %1';
107 1 => array($fullName, 'String'),
109 return CRM_Core_DAO
::singleValueQuery($sql, $params);