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:1eadd6ffdb011ed6d4ff672f1e629719)
  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         ) ,
 114         'module' => array(
 115           'name' => 'module',
 116           'type' => CRM_Utils_Type::T_STRING,
 117           'title' => ts('Module') ,
 118           'description' => 'Name of the module which declared this object',
 119           'required' => true,
 120           'maxlength' => 127,
 121           'size' => CRM_Utils_Type::HUGE,
 122           'table_name' => 'civicrm_managed',
 123           'entity' => 'Managed',
 124           'bao' => 'CRM_Core_DAO_Managed',
 125         ) ,
 126         'name' => array(
 127           'name' => 'name',
 128           'type' => CRM_Utils_Type::T_STRING,
 129           'title' => ts('Name') ,
 130           'description' => 'Symbolic name used by the module to identify the object',
 131           'maxlength' => 127,
 132           'size' => CRM_Utils_Type::HUGE,
 133           'table_name' => 'civicrm_managed',
 134           'entity' => 'Managed',
 135           'bao' => 'CRM_Core_DAO_Managed',
 136         ) ,
 137         'entity_type' => array(
 138           'name' => 'entity_type',
 139           'type' => CRM_Utils_Type::T_STRING,
 140           'title' => ts('Entity Type') ,
 141           'description' => 'API entity type',
 142           'required' => true,
 143           'maxlength' => 64,
 144           'size' => CRM_Utils_Type::BIG,
 145           'table_name' => 'civicrm_managed',
 146           'entity' => 'Managed',
 147           'bao' => 'CRM_Core_DAO_Managed',
 148         ) ,
 149         'entity_id' => array(
 150           'name' => 'entity_id',
 151           'type' => CRM_Utils_Type::T_INT,
 152           'title' => ts('Entity ID') ,
 153           'description' => 'Foreign key to the referenced item.',
 154           'required' => true,
 155           'table_name' => 'civicrm_managed',
 156           'entity' => 'Managed',
 157           'bao' => 'CRM_Core_DAO_Managed',
 158         ) ,
 159         'cleanup' => array(
 160           'name' => 'cleanup',
 161           'type' => CRM_Utils_Type::T_STRING,
 162           'title' => ts('Cleanup Setting') ,
 163           'description' => 'Policy on when to cleanup entity (always, never, unused)',
 164           'maxlength' => 32,
 165           'size' => CRM_Utils_Type::MEDIUM,
 166           'table_name' => 'civicrm_managed',
 167           'entity' => 'Managed',
 168           'bao' => 'CRM_Core_DAO_Managed',
 169           'html' => array(
 170             'type' => 'Select',
 171           ) ,
 172           'pseudoconstant' => array(
 173             'callback' => 'CRM_Core_ManagedEntities::getCleanupOptions',
 174           )
 175         ) ,
 176       );
 177       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 178     }
 179     return Civi::$statics[__CLASS__]['fields'];
 180   }
 181   /**
 182    * Return a mapping from field-name to the corresponding key (as used in fields()).
 183    *
 184    * @return array
 185    *   Array(string $name => string $uniqueName).
 186    */
 187   static function &fieldKeys() {
 188     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 189       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 190     }
 191     return Civi::$statics[__CLASS__]['fieldKeys'];
 192   }
 193   /**
 194    * Returns the names of this table
 195    *
 196    * @return string
 197    */
 198   static function getTableName() {
 199     return self::$_tableName;
 200   }
 201   /**
 202    * Returns if this table needs to be logged
 203    *
 204    * @return boolean
 205    */
 206   function getLog() {
 207     return self::$_log;
 208   }
 209   /**
 210    * Returns the list of fields that can be imported
 211    *
 212    * @param bool $prefix
 213    *
 214    * @return array
 215    */
 216   static function &import($prefix = false) {
 217     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'managed', $prefix, array());
 218     return $r;
 219   }
 220   /**
 221    * Returns the list of fields that can be exported
 222    *
 223    * @param bool $prefix
 224    *
 225    * @return array
 226    */
 227   static function &export($prefix = false) {
 228     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'managed', $prefix, array());
 229     return $r;
 230   }
 231 }