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
{
15 public function run() {
16 CRM_Core_Error
::fatal('This is not a real page!');
20 * Register profile scripts.
22 public static function registerProfileScripts() {
23 static $loaded = FALSE;
24 if ($loaded || CRM_Core_Resources
::isAjaxMode()) {
29 CRM_Core_Resources
::singleton()
30 ->addSettingsFactory(function () {
31 $ufGroups = civicrm_api3('UFGroup', 'get', array(
34 'options' => array('limit' => 0),
36 //CRM-16915 - insert 'module' param for the profile used by CiviEvent.
37 if (CRM_Core_Permission
::check('manage event profiles') && !CRM_Core_Permission
::check('administer CiviCRM')) {
38 foreach ($ufGroups['values'] as $key => $value) {
39 $ufJoin = CRM_Core_BAO_UFGroup
::getUFJoinRecord($value['id']);
40 if (in_array('CiviEvent', $ufJoin) ||
in_array('CiviEvent_Additional', $ufJoin)) {
41 $ufGroups['values'][$key]['module'] = 'CiviEvent';
46 'PseudoConstant' => array(
47 'locationType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id'),
48 'websiteType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id'),
49 'phoneType' => CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', 'phone_type_id'),
51 'initialProfileList' => $ufGroups,
52 'contactSubTypes' => CRM_Contact_BAO_ContactType
::subTypes(),
53 'profilePreviewKey' => CRM_Core_Key
::get('CRM_UF_Form_Inline_Preview', TRUE),
56 ->addScriptFile('civicrm', 'packages/backbone/json2.js', 100, 'html-header', FALSE)
57 ->addScriptFile('civicrm', 'packages/backbone/backbone.js', 120, 'html-header')
58 ->addScriptFile('civicrm', 'packages/backbone/backbone.marionette.js', 125, 'html-header', FALSE)
59 ->addScriptFile('civicrm', 'packages/backbone/backbone.collectionsubset.js', 125, 'html-header', FALSE)
60 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/backbone-forms.js', 130, 'html-header', FALSE)
61 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/adapters/backbone.bootstrap-modal.min.js', 140, 'html-header', FALSE)
62 ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/editors/list.min.js', 140, 'html-header', FALSE)
63 ->addStyleFile('civicrm', 'packages/backbone-forms/distribution/templates/default.css', 140, 'html-header')
64 ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE)
65 ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header')
66 ->addStyleFile('civicrm', 'css/crm.designer.css', 140, 'html-header')
67 ->addScriptFile('civicrm', 'js/crm.backbone.js', 150)
68 ->addScriptFile('civicrm', 'js/model/crm.schema-mapped.js', 200)
69 ->addScriptFile('civicrm', 'js/model/crm.uf.js', 200)
70 ->addScriptFile('civicrm', 'js/model/crm.designer.js', 200)
71 ->addScriptFile('civicrm', 'js/model/crm.profile-selector.js', 200)
72 ->addScriptFile('civicrm', 'js/view/crm.designer.js', 200)
73 ->addScriptFile('civicrm', 'js/view/crm.profile-selector.js', 200)
74 ->addScriptFile('civicrm', 'js/jquery/jquery.crmProfileSelector.js', 250)
75 ->addScriptFile('civicrm', 'js/crm.designerapp.js', 250);
77 CRM_Core_Region
::instance('page-header')->add(array(
78 'template' => 'CRM/UF/Page/ProfileTemplates.tpl',
83 * Register entity schemas for use in the editor's palette.
85 * @param array $entityTypes
86 * Strings, e.g. "IndividualModel", "ActivityModel".
88 public static function registerSchemas($entityTypes) {
89 // TODO in cases where registerSchemas is called multiple times for same entity, be more efficient
90 CRM_Core_Resources
::singleton()->addSettingsFactory(function () use ($entityTypes) {
92 'civiSchema' => CRM_UF_Page_ProfileEditor
::getSchema($entityTypes),
100 public static function getSchemaJSON() {
101 $entityTypes = explode(',', $_REQUEST['entityTypes']);
102 CRM_Utils_JSON
::output(self
::getSchema($entityTypes));
106 * Get a list of Backbone-Form models
108 * @param array $entityTypes
109 * Model names ("IndividualModel").
111 * @throws CRM_Core_Exception
112 * @return array; keys are model names ("IndividualModel") and values describe 'sections' and 'schema'
113 * @see js/model/crm.core.js
114 * @see js/model/crm.mappedcore.js
116 public static function getSchema($entityTypes) {
117 // FIXME: Depending on context (eg civicrm/profile/create vs search-columns), it may be appropriate to
118 // pick importable or exportable fields
120 $entityTypes = array_unique($entityTypes);
121 $availableFields = NULL;
122 $civiSchema = array();
123 foreach ($entityTypes as $entityType) {
124 if (!$availableFields) {
125 $availableFields = CRM_Core_BAO_UFField
::getAvailableFieldsFlat();
127 switch ($entityType) {
128 case 'IndividualModel':
129 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
136 case 'OrganizationModel':
137 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
144 case 'HouseholdModel':
145 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
152 case 'ActivityModel':
153 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
160 case 'ContributionModel':
161 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
168 case 'MembershipModel':
169 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
176 case 'ParticipantModel':
177 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
185 $civiSchema[$entityType] = self
::convertCiviModelToBackboneModel(
193 throw new CRM_Core_Exception("Unrecognized entity type: $entityType");
197 // Adding the oddball "formatting" field here because there's no other place to put it
198 foreach (array('Individual', 'Organization', 'Household') as $type) {
199 if (isset($civiSchema[$type . 'Model'])) {
200 $civiSchema[$type . 'Model']['schema'] +
= array(
201 'formatting' => array(
203 'title' => ts('Free HTML'),
204 'civiFieldType' => 'Formatting',
205 'section' => 'formatting',
208 $civiSchema[$type . 'Model']['sections'] +
= array(
209 'formatting' => array(
210 'title' => ts('Formatting'),
211 'is_addable' => FALSE,
221 * FIXME: Move to somewhere more useful
222 * FIXME: Do real mapping of "types"
224 * @param string $extends
225 * Entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact".
226 * @param string $title
227 * A string to use in section headers.
228 * @param array $availableFields
229 * List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type'].
231 * with keys 'sections' and 'schema'
232 * @see js/model/crm.core.js
233 * @see js/model/crm.mappedcore.js
235 public static function convertCiviModelToBackboneModel($extends, $title, $availableFields) {
236 $locationFields = CRM_Core_BAO_UFGroup
::getLocationFields();
238 // schema in format array($fieldName => $fieldSchema)
239 // sections in format array($sectionName => $section)
242 'sections' => array(),
246 foreach ($availableFields as $fieldName => $field) {
251 if ($field['field_type'] != $extends && $field['field_type'] != 'Contact'
252 //CRM-15595 check if subtype
253 && !in_array($field['field_type'], CRM_Contact_BAO_ContactType
::subTypes($extends))
260 if ($field['field_type'] != $extends) {
264 // FIXME: type set to "Text"
265 $result['schema'][$fieldName] = array(
267 'title' => $field['title'],
268 'civiFieldType' => $field['field_type'],
270 if (in_array($fieldName, $locationFields)) {
271 $result['schema'][$fieldName]['civiIsLocation'] = TRUE;
273 if ($fieldName == 'url') {
274 $result['schema'][$fieldName]['civiIsWebsite'] = TRUE;
276 if (in_array($fieldName, array('phone', 'phone_and_ext'))) {
277 // FIXME what about phone_ext?
278 $result['schema'][$fieldName]['civiIsPhone'] = TRUE;
282 // build section list
283 $result['sections']['default'] = array(
285 'is_addable' => FALSE,
288 $customGroup = CRM_Core_BAO_CustomGroup
::getAllCustomGroupsByBaseEntity($extends);
289 $customGroup->orderBy('weight');
290 $customGroup->is_active
= 1;
291 $customGroup->find();
292 while ($customGroup->fetch()) {
293 $sectionName = 'cg_' . $customGroup->id
;
295 'title' => ts('%1: %2', array(1 => $title, 2 => $customGroup->title
)),
296 'is_addable' => $customGroup->is_reserved ?
FALSE : TRUE,
297 'custom_group_id' => $customGroup->id
,
298 'extends_entity_column_id' => $customGroup->extends_entity_column_id
,
299 'extends_entity_column_value' => CRM_Utils_Array
::explodePadded($customGroup->extends_entity_column_value
),
300 'is_reserved' => $customGroup->is_reserved ?
TRUE : FALSE,
302 $result['sections'][$sectionName] = $section;
305 // put fields in their sections
306 $fields = CRM_Core_BAO_CustomField
::getFields($extends);
307 foreach ($fields as $fieldId => $field) {
308 $sectionName = 'cg_' . $field['custom_group_id'];
309 $fieldName = 'custom_' . $fieldId;
310 if (isset($result['schema'][$fieldName])) {
311 $result['schema'][$fieldName]['section'] = $sectionName;
312 $result['schema'][$fieldName]['civiIsMultiple'] = (bool) CRM_Core_BAO_CustomField
::isMultiRecordField($fieldId);