3 require_once 'CRM/Core/Page.php';
6 * This class is not a real page -- it contains helpers for rendering the profile-selector and profile-editor
9 class CRM_UF_Page_ProfileEditor
extends CRM_Core_Page
{
10 public function run() {
11 CRM_Core_Error
::fatal('This is not a real page!');
14 public static function registerProfileScripts() {
15 static $loaded = FALSE;
16 if ($loaded || CRM_Core_Resources
::isAjaxMode()) {
21 CRM_Core_Resources
::singleton()
22 ->addSettingsFactory(function () {
24 'PseudoConstant' => array(
25 'locationType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id'),
26 'phoneType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
28 'initialProfileList' => civicrm_api('UFGroup', 'get', array(
32 'rowCount' => 1000, // FIXME
34 'contactSubTypes' => CRM_Contact_BAO_ContactType
::subTypes(),
35 'profilePreviewKey' => CRM_Core_Key
::get('CRM_UF_Form_Inline_Preview', TRUE),
38 ->addScriptFile('civicrm', 'packages/backbone/json2.js', 100, 'html-header', FALSE)
39 ->addScriptFile('civicrm', 'packages/backbone/backbone.js', 120, 'html-header')
40 ->addScriptFile('civicrm', 'packages/backbone/backbone.marionette.js', 125, 'html-header', FALSE)
41 ->addScriptFile('civicrm', 'packages/backbone/backbone.collectionsubset.js', 125, 'html-header', FALSE)
42 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/backbone-forms.js', 130, 'html-header', FALSE)
43 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/adapters/backbone.bootstrap-modal.min.js', 140, 'html-header', FALSE)
44 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/editors/list.min.js', 140, 'html-header', FALSE)
45 ->addStyleFile('civicrm', 'packages/backbone-forms/distribution/templates/default.css', 140, 'html-header')
46 ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE)
47 ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header')
48 ->addStyleFile('civicrm', 'css/crm.designer.css', 140, 'html-header')
49 ->addScriptFile('civicrm', 'js/crm.backbone.js', 150)
50 ->addScriptFile('civicrm', 'js/model/crm.schema-mapped.js', 200)
51 ->addScriptFile('civicrm', 'js/model/crm.uf.js', 200)
52 ->addScriptFile('civicrm', 'js/model/crm.designer.js', 200)
53 ->addScriptFile('civicrm', 'js/model/crm.profile-selector.js', 200)
54 ->addScriptFile('civicrm', 'js/view/crm.designer.js', 200)
55 ->addScriptFile('civicrm', 'js/view/crm.profile-selector.js', 200)
56 ->addScriptFile('civicrm', 'js/jquery/jquery.crmProfileSelector.js', 250)
57 ->addScriptFile('civicrm', 'js/crm.designerapp.js', 250);
59 CRM_Core_Region
::instance('page-header')->add(array(
60 'template' => 'CRM/UF/Page/ProfileTemplates.tpl',
65 * Register entity schemas for use in the editor's palette
67 * @param array $entityTypes
68 * Strings, e.g. "IndividualModel", "ActivityModel".
70 public static function registerSchemas($entityTypes) {
71 // TODO in cases where registerSchemas is called multiple times for same entity, be more efficient
72 CRM_Core_Resources
::singleton()->addSettingsFactory(function () use ($entityTypes) {
74 'civiSchema' => CRM_UF_Page_ProfileEditor
::getSchema($entityTypes),
82 public static function getSchemaJSON() {
83 $entityTypes = explode(',', $_REQUEST['entityTypes']);
84 CRM_Utils_JSON
::output(self
::getSchema($entityTypes));
88 * Get a list of Backbone-Form models
90 * @param array $entityTypes
91 * Model names ("IndividualModel").
93 * @throws CRM_Core_Exception
94 * @return array; keys are model names ("IndividualModel") and values describe 'sections' and 'schema'
95 * @see js/model/crm.core.js
96 * @see js/model/crm.mappedcore.js
98 public static function getSchema($entityTypes) {
99 // FIXME: Depending on context (eg civicrm/profile/create vs search-columns), it may be appropriate to
100 // pick importable or exportable fields
102 $entityTypes = array_unique($entityTypes);
103 $availableFields = NULL;
104 foreach ($entityTypes as $entityType) {
105 if (!$availableFields) {
106 $availableFields = CRM_Core_BAO_UFField
::getAvailableFieldsFlat();
107 //dpm($availableFields);
109 switch ($entityType) {
110 case 'IndividualModel':
111 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
118 case 'OrganizationModel':
119 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
126 case 'HouseholdModel':
127 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
134 case 'ActivityModel':
135 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
142 case 'ContributionModel':
143 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
150 case 'MembershipModel':
151 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
158 case 'ParticipantModel':
159 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
167 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
175 throw new CRM_Core_Exception("Unrecognized entity type: $entityType");
183 * FIXME: Move to somewhere more useful
184 * FIXME: Do real mapping of "types"
186 * @param string $extends
187 * Entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact".
188 * @param string $title
189 * A string to use in section headers.
190 * @param array $availableFields
191 * List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type'].
193 * with keys 'sections' and 'schema'
194 * @see js/model/crm.core.js
195 * @see js/model/crm.mappedcore.js
197 public static function convertCiviModelToBackboneModel($extends, $title, $availableFields) {
198 $locationFields = CRM_Core_BAO_UFGroup
::getLocationFields();
201 'schema' => array(), // array($fieldName => $fieldSchema)
202 'sections' => array(), // array($sectionName => $section)
206 foreach ($availableFields as $fieldName => $field) {
211 if ($field['field_type'] != $extends && $field['field_type'] != 'Contact'
212 //CRM-15595 check if subtype
213 && !in_array($field['field_type'], CRM_Contact_BAO_ContactType
::subTypes($extends))
220 if ($field['field_type'] != $extends) {
224 $result['schema'][$fieldName] = array(
225 'type' => 'Text', // FIXME,
226 'title' => $field['title'],
227 'civiFieldType' => $field['field_type'],
229 if (in_array($fieldName, $locationFields)) {
230 $result['schema'][$fieldName]['civiIsLocation'] = TRUE;
232 if (in_array($fieldName, array('phone', 'phone_and_ext'))) {
233 // FIXME what about phone_ext?
234 $result['schema'][$fieldName]['civiIsPhone'] = TRUE;
238 // build section list
239 $result['sections']['default'] = array(
241 'is_addable' => FALSE,
244 $customGroup = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity($extends);
245 $customGroup->orderBy('weight');
246 $customGroup->is_active
= 1;
247 $customGroup->find();
248 while ($customGroup->fetch()) {
249 $sectionName = 'cg_' . $customGroup->id
;
251 'title' => ts('%1: %2', array(1 => $title, 2 => $customGroup->title
)),
252 'is_addable' => $customGroup->is_reserved ?
FALSE : TRUE,
253 'custom_group_id' => $customGroup->id
,
254 'extends_entity_column_id' => $customGroup->extends_entity_column_id
,
255 'extends_entity_column_value' => CRM_Utils_Array
::explodePadded($customGroup->extends_entity_column_value
),
256 'is_reserved' => $customGroup->is_reserved ?
TRUE : FALSE,
258 $result['sections'][$sectionName] = $section;
261 // put fields in their sections
262 $fields = CRM_Core_BAO_CustomField
::getFields($extends);
263 foreach ($fields as $fieldId => $field) {
264 $sectionName = 'cg_' . $field['custom_group_id'];
265 $fieldName = 'custom_' . $fieldId;
266 if (isset($result['schema'][$fieldName])) {
267 $result['schema'][$fieldName]['section'] = $sectionName;
268 $result['schema'][$fieldName]['civiIsMultiple'] = (bool) CRM_Core_BAO_CustomField
::isMultiRecordField($fieldId);