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 'websiteType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id'),
27 'phoneType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
29 'initialProfileList' => civicrm_api('UFGroup', 'get', array(
33 'rowCount' => 1000, // FIXME
35 'contactSubTypes' => CRM_Contact_BAO_ContactType
::subTypes(),
36 'profilePreviewKey' => CRM_Core_Key
::get('CRM_UF_Form_Inline_Preview', TRUE),
39 ->addScriptFile('civicrm', 'packages/backbone/json2.js', 100, 'html-header', FALSE)
40 ->addScriptFile('civicrm', 'packages/backbone/backbone.js', 120, 'html-header')
41 ->addScriptFile('civicrm', 'packages/backbone/backbone.marionette.js', 125, 'html-header', FALSE)
42 ->addScriptFile('civicrm', 'packages/backbone/backbone.collectionsubset.js', 125, 'html-header', FALSE)
43 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/backbone-forms.js', 130, 'html-header', FALSE)
44 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/adapters/backbone.bootstrap-modal.min.js', 140, 'html-header', FALSE)
45 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/editors/list.min.js', 140, 'html-header', FALSE)
46 ->addStyleFile('civicrm', 'packages/backbone-forms/distribution/templates/default.css', 140, 'html-header')
47 ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE)
48 ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header')
49 ->addStyleFile('civicrm', 'css/crm.designer.css', 140, 'html-header')
50 ->addScriptFile('civicrm', 'js/crm.backbone.js', 150)
51 ->addScriptFile('civicrm', 'js/model/crm.schema-mapped.js', 200)
52 ->addScriptFile('civicrm', 'js/model/crm.uf.js', 200)
53 ->addScriptFile('civicrm', 'js/model/crm.designer.js', 200)
54 ->addScriptFile('civicrm', 'js/model/crm.profile-selector.js', 200)
55 ->addScriptFile('civicrm', 'js/view/crm.designer.js', 200)
56 ->addScriptFile('civicrm', 'js/view/crm.profile-selector.js', 200)
57 ->addScriptFile('civicrm', 'js/jquery/jquery.crmProfileSelector.js', 250)
58 ->addScriptFile('civicrm', 'js/crm.designerapp.js', 250);
60 CRM_Core_Region
::instance('page-header')->add(array(
61 'template' => 'CRM/UF/Page/ProfileTemplates.tpl',
66 * Register entity schemas for use in the editor's palette
68 * @param array $entityTypes
69 * Strings, e.g. "IndividualModel", "ActivityModel".
71 public static function registerSchemas($entityTypes) {
72 // TODO in cases where registerSchemas is called multiple times for same entity, be more efficient
73 CRM_Core_Resources
::singleton()->addSettingsFactory(function () use ($entityTypes) {
75 'civiSchema' => CRM_UF_Page_ProfileEditor
::getSchema($entityTypes),
83 public static function getSchemaJSON() {
84 $entityTypes = explode(',', $_REQUEST['entityTypes']);
85 CRM_Utils_JSON
::output(self
::getSchema($entityTypes));
89 * Get a list of Backbone-Form models
91 * @param array $entityTypes
92 * Model names ("IndividualModel").
94 * @throws CRM_Core_Exception
95 * @return array; keys are model names ("IndividualModel") and values describe 'sections' and 'schema'
96 * @see js/model/crm.core.js
97 * @see js/model/crm.mappedcore.js
99 public static function getSchema($entityTypes) {
100 // FIXME: Depending on context (eg civicrm/profile/create vs search-columns), it may be appropriate to
101 // pick importable or exportable fields
103 $entityTypes = array_unique($entityTypes);
104 $availableFields = NULL;
105 foreach ($entityTypes as $entityType) {
106 if (!$availableFields) {
107 $availableFields = CRM_Core_BAO_UFField
::getAvailableFieldsFlat();
108 //dpm($availableFields);
110 switch ($entityType) {
111 case 'IndividualModel':
112 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
119 case 'OrganizationModel':
120 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
127 case 'HouseholdModel':
128 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
135 case 'ActivityModel':
136 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
143 case 'ContributionModel':
144 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
151 case 'MembershipModel':
152 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
159 case 'ParticipantModel':
160 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
168 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
176 throw new CRM_Core_Exception("Unrecognized entity type: $entityType");
184 * FIXME: Move to somewhere more useful
185 * FIXME: Do real mapping of "types"
187 * @param string $extends
188 * Entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact".
189 * @param string $title
190 * A string to use in section headers.
191 * @param array $availableFields
192 * List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type'].
194 * with keys 'sections' and 'schema'
195 * @see js/model/crm.core.js
196 * @see js/model/crm.mappedcore.js
198 public static function convertCiviModelToBackboneModel($extends, $title, $availableFields) {
199 $locationFields = CRM_Core_BAO_UFGroup
::getLocationFields();
202 'schema' => array(), // array($fieldName => $fieldSchema)
203 'sections' => array(), // array($sectionName => $section)
207 foreach ($availableFields as $fieldName => $field) {
212 if ($field['field_type'] != $extends && $field['field_type'] != 'Contact'
213 //CRM-15595 check if subtype
214 && !in_array($field['field_type'], CRM_Contact_BAO_ContactType
::subTypes($extends))
221 if ($field['field_type'] != $extends) {
225 $result['schema'][$fieldName] = array(
226 'type' => 'Text', // FIXME,
227 'title' => $field['title'],
228 'civiFieldType' => $field['field_type'],
230 if (in_array($fieldName, $locationFields)) {
231 $result['schema'][$fieldName]['civiIsLocation'] = TRUE;
233 if ($fieldName == 'url') {
234 $result['schema'][$fieldName]['civiIsWebsite'] = TRUE;
236 if (in_array($fieldName, array('phone', 'phone_and_ext'))) {
237 // FIXME what about phone_ext?
238 $result['schema'][$fieldName]['civiIsPhone'] = TRUE;
242 // build section list
243 $result['sections']['default'] = array(
245 'is_addable' => FALSE,
248 $customGroup = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity($extends);
249 $customGroup->orderBy('weight');
250 $customGroup->is_active
= 1;
251 $customGroup->find();
252 while ($customGroup->fetch()) {
253 $sectionName = 'cg_' . $customGroup->id
;
255 'title' => ts('%1: %2', array(1 => $title, 2 => $customGroup->title
)),
256 'is_addable' => $customGroup->is_reserved ?
FALSE : TRUE,
257 'custom_group_id' => $customGroup->id
,
258 'extends_entity_column_id' => $customGroup->extends_entity_column_id
,
259 'extends_entity_column_value' => CRM_Utils_Array
::explodePadded($customGroup->extends_entity_column_value
),
260 'is_reserved' => $customGroup->is_reserved ?
TRUE : FALSE,
262 $result['sections'][$sectionName] = $section;
265 // put fields in their sections
266 $fields = CRM_Core_BAO_CustomField
::getFields($extends);
267 foreach ($fields as $fieldId => $field) {
268 $sectionName = 'cg_' . $field['custom_group_id'];
269 $fieldName = 'custom_' . $fieldId;
270 if (isset($result['schema'][$fieldName])) {
271 $result['schema'][$fieldName]['section'] = $sectionName;
272 $result['schema'][$fieldName]['civiIsMultiple'] = (bool) CRM_Core_BAO_CustomField
::isMultiRecordField($fieldId);