3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Core/Tag.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:1e6ad1d5a7c05b1a7d300d2a7722ba4d)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Core_DAO_Tag constructor.
40 class CRM_Core_DAO_Tag
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_tag';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
66 * Optional verbose description of the tag.
72 * Optional parent id for this tag.
78 * Is this tag selectable / displayed
82 public $is_selectable;
99 * FK to civicrm_contact, who created this tag
105 * Hex color value e.g. #ffffff
111 * Date and time that tag was created.
115 public $created_date;
119 function __construct() {
120 $this->__table
= 'civicrm_tag';
121 parent
::__construct();
124 * Returns foreign keys and entity references.
127 * [CRM_Core_Reference_Interface]
129 static function getReferenceColumns() {
130 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
131 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
132 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'parent_id', 'civicrm_tag', 'id');
133 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'created_id', 'civicrm_contact', 'id');
134 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
136 return Civi
::$statics[__CLASS__
]['links'];
139 * Returns all the column names of this table
143 static function &fields() {
144 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
145 Civi
::$statics[__CLASS__
]['fields'] = array(
148 'type' => CRM_Utils_Type
::T_INT
,
149 'title' => ts('Tag ID') ,
150 'description' => 'Tag ID',
155 'type' => CRM_Utils_Type
::T_STRING
,
156 'title' => ts('Tag Name') ,
157 'description' => 'Name of Tag.',
160 'size' => CRM_Utils_Type
::BIG
,
162 'description' => array(
163 'name' => 'description',
164 'type' => CRM_Utils_Type
::T_STRING
,
165 'title' => ts('Description') ,
166 'description' => 'Optional verbose description of the tag.',
168 'size' => CRM_Utils_Type
::HUGE
,
170 'parent_id' => array(
171 'name' => 'parent_id',
172 'type' => CRM_Utils_Type
::T_INT
,
173 'title' => ts('Parent Tag') ,
174 'description' => 'Optional parent id for this tag.',
176 'FKClassName' => 'CRM_Core_DAO_Tag',
178 'is_selectable' => array(
179 'name' => 'is_selectable',
180 'type' => CRM_Utils_Type
::T_BOOLEAN
,
181 'title' => ts('Display Tag?') ,
182 'description' => 'Is this tag selectable / displayed',
185 'is_reserved' => array(
186 'name' => 'is_reserved',
187 'type' => CRM_Utils_Type
::T_BOOLEAN
,
188 'title' => ts('Reserved') ,
190 'is_tagset' => array(
191 'name' => 'is_tagset',
192 'type' => CRM_Utils_Type
::T_BOOLEAN
,
193 'title' => ts('Tagset') ,
196 'name' => 'used_for',
197 'type' => CRM_Utils_Type
::T_STRING
,
198 'title' => ts('Used For') ,
200 'size' => CRM_Utils_Type
::BIG
,
205 'pseudoconstant' => array(
206 'optionGroupName' => 'tag_used_for',
207 'optionEditPath' => 'civicrm/admin/options/tag_used_for',
210 'created_id' => array(
211 'name' => 'created_id',
212 'type' => CRM_Utils_Type
::T_INT
,
213 'title' => ts('Tag Created By') ,
214 'description' => 'FK to civicrm_contact, who created this tag',
215 'FKClassName' => 'CRM_Contact_DAO_Contact',
219 'type' => CRM_Utils_Type
::T_STRING
,
220 'title' => ts('Color') ,
221 'description' => 'Hex color value e.g. #ffffff',
223 'size' => CRM_Utils_Type
::HUGE
,
226 'created_date' => array(
227 'name' => 'created_date',
228 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
229 'title' => ts('Tag Created Date') ,
230 'description' => 'Date and time that tag was created.',
233 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
235 return Civi
::$statics[__CLASS__
]['fields'];
238 * Return a mapping from field-name to the corresponding key (as used in fields()).
241 * Array(string $name => string $uniqueName).
243 static function &fieldKeys() {
244 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
245 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
247 return Civi
::$statics[__CLASS__
]['fieldKeys'];
250 * Returns the names of this table
254 static function getTableName() {
255 return self
::$_tableName;
258 * Returns if this table needs to be logged
266 * Returns the list of fields that can be imported
268 * @param bool $prefix
272 static function &import($prefix = false) {
273 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'tag', $prefix, array());
277 * Returns the list of fields that can be exported
279 * @param bool $prefix
283 static function &export($prefix = false) {
284 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'tag', $prefix, array());