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 | |
2cbbebe8 | 9 | * (GenCodeChecksum:b1a1fc570a824bc61a8a977bad5309dc) |
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 | * | |
e6ca0a57 | 36 | * @var int |
e501603b TO |
37 | */ |
38 | public $id; | |
c3fc2621 | 39 | |
e501603b TO |
40 | /** |
41 | * ID of the child group | |
42 | * | |
e6ca0a57 | 43 | * @var int |
e501603b TO |
44 | */ |
45 | public $child_group_id; | |
c3fc2621 | 46 | |
e501603b TO |
47 | /** |
48 | * ID of the parent group | |
49 | * | |
e6ca0a57 | 50 | * @var int |
e501603b TO |
51 | */ |
52 | public $parent_group_id; | |
c3fc2621 | 53 | |
e501603b | 54 | /** |
f41f0342 | 55 | * Class constructor. |
e501603b | 56 | */ |
c3fc2621 | 57 | public function __construct() { |
e501603b TO |
58 | $this->__table = 'civicrm_group_nesting'; |
59 | parent::__construct(); | |
60 | } | |
c3fc2621 | 61 | |
449c4e6b CW |
62 | /** |
63 | * Returns localized title of this entity. | |
7b66c3b5 AH |
64 | * |
65 | * @param bool $plural | |
66 | * Whether to return the plural version of the title. | |
449c4e6b | 67 | */ |
7b66c3b5 AH |
68 | public static function getEntityTitle($plural = FALSE) { |
69 | return $plural ? ts('Group Nestings') : ts('Group Nesting'); | |
449c4e6b CW |
70 | } |
71 | ||
e501603b | 72 | /** |
f41f0342 | 73 | * Returns foreign keys and entity references. |
e501603b TO |
74 | * |
75 | * @return array | |
76 | * [CRM_Core_Reference_Interface] | |
77 | */ | |
c3fc2621 | 78 | public static function getReferenceColumns() { |
346aaaba | 79 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
fa45b5b9 | 80 | Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); |
c3fc2621 CW |
81 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'child_group_id', 'civicrm_group', 'id'); |
82 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'parent_group_id', 'civicrm_group', 'id'); | |
346aaaba | 83 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 84 | } |
346aaaba | 85 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 86 | } |
c3fc2621 | 87 | |
e501603b TO |
88 | /** |
89 | * Returns all the column names of this table | |
90 | * | |
91 | * @return array | |
92 | */ | |
c3fc2621 | 93 | public static function &fields() { |
346aaaba | 94 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
95 | Civi::$statics[__CLASS__]['fields'] = [ |
96 | 'id' => [ | |
e501603b TO |
97 | 'name' => 'id', |
98 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 99 | 'title' => ts('Group Nesting ID'), |
215b423e | 100 | 'description' => ts('Relationship ID'), |
c3fc2621 | 101 | 'required' => TRUE, |
a36434b9 | 102 | 'where' => 'civicrm_group_nesting.id', |
522a26c9 | 103 | 'table_name' => 'civicrm_group_nesting', |
104 | 'entity' => 'GroupNesting', | |
105 | 'bao' => 'CRM_Contact_BAO_GroupNesting', | |
6a7e5e5d | 106 | 'localizable' => 0, |
2cbbebe8 A |
107 | 'html' => [ |
108 | 'type' => 'Number', | |
109 | ], | |
a9d0587b | 110 | 'add' => '2.0', |
c3fc2621 CW |
111 | ], |
112 | 'child_group_id' => [ | |
e501603b TO |
113 | 'name' => 'child_group_id', |
114 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 115 | 'title' => ts('Child Group ID'), |
215b423e | 116 | 'description' => ts('ID of the child group'), |
c3fc2621 | 117 | 'required' => TRUE, |
a36434b9 | 118 | 'where' => 'civicrm_group_nesting.child_group_id', |
522a26c9 | 119 | 'table_name' => 'civicrm_group_nesting', |
120 | 'entity' => 'GroupNesting', | |
121 | 'bao' => 'CRM_Contact_BAO_GroupNesting', | |
6a7e5e5d | 122 | 'localizable' => 0, |
e501603b | 123 | 'FKClassName' => 'CRM_Contact_DAO_Group', |
2cbbebe8 A |
124 | 'html' => [ |
125 | 'label' => ts("Child Group"), | |
126 | ], | |
a9d0587b | 127 | 'add' => '2.0', |
c3fc2621 CW |
128 | ], |
129 | 'parent_group_id' => [ | |
e501603b TO |
130 | 'name' => 'parent_group_id', |
131 | 'type' => CRM_Utils_Type::T_INT, | |
2cbbebe8 | 132 | 'title' => ts('Parent Group ID'), |
215b423e | 133 | 'description' => ts('ID of the parent group'), |
c3fc2621 | 134 | 'required' => TRUE, |
a36434b9 | 135 | 'where' => 'civicrm_group_nesting.parent_group_id', |
522a26c9 | 136 | 'table_name' => 'civicrm_group_nesting', |
137 | 'entity' => 'GroupNesting', | |
138 | 'bao' => 'CRM_Contact_BAO_GroupNesting', | |
6a7e5e5d | 139 | 'localizable' => 0, |
e501603b | 140 | 'FKClassName' => 'CRM_Contact_DAO_Group', |
2cbbebe8 A |
141 | 'html' => [ |
142 | 'label' => ts("Parent Group"), | |
143 | ], | |
a9d0587b | 144 | 'add' => '2.0', |
c3fc2621 CW |
145 | ], |
146 | ]; | |
346aaaba | 147 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 148 | } |
346aaaba | 149 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 150 | } |
c3fc2621 | 151 | |
e501603b | 152 | /** |
bd8e0b14 | 153 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
154 | * |
155 | * @return array | |
bd8e0b14 | 156 | * Array(string $name => string $uniqueName). |
e501603b | 157 | */ |
c3fc2621 | 158 | public static function &fieldKeys() { |
bd8e0b14 TO |
159 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
160 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 161 | } |
bd8e0b14 | 162 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 163 | } |
c3fc2621 | 164 | |
e501603b TO |
165 | /** |
166 | * Returns the names of this table | |
167 | * | |
168 | * @return string | |
169 | */ | |
c3fc2621 | 170 | public static function getTableName() { |
e501603b TO |
171 | return self::$_tableName; |
172 | } | |
c3fc2621 | 173 | |
e501603b TO |
174 | /** |
175 | * Returns if this table needs to be logged | |
176 | * | |
c3fc2621 | 177 | * @return bool |
e501603b | 178 | */ |
c3fc2621 | 179 | public function getLog() { |
e501603b TO |
180 | return self::$_log; |
181 | } | |
c3fc2621 | 182 | |
e501603b TO |
183 | /** |
184 | * Returns the list of fields that can be imported | |
185 | * | |
186 | * @param bool $prefix | |
187 | * | |
188 | * @return array | |
189 | */ | |
c3fc2621 CW |
190 | public static function &import($prefix = FALSE) { |
191 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'group_nesting', $prefix, []); | |
60808919 | 192 | return $r; |
e501603b | 193 | } |
c3fc2621 | 194 | |
e501603b TO |
195 | /** |
196 | * Returns the list of fields that can be exported | |
197 | * | |
198 | * @param bool $prefix | |
199 | * | |
200 | * @return array | |
201 | */ | |
c3fc2621 CW |
202 | public static function &export($prefix = FALSE) { |
203 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'group_nesting', $prefix, []); | |
60808919 | 204 | return $r; |
e501603b | 205 | } |
c3fc2621 | 206 | |
e7a6b91a AS |
207 | /** |
208 | * Returns the list of indices | |
c3fc2621 CW |
209 | * |
210 | * @param bool $localize | |
211 | * | |
212 | * @return array | |
e7a6b91a AS |
213 | */ |
214 | public static function indices($localize = TRUE) { | |
c3fc2621 | 215 | $indices = []; |
e7a6b91a AS |
216 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
217 | } | |
c3fc2621 | 218 | |
e501603b | 219 | } |