CRM/Core/DAO/Managed.php

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