3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
35 * This class generates form components for Activity.
37 class CRM_Activity_Form_Activity
extends CRM_Contact_Form_Task
{
40 * The id of the object being edited / created
47 * Store activity ids when multiple activities are created.
51 public $_activityIds = array();
54 * The id of activity type.
58 public $_activityTypeId;
61 * The name of activity type.
65 public $_activityTypeName;
68 * The id of currently viewed contact.
72 public $_currentlyViewedContactId;
75 * The id of source contact and target contact.
79 protected $_sourceContactId;
80 protected $_targetContactId;
81 protected $_asigneeContactId;
88 public $_activityTypeFile;
91 * The id of the logged in user, used when add / edit
95 public $_currentUserId;
98 * The array of form field attributes.
105 * The the directory inside CRM, to include activity type file from
109 protected $_crmDir = 'Activity';
116 protected $_isSurveyActivity;
118 protected $_values = array();
120 protected $unsavedWarn = TRUE;
123 * Explicitly declare the entity api name.
127 public function getDefaultEntity() {
132 * The _fields var can be used by sub class to set/unset/edit the
133 * form fields based on their requirement
135 public function setFields() {
136 // Remove print document activity type
137 $unwanted = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, "AND v.name = 'Print PDF Letter'");
138 $activityTypes = array_diff_key(CRM_Core_PseudoConstant
::ActivityType(FALSE), $unwanted);
140 $this->_fields
= array(
143 'label' => ts('Subject'),
144 'attributes' => CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity',
150 'label' => ts('Duration'),
151 'attributes' => array('size' => 4, 'maxlength' => 8),
156 'label' => ts('Location'),
157 'attributes' => CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity', 'location'),
162 'label' => ts('Details'),
163 'attributes' => array('class' => 'huge'),
166 'status_id' => array(
170 'priority_id' => array(
174 'source_contact_id' => array(
175 'type' => 'entityRef',
176 'label' => ts('Added By'),
179 'target_contact_id' => array(
180 'type' => 'entityRef',
181 'label' => ts('With Contact'),
182 'attributes' => array('multiple' => TRUE, 'create' => TRUE),
184 'assignee_contact_id' => array(
185 'type' => 'entityRef',
186 'label' => ts('Assigned to'),
187 'attributes' => array(
190 'api' => array('params' => array('is_deceased' => 0)),
193 'followup_assignee_contact_id' => array(
194 'type' => 'entityRef',
195 'label' => ts('Assigned to'),
196 'attributes' => array(
199 'api' => array('params' => array('is_deceased' => 0)),
202 'followup_activity_type_id' => array(
204 'label' => ts('Followup Activity'),
205 'attributes' => array('' => '- ' . ts('select activity') . ' -') +
$activityTypes,
206 'extra' => array('class' => 'crm-select2'),
208 // Add optional 'Subject' field for the Follow-up Activiity, CRM-4491
209 'followup_activity_subject' => array(
211 'label' => ts('Subject'),
212 'attributes' => CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity',
220 * Build the form object.
222 public function preProcess() {
223 CRM_Core_Form_RecurringEntity
::preProcess('civicrm_activity');
224 $this->_atypefile
= CRM_Utils_Array
::value('atypefile', $_GET);
225 $this->assign('atypefile', FALSE);
226 if ($this->_atypefile
) {
227 $this->assign('atypefile', TRUE);
230 $session = CRM_Core_Session
::singleton();
231 $this->_currentUserId
= CRM_Core_Session
::getLoggedInContactID();
233 $this->_currentlyViewedContactId
= $this->get('contactId');
234 if (!$this->_currentlyViewedContactId
) {
235 $this->_currentlyViewedContactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
237 $this->assign('contactId', $this->_currentlyViewedContactId
);
240 if (!isset($this->_context
)) {
241 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
242 if (CRM_Contact_Form_Search
::isSearchContext($this->_context
)) {
243 $this->_context
= 'search';
245 elseif (!in_array($this->_context
, array('dashlet', 'dashletFullscreen'))
246 && $this->_currentlyViewedContactId
248 $this->_context
= 'activity';
250 $this->_compContext
= CRM_Utils_Request
::retrieve('compContext', 'String', $this);
253 $this->assign('context', $this->_context
);
255 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this);
257 if ($this->_action
& CRM_Core_Action
::DELETE
) {
258 if (!CRM_Core_Permission
::check('delete activities')) {
259 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
264 // When we come from contact search, activity id never comes.
265 // So don't try to get from object, it might gives you wrong one.
267 // if we're not adding new one, there must be an id to
268 // an activity we're trying to work on.
269 if ($this->_action
!= CRM_Core_Action
::ADD
&&
270 get_class($this->controller
) != 'CRM_Contact_Controller_Search'
272 $this->_activityId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
275 $this->_activityTypeId
= CRM_Utils_Request
::retrieve('atype', 'Positive', $this);
276 $this->assign('atype', $this->_activityTypeId
);
278 $this->assign('activityId', $this->_activityId
);
280 // Check for required permissions, CRM-6264.
281 if ($this->_activityId
&&
282 in_array($this->_action
, array(
283 CRM_Core_Action
::UPDATE
,
284 CRM_Core_Action
::VIEW
,
286 !CRM_Activity_BAO_Activity
::checkPermission($this->_activityId
, $this->_action
)
288 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
290 if (($this->_action
& CRM_Core_Action
::VIEW
) &&
291 CRM_Activity_BAO_Activity
::checkPermission($this->_activityId
, CRM_Core_Action
::UPDATE
)
293 $this->assign('permission', 'edit');
296 if (!$this->_activityTypeId
&& $this->_activityId
) {
297 $this->_activityTypeId
= CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
303 // Assigning Activity type name.
304 if ($this->_activityTypeId
) {
305 $activityTName = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, 'AND v.value = ' . $this->_activityTypeId
, 'label');
306 if ($activityTName[$this->_activityTypeId
]) {
307 $this->_activityTypeName
= $activityTName[$this->_activityTypeId
];
308 $this->assign('activityTName', $activityTName[$this->_activityTypeId
]);
313 if (isset($activityTName)) {
314 $activityName = CRM_Utils_Array
::value($this->_activityTypeId
, $activityTName);
315 $this->assign('pageTitle', ts('%1 Activity', array(1 => $activityName)));
317 if ($this->_currentlyViewedContactId
) {
318 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_currentlyViewedContactId
);
319 // Check if this is default domain contact CRM-10482.
320 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_currentlyViewedContactId
)) {
321 $displayName .= ' (' . ts('default organization') . ')';
323 CRM_Utils_System
::setTitle($displayName . ' - ' . $activityName);
326 CRM_Utils_System
::setTitle(ts('%1 Activity', array(1 => $activityName)));
330 // Check the mode when this form is called either single or as
331 // search task action.
332 if ($this->_activityTypeId ||
333 $this->_context
== 'standalone' ||
334 $this->_currentlyViewedContactId
336 $this->_single
= TRUE;
337 $this->assign('urlPath', 'civicrm/activity');
340 // Set the appropriate action.
341 $url = CRM_Utils_System
::currentPath();
342 $urlArray = explode('/', $url);
343 $searchPath = array_pop($urlArray);
344 $searchType = 'basic';
345 $this->_action
= CRM_Core_Action
::BASIC
;
346 switch ($searchPath) {
348 $searchType = $searchPath;
349 $this->_action
= CRM_Core_Action
::BASIC
;
353 $searchType = $searchPath;
354 $this->_action
= CRM_Core_Action
::ADVANCED
;
358 $searchType = $searchPath;
359 $this->_action
= CRM_Core_Action
::PROFILE
;
363 $this->_action
= CRM_Core_Action
::COPY
;
364 $searchType = $searchPath;
368 parent
::preProcess();
369 $this->_single
= FALSE;
371 $this->assign('urlPath', "civicrm/contact/search/$searchType");
372 $this->assign('urlPathVar', "_qf_Activity_display=true&qfKey={$this->controller->_key}");
375 $this->assign('single', $this->_single
);
376 $this->assign('action', $this->_action
);
378 if ($this->_action
& CRM_Core_Action
::VIEW
) {
379 // Get the tree of custom fields.
380 $this->_groupTree
= CRM_Core_BAO_CustomGroup
::getTree('Activity', $this,
381 $this->_activityId
, 0, $this->_activityTypeId
385 if ($this->_activityTypeId
) {
386 // Set activity type name and description to template.
387 list($this->_activityTypeName
, $activityTypeDescription) = CRM_Core_BAO_OptionValue
::getActivityTypeDetails($this->_activityTypeId
);
388 $this->assign('activityTypeName', $this->_activityTypeName
);
389 $this->assign('activityTypeDescription', $activityTypeDescription);
393 $urlParams = $urlString = NULL;
394 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
396 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $this);
399 // Validate the qfKey.
400 if (!CRM_Utils_Rule
::qfKey($qfKey)) {
404 if ($this->_context
== 'fulltext') {
406 $urlParams = 'force=1';
407 $urlString = 'civicrm/contact/search/custom';
408 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
410 $urlParams .= '&context=fulltext&action=view';
411 $urlString = 'civicrm/contact/view/activity';
414 $urlParams .= "$keyName=$qfKey";
416 $this->assign('searchKey', $qfKey);
418 elseif (in_array($this->_context
, array(
425 $urlParams = 'reset=1';
426 $urlString = 'civicrm/dashboard';
428 elseif ($this->_context
== 'search') {
429 $urlParams = 'force=1';
431 $urlParams .= "&qfKey=$qfKey";
433 $path = CRM_Utils_System
::currentPath();
434 if ($this->_compContext
== 'advanced') {
435 $urlString = 'civicrm/contact/search/advanced';
437 elseif ($path == 'civicrm/group/search'
438 ||
$path == 'civicrm/contact/search'
439 ||
$path == 'civicrm/contact/search/advanced'
440 ||
$path == 'civicrm/contact/search/custom'
441 ||
$path == 'civicrm/group/search'
446 $urlString = 'civicrm/activity/search';
448 $this->assign('searchKey', $qfKey);
450 elseif ($this->_context
!= 'caseActivity') {
451 $urlParams = "action=browse&reset=1&cid={$this->_currentlyViewedContactId}&selectedChild=activity";
452 $urlString = 'civicrm/contact/view';
456 $session->pushUserContext(CRM_Utils_System
::url($urlString, $urlParams));
459 // hack to retrieve activity type id from post variables
460 if (!$this->_activityTypeId
) {
461 $this->_activityTypeId
= CRM_Utils_Array
::value('activity_type_id', $_POST);
464 // when custom data is included in this page
465 if (!empty($_POST['hidden_custom'])) {
466 // We need to set it in the session for the code below to work.
468 // Need to assign custom data subtype to the template.
469 $this->set('type', 'Activity');
470 $this->set('subType', $this->_activityTypeId
);
471 $this->set('entityId', $this->_activityId
);
472 CRM_Custom_Form_CustomData
::preProcess($this, NULL, $this->_activityTypeId
, 1, 'Activity', $this->_activityId
);
473 CRM_Custom_Form_CustomData
::buildQuickForm($this);
474 CRM_Custom_Form_CustomData
::setDefaultValues($this);
477 // add attachments part
478 CRM_Core_BAO_File
::buildAttachment($this, 'civicrm_activity', $this->_activityId
, NULL, TRUE);
480 // figure out the file name for activity type, if any
481 if ($this->_activityTypeId
&&
482 $this->_activityTypeFile
= CRM_Activity_BAO_Activity
::getFileForActivityTypeId($this->_activityTypeId
, $this->_crmDir
)
484 $this->assign('activityTypeFile', $this->_activityTypeFile
);
485 $this->assign('crmDir', $this->_crmDir
);
490 if ($this->_activityTypeFile
) {
491 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
492 $className::preProcess($this);
495 $this->_values
= $this->get('values');
496 if (!is_array($this->_values
)) {
497 $this->_values
= array();
498 if (isset($this->_activityId
) && $this->_activityId
) {
499 $params = array('id' => $this->_activityId
);
500 CRM_Activity_BAO_Activity
::retrieve($params, $this->_values
);
502 $this->set('values', $this->_values
);
505 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
506 CRM_Core_Form_RecurringEntity
::preProcess('civicrm_activity');
511 * Set default values for the form.
513 * For edit/view mode the default values are retrieved from the database.
517 public function setDefaultValues() {
519 $defaults = $this->_values + CRM_Core_Form_RecurringEntity
::setDefaultValues();
520 // if we're editing...
521 if (isset($this->_activityId
)) {
522 if (empty($defaults['activity_date_time'])) {
523 list($defaults['activity_date_time'], $defaults['activity_date_time_time']) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
525 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
526 $this->assign('current_activity_date_time', $defaults['activity_date_time']);
527 list($defaults['activity_date_time'],
528 $defaults['activity_date_time_time']
529 ) = CRM_Utils_Date
::setDateDefaults($defaults['activity_date_time'], 'activityDateTime');
530 list($defaults['repetition_start_date'], $defaults['repetition_start_date_time']) = CRM_Utils_Date
::setDateDefaults($defaults['activity_date_time'], 'activityDateTime');
533 if ($this->_context
!= 'standalone') {
534 $this->assign('target_contact_value',
535 CRM_Utils_Array
::value('target_contact_value', $defaults)
537 $this->assign('assignee_contact_value',
538 CRM_Utils_Array
::value('assignee_contact_value', $defaults)
542 // Fixme: why are we getting the wrong keys from upstream?
543 $defaults['target_contact_id'] = CRM_Utils_Array
::value('target_contact', $defaults);
544 $defaults['assignee_contact_id'] = CRM_Utils_Array
::value('assignee_contact', $defaults);
546 // set default tags if exists
547 $defaults['tag'] = implode(',', CRM_Core_BAO_EntityTag
::getTag($this->_activityId
, 'civicrm_activity'));
550 // if it's a new activity, we need to set default values for associated contact fields
551 $this->_sourceContactId
= $this->_currentUserId
;
552 $this->_targetContactId
= $this->_currentlyViewedContactId
;
554 $defaults['source_contact_id'] = $this->_sourceContactId
;
555 $defaults['target_contact_id'] = $this->_targetContactId
;
557 list($defaults['activity_date_time'], $defaults['activity_date_time_time'])
558 = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
561 if ($this->_activityTypeId
) {
562 $defaults['activity_type_id'] = $this->_activityTypeId
;
565 if (!$this->_single
&& !empty($this->_contactIds
)) {
566 $defaults['target_contact_id'] = $this->_contactIds
;
569 // CRM-15472 - 50 is around the practical limit of how many items a select2 entityRef can handle
570 if (!empty($defaults['target_contact_id'])) {
571 $count = count(is_array($defaults['target_contact_id']) ?
$defaults['target_contact_id'] : explode(',', $defaults['target_contact_id']));
573 $this->freeze(array('target_contact_id'));
577 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::RENEW
)) {
578 $this->assign('delName', CRM_Utils_Array
::value('subject', $defaults));
581 if ($this->_activityTypeFile
) {
582 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
583 $defaults +
= $className::setDefaultValues($this);
585 if (empty($defaults['priority_id'])) {
586 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
587 $defaults['priority_id'] = array_search('Normal', $priority);
589 if (empty($defaults['status_id'])) {
590 $defaults['status_id'] = CRM_Core_OptionGroup
::getDefaultValue('activity_status');
595 public function buildQuickForm() {
596 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::RENEW
)) {
597 //enable form element (ActivityLinks sets this true)
598 $this->assign('suppressForm', FALSE);
600 $button = ts('Delete');
601 if ($this->_action
& CRM_Core_Action
::RENEW
) {
602 $button = ts('Restore');
604 $this->addButtons(array(
608 'spacing' => ' ',
613 'name' => ts('Cancel'),
619 // Build other activity links.
620 CRM_Activity_Form_ActivityLinks
::commonBuildQuickForm($this);
622 // Enable form element (ActivityLinks sets this true).
623 $this->assign('suppressForm', FALSE);
625 $element = &$this->add('select', 'activity_type_id', ts('Activity Type'),
626 array('' => '- ' . ts('select') . ' -') +
$this->_fields
['followup_activity_type_id']['attributes'],
628 'onchange' => "CRM.buildCustomData( 'Activity', this.value );",
629 'class' => 'crm-select2 required',
633 // Freeze for update mode.
634 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
638 // Call to RecurringEntity buildQuickForm for add/update mode.
639 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
640 CRM_Core_Form_RecurringEntity
::buildQuickForm($this);
643 foreach ($this->_fields
as $field => $values) {
644 if (!empty($this->_fields
[$field])) {
645 $attribute = CRM_Utils_Array
::value('attributes', $values);
646 $required = !empty($values['required']);
648 if ($values['type'] == 'select' && empty($attribute)) {
649 $this->addSelect($field, array('entity' => 'activity'), $required);
651 elseif ($values['type'] == 'entityRef') {
652 $this->addEntityRef($field, $values['label'], $attribute, $required);
655 $this->add($values['type'], $field, $values['label'], $attribute, $required, CRM_Utils_Array
::value('extra', $values));
660 // CRM-7362 --add campaigns.
661 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
663 // Add engagement level CRM-7775
664 $buildEngagementLevel = FALSE;
665 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable() &&
666 CRM_Campaign_BAO_Campaign
::accessCampaign()
668 $buildEngagementLevel = TRUE;
669 $this->addSelect('engagement_level', array('entity' => 'activity'));
670 $this->addRule('engagement_level',
671 ts('Please enter the engagement index as a number (integers only).'),
675 $this->assign('buildEngagementLevel', $buildEngagementLevel);
677 // check for survey activity
678 $this->_isSurveyActivity
= FALSE;
680 if ($this->_activityId
&& CRM_Campaign_BAO_Campaign
::isCampaignEnable() &&
681 CRM_Campaign_BAO_Campaign
::accessCampaign()
684 $this->_isSurveyActivity
= CRM_Campaign_BAO_Survey
::isSurveyActivity($this->_activityId
);
685 if ($this->_isSurveyActivity
) {
686 $surveyId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
690 $responseOptions = CRM_Campaign_BAO_Survey
::getResponsesOptions($surveyId);
691 if ($responseOptions) {
692 $this->add('select', 'result', ts('Result'),
693 array('' => ts('- select -')) +
array_combine($responseOptions, $responseOptions)
698 $surveyTitle = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $surveyId, 'title');
700 $this->assign('surveyTitle', $surveyTitle);
703 $this->assign('surveyActivity', $this->_isSurveyActivity
);
705 // this option should be available only during add mode
706 if ($this->_action
!= CRM_Core_Action
::UPDATE
) {
707 $this->add('advcheckbox', 'is_multi_activity', ts('Create a separate activity for each contact.'));
710 $this->addRule('duration',
711 ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger'
713 $this->addDateTime('activity_date_time', ts('Date'), TRUE, array('formatType' => 'activityDateTime'));
715 // Add followup date.
716 $this->addDateTime('followup_date', ts('in'), FALSE, array('formatType' => 'activityDateTime'));
718 // Only admins and case-workers can change the activity source
719 if (!CRM_Core_Permission
::check('administer CiviCRM') && $this->_context
!= 'caseActivity') {
720 $this->getElement('source_contact_id')->freeze();
723 //need to assign custom data type and subtype to the template
724 $this->assign('customDataType', 'Activity');
725 $this->assign('customDataSubType', $this->_activityTypeId
);
726 $this->assign('entityID', $this->_activityId
);
728 $tags = CRM_Core_BAO_Tag
::getColorTags('civicrm_activity');
731 $this->add('select2', 'tag', ts('Tags'), $tags, FALSE, array('class' => 'huge', 'placeholder' => ts('- select -'), 'multiple' => TRUE));
734 // we need to hide activity tagset for special activities
735 $specialActivities = array('Open Case');
737 if (!in_array($this->_activityTypeName
, $specialActivities)) {
739 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_activity');
740 CRM_Core_Form_Tag
::buildQuickForm($this, $parentNames, 'civicrm_activity', $this->_activityId
);
743 // if we're viewing, we're assigning different buttons than for adding/editing
744 if ($this->_action
& CRM_Core_Action
::VIEW
) {
745 if (isset($this->_groupTree
)) {
746 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $this->_groupTree
, FALSE, NULL, NULL, NULL, $this->_activityId
);
748 // form should be frozen for view mode
754 'name' => ts('Done'),
756 $this->addButtons($buttons);
760 'completed' => ts('Are you sure? This is a COMPLETED activity with the DATE in the FUTURE. Click Cancel to change the date / status. Otherwise, click OK to save.'),
761 'scheduled' => ts('Are you sure? This is a SCHEDULED activity with the DATE in the PAST. Click Cancel to change the date / status. Otherwise, click OK to save.'),
763 $js = array('onclick' => "return activityStatus(" . json_encode($message) . ");");
764 $this->addButtons(array(
767 'name' => ts('Save'),
773 'name' => ts('Cancel'),
778 if ($this->_activityTypeFile
) {
779 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
781 $className::buildQuickForm($this);
782 $this->addFormRule(array($className, 'formRule'), $this);
785 $this->addFormRule(array('CRM_Activity_Form_Activity', 'formRule'), $this);
787 if (Civi
::settings()->get('activity_assignee_notification')) {
788 $this->assign('activityAssigneeNotification', TRUE);
791 $this->assign('activityAssigneeNotification', FALSE);
798 * @param array $fields
799 * The input form values.
800 * @param array $files
801 * The uploaded files if any.
805 * true if no errors, else array of errors
807 public static function formRule($fields, $files, $self) {
808 // skip form rule if deleting
809 if (CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Delete') {
813 if ((array_key_exists('activity_type_id', $fields) ||
!$self->_single
) && empty($fields['activity_type_id'])) {
814 $errors['activity_type_id'] = ts('Activity Type is a required field');
817 if (CRM_Utils_Array
::value('activity_type_id', $fields) == 3 &&
818 CRM_Utils_Array
::value('status_id', $fields) == 1
820 $errors['status_id'] = ts('You cannot record scheduled email activity.');
822 elseif (CRM_Utils_Array
::value('activity_type_id', $fields) == 4 &&
823 CRM_Utils_Array
::value('status_id', $fields) == 1
825 $errors['status_id'] = ts('You cannot record scheduled SMS activity.');
828 if (!empty($fields['followup_activity_type_id']) && empty($fields['followup_date'])) {
829 $errors['followup_date_time'] = ts('Followup date is a required field.');
831 // Activity type is mandatory if subject or follow-up date is specified for an Follow-up activity, CRM-4515.
832 if ((!empty($fields['followup_activity_subject']) ||
!empty($fields['followup_date'])) && empty($fields['followup_activity_type_id'])) {
833 $errors['followup_activity_subject'] = ts('Follow-up Activity type is a required field.');
839 * Process the form submission.
842 * @param array $params
845 public function postProcess($params = NULL) {
846 if ($this->_action
& CRM_Core_Action
::DELETE
) {
847 $deleteParams = array('id' => $this->_activityId
);
848 $moveToTrash = CRM_Case_BAO_Case
::isCaseActivity($this->_activityId
);
849 CRM_Activity_BAO_Activity
::deleteActivity($deleteParams, $moveToTrash);
851 // delete tags for the entity
853 'entity_table' => 'civicrm_activity',
854 'entity_id' => $this->_activityId
,
857 CRM_Core_BAO_EntityTag
::del($tagParams);
859 CRM_Core_Session
::setStatus(ts("Selected Activity has been deleted successfully."), ts('Record Deleted'), 'success');
863 // store the submitted values in an array
865 $params = $this->controller
->exportValues($this->_name
);
868 // Set activity type id.
869 if (empty($params['activity_type_id'])) {
870 $params['activity_type_id'] = $this->_activityTypeId
;
873 if (!empty($params['hidden_custom']) &&
874 !isset($params['custom'])
876 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
877 $this->_activityTypeId
879 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
880 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
884 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
890 // store the date with proper format
891 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
893 // format params as arrays
894 foreach (array('target', 'assignee', 'followup_assignee') as $name) {
895 if (!empty($params["{$name}_contact_id"])) {
896 $params["{$name}_contact_id"] = explode(',', $params["{$name}_contact_id"]);
899 $params["{$name}_contact_id"] = array();
903 // get ids for associated contacts
904 if (!$params['source_contact_id']) {
905 $params['source_contact_id'] = $this->_currentUserId
;
908 if (isset($this->_activityId
)) {
909 $params['id'] = $this->_activityId
;
912 // add attachments as needed
913 CRM_Core_BAO_File
::formatAttachment($params,
920 if (!empty($params['is_multi_activity']) &&
921 !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])
923 $targetContacts = $params['target_contact_id'];
924 foreach ($targetContacts as $targetContactId) {
925 $params['target_contact_id'] = array($targetContactId);
927 $activity[] = $this->processActivity($params);
932 $activity = $this->processActivity($params);
935 $activityIds = empty($this->_activityIds
) ?
array($this->_activityId
) : $this->_activityIds
;
936 foreach ($activityIds as $activityId) {
937 // set params for repeat configuration in create mode
938 $params['entity_id'] = $activityId;
939 $params['entity_table'] = 'civicrm_activity';
940 if (!empty($params['entity_id']) && !empty($params['entity_table'])) {
941 $checkParentExistsForThisId = CRM_Core_BAO_RecurringEntity
::getParentFor($params['entity_id'], $params['entity_table']);
942 if ($checkParentExistsForThisId) {
943 $params['parent_entity_id'] = $checkParentExistsForThisId;
944 $scheduleReminderDetails = CRM_Core_BAO_RecurringEntity
::getReminderDetailsByEntityId($checkParentExistsForThisId, $params['entity_table']);
947 $params['parent_entity_id'] = $params['entity_id'];
948 $scheduleReminderDetails = CRM_Core_BAO_RecurringEntity
::getReminderDetailsByEntityId($params['entity_id'], $params['entity_table']);
950 if (property_exists($scheduleReminderDetails, 'id')) {
951 $params['schedule_reminder_id'] = $scheduleReminderDetails->id
;
954 $params['dateColumns'] = array('activity_date_time');
956 // Set default repetition start if it was not provided.
957 if (empty($params['repetition_start_date'])) {
958 $params['repetition_start_date'] = $params['activity_date_time'];
962 unset($params['id']);
963 $linkedEntities = array(
965 'table' => 'civicrm_activity_contact',
966 'findCriteria' => array(
967 'activity_id' => $activityId,
969 'linkedColumns' => array('activity_id'),
970 'isRecurringEntityRecord' => FALSE,
973 CRM_Core_Form_RecurringEntity
::postProcess($params, 'civicrm_activity', $linkedEntities);
976 return array('activity' => $activity);
980 * Process activity creation.
982 * @param array $params
983 * Associated array of submitted values.
985 * @return self|null|object
987 protected function processActivity(&$params) {
988 $activityAssigned = array();
989 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
990 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
991 // format assignee params
992 if (!CRM_Utils_Array
::crmIsEmptyArray($params['assignee_contact_id'])) {
993 //skip those assignee contacts which are already assigned
994 //while sending a copy.CRM-4509.
995 $activityAssigned = array_flip($params['assignee_contact_id']);
996 if ($this->_activityId
) {
997 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::getNames($this->_activityId
, $assigneeID);
998 $activityAssigned = array_diff_key($activityAssigned, $assigneeContacts);
1002 // call begin post process. Idea is to let injecting file do
1003 // any processing before the activity is added/updated.
1004 $this->beginPostProcess($params);
1006 $activity = CRM_Activity_BAO_Activity
::create($params);
1008 // add tags if exists
1009 $tagParams = array();
1010 if (!empty($params['tag'])) {
1011 if (!is_array($params['tag'])) {
1012 $params['tag'] = explode(',', $params['tag']);
1014 foreach ($params['tag'] as $tag) {
1015 $tagParams[$tag] = 1;
1019 // Save static tags.
1020 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_activity', $activity->id
);
1023 if (isset($params['activity_taglist']) && !empty($params['activity_taglist'])) {
1024 CRM_Core_Form_Tag
::postProcess($params['activity_taglist'], $activity->id
, 'civicrm_activity', $this);
1027 // call end post process. Idea is to let injecting file do any
1028 // processing needed, after the activity has been added/updated.
1029 $this->endPostProcess($params, $activity);
1032 if (!empty($params['is_multi_activity'])) {
1033 $this->_activityIds
[] = $activity->id
;
1036 $this->_activityId
= $activity->id
;
1039 // create follow up activity if needed
1040 $followupStatus = '';
1041 $followupActivity = NULL;
1042 if (!empty($params['followup_activity_type_id'])) {
1043 $followupActivity = CRM_Activity_BAO_Activity
::createFollowupActivity($activity->id
, $params);
1044 $followupStatus = ts('A followup activity has been scheduled.');
1047 // send copy to assignee contacts.CRM-4509
1050 if (Civi
::settings()->get('activity_assignee_notification')) {
1051 $activityIDs = array($activity->id
);
1052 if ($followupActivity) {
1053 $activityIDs = array_merge($activityIDs, array($followupActivity->id
));
1055 $assigneeContacts = CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames($activityIDs, TRUE, FALSE);
1057 if (!CRM_Utils_Array
::crmIsEmptyArray($params['assignee_contact_id'])) {
1058 $mailToContacts = array();
1060 // Build an associative array with unique email addresses.
1061 foreach ($activityAssigned as $id => $dnc) {
1062 if (isset($id) && array_key_exists($id, $assigneeContacts)) {
1063 $mailToContacts[$assigneeContacts[$id]['email']] = $assigneeContacts[$id];
1067 $sent = CRM_Activity_BAO_Activity
::sendToAssignee($activity, $mailToContacts);
1069 $mailStatus .= ts("A copy of the activity has also been sent to assignee contacts(s).");
1073 // Also send email to follow-up activity assignees if set
1074 if ($followupActivity) {
1075 $mailToFollowupContacts = array();
1076 foreach ($assigneeContacts as $values) {
1077 if ($values['activity_id'] == $followupActivity->id
) {
1078 $mailToFollowupContacts[$values['email']] = $values;
1082 $sentFollowup = CRM_Activity_BAO_Activity
::sendToAssignee($followupActivity, $mailToFollowupContacts);
1083 if ($sentFollowup) {
1084 $mailStatus .= '<br />' . ts("A copy of the follow-up activity has also been sent to follow-up assignee contacts(s).");
1089 // set status message
1091 if (!empty($params['subject'])) {
1092 $subject = "'" . $params['subject'] . "'";
1095 CRM_Core_Session
::setStatus(ts('Activity %1 has been saved. %2 %3',
1098 2 => $followupStatus,
1101 ), ts('Saved'), 'success');
1107 * Shorthand for getting id by display name (makes code more readable)
1108 * @param $displayName
1109 * @return null|string
1111 protected function _getIdByDisplayName($displayName) {
1112 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1120 * Shorthand for getting display name by id (makes code more readable)
1122 * @return null|string
1124 protected function _getDisplayNameById($id) {
1125 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1133 * Let injecting activity type file do any processing.
1134 * needed, before the activity is added/updated
1136 * @param array $params
1138 public function beginPostProcess(&$params) {
1139 if ($this->_activityTypeFile
) {
1140 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
1141 $className::beginPostProcess($this, $params);
1146 * Let injecting activity type file do any processing
1147 * needed, after the activity has been added/updated
1149 * @param array $params
1152 public function endPostProcess(&$params, &$activity) {
1153 if ($this->_activityTypeFile
) {
1154 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
1155 $className::endPostProcess($this, $params, $activity);