CRM/Contact/Form/Edit/TagsAndGroups.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Contact_Form_Edit_TagsAndGroups {
  18
  19   /**
  20    * Constant to determine which forms we are generating.
  21    *
  22    * Used by both profile and edit contact
  23    */
  24   const GROUP = 1, TAG = 2, ALL = 3;
  25
  26   /**
  27    * Build form elements.
  28    *
  29    * @param CRM_Core_Form $form
  30    *   The form object that we are operating on.
  31    * @param int $contactId
  32    *   Contact id.
  33    * @param int $type
  34    *   What components are we interested in.
  35    * @param bool $visibility
  36    *   Visibility of the field.
  37    * @param null $isRequired
  38    * @param string $groupName
  39    *   If used for building group block.
  40    * @param string $tagName
  41    *   If used for building tag block.
  42    * @param string $fieldName
  43    *   This is used in batch profile(i.e to build multiple blocks).
  44    *
  45    * @param string $groupElementType
  46    *
  47    */
  48   public static function buildQuickForm(
  49     &$form,
  50     $contactId = 0,
  51     $type = self::ALL,
  52     $visibility = FALSE,
  53     $isRequired = NULL,
  54     $groupName = 'Group(s)',
  55     $tagName = 'Tag(s)',
  56     $fieldName = NULL,
  57     $groupElementType = 'checkbox'
  58   ) {
  59     if (!isset($form->_tagGroup)) {
  60       $form->_tagGroup = [];
  61     }
  62
  63     // NYSS 5670
  64     if (!$contactId && !empty($form->_contactId)) {
  65       $contactId = $form->_contactId;
  66     }
  67
  68     $type = (int) $type;
  69     if ($type & self::GROUP) {
  70
  71       $fName = 'group';
  72       if ($fieldName) {
  73         $fName = $fieldName;
  74       }
  75
  76       $groupID = $form->_grid ?? NULL;
  77       if ($groupID && $visibility) {
  78         $ids = [$groupID => $groupID];
  79       }
  80       else {
  81         if ($visibility) {
  82           $group = CRM_Core_PseudoConstant::allGroup();
  83         }
  84         else {
  85           $group = CRM_Core_PseudoConstant::group();
  86         }
  87         $ids = $group;
  88       }
  89
  90       if ($groupID || !empty($group)) {
  91         $groups = CRM_Contact_BAO_Group::getGroupsHierarchy($ids, NULL, '- ');
  92
  93         $attributes['skiplabel'] = TRUE;
  94         $elements = [];
  95         $groupsOptions = [];
  96         foreach ($groups as $id => $group) {
  97           // make sure that this group has public visibility
  98           if ($visibility &&
  99             $group['visibility'] == 'User and User Admin Only'
 100           ) {
 101             continue;
 102           }
 103
 104           if ($groupElementType == 'select') {
 105             $groupsOptions[$id] = $group;
 106           }
 107           else {
 108             $form->_tagGroup[$fName][$id]['description'] = $group['description'];
 109             $elements[] = &$form->addElement('advcheckbox', $id, NULL, $group['text'], $attributes);
 110           }
 111         }
 112
 113         if ($groupElementType == 'select' && !empty($groupsOptions)) {
 114           $form->add('select2', $fName, $groupName, $groupsOptions, FALSE,
 115             ['placeholder' => '- select -', 'multiple' => TRUE, 'class' => 'twenty']
 116           );
 117           $form->assign('groupCount', count($groupsOptions));
 118         }
 119
 120         if ($groupElementType == 'checkbox' && !empty($elements)) {
 121           $form->addGroup($elements, $fName, $groupName, '&nbsp;<br />');
 122           $form->assign('groupCount', count($elements));
 123           if ($isRequired) {
 124             $form->addRule($fName, ts('%1 is a required field.', [1 => $groupName]), 'required');
 125           }
 126         }
 127         $form->assign('groupElementType', $groupElementType);
 128       }
 129     }
 130
 131     if ($type & self::TAG) {
 132       $tags = CRM_Core_BAO_Tag::getColorTags('civicrm_contact');
 133
 134       if (!empty($tags)) {
 135         $form->add('select2', 'tag', ts('Tag(s)'), $tags, FALSE, ['class' => 'huge', 'placeholder' => ts('- select -'), 'multiple' => TRUE]);
 136       }
 137
 138       // build tag widget
 139       $parentNames = CRM_Core_BAO_Tag::getTagSet('civicrm_contact');
 140       CRM_Core_Form_Tag::buildQuickForm($form, $parentNames, 'civicrm_contact', $contactId, FALSE, TRUE);
 141     }
 142     $form->assign('tagGroup', $form->_tagGroup);
 143   }
 144
 145   /**
 146    * Set defaults for relevant form elements.
 147    *
 148    * @param int $id
 149    *   The contact id.
 150    * @param array $defaults
 151    *   The defaults array to store the values in.
 152    * @param int $type
 153    *   What components are we interested in.
 154    * @param string $fieldName
 155    *   This is used in batch profile(i.e to build multiple blocks).
 156    *
 157    * @param string $groupElementType
 158    */
 159   public static function setDefaults($id, &$defaults, $type = self::ALL, $fieldName = NULL, $groupElementType = 'checkbox') {
 160     $type = (int ) $type;
 161     if ($type & self::GROUP) {
 162       $fName = 'group';
 163       if ($fieldName) {
 164         $fName = $fieldName;
 165       }
 166
 167       $contactGroup = CRM_Contact_BAO_GroupContact::getContactGroup($id, 'Added', NULL, FALSE, TRUE);
 168       if ($contactGroup) {
 169         if ($groupElementType == 'select') {
 170           $defaults[$fName] = implode(',', CRM_Utils_Array::collect('group_id', $contactGroup));
 171         }
 172         else {
 173           foreach ($contactGroup as $group) {
 174             $defaults[$fName . '[' . $group['group_id'] . ']'] = 1;
 175           }
 176         }
 177       }
 178     }
 179
 180     if ($type & self::TAG) {
 181       $defaults['tag'] = implode(',', CRM_Core_BAO_EntityTag::getTag($id, 'civicrm_contact'));
 182     }
 183   }
 184
 185   /**
 186    * Set default values for the form. Note that in edit/view mode
 187    * the default values are retrieved from the database
 188    *
 189    *
 190    * @param CRM_Core_Form $form
 191    * @param array $defaults
 192    */
 193   public static function setDefaultValues(&$form, &$defaults) {
 194     $contactEditOptions = $form->get('contactEditOptions');
 195
 196     if ($form->_action & CRM_Core_Action::ADD) {
 197       if (array_key_exists('TagsAndGroups', $contactEditOptions)) {
 198         // set group and tag defaults if any
 199         if ($form->_gid) {
 200           $defaults['group'][$form->_gid] = 1;
 201         }
 202         if ($form->_tid) {
 203           $defaults['tag'][$form->_tid] = 1;
 204         }
 205       }
 206     }
 207     else {
 208       if (array_key_exists('TagsAndGroups', $contactEditOptions)) {
 209         // set the group and tag ids
 210         $groupElementType = 'checkbox';
 211         if (CRM_Utils_System::getClassName($form) == 'CRM_Contact_Form_Contact') {
 212           $groupElementType = 'select';
 213         }
 214         self::setDefaults($form->_contactId, $defaults, self::ALL, NULL, $groupElementType);
 215       }
 216     }
 217   }
 218
 219 }