Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
ca5cec67 | 5 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Contact/GroupNesting.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
28979d65 | 9 | * (GenCodeChecksum:f93c2699304caa24bcb30d71891621ad) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the GroupNesting entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Contact_DAO_GroupNesting extends CRM_Core_DAO { |
929a1c14 CW |
16 | const EXT = 'civicrm'; |
17 | const TABLE_ADDED = '2.0'; | |
c3fc2621 | 18 | |
e501603b | 19 | /** |
f41f0342 | 20 | * Static instance to hold the table name. |
e501603b TO |
21 | * |
22 | * @var string | |
23 | */ | |
fa45b5b9 | 24 | public static $_tableName = 'civicrm_group_nesting'; |
c3fc2621 | 25 | |
e501603b | 26 | /** |
f41f0342 | 27 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 28 | * |
c3fc2621 | 29 | * @var bool |
e501603b | 30 | */ |
fa45b5b9 | 31 | public static $_log = TRUE; |
c3fc2621 | 32 | |
e501603b TO |
33 | /** |
34 | * Relationship ID | |
35 | * | |
28979d65 CW |
36 | * @var int|string|null |
37 | * (SQL type: int unsigned) | |
38 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
39 | */ |
40 | public $id; | |
c3fc2621 | 41 | |
e501603b TO |
42 | /** |
43 | * ID of the child group | |
44 | * | |
28979d65 CW |
45 | * @var int|string |
46 | * (SQL type: int unsigned) | |
47 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
48 | */ |
49 | public $child_group_id; | |
c3fc2621 | 50 | |
e501603b TO |
51 | /** |
52 | * ID of the parent group | |
53 | * | |
28979d65 CW |
54 | * @var int|string |
55 | * (SQL type: int unsigned) | |
56 | * Note that values will be retrieved from the database as a string. | |
e501603b TO |
57 | */ |
58 | public $parent_group_id; | |
c3fc2621 | 59 | |
e501603b | 60 | /** |
f41f0342 | 61 | * Class constructor. |
e501603b | 62 | */ |
c3fc2621 | 63 | public function __construct() { |
e501603b TO |
64 | $this->__table = 'civicrm_group_nesting'; |
65 | parent::__construct(); | |
66 | } | |
c3fc2621 | 67 | |
449c4e6b CW |
68 | /** |
69 | * Returns localized title of this entity. | |
7b66c3b5 AH |
70 | * |
71 | * @param bool $plural | |
72 | * Whether to return the plural version of the title. | |
449c4e6b | 73 | */ |
7b66c3b5 AH |
74 | public static function getEntityTitle($plural = FALSE) { |
75 | return $plural ? ts('Group Nestings') : ts('Group Nesting'); | |
449c4e6b CW |
76 | } |
77 | ||
e501603b | 78 | /** |
f41f0342 | 79 | * Returns foreign keys and entity references. |
e501603b TO |
80 | * |
81 | * @return array | |
82 | * [CRM_Core_Reference_Interface] | |
83 | */ | |
c3fc2621 | 84 | public static function getReferenceColumns() { |
346aaaba | 85 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 86 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
87 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'child_group_id', 'civicrm_group', 'id'); |
88 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_group_id', 'civicrm_group', 'id'); | |
346aaaba | 89 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 90 | } |
346aaaba | 91 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 92 | } |
c3fc2621 | 93 | |
e501603b TO |
94 | /** |
95 | * Returns all the column names of this table | |
96 | * | |
97 | * @return array | |
98 | */ | |
c3fc2621 | 99 | public static function &fields() { |
346aaaba | 100 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
101 | Civi::$statics[__CLASS__]['fields'] = [ |
102 | 'id' => [ | |
e501603b TO |
103 | 'name' => 'id', |
104 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 105 | 'title' => ts('Group Nesting ID'), |
215b423e | 106 | 'description' => ts('Relationship ID'), |
c3fc2621 | 107 | 'required' => TRUE, |
a36434b9 | 108 | 'where' => 'civicrm_group_nesting.id', |
522a26c9 | 109 | 'table_name' => 'civicrm_group_nesting', |
110 | 'entity' => 'GroupNesting', | |
111 | 'bao' => 'CRM_Contact_BAO_GroupNesting', | |
6a7e5e5d | 112 | 'localizable' => 0, |
2cbbebe8 A |
113 | 'html' => [ |
114 | 'type' => 'Number', | |
115 | ], | |
1fe423d6 | 116 | 'readonly' => TRUE, |
a9d0587b | 117 | 'add' => '2.0', |
c3fc2621 CW |
118 | ], |
119 | 'child_group_id' => [ | |
e501603b TO |
120 | 'name' => 'child_group_id', |
121 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 122 | 'title' => ts('Child Group ID'), |
215b423e | 123 | 'description' => ts('ID of the child group'), |
c3fc2621 | 124 | 'required' => TRUE, |
a36434b9 | 125 | 'where' => 'civicrm_group_nesting.child_group_id', |
522a26c9 | 126 | 'table_name' => 'civicrm_group_nesting', |
127 | 'entity' => 'GroupNesting', | |
128 | 'bao' => 'CRM_Contact_BAO_GroupNesting', | |
6a7e5e5d | 129 | 'localizable' => 0, |
e501603b | 130 | 'FKClassName' => 'CRM_Contact_DAO_Group', |
2cbbebe8 A |
131 | 'html' => [ |
132 | 'label' => ts("Child Group"), | |
133 | ], | |
a9d0587b | 134 | 'add' => '2.0', |
c3fc2621 CW |
135 | ], |
136 | 'parent_group_id' => [ | |
e501603b TO |
137 | 'name' => 'parent_group_id', |
138 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 139 | 'title' => ts('Parent Group ID'), |
215b423e | 140 | 'description' => ts('ID of the parent group'), |
c3fc2621 | 141 | 'required' => TRUE, |
a36434b9 | 142 | 'where' => 'civicrm_group_nesting.parent_group_id', |
522a26c9 | 143 | 'table_name' => 'civicrm_group_nesting', |
144 | 'entity' => 'GroupNesting', | |
145 | 'bao' => 'CRM_Contact_BAO_GroupNesting', | |
6a7e5e5d | 146 | 'localizable' => 0, |
e501603b | 147 | 'FKClassName' => 'CRM_Contact_DAO_Group', |
2cbbebe8 A |
148 | 'html' => [ |
149 | 'label' => ts("Parent Group"), | |
150 | ], | |
a9d0587b | 151 | 'add' => '2.0', |
c3fc2621 CW |
152 | ], |
153 | ]; | |
346aaaba | 154 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 155 | } |
346aaaba | 156 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 157 | } |
c3fc2621 | 158 | |
e501603b | 159 | /** |
bd8e0b14 | 160 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
161 | * |
162 | * @return array | |
bd8e0b14 | 163 | * Array(string $name => string $uniqueName). |
e501603b | 164 | */ |
c3fc2621 | 165 | public static function &fieldKeys() { |
bd8e0b14 TO |
166 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
167 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 168 | } |
bd8e0b14 | 169 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 170 | } |
c3fc2621 | 171 | |
e501603b TO |
172 | /** |
173 | * Returns the names of this table | |
174 | * | |
175 | * @return string | |
176 | */ | |
c3fc2621 | 177 | public static function getTableName() { |
e501603b TO |
178 | return self::$_tableName; |
179 | } | |
c3fc2621 | 180 | |
e501603b TO |
181 | /** |
182 | * Returns if this table needs to be logged | |
183 | * | |
c3fc2621 | 184 | * @return bool |
e501603b | 185 | */ |
c3fc2621 | 186 | public function getLog() { |
e501603b TO |
187 | return self::$_log; |
188 | } | |
c3fc2621 | 189 | |
e501603b TO |
190 | /** |
191 | * Returns the list of fields that can be imported | |
192 | * | |
193 | * @param bool $prefix | |
194 | * | |
195 | * @return array | |
196 | */ | |
c3fc2621 CW |
197 | public static function &import($prefix = FALSE) { |
198 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'group_nesting', $prefix, []); | |
60808919 | 199 | return $r; |
e501603b | 200 | } |
c3fc2621 | 201 | |
e501603b TO |
202 | /** |
203 | * Returns the list of fields that can be exported | |
204 | * | |
205 | * @param bool $prefix | |
206 | * | |
207 | * @return array | |
208 | */ | |
c3fc2621 CW |
209 | public static function &export($prefix = FALSE) { |
210 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'group_nesting', $prefix, []); | |
60808919 | 211 | return $r; |
e501603b | 212 | } |
c3fc2621 | 213 | |
e7a6b91a AS |
214 | /** |
215 | * Returns the list of indices | |
c3fc2621 CW |
216 | * |
217 | * @param bool $localize | |
218 | * | |
219 | * @return array | |
e7a6b91a AS |
220 | */ |
221 | public static function indices($localize = TRUE) { | |
c3fc2621 | 222 | $indices = []; |
e7a6b91a AS |
223 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
224 | } | |
c3fc2621 | 225 | |
e501603b | 226 | } |