CRM/Core/DAO/Managed.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2016
  30  *
  31  * Generated from xml/schema/CRM/Core/Managed.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:c6ff05c82573ab973ddae2bd839a5a6d)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Core_DAO_Managed extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_managed';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = false;
  51   /**
  52    * Surrogate Key
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Name of the module which declared this object
  59    *
  60    * @var string
  61    */
  62   public $module;
  63   /**
  64    * Symbolic name used by the module to identify the object
  65    *
  66    * @var string
  67    */
  68   public $name;
  69   /**
  70    * API entity type
  71    *
  72    * @var string
  73    */
  74   public $entity_type;
  75   /**
  76    * Foreign key to the referenced item.
  77    *
  78    * @var int unsigned
  79    */
  80   public $entity_id;
  81   /**
  82    * Policy on when to cleanup entity (always, never, unused)
  83    *
  84    * @var string
  85    */
  86   public $cleanup;
  87   /**
  88    * class constructor
  89    *
  90    * @return civicrm_managed
  91    */
  92   function __construct() {
  93     $this->__table = 'civicrm_managed';
  94     parent::__construct();
  95   }
  96   /**
  97    * Returns all the column names of this table
  98    *
  99    * @return array
 100    */
 101   static function &fields() {
 102     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 103       Civi::$statics[__CLASS__]['fields'] = array(
 104         'id' => array(
 105           'name' => 'id',
 106           'type' => CRM_Utils_Type::T_INT,
 107           'title' => ts('Managed ID') ,
 108           'description' => 'Surrogate Key',
 109           'required' => true,
 110         ) ,
 111         'module' => array(
 112           'name' => 'module',
 113           'type' => CRM_Utils_Type::T_STRING,
 114           'title' => ts('Module') ,
 115           'description' => 'Name of the module which declared this object',
 116           'required' => true,
 117           'maxlength' => 127,
 118           'size' => CRM_Utils_Type::HUGE,
 119         ) ,
 120         'name' => array(
 121           'name' => 'name',
 122           'type' => CRM_Utils_Type::T_STRING,
 123           'title' => ts('Name') ,
 124           'description' => 'Symbolic name used by the module to identify the object',
 125           'maxlength' => 127,
 126           'size' => CRM_Utils_Type::HUGE,
 127         ) ,
 128         'entity_type' => array(
 129           'name' => 'entity_type',
 130           'type' => CRM_Utils_Type::T_STRING,
 131           'title' => ts('Entity Type') ,
 132           'description' => 'API entity type',
 133           'required' => true,
 134           'maxlength' => 64,
 135           'size' => CRM_Utils_Type::BIG,
 136         ) ,
 137         'entity_id' => array(
 138           'name' => 'entity_id',
 139           'type' => CRM_Utils_Type::T_INT,
 140           'title' => ts('Entity ID') ,
 141           'description' => 'Foreign key to the referenced item.',
 142           'required' => true,
 143         ) ,
 144         'cleanup' => array(
 145           'name' => 'cleanup',
 146           'type' => CRM_Utils_Type::T_STRING,
 147           'title' => ts('Cleanup Setting') ,
 148           'description' => 'Policy on when to cleanup entity (always, never, unused)',
 149           'maxlength' => 32,
 150           'size' => CRM_Utils_Type::MEDIUM,
 151           'html' => array(
 152             'type' => 'Select',
 153           ) ,
 154           'pseudoconstant' => array(
 155             'callback' => 'CRM_Core_ManagedEntities::getCleanupOptions',
 156           )
 157         ) ,
 158       );
 159       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 160     }
 161     return Civi::$statics[__CLASS__]['fields'];
 162   }
 163   /**
 164    * Return a mapping from field-name to the corresponding key (as used in fields()).
 165    *
 166    * @return array
 167    *   Array(string $name => string $uniqueName).
 168    */
 169   static function &fieldKeys() {
 170     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 171       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 172     }
 173     return Civi::$statics[__CLASS__]['fieldKeys'];
 174   }
 175   /**
 176    * Returns the names of this table
 177    *
 178    * @return string
 179    */
 180   static function getTableName() {
 181     return self::$_tableName;
 182   }
 183   /**
 184    * Returns if this table needs to be logged
 185    *
 186    * @return boolean
 187    */
 188   function getLog() {
 189     return self::$_log;
 190   }
 191   /**
 192    * Returns the list of fields that can be imported
 193    *
 194    * @param bool $prefix
 195    *
 196    * @return array
 197    */
 198   static function &import($prefix = false) {
 199     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'managed', $prefix, array());
 200     return $r;
 201   }
 202   /**
 203    * Returns the list of fields that can be exported
 204    *
 205    * @param bool $prefix
 206    *
 207    * @return array
 208    */
 209   static function &export($prefix = false) {
 210     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'managed', $prefix, array());
 211     return $r;
 212   }
 213 }