CRM/Custom/Form/Group.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * form to process actions on the set aspect of Custom Data
  38  */
  39 class CRM_Custom_Form_Group extends CRM_Core_Form {
  40
  41   /**
  42    * the set id saved to the session for an update
  43    *
  44    * @var int
  45    * @access protected
  46    */
  47   protected $_id;
  48
  49   /**
  50    *  set is empty or not
  51    *
  52    * @var bool
  53    * @access protected
  54    */
  55   protected $_isGroupEmpty = TRUE;
  56
  57   /**
  58    * array of existing subtypes set for a custom set
  59    *
  60    * @var array
  61    * @access protected
  62    */
  63   protected $_subtypes = array();
  64
  65   /**
  66    * array of default params
  67    *
  68    * @var array
  69    * @access protected
  70    */
  71   protected $_defaults = array();
  72
  73   /**
  74    * Function to set variables up before form is built
  75    *
  76    * @param null
  77    *
  78    * @return void
  79    * @access public
  80    */
  81   public function preProcess() {
  82     // current set id
  83     $this->_id = $this->get('id');
  84
  85     if ($this->_id && $isReserved = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $this->_id, 'is_reserved', 'id')) {
  86       CRM_Core_Error::fatal("You cannot edit the settings of a reserved custom field-set.");
  87     }
  88     // setting title for html page
  89     if ($this->_action == CRM_Core_Action::UPDATE) {
  90       $title = CRM_Core_BAO_CustomGroup::getTitle($this->_id);
  91       CRM_Utils_System::setTitle(ts('Edit %1', array(1 => $title)));
  92     }
  93     elseif ($this->_action == CRM_Core_Action::VIEW) {
  94       $title = CRM_Core_BAO_CustomGroup::getTitle($this->_id);
  95       CRM_Utils_System::setTitle(ts('Preview %1', array(1 => $title)));
  96     }
  97     else {
  98       CRM_Utils_System::setTitle(ts('New Custom Field Set'));
  99     }
 100
 101     if (isset($this->_id)) {
 102       $params = array('id' => $this->_id);
 103       CRM_Core_BAO_CustomGroup::retrieve($params, $this->_defaults);
 104
 105       $subExtends = CRM_Utils_Array::value('extends_entity_column_value', $this->_defaults);
 106       if (!empty($subExtends)) {
 107         $this->_subtypes = explode(CRM_Core_DAO::VALUE_SEPARATOR, substr($subExtends, 1, -1));
 108       }
 109     }
 110   }
 111
 112   /**
 113    * global form rule
 114    *
 115    * @param array $fields  the input form values
 116    * @param array $files   the uploaded files if any
 117    * @param array $options additional user data
 118    *
 119    * @return true if no errors, else array of errors
 120    * @access public
 121    * @static
 122    */
 123   static function formRule($fields, $files, $self) {
 124     $errors = array();
 125
 126     //validate group title as well as name.
 127     $title  = $fields['title'];
 128     $name   = CRM_Utils_String::munge($title, '_', 64);
 129     $query  = 'select count(*) from civicrm_custom_group where ( name like %1 OR title like %2 ) and id != %3';
 130     $grpCnt = CRM_Core_DAO::singleValueQuery($query, array(1 => array($name, 'String'),
 131         2 => array($title, 'String'),
 132         3 => array((int)$self->_id, 'Integer'),
 133       ));
 134     if ($grpCnt) {
 135       $errors['title'] = ts('Custom group \'%1\' already exists in Database.', array(1 => $title));
 136     }
 137
 138     if (CRM_Utils_Array::value(1, $fields['extends'])) {
 139       if (in_array('', $fields['extends'][1]) && count($fields['extends'][1]) > 1) {
 140         $errors['extends'] = ts("Cannot combine other option with 'Any'.");
 141       }
 142     }
 143
 144     if (empty($fields['extends'][0])) {
 145       $errors['extends'] = ts("You need to select the type of record that this set of custom fields is applicable for.");
 146     }
 147
 148     $extends = array('Activity', 'Relationship', 'Group', 'Contribution', 'Membership', 'Event', 'Participant');
 149     if (in_array($fields['extends'][0], $extends) && $fields['style'] == 'Tab') {
 150       $errors['style'] = ts("Display Style should be Inline for this Class");
 151       $self->assign('showStyle', TRUE);
 152     }
 153
 154     if (CRM_Utils_Array::value('is_multiple', $fields)) {
 155         $self->assign('showMultiple', TRUE);
 156     }
 157
 158     //checks the given custom set doesnot start with digit
 159     $title = $fields['title'];
 160     if (!empty($title)) {
 161       // gives the ascii value
 162       $asciiValue = ord($title{0});
 163       if ($asciiValue >= 48 && $asciiValue <= 57) {
 164         $errors['title'] = ts("Set's Name should not start with digit");
 165       }
 166     }
 167
 168     return empty($errors) ? TRUE : $errors;
 169   }
 170
 171   /**
 172    * This function is used to add the rules (mainly global rules) for form.
 173    * All local rules are added near the element
 174    *
 175    * @param null
 176    *
 177    * @return void
 178    * @access public
 179    * @see valid_date
 180    */
 181   function addRules() {
 182     $this->addFormRule(array('CRM_Custom_Form_Group', 'formRule'), $this);
 183   }
 184
 185   /**
 186    * Function to actually build the form
 187    *
 188    * @param null
 189    *
 190    * @return void
 191    * @access public
 192    */
 193   public function buildQuickForm() {
 194     $this->applyFilter('__ALL__', 'trim');
 195
 196     $attributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_CustomGroup');
 197
 198     //title
 199     $this->add('text', 'title', ts('Set Name'), $attributes['title'], TRUE);
 200
 201     //Fix for code alignment, CRM-3058
 202     $contactTypes = array('Contact', 'Individual', 'Household', 'Organization');
 203     $this->assign('contactTypes', json_encode($contactTypes));
 204
 205     $sel1         = array("" => "- select -") + CRM_Core_SelectValues::customGroupExtends();
 206     $sel2         = array();
 207     $activityType = CRM_Core_PseudoConstant::activityType(FALSE, TRUE, FALSE, 'label', TRUE);
 208
 209     $eventType       = CRM_Core_OptionGroup::values('event_type');
 210     $grantType       = CRM_Core_OptionGroup::values('grant_type');
 211     $campaignTypes   = CRM_Campaign_PseudoConstant::campaignType();
 212     $membershipType  = CRM_Member_BAO_MembershipType::getMembershipTypes(FALSE);
 213     $participantRole = CRM_Core_OptionGroup::values('participant_role');
 214     $relTypeInd      = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
 215     $relTypeOrg      = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
 216     $relTypeHou      = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Household');
 217
 218     ksort($sel1);
 219     asort($activityType);
 220     asort($eventType);
 221     asort($grantType);
 222     asort($membershipType);
 223     asort($participantRole);
 224     $allRelationshipType = array();
 225     $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
 226     $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
 227
 228     //adding subtype specific relationships CRM-5256
 229     $subTypes = CRM_Contact_BAO_ContactType::subTypeInfo();
 230
 231     foreach ($subTypes as $subType => $val) {
 232       $subTypeRelationshipTypes = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, NULL, NULL, $val['parent'],
 233         FALSE, 'label', TRUE, $subType
 234       );
 235       $allRelationshipType = array_merge($allRelationshipType, $subTypeRelationshipTypes);
 236     }
 237
 238     $sel2['Event'] = $eventType;
 239     $sel2['Grant'] = $grantType;
 240     $sel2['Activity'] = $activityType;
 241     $sel2['Campaign'] = $campaignTypes;
 242     $sel2['Membership'] = $membershipType;
 243     $sel2['ParticipantRole'] = $participantRole;
 244     $sel2['ParticipantEventName'] = CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
 245     $sel2['ParticipantEventType'] = $eventType;
 246         $sel2['Contribution']         = CRM_Contribute_PseudoConstant::financialType( );
 247     $sel2['Relationship'] = $allRelationshipType;
 248
 249     $sel2['Individual'] = CRM_Contact_BAO_ContactType::subTypePairs('Individual', FALSE, NULL);
 250     $sel2['Household'] = CRM_Contact_BAO_ContactType::subTypePairs('Household', FALSE, NULL);
 251     $sel2['Organization'] = CRM_Contact_BAO_ContactType::subTypePairs('Organization', FALSE, NULL);
 252
 253     CRM_Core_BAO_CustomGroup::getExtendedObjectTypes($sel2);
 254
 255     foreach ($sel2 as $main => $sub) {
 256       if (!empty($sel2[$main])) {
 257         if ($main == 'Relationship') {
 258           $relName = self::getFormattedList($sel2[$main]);
 259           $sel2[$main] = array(
 260             '' => ts("- Any -")) + $relName;
 261         }
 262         else {
 263           $sel2[$main] = array(
 264             '' => ts("- Any -")) + $sel2[$main];
 265         }
 266       }
 267     }
 268
 269     $cSubTypes = CRM_Core_Component::contactSubTypes();
 270
 271     if (!empty($cSubTypes)) {
 272       $contactSubTypes = array();
 273       foreach ($cSubTypes as $key => $value) {
 274         $contactSubTypes[$key] = $key;
 275       }
 276       $sel2['Contact'] = array(
 277         "" => "-- Any --") + $contactSubTypes;
 278     }
 279     else {
 280       if (!isset($this->_id)) {
 281         $formName = 'document.forms.' . $this->_name;
 282
 283         $js = "<script type='text/javascript'>\n";
 284         $js .= "{$formName}['extends_1'].style.display = 'none';\n";
 285         $js .= "</script>";
 286         $this->assign('initHideBlocks', $js);
 287       }
 288     }
 289
 290     $sel = &$this->add('hierselect',
 291       'extends',
 292       ts('Used For'),
 293       array(
 294         'name' => 'extends[0]',
 295         'style' => 'vertical-align: top;'
 296       ),
 297       TRUE
 298     );
 299     $sel->setOptions(array($sel1, $sel2));
 300     if (is_a($sel->_elements[1], 'HTML_QuickForm_select')) {
 301       // make second selector a multi-select -
 302       $sel->_elements[1]->setMultiple(TRUE);
 303       $sel->_elements[1]->setSize(5);
 304     }
 305     if ($this->_action == CRM_Core_Action::UPDATE) {
 306       $subName = CRM_Utils_Array::value('extends_entity_column_id', $this->_defaults);
 307       if ($this->_defaults['extends'] == 'Participant') {
 308         if ($subName == 1) {
 309           $this->_defaults['extends'] = 'ParticipantRole';
 310         }
 311         elseif ($subName == 2) {
 312           $this->_defaults['extends'] = 'ParticipantEventName';
 313         }
 314         elseif ($subName == 3) {
 315           $this->_defaults['extends'] = 'ParticipantEventType';
 316         }
 317       }
 318
 319       //allow to edit settings if custom set is empty CRM-5258
 320       $this->_isGroupEmpty = CRM_Core_BAO_CustomGroup::isGroupEmpty($this->_id);
 321       if (!$this->_isGroupEmpty) {
 322         if (!empty($this->_subtypes)) {
 323           // we want to allow adding / updating subtypes for this case,
 324           // and therefore freeze the first selector only.
 325           $sel->_elements[0]->freeze();
 326         }
 327         else {
 328           // freeze both the selectors
 329           $sel->freeze();
 330         }
 331       }
 332       $this->assign('isCustomGroupEmpty', $this->_isGroupEmpty);
 333       $this->assign('gid', $this->_id);
 334     }
 335     $this->assign('defaultSubtypes', json_encode($this->_subtypes));
 336
 337     // help text
 338     $this->addWysiwyg('help_pre', ts('Pre-form Help'), $attributes['help_pre']);
 339     $this->addWysiwyg('help_post', ts('Post-form Help'), $attributes['help_post']);
 340
 341     // weight
 342     $this->add('text', 'weight', ts('Order'), $attributes['weight'], TRUE);
 343     $this->addRule('weight', ts('is a numeric field'), 'numeric');
 344
 345     // display style
 346     $this->add('select', 'style', ts('Display Style'), CRM_Core_SelectValues::customGroupStyle());
 347
 348     // is this set collapsed or expanded ?
 349     $this->addElement('checkbox', 'collapse_display', ts('Collapse this set on initial display'));
 350
 351     // is this set collapsed or expanded ? in advanced search
 352     $this->addElement('checkbox', 'collapse_adv_display', ts('Collapse this set in Advanced Search'));
 353
 354     // is this set active ?
 355     $this->addElement('checkbox', 'is_active', ts('Is this Custom Data Set active?'));
 356
 357     // does this set have multiple record?
 358     $multiple = $this->addElement('checkbox', 'is_multiple',
 359       ts('Does this Custom Field Set allow multiple records?'), NULL);
 360
 361     // $min_multiple = $this->add('text', 'min_multiple', ts('Minimum number of multiple records'), $attributes['min_multiple'] );
 362     // $this->addRule('min_multiple', ts('is a numeric field') , 'numeric');
 363
 364     $max_multiple = $this->add('text', 'max_multiple', ts('Maximum number of multiple records'), $attributes['max_multiple']);
 365     $this->addRule('max_multiple', ts('is a numeric field'), 'numeric');
 366
 367     //allow to edit settings if custom set is empty CRM-5258
 368     $this->assign('isGroupEmpty', $this->_isGroupEmpty);
 369     if (!$this->_isGroupEmpty) {
 370       $multiple->freeze();
 371       //$min_multiple->freeze();
 372       $max_multiple->freeze();
 373     }
 374
 375     $this->assign('showStyle', FALSE);
 376     $this->assign('showMultiple', FALSE);
 377     $buttons = array(
 378       array(
 379         'type' => 'next',
 380         'name' => ts('Save'),
 381         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 382         'isDefault' => TRUE,
 383       ),
 384       array(
 385         'type' => 'cancel',
 386         'name' => ts('Cancel'),
 387       ),
 388     );
 389     if (!$this->_isGroupEmpty && !empty($this->_subtypes)) {
 390       $buttons[0]['js'] = array('onclick' => "return warnDataLoss()");
 391     }
 392     $this->addButtons($buttons);
 393
 394     // views are implemented as frozen form
 395     if ($this->_action & CRM_Core_Action::VIEW) {
 396       $this->freeze();
 397       $this->addElement('button', 'done', ts('Done'), array('onclick' => "location.href='civicrm/admin/custom/group?reset=1&action=browse'"));
 398     }
 399   }
 400
 401   /**
 402    * This function sets the default values for the form. Note that in edit/view mode
 403    * the default values are retrieved from the database
 404    *
 405    * @param null
 406    *
 407    * @return array   array of default values
 408    * @access public
 409    */
 410   function setDefaultValues() {
 411     $defaults = &$this->_defaults;
 412     $this->assign('showMaxMultiple', TRUE);
 413     if ($this->_action == CRM_Core_Action::ADD) {
 414       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_CustomGroup');
 415
 416       $defaults['is_multiple'] = $defaults['min_multiple'] = 0;
 417       $defaults['is_active'] = $defaults['collapse_display'] = 1;
 418       $defaults['style'] = 'Inline';
 419     }
 420     elseif (!CRM_Utils_Array::value('max_multiple', $defaults) && !$this->_isGroupEmpty) {
 421       $this->assign('showMaxMultiple', FALSE);
 422     }
 423
 424     if (isset($defaults['extends'])) {
 425       $extends = $defaults['extends'];
 426       unset($defaults['extends']);
 427
 428       $defaults['extends'][0] = $extends;
 429
 430       if (!empty($this->_subtypes)) {
 431         $defaults['extends'][1] = $this->_subtypes;
 432       }
 433       else {
 434         $defaults['extends'][1] = array(0 => '');
 435       }
 436
 437
 438       $subName = CRM_Utils_Array::value('extends_entity_column_id', $defaults);
 439
 440       if ($extends == 'Relationship' && !empty($this->_subtypes)) {
 441         $relationshipDefaults = array();
 442         foreach ($defaults['extends'][1] as $donCare => $rel_type_id) {
 443           $relationshipDefaults[] = $rel_type_id;
 444         }
 445
 446         $defaults['extends'][1] = $relationshipDefaults;
 447       }
 448     }
 449
 450     return $defaults;
 451   }
 452
 453   /**
 454    * Process the form
 455    *
 456    * @param null
 457    *
 458    * @return void
 459    * @access public
 460    */
 461   public function postProcess() {
 462     // get the submitted form values.
 463     $params = $this->controller->exportValues('Group');
 464     $params['overrideFKConstraint'] = 0;
 465     if ($this->_action & CRM_Core_Action::UPDATE) {
 466       $params['id'] = $this->_id;
 467       if ($this->_defaults['extends'][0] != $params['extends'][0]) {
 468         $params['overrideFKConstraint'] = 1;
 469       }
 470
 471       if (!empty($this->_subtypes)) {
 472         $subtypesToBeRemoved = array_diff($this->_subtypes, array_intersect($this->_subtypes, $params['extends'][1]));
 473         CRM_Contact_BAO_ContactType::deleteCustomRowsOfSubtype($this->_id, $subtypesToBeRemoved);
 474       }
 475     }
 476     elseif ($this->_action & CRM_Core_Action::ADD) {
 477       //new custom set , so lets set the created_id
 478       $session = CRM_Core_Session::singleton();
 479       $params['created_id'] = $session->get('userID');
 480       $params['created_date'] = date('YmdHis');
 481     }
 482
 483     $group = CRM_Core_BAO_CustomGroup::create($params);
 484
 485     // reset the cache
 486     CRM_Core_BAO_Cache::deleteGroup('contact fields');
 487
 488     if ($this->_action & CRM_Core_Action::UPDATE) {
 489       CRM_Core_Session::setStatus(ts('Your custom field set \'%1 \' has been saved.', array(1 => $group->title)), ts('Saved'), 'success');
 490     }
 491     else {
 492       $url = CRM_Utils_System::url('civicrm/admin/custom/group/field/add', 'reset=1&action=add&gid=' . $group->id);
 493       CRM_Core_Session::setStatus(ts("Your custom field set '%1' has been added. You can add custom fields now.",
 494           array(1 => $group->title)
 495         ), ts('Saved'), 'success');
 496       $session = CRM_Core_Session::singleton();
 497       $session->replaceUserContext($url);
 498     }
 499
 500     // prompt Drupal Views users to update $db_prefix in settings.php, if necessary
 501     global $db_prefix;
 502     $config = CRM_Core_Config::singleton();
 503     if (is_array($db_prefix) && $config->userSystem->is_drupal && module_exists('views')) {
 504       // get table_name for each custom group
 505       $tables = array();
 506       $sql    = "SELECT table_name FROM civicrm_custom_group WHERE is_active = 1";
 507       $result = CRM_Core_DAO::executeQuery($sql);
 508       while ($result->fetch()) {
 509         $tables[$result->table_name] = $result->table_name;
 510       }
 511
 512       // find out which tables are missing from the $db_prefix array
 513       $missingTableNames = array_diff_key($tables, $db_prefix);
 514
 515       if (!empty($missingTableNames)) {
 516         CRM_Core_Session::setStatus(ts("To ensure that all of your custom data groups are available to Views, you may need to add the following key(s) to the db_prefix array in your settings.php file: '%1'.",
 517             array(1 => implode(', ', $missingTableNames))
 518           ), ts('Note'), 'info');
 519       }
 520     }
 521   }
 522
 523   /*
 524    * Function to return a formatted list of relationship name.
 525    * @param $list array array of relationship name.
 526    * @static
 527    * return array array of relationship name.
 528    */
 529   static function getFormattedList(&$list) {
 530     $relName = array();
 531
 532     foreach ($list as $k => $v) {
 533       $key = substr($k, 0, strpos($k, '_'));
 534       if (isset($list["{$key}_b_a"])) {
 535         if ($list["{$key}_a_b"] != $list["{$key}_b_a"]) {
 536           $relName["$key"] = $list["{$key}_a_b"] . ' / ' . $list["{$key}_b_a"];
 537         }
 538         unset($list["{$key}_b_a"]);
 539       }
 540       else {
 541         $relName["{$key}"] = $list["{$key}_a_b"];
 542       }
 543     }
 544     return $relName;
 545   }
 546 }
 547