3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 trait CRM_Core_Form_EntityFormTrait
{
20 * The id of the object being edited / created.
27 * The entity subtype ID (eg. for Relationship / Activity)
31 protected $_entitySubTypeId = NULL;
34 * Get entity fields for the entity to be added to the form.
38 public function getEntityFields() {
39 return $this->entityFields
;
43 * Explicitly declare the form context.
45 public function getDefaultContext() {
50 * Get entity fields for the entity to be added to the form.
54 public function getDeleteMessage() {
55 return $this->deleteMessage
;
59 * Set the delete message.
61 * We do this from the constructor in order to do a translation.
63 public function setDeleteMessage() {
67 * Set entity fields to be assigned to the form.
69 protected function setEntityFields() {
73 * Get the entity id being edited.
77 public function getEntityId() {
84 * @param int $id The entity ID
86 public function setEntityId($id) {
91 * Should custom data be suppressed on this form.
95 protected function isSuppressCustomData() {
100 * Get the entity subtype ID being edited
104 public function getEntitySubTypeId() {
105 return $this->_entitySubTypeId
;
109 * Set the entity subtype ID being edited
113 public function setEntitySubTypeId($subTypeId) {
114 $this->_entitySubTypeId
= $subTypeId;
118 * If the custom data is in the submitted data (eg. added via ajax loaded form) add to form.
120 public function addCustomDataToForm() {
121 if ($this->isSuppressCustomData()) {
124 $customisableEntities = CRM_Core_SelectValues
::customGroupExtends();
125 if (isset($customisableEntities[$this->getDefaultEntity()])) {
126 CRM_Custom_Form_CustomData
::addToForm($this, $this->getEntitySubTypeId());
131 * Build the form object.
133 public function buildQuickEntityForm() {
134 if ($this->isDeleteContext()) {
135 $this->buildDeleteForm();
138 $this->applyFilter('__ALL__', 'trim');
139 $this->addEntityFieldsToTemplate();
140 foreach ($this->entityFields
as $index => $fields) {
141 $this->entityFields
[$index] = array_merge([
144 'pre_html_text' => '',
145 'post_html_text' => '',
147 'documentation_link' => '',
150 $this->assign('entityFields', $this->entityFields
);
151 $this->assign('entityID', $this->getEntityId());
152 $this->assign('entityInClassFormat', strtolower(str_replace('_', '-', $this->getDefaultEntity())));
153 $this->assign('entityTable', CRM_Core_DAO_AllCoreTables
::getTableForClass(CRM_Core_DAO_AllCoreTables
::getFullName($this->getDefaultEntity())));
154 $this->addCustomDataToForm();
155 $this->addFormButtons();
157 if ($this->isViewContext()) {
163 * Build the form for any deletion.
165 protected function buildDeleteForm() {
166 $this->assign('deleteMessage', $this->getDeleteMessage());
167 $this->addFormButtons();
171 * Add relevant buttons to the form.
173 protected function addFormButtons() {
174 if ($this->isViewContext() ||
$this->_action
& CRM_Core_Action
::PREVIEW
) {
178 'name' => ts('Done'),
187 'name' => $this->isDeleteContext() ?
ts('Delete') : ts('Save'),
192 'name' => ts('Cancel'),
199 * Get the defaults for the entity.
201 protected function getEntityDefaults() {
202 $defaults = $moneyFields = [];
204 if (!$this->isDeleteContext() &&
205 $this->getEntityId()) {
206 $params = ['id' => $this->getEntityId()];
207 $baoName = $this->_BAOName
;
208 $baoName::retrieve($params, $defaults);
210 foreach ($this->entityFields
as $entityFieldName => $fieldSpec) {
211 $value = CRM_Utils_Request
::retrieveValue($fieldSpec['name'], $this->getValidationTypeForField($fieldSpec['name']));
212 if ($value !== FALSE && $value !== NULL) {
213 $defaults[$fieldSpec['name']] = $value;
215 // Store a list of fields with money formatters
216 if (CRM_Utils_Array
::value('formatter', $fieldSpec) == 'crmMoney') {
217 $moneyFields[] = $entityFieldName;
220 if (!empty($defaults['currency'])) {
221 // If we have a money formatter we need to pass the specified currency or it will render as the default
222 foreach ($moneyFields as $entityFieldName) {
223 $this->entityFields
[$entityFieldName]['formatterParam'] = $defaults['currency'];
227 // Assign again as we may have modified above
228 $this->assign('entityFields', $this->entityFields
);
233 * Get the validation rule to apply to a function.
235 * Alphanumeric is designed to always be safe & for now we just return
236 * that but in future we can use tighter rules for types like int, bool etc.
238 * @param string $fieldName
240 * @return string|int|bool
242 protected function getValidationTypeForField($fieldName) {
243 switch ($this->metadata
[$fieldName]['type']) {
244 case CRM_Utils_Type
::T_BOOLEAN
:
248 return 'Alphanumeric';
253 * Set translated fields.
255 * This function is called from the class constructor, allowing us to set
256 * fields on the class that can't be set as properties due to need for
257 * translation or other non-input specific handling.
259 protected function setTranslatedFields() {
260 $this->setEntityFields();
261 $this->setDeleteMessage();
262 $metadata = civicrm_api3($this->getDefaultEntity(), 'getfields', ['action' => 'create']);
263 $this->metadata
= $metadata['values'];
264 foreach ($this->metadata
as $fieldName => $spec) {
265 if (isset($this->entityFields
[$fieldName])) {
266 if ($spec['localizable']) {
267 $this->entityFields
[$fieldName]['is_add_translate_dialog'] = TRUE;
269 if (empty($spec['html']['type'])) {
270 $this->entityFields
[$fieldName]['not-auto-addable'] = TRUE;
277 * Add defined entity field to template.
279 protected function addEntityFieldsToTemplate() {
280 foreach ($this->getEntityFields() as $fieldSpec) {
281 if (empty($fieldSpec['not-auto-addable'])) {
282 $element = $this->addField($fieldSpec['name'], [], CRM_Utils_Array
::value('required', $fieldSpec), FALSE);
283 if (!empty($fieldSpec['is_freeze'])) {
291 * Is the form being used in the context of a deletion.
293 * (For some reason rather than having separate forms Civi overloads one form).
297 protected function isDeleteContext() {
298 return ($this->_action
& CRM_Core_Action
::DELETE
);
302 * Is the form being used in the context of a view.
306 protected function isViewContext() {
307 return ($this->_action
& CRM_Core_Action
::VIEW
);
310 protected function setEntityFieldsMetadata() {
311 foreach ($this->entityFields
as $field => &$props) {
312 if (!empty($props['not-auto-addable'])) {
313 // We can't load this field using metadata
316 if ($field != 'id' && $this->isDeleteContext()) {
317 // Delete forms don't generally present any fields to edit
321 if (empty($props['action'])) {
322 $props['action'] = $this->getApiAction();
324 $fieldSpec = civicrm_api3($this->getDefaultEntity(), 'getfield', $props);
325 $fieldSpec = $fieldSpec['values'];
326 if (!isset($props['description']) && isset($fieldSpec['description'])) {
327 $props['description'] = $fieldSpec['description'];