Commit | Line | Data |
---|---|---|
e501603b TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.7 | | |
5 | +--------------------------------------------------------------------+ | |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
e501603b TO |
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 | |
0f03f337 | 29 | * @copyright CiviCRM LLC (c) 2004-2017 |
e501603b TO |
30 | * |
31 | * Generated from xml/schema/CRM/Core/Component.xml | |
32 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
022785d8 | 33 | * (GenCodeChecksum:14ca0040d5a5656fd5dd91ad60a8ac89) |
e501603b TO |
34 | */ |
35 | require_once 'CRM/Core/DAO.php'; | |
36 | require_once 'CRM/Utils/Type.php'; | |
f41f0342 | 37 | /** |
38 | * CRM_Core_DAO_Component constructor. | |
39 | */ | |
e501603b TO |
40 | class CRM_Core_DAO_Component extends CRM_Core_DAO { |
41 | /** | |
f41f0342 | 42 | * Static instance to hold the table name. |
e501603b TO |
43 | * |
44 | * @var string | |
45 | */ | |
46 | static $_tableName = 'civicrm_component'; | |
e501603b | 47 | /** |
f41f0342 | 48 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b TO |
49 | * |
50 | * @var boolean | |
51 | */ | |
52 | static $_log = false; | |
53 | /** | |
54 | * Component ID | |
55 | * | |
56 | * @var int unsigned | |
57 | */ | |
58 | public $id; | |
59 | /** | |
60 | * Name of the component. | |
61 | * | |
62 | * @var string | |
63 | */ | |
64 | public $name; | |
65 | /** | |
66 | * Path to components main directory in a form of a class | |
67 | namespace. | |
68 | * | |
69 | * @var string | |
70 | */ | |
71 | public $namespace; | |
72 | /** | |
f41f0342 | 73 | * Class constructor. |
e501603b TO |
74 | */ |
75 | function __construct() { | |
76 | $this->__table = 'civicrm_component'; | |
77 | parent::__construct(); | |
78 | } | |
79 | /** | |
80 | * Returns all the column names of this table | |
81 | * | |
82 | * @return array | |
83 | */ | |
84 | static function &fields() { | |
346aaaba TO |
85 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
86 | Civi::$statics[__CLASS__]['fields'] = array( | |
e501603b TO |
87 | 'id' => array( |
88 | 'name' => 'id', | |
89 | 'type' => CRM_Utils_Type::T_INT, | |
90 | 'description' => 'Component ID', | |
91 | 'required' => true, | |
522a26c9 | 92 | 'table_name' => 'civicrm_component', |
93 | 'entity' => 'Component', | |
94 | 'bao' => 'CRM_Core_DAO_Component', | |
6a7e5e5d | 95 | 'localizable' => 0, |
e501603b TO |
96 | ) , |
97 | 'name' => array( | |
98 | 'name' => 'name', | |
99 | 'type' => CRM_Utils_Type::T_STRING, | |
100 | 'title' => ts('Component name') , | |
101 | 'description' => 'Name of the component.', | |
102 | 'required' => true, | |
103 | 'maxlength' => 64, | |
104 | 'size' => CRM_Utils_Type::BIG, | |
522a26c9 | 105 | 'table_name' => 'civicrm_component', |
106 | 'entity' => 'Component', | |
107 | 'bao' => 'CRM_Core_DAO_Component', | |
6a7e5e5d | 108 | 'localizable' => 0, |
e501603b TO |
109 | ) , |
110 | 'namespace' => array( | |
111 | 'name' => 'namespace', | |
112 | 'type' => CRM_Utils_Type::T_STRING, | |
113 | 'title' => ts('Namespace reserved for component.') , | |
114 | 'description' => 'Path to components main directory in a form of a class | |
115 | namespace. | |
116 | ', | |
117 | 'maxlength' => 128, | |
118 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 119 | 'table_name' => 'civicrm_component', |
120 | 'entity' => 'Component', | |
121 | 'bao' => 'CRM_Core_DAO_Component', | |
6a7e5e5d | 122 | 'localizable' => 0, |
e501603b TO |
123 | ) , |
124 | ); | |
346aaaba | 125 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 126 | } |
346aaaba | 127 | return Civi::$statics[__CLASS__]['fields']; |
e501603b TO |
128 | } |
129 | /** | |
bd8e0b14 | 130 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
131 | * |
132 | * @return array | |
bd8e0b14 | 133 | * Array(string $name => string $uniqueName). |
e501603b TO |
134 | */ |
135 | static function &fieldKeys() { | |
bd8e0b14 TO |
136 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
137 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 138 | } |
bd8e0b14 | 139 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b TO |
140 | } |
141 | /** | |
142 | * Returns the names of this table | |
143 | * | |
144 | * @return string | |
145 | */ | |
146 | static function getTableName() { | |
147 | return self::$_tableName; | |
148 | } | |
149 | /** | |
150 | * Returns if this table needs to be logged | |
151 | * | |
152 | * @return boolean | |
153 | */ | |
154 | function getLog() { | |
155 | return self::$_log; | |
156 | } | |
157 | /** | |
158 | * Returns the list of fields that can be imported | |
159 | * | |
160 | * @param bool $prefix | |
161 | * | |
162 | * @return array | |
163 | */ | |
164 | static function &import($prefix = false) { | |
60808919 TO |
165 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'component', $prefix, array()); |
166 | return $r; | |
e501603b TO |
167 | } |
168 | /** | |
169 | * Returns the list of fields that can be exported | |
170 | * | |
171 | * @param bool $prefix | |
172 | * | |
173 | * @return array | |
174 | */ | |
175 | static function &export($prefix = false) { | |
60808919 TO |
176 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'component', $prefix, array()); |
177 | return $r; | |
e501603b | 178 | } |
e7a6b91a AS |
179 | /** |
180 | * Returns the list of indices | |
181 | */ | |
182 | public static function indices($localize = TRUE) { | |
183 | $indices = array(); | |
184 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; | |
185 | } | |
e501603b | 186 | } |