CRM/Core/BAO/Extension.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  * This class contains functions for managing extensions
  39  */
  40 class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension {
  41
  42   /**
  43    * Fetch object based on array of properties
  44    *
  45    * @param array $params
  46    *   (reference ) an assoc array of name/value pairs.
  47    * @param array $defaults
  48    *   (reference ) an assoc array to hold the flattened values.
  49    *
  50    * @return CRM_Core_BAO_LocationType|null
  51    *   object on success, null otherwise
  52    * @static
  53    */
  54   public static function retrieve(&$params, &$defaults) {
  55     $extension = new CRM_Core_DAO_Extension();
  56     $extension->copyValues($params);
  57     if ($extension->find(TRUE)) {
  58       CRM_Core_DAO::storeValues($extension, $defaults);
  59       return $extension;
  60     }
  61     return NULL;
  62   }
  63
  64   /**
  65    * Delete an extension
  66    *
  67    * @param int $id
  68    *   Id of the extension to be deleted.
  69    *
  70    * @return void
  71    *
  72    * @static
  73    */
  74   public static function del($id) {
  75     $extension = new CRM_Core_DAO_Extension();
  76     $extension->id = $id;
  77     return $extension->delete();
  78   }
  79
  80   /**
  81    * Change the schema version of an extension
  82    *
  83    * @param string $fullName
  84    *   the fully-qualified name (eg "com.example.myextension").
  85    * @param string $schemaVersion
  86    * @return void
  87    */
  88   public static function setSchemaVersion($fullName, $schemaVersion) {
  89     $sql = 'UPDATE civicrm_extension SET schema_version = %1 WHERE full_name = %2';
  90     $params = array(
  91       1 => array($schemaVersion, 'String'),
  92       2 => array($fullName, 'String'),
  93     );
  94     return CRM_Core_DAO::executeQuery($sql, $params);
  95   }
  96
  97   /**
  98    * Determine the schema version of an extension
  99    *
 100    * @param string $fullName
 101    *   the fully-qualified name (eg "com.example.myextension").
 102    * @return string
 103    */
 104   public static function getSchemaVersion($fullName) {
 105     $sql = 'SELECT schema_version FROM civicrm_extension WHERE full_name = %1';
 106     $params = array(
 107       1 => array($fullName, 'String'),
 108     );
 109     return CRM_Core_DAO::singleValueQuery($sql, $params);
 110   }
 111
 112 }