diff --git a/CRM/Admin/Form/RelationshipType.php b/CRM/Admin/Form/RelationshipType.php
index 2c07ed88634e..ed13ef49a366 100644
--- a/CRM/Admin/Form/RelationshipType.php
+++ b/CRM/Admin/Form/RelationshipType.php
@@ -36,6 +36,50 @@
*/
class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form {
+ use CRM_Core_Form_EntityFormTrait;
+
+ /**
+ * Fields for the entity to be assigned to the template.
+ *
+ * Fields may have keys
+ * - name (required to show in tpl from the array)
+ * - description (optional, will appear below the field)
+ * - not-auto-addable - this class will not attempt to add the field using addField.
+ * (this will be automatically set if the field does not have html in it's metadata
+ * or is not a core field on the form's entity).
+ * - help (option) add help to the field - e.g ['id' => 'id-source', 'file' => 'CRM/Contact/Form/Contact']]
+ * - template - use a field specific template to render this field
+ * @var array
+ */
+ protected $entityFields = [];
+
+ /**
+ * Set entity fields to be assigned to the form.
+ */
+ protected function setEntityFields() {
+ $this->entityFields = [
+ 'label_a_b' => [
+ 'name' => 'label_a_b',
+ 'description' => ts("Label for the relationship from Contact A to Contact B. EXAMPLE: Contact A is 'Parent of' Contact B.")
+ ],
+ 'label_b_a' => [
+ 'name' => 'label_b_a',
+ 'description' => ts("Label for the relationship from Contact B to Contact A. EXAMPLE: Contact B is 'Child of' Contact A. You may leave this blank for relationships where the name is the same in both directions (e.g. Spouse).")
+ ],
+ 'description' => ['name' => 'description'],
+ 'contact_types_a' => ['name' => 'contact_types_a', 'not-auto-addable' => TRUE],
+ 'contact_types_b' => ['name' => 'contact_types_b', 'not-auto-addable' => TRUE],
+ 'is_active' => ['name' => 'is_active'],
+ ];
+ }
+
+ /**
+ * Deletion message to be assigned to the form.
+ *
+ * @var string
+ */
+ protected $deleteMessage;
+
/**
* Explicitly declare the entity api name.
*/
@@ -43,21 +87,25 @@ public function getDefaultEntity() {
return 'RelationshipType';
}
+ /**
+ * Set the delete message.
+ *
+ * We do this from the constructor in order to do a translation.
+ */
+ public function setDeleteMessage() {
+ $this->deleteMessage = ts('WARNING: Deleting this option will result in the loss of all Relationship records of this type.') . ts('This may mean the loss of a substantial amount of data, and the action cannot be undone.') . ts('Do you want to continue?');
+ }
+
/**
* Build the form object.
*/
public function buildQuickForm() {
- parent::buildQuickForm();
- $this->setPageTitle(ts('Relationship Type'));
+ self::buildQuickEntityForm();
if ($this->_action & CRM_Core_Action::DELETE) {
return;
}
- $this->applyFilter('__ALL__', 'trim');
-
- $this->addField('label_a_b');
- $this->addField('label_b_a');
$this->addRule('label_a_b', ts('Label already exists in Database.'),
'objectExists', array('CRM_Contact_DAO_RelationshipType', $this->_id, 'label_a_b')
);
@@ -65,8 +113,6 @@ public function buildQuickForm() {
'objectExists', array('CRM_Contact_DAO_RelationshipType', $this->_id, 'label_b_a')
);
- $this->addField('description');
-
$contactTypes = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, TRUE, '__');
// add select for contact type
@@ -81,8 +127,6 @@ public function buildQuickForm() {
) + $contactTypes
);
- $this->addField('is_active');
-
//only selected field should be allow for edit, CRM-4888
if ($this->_id &&
CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', $this->_id, 'is_reserved')
@@ -96,8 +140,6 @@ public function buildQuickForm() {
$this->freeze();
}
- $this->assign('relationship_type_id', $this->_id);
-
}
/**
diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php
index 58c332f48bbf..15a0cd245f60 100644
--- a/CRM/Core/Form.php
+++ b/CRM/Core/Form.php
@@ -269,8 +269,18 @@ public function __construct(
$this->addClass(CRM_Utils_System::getClassName($this));
$this->assign('snippet', CRM_Utils_Array::value('snippet', $_GET));
+ $this->setTranslatedFields();
}
+ /**
+ * Set translated fields.
+ *
+ * This function is called from the class constructor, allowing us to set
+ * fields on the class that can't be set as properties due to need for
+ * translation or other non-input specific handling.
+ */
+ protected function setTranslatedFields() {}
+
/**
* Add one or more css classes to the form.
*
diff --git a/CRM/Core/Form/EntityFormTrait.php b/CRM/Core/Form/EntityFormTrait.php
new file mode 100644
index 000000000000..c102c94e7f67
--- /dev/null
+++ b/CRM/Core/Form/EntityFormTrait.php
@@ -0,0 +1,169 @@
+entityFields;
+ }
+
+ /**
+ * Explicitly declare the form context.
+ */
+ public function getDefaultContext() {
+ return 'create';
+ }
+
+ /**
+ * Get entity fields for the entity to be added to the form.
+ *
+ * @var array
+ */
+ public function getDeleteMessage() {
+ return $this->deleteMessage;
+ }
+
+ /**
+ * Get the entity id being edited.
+ *
+ * @return int|null
+ */
+ public function getEntityId() {
+ return $this->_id;
+ }
+ /**
+ * If the custom data is in the submitted data (eg. added via ajax loaded form) add to form.
+ */
+ public function addCustomDataToForm() {
+ $customisableEntities = CRM_Core_SelectValues::customGroupExtends();
+ if (isset($customisableEntities[$this->getDefaultEntity()])) {
+ CRM_Custom_Form_CustomData::addToForm($this);
+ }
+ }
+
+ /**
+ * Build the form object.
+ */
+ public function buildQuickEntityForm() {
+ if ($this->_action & CRM_Core_Action::DELETE) {
+ $this->buildDeleteForm();
+ return;
+ }
+ $this->applyFilter('__ALL__', 'trim');
+ $this->addEntityFieldsToTemplate();
+ $this->assign('entityFields', $this->entityFields);
+ $this->assign('entityID', $this->getEntityId());
+ $this->assign('entityInClassFormat', strtolower(str_replace('_', '-', $this->getDefaultEntity())));
+ $this->assign('entityTable', CRM_Core_DAO_AllCoreTables::getTableForClass(CRM_Core_DAO_AllCoreTables::getFullName($this->getDefaultEntity())));
+ $this->addCustomDataToForm();
+ $this->addFormButtons();
+ }
+
+ /**
+ * Build the form for any deletion.
+ */
+ protected function buildDeleteForm() {
+ $this->assign('deleteMessage', $this->getDeleteMessage());
+ $this->addFormButtons();
+ }
+
+ /**
+ * Add relevant buttons to the form.
+ */
+ protected function addFormButtons() {
+ if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) {
+ $this->addButtons(array(
+ array(
+ 'type' => 'cancel',
+ 'name' => ts('Done'),
+ 'isDefault' => TRUE,
+ ),
+ )
+ );
+ }
+ else {
+ $this->addButtons(array(
+ array(
+ 'type' => 'next',
+ 'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'),
+ 'isDefault' => TRUE,
+ ),
+ array(
+ 'type' => 'cancel',
+ 'name' => ts('Cancel'),
+ ),
+ )
+ );
+ }
+ }
+
+ /**
+ * Set translated fields.
+ *
+ * This function is called from the class constructor, allowing us to set
+ * fields on the class that can't be set as properties due to need for
+ * translation or other non-input specific handling.
+ */
+ protected function setTranslatedFields() {
+ $this->setEntityFields();
+ $this->setDeleteMessage();
+ $metadata = civicrm_api3($this->getDefaultEntity(), 'getfields', ['action' => 'create']);
+ $this->metadata = $metadata['values'];
+ foreach ($this->metadata as $fieldName => $spec) {
+ if (isset($this->entityFields[$fieldName])) {
+ if ($spec['localizable']) {
+ $this->entityFields[$fieldName]['is_add_translate_dialog'] = TRUE;
+ }
+ if (empty($spec['html'])) {
+ $this->entityFields[$fieldName]['not-auto-addable'] = TRUE;
+ }
+ }
+ }
+ }
+
+ /**
+ * Add defined entity field to template.
+ */
+ protected function addEntityFieldsToTemplate() {
+ foreach ($this->getEntityFields() as $fieldSpec) {
+ if (empty($fieldSpec['not-auto-addable'])) {
+ $this->addField($fieldSpec['name']);
+ }
+ }
+ }
+
+}
diff --git a/templates/CRM/Admin/Form/RelationshipType.tpl b/templates/CRM/Admin/Form/RelationshipType.tpl
index 63b86f289e4e..ffd91f73d378 100644
--- a/templates/CRM/Admin/Form/RelationshipType.tpl
+++ b/templates/CRM/Admin/Form/RelationshipType.tpl
@@ -24,44 +24,4 @@
+--------------------------------------------------------------------+
*}
{* this template is used for adding/editing relationship types *}
-
+{include file="CRM/Core/Form/EntityForm.tpl"}
diff --git a/templates/CRM/Core/Form/EntityForm.tpl b/templates/CRM/Core/Form/EntityForm.tpl
new file mode 100644
index 000000000000..c59b0d2cf5de
--- /dev/null
+++ b/templates/CRM/Core/Form/EntityForm.tpl
@@ -0,0 +1,46 @@
+{*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 5 |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2018 |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM. |
+ | |
+ | CiviCRM is free software; you can copy, modify, and distribute it |
+ | under the terms of the GNU Affero General Public License |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
+ | |
+ | CiviCRM is distributed in the hope that it will be useful, but |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
+ | See the GNU Affero General Public License for more details. |
+ | |
+ | You should have received a copy of the GNU Affero General Public |
+ | License and the CiviCRM Licensing Exception along |
+ | with this program; if not, contact CiviCRM LLC |
+ | at info[AT]civicrm[DOT]org. If you have questions about the |
+ | GNU Affero General Public License or the licensing of CiviCRM, |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+*}
+{* this template is used for adding/editing entities *}
+
diff --git a/templates/CRM/Core/Form/Field.tpl b/templates/CRM/Core/Form/Field.tpl
new file mode 100644
index 000000000000..79d68bda40cd
--- /dev/null
+++ b/templates/CRM/Core/Form/Field.tpl
@@ -0,0 +1,39 @@
+{*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 5 |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2018 |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM. |
+ | |
+ | CiviCRM is free software; you can copy, modify, and distribute it |
+ | under the terms of the GNU Affero General Public License |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
+ | |
+ | CiviCRM is distributed in the hope that it will be useful, but |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
+ | See the GNU Affero General Public License for more details. |
+ | |
+ | You should have received a copy of the GNU Affero General Public |
+ | License and the CiviCRM Licensing Exception along |
+ | with this program; if not, contact CiviCRM LLC |
+ | at info[AT]civicrm[DOT]org. If you have questions about the |
+ | GNU Affero General Public License or the licensing of CiviCRM, |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+*}
+{if $fieldSpec.template}
+ {include file=$fieldSpec.template}
+{else}
+ | {$form.$fieldName.label}
+ {if $fieldSpec.help}{assign var=help value=$fieldSpec.help}{capture assign=helpFile}{if $fieldSpec.help}
+ {$fieldSpec.help}
+ {else}''{/if}
+ {/capture}{help id=$help.id file=$help.file}{/if}
+ {if $action == 2 && $fieldSpec.is_add_translate_dialog}{include file='CRM/Core/I18n/Dialog.tpl' table=$entityTable field=$fieldName id=$entityID}{/if}
+ |
+ {if $form.$fieldName.html}{if $fieldSpec.formatter === 'crmMoney'}{$form.$fieldName.html|crmMoney}{else}{$form.$fieldName.html}{/if}{else}{$fieldSpec.place_holder}{/if}
+ {if $fieldSpec.description}{$fieldSpec.description}{/if}
+ |
+{/if}