Merge pull request #15837 from totten/master-prtmpl
[civicrm-core.git] / CRM / UF / Page / ProfileEditor.php
index 0991bd7894a2f00bee33fdacff4e304ba0b88e5d..9d4e38a7b1bcf58942a4d62e02f02147542c5f3e 100644 (file)
@@ -7,11 +7,20 @@ require_once 'CRM/Core/Page.php';
  * widgets
  */
 class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
-  function run() {
+
+  /**
+   * Run page.
+   *
+   * @throws \Exception
+   */
+  public function run() {
     CRM_Core_Error::fatal('This is not a real page!');
   }
 
-  static function registerProfileScripts() {
+  /**
+   * Register profile scripts.
+   */
+  public static function registerProfileScripts() {
     static $loaded = FALSE;
     if ($loaded || CRM_Core_Resources::isAjaxMode()) {
       return;
@@ -19,21 +28,31 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
     $loaded = TRUE;
 
     CRM_Core_Resources::singleton()
-      ->addSettingsFactory(function(){
-        return array(
-          'PseudoConstant' => array(
+      ->addSettingsFactory(function () {
+        $ufGroups = civicrm_api3('UFGroup', 'get', [
+          'sequential' => 1,
+          'is_active' => 1,
+          'options' => ['limit' => 0],
+        ]);
+        //CRM-16915 - insert 'module' param for the profile used by CiviEvent.
+        if (CRM_Core_Permission::check('manage event profiles') && !CRM_Core_Permission::check('administer CiviCRM')) {
+          foreach ($ufGroups['values'] as $key => $value) {
+            $ufJoin = CRM_Core_BAO_UFGroup::getUFJoinRecord($value['id']);
+            if (in_array('CiviEvent', $ufJoin) || in_array('CiviEvent_Additional', $ufJoin)) {
+              $ufGroups['values'][$key]['module'] = 'CiviEvent';
+            }
+          }
+        }
+        return [
+          'PseudoConstant' => [
             'locationType' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'),
+            'websiteType' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'),
             'phoneType' => CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', 'phone_type_id'),
-          ),
-          'initialProfileList' => civicrm_api('UFGroup', 'get', array(
-            'version' => 3,
-            'sequential' => 1,
-            'is_active' => 1,
-            'rowCount' => 1000, // FIXME
-          )),
+          ],
+          'initialProfileList' => $ufGroups,
           'contactSubTypes' => CRM_Contact_BAO_ContactType::subTypes(),
           'profilePreviewKey' => CRM_Core_Key::get('CRM_UF_Form_Inline_Preview', TRUE),
-        );
+        ];
       })
       ->addScriptFile('civicrm', 'packages/backbone/json2.js', 100, 'html-header', FALSE)
       ->addScriptFile('civicrm', 'packages/backbone/backbone.js', 120, 'html-header')
@@ -43,6 +62,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
       ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/adapters/backbone.bootstrap-modal.min.js', 140, 'html-header', FALSE)
       ->addScriptFile('civicrm', 'packages/backbone-forms/distribution/editors/list.min.js', 140, 'html-header', FALSE)
       ->addStyleFile('civicrm', 'packages/backbone-forms/distribution/templates/default.css', 140, 'html-header')
+      ->addScript('CRM.BB = Backbone.noConflict();', 300, 'html-header')
       ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE)
       ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header')
       ->addStyleFile('civicrm', 'css/crm.designer.css', 140, 'html-header')
@@ -56,31 +76,30 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
       ->addScriptFile('civicrm', 'js/jquery/jquery.crmProfileSelector.js', 250)
       ->addScriptFile('civicrm', 'js/crm.designerapp.js', 250);
 
-    CRM_Core_Region::instance('page-header')->add(array(
+    CRM_Core_Region::instance('page-header')->add([
       'template' => 'CRM/UF/Page/ProfileTemplates.tpl',
-    ));
+    ]);
   }
 
   /**
-   * Register entity schemas for use in the editor's palette
+   * Register entity schemas for use in the editor's palette.
    *
-   * @param array $entityTypes strings, e.g. "IndividualModel", "ActivityModel"
+   * @param array $entityTypes
+   *   Strings, e.g. "IndividualModel", "ActivityModel".
    */
-  static function registerSchemas($entityTypes) {
-    /* CRM_Core_Error::backtrace(); */
-    /*   CRM_Core_Error::debug( '$entityTypes', $entityTypes ); */
+  public static function registerSchemas($entityTypes) {
     // TODO in cases where registerSchemas is called multiple times for same entity, be more efficient
     CRM_Core_Resources::singleton()->addSettingsFactory(function () use ($entityTypes) {
-      return array(
+      return [
         'civiSchema' => CRM_UF_Page_ProfileEditor::getSchema($entityTypes),
-      );
+      ];
     });
   }
 
   /**
-   * AJAX callback
+   * AJAX callback.
    */
-  static function getSchemaJSON() {
+  public static function getSchemaJSON() {
     $entityTypes = explode(',', $_REQUEST['entityTypes']);
     CRM_Utils_JSON::output(self::getSchema($entityTypes));
   }
@@ -88,23 +107,24 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
   /**
    * Get a list of Backbone-Form models
    *
-   * @param array $entityTypes model names ("IndividualModel")
+   * @param array $entityTypes
+   *   Model names ("IndividualModel").
    *
    * @throws CRM_Core_Exception
    * @return array; keys are model names ("IndividualModel") and values describe 'sections' and 'schema'
    * @see js/model/crm.core.js
    * @see js/model/crm.mappedcore.js
    */
-  static function getSchema($entityTypes) {
+  public static function getSchema($entityTypes) {
     // FIXME: Depending on context (eg civicrm/profile/create vs search-columns), it may be appropriate to
     // pick importable or exportable fields
 
     $entityTypes = array_unique($entityTypes);
     $availableFields = NULL;
+    $civiSchema = [];
     foreach ($entityTypes as $entityType) {
       if (!$availableFields) {
         $availableFields = CRM_Core_BAO_UFField::getAvailableFieldsFlat();
-        //dpm($availableFields);
       }
       switch ($entityType) {
         case 'IndividualModel':
@@ -114,6 +134,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'OrganizationModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Organization',
@@ -121,6 +142,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'HouseholdModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Household',
@@ -128,6 +150,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'ActivityModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Activity',
@@ -135,6 +158,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'ContributionModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Contribution',
@@ -142,6 +166,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'MembershipModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Membership',
@@ -149,6 +174,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'ParticipantModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Participant',
@@ -156,6 +182,7 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         case 'CaseModel':
           $civiSchema[$entityType] = self::convertCiviModelToBackboneModel(
             'Case',
@@ -163,11 +190,32 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
             $availableFields
           );
           break;
+
         default:
           throw new CRM_Core_Exception("Unrecognized entity type: $entityType");
       }
     }
 
+    // Adding the oddball "formatting" field here because there's no other place to put it
+    foreach (['Individual', 'Organization', 'Household'] as $type) {
+      if (isset($civiSchema[$type . 'Model'])) {
+        $civiSchema[$type . 'Model']['schema'] += [
+          'formatting' => [
+            'type' => 'Markup',
+            'title' => ts('Free HTML'),
+            'civiFieldType' => 'Formatting',
+            'section' => 'formatting',
+          ],
+        ];
+        $civiSchema[$type . 'Model']['sections'] += [
+          'formatting' => [
+            'title' => ts('Formatting'),
+            'is_addable' => FALSE,
+          ],
+        ];
+      }
+    }
+
     return $civiSchema;
   }
 
@@ -175,20 +223,26 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
    * FIXME: Move to somewhere more useful
    * FIXME: Do real mapping of "types"
    *
-   * @param string $extends entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact"
-   * @param string $title a string to use in section headers
-   * @param array $availableFields list of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type']
-   * @return array with keys 'sections' and 'schema'
+   * @param string $extends
+   *   Entity type; note: "Individual" means "Individual|Contact"; "Household" means "Household|Contact".
+   * @param string $title
+   *   A string to use in section headers.
+   * @param array $availableFields
+   *   List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type'].
+   * @return array
+   *   with keys 'sections' and 'schema'
    * @see js/model/crm.core.js
    * @see js/model/crm.mappedcore.js
    */
-  static function convertCiviModelToBackboneModel($extends, $title, $availableFields) {
+  public static function convertCiviModelToBackboneModel($extends, $title, $availableFields) {
     $locationFields = CRM_Core_BAO_UFGroup::getLocationFields();
 
-    $result = array(
-      'schema' => array(), // array($fieldName => $fieldSchema)
-      'sections' => array(), // array($sectionName => $section)
-    );
+    // schema in format array($fieldName => $fieldSchema)
+    // sections in format array($sectionName => $section)
+    $result = [
+      'schema' => [],
+      'sections' => [],
+    ];
 
     // build field list
     foreach ($availableFields as $fieldName => $field) {
@@ -198,33 +252,40 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
         case 'Household':
           if ($field['field_type'] != $extends && $field['field_type'] != 'Contact'
             //CRM-15595 check if subtype
-            && !in_array($field['field_type'], CRM_Contact_BAO_ContactType::subTypes($extends))) {
+            && !in_array($field['field_type'], CRM_Contact_BAO_ContactType::subTypes($extends))
+          ) {
             continue 2;
           }
           break;
+
         default:
           if ($field['field_type'] != $extends) {
             continue 2;
           }
       }
-      $result['schema'][$fieldName] = array(
-        'type' => 'Text', // FIXME,
+      // FIXME: type set to "Text"
+      $result['schema'][$fieldName] = [
+        'type' => 'Text',
         'title' => $field['title'],
         'civiFieldType' => $field['field_type'],
-      );
+      ];
       if (in_array($fieldName, $locationFields)) {
         $result['schema'][$fieldName]['civiIsLocation'] = TRUE;
       }
-      if (in_array($fieldName, array('phone', 'phone_and_ext'))) { // FIXME what about phone_ext?
+      if ($fieldName == 'url') {
+        $result['schema'][$fieldName]['civiIsWebsite'] = TRUE;
+      }
+      if (in_array($fieldName, ['phone', 'phone_and_ext'])) {
+        // FIXME what about phone_ext?
         $result['schema'][$fieldName]['civiIsPhone'] = TRUE;
       }
     }
 
     // build section list
-    $result['sections']['default'] = array(
+    $result['sections']['default'] = [
       'title' => $title,
       'is_addable' => FALSE,
-    );
+    ];
 
     $customGroup = CRM_Core_BAO_CustomGroup::getAllCustomGroupsByBaseEntity($extends);
     $customGroup->orderBy('weight');
@@ -232,14 +293,14 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
     $customGroup->find();
     while ($customGroup->fetch()) {
       $sectionName = 'cg_' . $customGroup->id;
-      $section = array(
-        'title' => ts('%1: %2', array(1 => $title, 2 => $customGroup->title)),
+      $section = [
+        'title' => ts('%1: %2', [1 => $title, 2 => $customGroup->title]),
         'is_addable' => $customGroup->is_reserved ? FALSE : TRUE,
         'custom_group_id' => $customGroup->id,
         'extends_entity_column_id' => $customGroup->extends_entity_column_id,
         'extends_entity_column_value' => CRM_Utils_Array::explodePadded($customGroup->extends_entity_column_value),
         'is_reserved' => $customGroup->is_reserved ? TRUE : FALSE,
-      );
+      ];
       $result['sections'][$sectionName] = $section;
     }
 
@@ -255,4 +316,5 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page {
     }
     return $result;
   }
+
 }