Commit | Line | Data |
---|---|---|
19b53e5b | 1 | <?php |
380f3545 TO |
2 | |
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
41498ac5 | 5 | | Copyright CiviCRM LLC. All rights reserved. | |
380f3545 | 6 | | | |
41498ac5 TO |
7 | | This work is published under the GNU AGPLv3 license with some | |
8 | | permitted exceptions and without any warranty. For full license | | |
9 | | and copyright information, see https://civicrm.org/licensing | | |
380f3545 TO |
10 | +--------------------------------------------------------------------+ |
11 | */ | |
12 | ||
19b53e5b C |
13 | namespace Civi\Api4\Generic\Traits; |
14 | ||
c9e3994d | 15 | use Civi\Api4\CustomField; |
721c9da1 | 16 | use Civi\Api4\Service\Schema\Joinable\CustomGroupJoinable; |
19b53e5b | 17 | use Civi\Api4\Utils\FormattingUtil; |
a62d97f3 | 18 | use Civi\Api4\Utils\CoreUtil; |
19b53e5b C |
19 | |
20 | /** | |
21 | * @method string getLanguage() | |
14a9c588 | 22 | * @method $this setLanguage(string $language) |
19b53e5b C |
23 | */ |
24 | trait DAOActionTrait { | |
25 | ||
26 | /** | |
27 | * Specify the language to use if this is a multi-lingual environment. | |
28 | * | |
29 | * E.g. "en_US" or "fr_CA" | |
30 | * | |
31 | * @var string | |
32 | */ | |
33 | protected $language; | |
34 | ||
35 | /** | |
36 | * @return \CRM_Core_DAO|string | |
37 | */ | |
38 | protected function getBaoName() { | |
a62d97f3 | 39 | return CoreUtil::getBAOFromApiName($this->getEntityName()); |
19b53e5b C |
40 | } |
41 | ||
42 | /** | |
a4c7afc0 | 43 | * Convert saved object to array |
19b53e5b | 44 | * |
a4c7afc0 CW |
45 | * Used by create, update & save actions |
46 | * | |
47 | * @param \CRM_Core_DAO $bao | |
48 | * @param array $input | |
19b53e5b C |
49 | * @return array |
50 | */ | |
a4c7afc0 CW |
51 | public function baoToArray($bao, $input) { |
52 | $allFields = array_column($bao->fields(), 'name'); | |
53 | if (!empty($this->reload)) { | |
54 | $inputFields = $allFields; | |
55 | $bao->find(TRUE); | |
56 | } | |
57 | else { | |
58 | $inputFields = array_keys($input); | |
59 | // Convert 'null' input to true null | |
60 | foreach ($input as $key => $val) { | |
61 | if ($val === 'null') { | |
62 | $bao->$key = NULL; | |
63 | } | |
64 | } | |
65 | } | |
19b53e5b | 66 | $values = []; |
a4c7afc0 CW |
67 | foreach ($allFields as $field) { |
68 | if (isset($bao->$field) || in_array($field, $inputFields)) { | |
69 | $values[$field] = $bao->$field ?? NULL; | |
19b53e5b C |
70 | } |
71 | } | |
72 | return $values; | |
73 | } | |
74 | ||
19b53e5b C |
75 | /** |
76 | * Fill field defaults which were declared by the api. | |
77 | * | |
78 | * Note: default values from core are ignored because the BAO or database layer will supply them. | |
79 | * | |
80 | * @param array $params | |
81 | */ | |
82 | protected function fillDefaults(&$params) { | |
83 | $fields = $this->entityFields(); | |
84 | $bao = $this->getBaoName(); | |
85 | $coreFields = array_column($bao::fields(), NULL, 'name'); | |
86 | ||
87 | foreach ($fields as $name => $field) { | |
88 | // If a default value in the api field is different than in core, the api should override it. | |
89 | if (!isset($params[$name]) && !empty($field['default_value']) && $field['default_value'] != \CRM_Utils_Array::pathGet($coreFields, [$name, 'default'])) { | |
90 | $params[$name] = $field['default_value']; | |
91 | } | |
92 | } | |
93 | } | |
94 | ||
95 | /** | |
96 | * Write bao objects as part of a create/update action. | |
97 | * | |
98 | * @param array $items | |
99 | * The records to write to the DB. | |
14a9c588 | 100 | * |
19b53e5b C |
101 | * @return array |
102 | * The records after being written to the DB (e.g. including newly assigned "id"). | |
103 | * @throws \API_Exception | |
14a9c588 | 104 | * @throws \CRM_Core_Exception |
19b53e5b | 105 | */ |
baf63a69 | 106 | protected function writeObjects(&$items) { |
19b53e5b C |
107 | $baoName = $this->getBaoName(); |
108 | ||
bfa91094 CW |
109 | // TODO: Opt-in more entities to use the new writeRecords BAO method. |
110 | $functionNames = [ | |
236f858e | 111 | 'Address' => 'add', |
bfa91094 | 112 | 'CustomField' => 'writeRecords', |
19b53e5b C |
113 | 'EntityTag' => 'add', |
114 | 'GroupContact' => 'add', | |
19b53e5b | 115 | ]; |
bfa91094 CW |
116 | $method = $functionNames[$this->getEntityName()] ?? NULL; |
117 | if (!isset($method)) { | |
118 | $method = method_exists($baoName, 'create') ? 'create' : (method_exists($baoName, 'add') ? 'add' : 'writeRecords'); | |
19b53e5b C |
119 | } |
120 | ||
121 | $result = []; | |
122 | ||
baf63a69 | 123 | foreach ($items as &$item) { |
2929a8fb | 124 | $entityId = $item['id'] ?? NULL; |
37d82abe | 125 | FormattingUtil::formatWriteParams($item, $this->entityFields()); |
19b53e5b | 126 | $this->formatCustomParams($item, $entityId); |
236f858e | 127 | |
bfa91094 CW |
128 | // Skip individual processing if using writeRecords |
129 | if ($method === 'writeRecords') { | |
236f858e CW |
130 | continue; |
131 | } | |
19b53e5b C |
132 | $item['check_permissions'] = $this->getCheckPermissions(); |
133 | ||
134 | // For some reason the contact bao requires this | |
14a9c588 | 135 | if ($entityId && $this->getEntityName() === 'Contact') { |
19b53e5b C |
136 | $item['contact_id'] = $entityId; |
137 | } | |
138 | ||
14a9c588 | 139 | if ($this->getEntityName() === 'Address') { |
1db5a675 | 140 | $createResult = $baoName::$method($item, $this->fixAddress); |
19b53e5b | 141 | } |
19b53e5b | 142 | else { |
236f858e | 143 | $createResult = $baoName::$method($item); |
19b53e5b C |
144 | } |
145 | ||
146 | if (!$createResult) { | |
147 | $errMessage = sprintf('%s write operation failed', $this->getEntityName()); | |
148 | throw new \API_Exception($errMessage); | |
149 | } | |
150 | ||
a4c7afc0 | 151 | $result[] = $this->baoToArray($createResult, $item); |
067dea45 | 152 | \CRM_Utils_API_HTMLInputCoder::singleton()->decodeRows($result); |
19b53e5b | 153 | } |
236f858e CW |
154 | |
155 | // Use bulk `writeRecords` method if the BAO doesn't have a create or add method | |
156 | // TODO: reverse this from opt-in to opt-out and default to using `writeRecords` for all BAOs | |
bfa91094 | 157 | if ($method === 'writeRecords') { |
236f858e CW |
158 | $items = array_values($items); |
159 | foreach ($baoName::writeRecords($items) as $i => $createResult) { | |
160 | $result[] = $this->baoToArray($createResult, $items[$i]); | |
161 | } | |
162 | } | |
163 | ||
2929a8fb | 164 | FormattingUtil::formatOutputValues($result, $this->entityFields(), $this->getEntityName()); |
19b53e5b C |
165 | return $result; |
166 | } | |
167 | ||
4fd13075 CW |
168 | /** |
169 | * @inheritDoc | |
170 | */ | |
171 | protected function formatWriteValues(&$record) { | |
172 | $this->resolveFKValues($record); | |
173 | parent::formatWriteValues($record); | |
174 | } | |
175 | ||
176 | /** | |
177 | * Looks up an id based on some other property of an fk entity | |
178 | * | |
179 | * @param array $record | |
180 | */ | |
181 | private function resolveFKValues(array &$record): void { | |
182 | foreach ($record as $key => $value) { | |
183 | if (substr_count($key, '.') !== 1) { | |
184 | continue; | |
185 | } | |
186 | [$fieldName, $fkField] = explode('.', $key); | |
187 | $field = $this->entityFields()[$fieldName] ?? NULL; | |
188 | if (!$field || empty($field['fk_entity'])) { | |
189 | continue; | |
190 | } | |
191 | $fkDao = CoreUtil::getBAOFromApiName($field['fk_entity']); | |
192 | $record[$fieldName] = \CRM_Core_DAO::getFieldValue($fkDao, $value, 'id', $fkField); | |
193 | unset($record[$key]); | |
194 | } | |
195 | } | |
196 | ||
19b53e5b | 197 | /** |
932303e6 CW |
198 | * Converts params from flat array e.g. ['GroupName.Fieldname' => value] to the |
199 | * hierarchy expected by the BAO, nested within $params['custom']. | |
200 | * | |
19b53e5b C |
201 | * @param array $params |
202 | * @param int $entityId | |
14a9c588 | 203 | * |
14a9c588 | 204 | * @throws \API_Exception |
205 | * @throws \CRM_Core_Exception | |
19b53e5b C |
206 | */ |
207 | protected function formatCustomParams(&$params, $entityId) { | |
208 | $customParams = []; | |
209 | ||
19b53e5b | 210 | foreach ($params as $name => $value) { |
c9e3994d CW |
211 | $field = $this->getCustomFieldInfo($name); |
212 | if (!$field) { | |
19b53e5b C |
213 | continue; |
214 | } | |
215 | ||
19b53e5b | 216 | // todo are we sure we don't want to allow setting to NULL? need to test |
c9e3994d | 217 | if (NULL !== $value) { |
19b53e5b | 218 | |
c9e3994d | 219 | if ($field['suffix']) { |
265192b2 | 220 | $options = FormattingUtil::getPseudoconstantList($field, $name, $params, $this->getActionName()); |
961e974c CW |
221 | $value = FormattingUtil::replacePseudoconstant($options, $value, TRUE); |
222 | } | |
223 | ||
c9e3994d | 224 | if ($field['html_type'] === 'CheckBox') { |
19b53e5b | 225 | // this function should be part of a class |
c9e3994d | 226 | formatCheckBoxField($value, 'custom_' . $field['id'], $this->getEntityName()); |
19b53e5b C |
227 | } |
228 | ||
ef9170e4 CW |
229 | // Match contact id to strings like "user_contact_id" |
230 | // FIXME handle arrays for multi-value contact reference fields, etc. | |
231 | if ($field['data_type'] === 'ContactReference' && is_string($value) && !is_numeric($value)) { | |
232 | // FIXME decouple from v3 API | |
a6a158e7 CW |
233 | require_once 'api/v3/utils.php'; |
234 | $value = \_civicrm_api3_resolve_contactID($value); | |
235 | if ('unknown-user' === $value) { | |
236 | throw new \API_Exception("\"{$field['name']}\" \"{$value}\" cannot be resolved to a contact ID", 2002, ['error_field' => $field['name'], "type" => "integer"]); | |
237 | } | |
238 | } | |
239 | ||
19b53e5b | 240 | \CRM_Core_BAO_CustomField::formatCustomField( |
c9e3994d | 241 | $field['id'], |
19b53e5b C |
242 | $customParams, |
243 | $value, | |
84ad7693 | 244 | $field['custom_group_id.extends'], |
19b53e5b C |
245 | // todo check when this is needed |
246 | NULL, | |
247 | $entityId, | |
248 | FALSE, | |
317103ab | 249 | $this->getCheckPermissions(), |
19b53e5b C |
250 | TRUE |
251 | ); | |
252 | } | |
253 | } | |
254 | ||
317103ab | 255 | $params['custom'] = $customParams ?: NULL; |
19b53e5b C |
256 | } |
257 | ||
c9e3994d CW |
258 | /** |
259 | * Gets field info needed to save custom data | |
260 | * | |
721c9da1 | 261 | * @param string $fieldExpr |
c9e3994d | 262 | * Field identifier with possible suffix, e.g. MyCustomGroup.MyField1:label |
932303e6 | 263 | * @return array{id: int, name: string, entity: string, suffix: string, html_type: string, data_type: string}|NULL |
c9e3994d | 264 | */ |
721c9da1 CW |
265 | protected function getCustomFieldInfo(string $fieldExpr) { |
266 | if (strpos($fieldExpr, '.') === FALSE) { | |
c9e3994d CW |
267 | return NULL; |
268 | } | |
265192b2 CW |
269 | [$groupName, $fieldName] = explode('.', $fieldExpr); |
270 | [$fieldName, $suffix] = array_pad(explode(':', $fieldName), 2, NULL); | |
721c9da1 CW |
271 | $cacheKey = "APIv4_Custom_Fields-$groupName"; |
272 | $info = \Civi::cache('metadata')->get($cacheKey); | |
273 | if (!isset($info[$fieldName])) { | |
274 | $info = []; | |
275 | $fields = CustomField::get(FALSE) | |
84ad7693 CW |
276 | ->addSelect('id', 'name', 'html_type', 'data_type', 'custom_group_id.extends') |
277 | ->addWhere('custom_group_id.name', '=', $groupName) | |
c9e3994d | 278 | ->execute()->indexBy('name'); |
721c9da1 CW |
279 | foreach ($fields as $name => $field) { |
280 | $field['custom_field_id'] = $field['id']; | |
281 | $field['name'] = $groupName . '.' . $name; | |
84ad7693 | 282 | $field['entity'] = CustomGroupJoinable::getEntityFromExtends($field['custom_group_id.extends']); |
721c9da1 CW |
283 | $info[$name] = $field; |
284 | } | |
285 | \Civi::cache('metadata')->set($cacheKey, $info); | |
c9e3994d | 286 | } |
721c9da1 | 287 | return isset($info[$fieldName]) ? ['suffix' => $suffix] + $info[$fieldName] : NULL; |
c9e3994d CW |
288 | } |
289 | ||
19b53e5b | 290 | } |