CRM/ACL/DAO/Cache.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/ACL/Cache.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:2022900f4e480daf0ed872bd88a3579b)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_ACL_DAO_Cache extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_acl_cache';
  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    * Unique table ID
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Foreign Key to Contact
  59    *
  60    * @var int unsigned
  61    */
  62   public $contact_id;
  63   /**
  64    * Foreign Key to ACL
  65    *
  66    * @var int unsigned
  67    */
  68   public $acl_id;
  69   /**
  70    * When was this cache entry last modified
  71    *
  72    * @var timestamp
  73    */
  74   public $modified_date;
  75   /**
  76    * class constructor
  77    *
  78    * @return civicrm_acl_cache
  79    */
  80   function __construct() {
  81     $this->__table = 'civicrm_acl_cache';
  82     parent::__construct();
  83   }
  84   /**
  85    * Returns foreign keys and entity references
  86    *
  87    * @return array
  88    *   [CRM_Core_Reference_Interface]
  89    */
  90   static function getReferenceColumns() {
  91     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  92       Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
  93       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
  94       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'acl_id', 'civicrm_acl', 'id');
  95       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  96     }
  97     return Civi::$statics[__CLASS__]['links'];
  98   }
  99   /**
 100    * Returns all the column names of this table
 101    *
 102    * @return array
 103    */
 104   static function &fields() {
 105     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 106       Civi::$statics[__CLASS__]['fields'] = array(
 107         'id' => array(
 108           'name' => 'id',
 109           'type' => CRM_Utils_Type::T_INT,
 110           'title' => ts('Cache ID') ,
 111           'description' => 'Unique table ID',
 112           'required' => true,
 113         ) ,
 114         'contact_id' => array(
 115           'name' => 'contact_id',
 116           'type' => CRM_Utils_Type::T_INT,
 117           'title' => ts('Cache Contact') ,
 118           'description' => 'Foreign Key to Contact',
 119           'FKClassName' => 'CRM_Contact_DAO_Contact',
 120         ) ,
 121         'acl_id' => array(
 122           'name' => 'acl_id',
 123           'type' => CRM_Utils_Type::T_INT,
 124           'title' => ts('Cache ACL') ,
 125           'description' => 'Foreign Key to ACL',
 126           'required' => true,
 127           'FKClassName' => 'CRM_ACL_DAO_ACL',
 128         ) ,
 129         'modified_date' => array(
 130           'name' => 'modified_date',
 131           'type' => CRM_Utils_Type::T_TIMESTAMP,
 132           'title' => ts('Cache Modified Date') ,
 133           'description' => 'When was this cache entry last modified',
 134           'required' => false,
 135         ) ,
 136       );
 137       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 138     }
 139     return Civi::$statics[__CLASS__]['fields'];
 140   }
 141   /**
 142    * Return a mapping from field-name to the corresponding key (as used in fields()).
 143    *
 144    * @return array
 145    *   Array(string $name => string $uniqueName).
 146    */
 147   static function &fieldKeys() {
 148     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 149       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 150     }
 151     return Civi::$statics[__CLASS__]['fieldKeys'];
 152   }
 153   /**
 154    * Returns the names of this table
 155    *
 156    * @return string
 157    */
 158   static function getTableName() {
 159     return self::$_tableName;
 160   }
 161   /**
 162    * Returns if this table needs to be logged
 163    *
 164    * @return boolean
 165    */
 166   function getLog() {
 167     return self::$_log;
 168   }
 169   /**
 170    * Returns the list of fields that can be imported
 171    *
 172    * @param bool $prefix
 173    *
 174    * @return array
 175    */
 176   static function &import($prefix = false) {
 177     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'acl_cache', $prefix, array());
 178     return $r;
 179   }
 180   /**
 181    * Returns the list of fields that can be exported
 182    *
 183    * @param bool $prefix
 184    *
 185    * @return array
 186    */
 187   static function &export($prefix = false) {
 188     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'acl_cache', $prefix, array());
 189     return $r;
 190   }
 191 }