3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
37 * This class generates form components for Activity
40 class CRM_Activity_Form_Activity
extends CRM_Contact_Form_Task
{
43 * The id of the object being edited / created
50 * Store activity ids when multiple activities are created.
54 public $_activityIds = array();
57 * The id of activity type.
61 public $_activityTypeId;
64 * The name of activity type.
68 public $_activityTypeName;
71 * The id of currently viewed contact.
75 public $_currentlyViewedContactId;
78 * The id of source contact and target contact.
82 protected $_sourceContactId;
83 protected $_targetContactId;
84 protected $_asigneeContactId;
91 public $_activityTypeFile;
94 * The id of the logged in user, used when add / edit
98 public $_currentUserId;
101 * The array of form field attributes.
108 * The the directory inside CRM, to include activity type file from
112 protected $_crmDir = 'Activity';
119 protected $_isSurveyActivity;
121 protected $_values = array();
123 protected $unsavedWarn = TRUE;
126 * The _fields var can be used by sub class to set/unset/edit the
127 * form fields based on their requirement
129 public function setFields() {
130 $this->_fields
= array(
133 'label' => ts('Subject'),
134 'attributes' => CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity',
140 'label' => ts('Duration'),
141 'attributes' => array('size' => 4, 'maxlength' => 8),
146 'label' => ts('Location'),
147 'attributes' => CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity', 'location'),
152 'label' => ts('Details'),
153 // forces a smaller edit window
154 'attributes' => array('rows' => 4, 'cols' => 60),
157 'status_id' => array(
161 'priority_id' => array(
165 'source_contact_id' => array(
166 'type' => 'entityRef',
167 'label' => ts('Added By'),
170 'target_contact_id' => array(
171 'type' => 'entityRef',
172 'label' => ts('With Contact'),
173 'attributes' => array('multiple' => TRUE, 'create' => TRUE),
175 'assignee_contact_id' => array(
176 'type' => 'entityRef',
177 'label' => ts('Assigned to'),
178 'attributes' => array(
181 'api' => array('params' => array('is_deceased' => 0)),
184 'followup_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_activity_type_id' => array(
195 'label' => ts('Followup Activity'),
196 'attributes' => array('' => '- ' . ts('select activity') . ' -') + CRM_Core_PseudoConstant
::ActivityType(FALSE),
197 'extra' => array('class' => 'crm-select2'),
199 // Add optional 'Subject' field for the Follow-up Activiity, CRM-4491
200 'followup_activity_subject' => array(
202 'label' => ts('Subject'),
203 'attributes' => CRM_Core_DAO
::getAttribute('CRM_Activity_DAO_Activity',
209 if (($this->_context
== 'standalone') &&
210 ($printPDF = CRM_Utils_Array
::key('Print PDF Letter', $this->_fields
['followup_activity_type_id']['attributes']))
212 unset($this->_fields
['followup_activity_type_id']['attributes'][$printPDF]);
217 * Build the form object.
221 public function preProcess() {
222 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
223 $this->assign('cdType', FALSE);
224 if ($this->_cdType
) {
225 $this->assign('cdType', TRUE);
226 return CRM_Custom_Form_CustomData
::preProcess($this);
228 CRM_Core_Form_RecurringEntity
::preProcess('civicrm_activity');
229 $this->_atypefile
= CRM_Utils_Array
::value('atypefile', $_GET);
230 $this->assign('atypefile', FALSE);
231 if ($this->_atypefile
) {
232 $this->assign('atypefile', TRUE);
235 $session = CRM_Core_Session
::singleton();
236 $this->_currentUserId
= $session->get('userID');
238 $this->_currentlyViewedContactId
= $this->get('contactId');
239 if (!$this->_currentlyViewedContactId
) {
240 $this->_currentlyViewedContactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
242 $this->assign('contactId', $this->_currentlyViewedContactId
);
245 if (!isset($this->_context
)) {
246 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
247 if (CRM_Contact_Form_Search
::isSearchContext($this->_context
)) {
248 $this->_context
= 'search';
250 elseif (!in_array($this->_context
, array('dashlet', 'dashletFullscreen'))
251 && $this->_currentlyViewedContactId
253 $this->_context
= 'activity';
255 $this->_compContext
= CRM_Utils_Request
::retrieve('compContext', 'String', $this);
258 $this->assign('context', $this->_context
);
260 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this);
262 if ($this->_action
& CRM_Core_Action
::DELETE
) {
263 if (!CRM_Core_Permission
::check('delete activities')) {
264 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
269 //when we come from contact search, activity id never comes.
270 //so don't try to get from object, it might gives you wrong one.
272 // if we're not adding new one, there must be an id to
273 // an activity we're trying to work on.
274 if ($this->_action
!= CRM_Core_Action
::ADD
&&
275 get_class($this->controller
) != 'CRM_Contact_Controller_Search'
277 $this->_activityId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
280 $this->_activityTypeId
= CRM_Utils_Request
::retrieve('atype', 'Positive', $this);
281 $this->assign('atype', $this->_activityTypeId
);
283 $this->assign('activityId', $this->_activityId
);
285 //check for required permissions, CRM-6264
286 if ($this->_activityId
&&
287 in_array($this->_action
, array(
288 CRM_Core_Action
::UPDATE
,
289 CRM_Core_Action
::VIEW
,
291 !CRM_Activity_BAO_Activity
::checkPermission($this->_activityId
, $this->_action
)
293 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
295 if (($this->_action
& CRM_Core_Action
::VIEW
) &&
296 CRM_Activity_BAO_Activity
::checkPermission($this->_activityId
, CRM_Core_Action
::UPDATE
)
298 $this->assign('permission', 'edit');
301 if (!$this->_activityTypeId
&& $this->_activityId
) {
302 $this->_activityTypeId
= CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
308 //Assigning Activity type name
309 if ($this->_activityTypeId
) {
310 $activityTName = CRM_Core_OptionGroup
::values('activity_type', FALSE, FALSE, FALSE, 'AND v.value = ' . $this->_activityTypeId
, 'name');
311 if ($activityTName[$this->_activityTypeId
]) {
312 $this->_activityTypeName
= $activityTName[$this->_activityTypeId
];
313 $this->assign('activityTName', $activityTName[$this->_activityTypeId
]);
318 if (isset($activityTName)) {
319 $activityName = CRM_Utils_Array
::value($this->_activityTypeId
, $activityTName);
320 $this->assign('pageTitle', ts('%1 Activity', array(1 => $activityName)));
322 if ($this->_currentlyViewedContactId
) {
323 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_currentlyViewedContactId
);
324 // Check if this is default domain contact CRM-10482
325 if (CRM_Contact_BAO_Contact
::checkDomainContact($this->_currentlyViewedContactId
)) {
326 $displayName .= ' (' . ts('default organization') . ')';
328 CRM_Utils_System
::setTitle($displayName . ' - ' . $activityName);
331 CRM_Utils_System
::setTitle(ts('%1 Activity', array(1 => $activityName)));
335 //check the mode when this form is called either single or as
337 if ($this->_activityTypeId ||
338 $this->_context
== 'standalone' ||
339 $this->_currentlyViewedContactId
341 $this->_single
= TRUE;
342 $this->assign('urlPath', 'civicrm/activity');
345 //set the appropriate action
346 $url = CRM_Utils_System
::currentPath();
347 $urlArray = explode('/', $url);
348 $searchPath = array_pop($urlArray);
349 $searchType = 'basic';
350 $this->_action
= CRM_Core_Action
::BASIC
;
351 switch ($searchPath) {
353 $searchType = $searchPath;
354 $this->_action
= CRM_Core_Action
::BASIC
;
358 $searchType = $searchPath;
359 $this->_action
= CRM_Core_Action
::ADVANCED
;
363 $searchType = $searchPath;
364 $this->_action
= CRM_Core_Action
::PROFILE
;
368 $this->_action
= CRM_Core_Action
::COPY
;
369 $searchType = $searchPath;
373 parent
::preProcess();
374 $this->_single
= FALSE;
376 $this->assign('urlPath', "civicrm/contact/search/$searchType");
377 $this->assign('urlPathVar', "_qf_Activity_display=true&qfKey={$this->controller->_key}");
380 $this->assign('single', $this->_single
);
381 $this->assign('action', $this->_action
);
383 if ($this->_action
& CRM_Core_Action
::VIEW
) {
384 // get the tree of custom fields
385 $this->_groupTree
= &CRM_Core_BAO_CustomGroup
::getTree('Activity', $this,
386 $this->_activityId
, 0, $this->_activityTypeId
390 if ($this->_activityTypeId
) {
391 //set activity type name and description to template
392 list($this->_activityTypeName
, $activityTypeDescription) = CRM_Core_BAO_OptionValue
::getActivityTypeDetails($this->_activityTypeId
);
393 $this->assign('activityTypeName', $this->_activityTypeName
);
394 $this->assign('activityTypeDescription', $activityTypeDescription);
398 $urlParams = $urlString = NULL;
399 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', $this);
401 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', $this);
405 if (!CRM_Utils_Rule
::qfKey($qfKey)) {
409 if ($this->_context
== 'fulltext') {
411 $urlParams = 'force=1';
412 $urlString = 'civicrm/contact/search/custom';
413 if ($this->_action
== CRM_Core_Action
::UPDATE
) {
415 $urlParams .= '&context=fulltext&action=view';
416 $urlString = 'civicrm/contact/view/activity';
419 $urlParams .= "$keyName=$qfKey";
421 $this->assign('searchKey', $qfKey);
423 elseif (in_array($this->_context
, array(
430 $urlParams = 'reset=1';
431 $urlString = 'civicrm/dashboard';
433 elseif ($this->_context
== 'search') {
434 $urlParams = 'force=1';
436 $urlParams .= "&qfKey=$qfKey";
438 $path = CRM_Utils_System
::currentPath();
439 if ($this->_compContext
== 'advanced') {
440 $urlString = 'civicrm/contact/search/advanced';
442 elseif ($path == 'civicrm/group/search'
443 ||
$path == 'civicrm/contact/search'
444 ||
$path == 'civicrm/contact/search/advanced'
445 ||
$path == 'civicrm/contact/search/custom'
446 ||
$path == 'civicrm/group/search'
451 $urlString = 'civicrm/activity/search';
453 $this->assign('searchKey', $qfKey);
455 elseif ($this->_context
!= 'caseActivity') {
456 $urlParams = "action=browse&reset=1&cid={$this->_currentlyViewedContactId}&selectedChild=activity";
457 $urlString = 'civicrm/contact/view';
461 $session->pushUserContext(CRM_Utils_System
::url($urlString, $urlParams));
464 // hack to retrieve activity type id from post variables
465 if (!$this->_activityTypeId
) {
466 $this->_activityTypeId
= CRM_Utils_Array
::value('activity_type_id', $_POST);
469 // when custom data is included in this page
470 if (!empty($_POST['hidden_custom'])) {
471 // we need to set it in the session for the below code to work
473 //need to assign custom data subtype to the template
474 $this->set('type', 'Activity');
475 $this->set('subType', $this->_activityTypeId
);
476 $this->set('entityId', $this->_activityId
);
477 CRM_Custom_Form_CustomData
::preProcess($this);
478 CRM_Custom_Form_CustomData
::buildQuickForm($this);
479 CRM_Custom_Form_CustomData
::setDefaultValues($this);
482 // add attachments part
483 CRM_Core_BAO_File
::buildAttachment($this, 'civicrm_activity', $this->_activityId
, NULL, TRUE);
485 // figure out the file name for activity type, if any
486 if ($this->_activityTypeId
&&
487 $this->_activityTypeFile
= CRM_Activity_BAO_Activity
::getFileForActivityTypeId($this->_activityTypeId
, $this->_crmDir
)
489 $this->assign('activityTypeFile', $this->_activityTypeFile
);
490 $this->assign('crmDir', $this->_crmDir
);
495 if ($this->_activityTypeFile
) {
496 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
497 $className::preProcess($this);
500 $this->_values
= $this->get('values');
501 if (!is_array($this->_values
)) {
502 $this->_values
= array();
503 if (isset($this->_activityId
) && $this->_activityId
) {
504 $params = array('id' => $this->_activityId
);
505 CRM_Activity_BAO_Activity
::retrieve($params, $this->_values
);
507 $this->set('values', $this->_values
);
510 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
511 CRM_Core_Form_RecurringEntity
::preProcess('civicrm_activity');
516 * Set default values for the form. For edit/view mode
517 * the default values are retrieved from the database
522 public function setDefaultValues() {
523 if ($this->_cdType
) {
524 return CRM_Custom_Form_CustomData
::setDefaultValues($this);
527 $defaults = $this->_values
;
528 // if we're editing...
529 if (isset($this->_activityId
)) {
530 if (empty($defaults['activity_date_time'])) {
531 list($defaults['activity_date_time'], $defaults['activity_date_time_time']) = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
533 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
534 $this->assign('current_activity_date_time', $defaults['activity_date_time']);
535 list($defaults['activity_date_time'],
536 $defaults['activity_date_time_time']
537 ) = CRM_Utils_Date
::setDateDefaults($defaults['activity_date_time'], 'activityDateTime');
538 list($defaults['repetition_start_date'], $defaults['repetition_start_date_time']) = CRM_Utils_Date
::setDateDefaults($defaults['activity_date_time'], 'activityDateTime');
539 $recurringEntityDefaults = array();
540 $recurringEntityDefaults = CRM_Core_Form_RecurringEntity
::setDefaultValues();
541 $defaults = array_merge($defaults, $recurringEntityDefaults);
544 if ($this->_context
!= 'standalone') {
545 $this->assign('target_contact_value',
546 CRM_Utils_Array
::value('target_contact_value', $defaults)
548 $this->assign('assignee_contact_value',
549 CRM_Utils_Array
::value('assignee_contact_value', $defaults)
553 // Fixme: why are we getting the wrong keys from upstream?
554 $defaults['target_contact_id'] = CRM_Utils_Array
::value('target_contact', $defaults);
555 $defaults['assignee_contact_id'] = CRM_Utils_Array
::value('assignee_contact', $defaults);
557 // set default tags if exists
558 $defaults['tag'] = CRM_Core_BAO_EntityTag
::getTag($this->_activityId
, 'civicrm_activity');
561 // if it's a new activity, we need to set default values for associated contact fields
562 $this->_sourceContactId
= $this->_currentUserId
;
563 $this->_targetContactId
= $this->_currentlyViewedContactId
;
565 $defaults['source_contact_id'] = $this->_sourceContactId
;
566 $defaults['target_contact_id'] = $this->_targetContactId
;
568 list($defaults['activity_date_time'], $defaults['activity_date_time_time'])
569 = CRM_Utils_Date
::setDateDefaults(NULL, 'activityDateTime');
572 if ($this->_activityTypeId
) {
573 $defaults['activity_type_id'] = $this->_activityTypeId
;
576 if (!$this->_single
&& !empty($this->_contactIds
)) {
577 $defaults['target_contact_id'] = $this->_contactIds
;
580 // CRM-15472 - 50 is around the practial limit of how many items a select2 entityRef can handle
581 if (!empty($defaults['target_contact_id'])) {
582 $count = count(is_array($defaults['target_contact_id']) ?
$defaults['target_contact_id'] : explode(',', $defaults['target_contact_id']));
584 $this->freeze(array('target_contact_id'));
588 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::RENEW
)) {
589 $this->assign('delName', CRM_Utils_Array
::value('subject', $defaults));
592 if ($this->_activityTypeFile
) {
593 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
594 $defaults +
= $className::setDefaultValues($this);
596 if (empty($defaults['priority_id'])) {
597 $priority = CRM_Core_PseudoConstant
::get('CRM_Activity_DAO_Activity', 'priority_id');
598 $defaults['priority_id'] = array_search('Normal', $priority);
600 if (empty($defaults['status_id'])) {
601 $defaults['status_id'] = CRM_Core_OptionGroup
::getDefaultValue('activity_status');
606 public function buildQuickForm() {
607 if ($this->_action
& (CRM_Core_Action
::DELETE | CRM_Core_Action
::RENEW
)) {
608 //enable form element (ActivityLinks sets this true)
609 $this->assign('suppressForm', FALSE);
611 $button = ts('Delete');
612 if ($this->_action
& CRM_Core_Action
::RENEW
) {
613 $button = ts('Restore');
615 $this->addButtons(array(
619 'spacing' => ' ',
624 'name' => ts('Cancel'),
630 if ($this->_cdType
) {
631 return CRM_Custom_Form_CustomData
::buildQuickForm($this);
634 //build other activity links
635 CRM_Activity_Form_ActivityLinks
::commonBuildQuickForm($this);
637 //enable form element (ActivityLinks sets this true)
638 $this->assign('suppressForm', FALSE);
640 $element = &$this->add('select', 'activity_type_id', ts('Activity Type'),
641 $this->_fields
['followup_activity_type_id']['attributes'],
643 'onchange' => "CRM.buildCustomData( 'Activity', this.value );",
644 'class' => 'crm-select2',
648 //freeze for update mode.
649 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
653 //Call to RecurringEntity buildQuickForm for add/update mode
654 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
655 CRM_Core_Form_RecurringEntity
::buildQuickForm($this);
658 foreach ($this->_fields
as $field => $values) {
659 if (!empty($this->_fields
[$field])) {
660 $attribute = CRM_Utils_Array
::value('attributes', $values);
661 $required = !empty($values['required']);
663 if ($values['type'] == 'wysiwyg') {
664 $this->addWysiwyg($field, $values['label'], $attribute, $required);
666 elseif ($values['type'] == 'select' && empty($attribute)) {
667 $this->addSelect($field, array('entity' => 'activity'), $required);
669 elseif ($values['type'] == 'entityRef') {
670 $this->addEntityRef($field, $values['label'], $attribute, $required);
673 $this->add($values['type'], $field, $values['label'], $attribute, $required, CRM_Utils_Array
::value('extra', $values));
678 //CRM-7362 --add campaigns.
679 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
681 //add engagement level CRM-7775
682 $buildEngagementLevel = FALSE;
683 if (CRM_Campaign_BAO_Campaign
::isCampaignEnable() &&
684 CRM_Campaign_BAO_Campaign
::accessCampaign()
686 $buildEngagementLevel = TRUE;
687 $this->addSelect('engagement_level', array('entity' => 'activity'));
688 $this->addRule('engagement_level',
689 ts('Please enter the engagement index as a number (integers only).'),
693 $this->assign('buildEngagementLevel', $buildEngagementLevel);
695 // check for survey activity
696 $this->_isSurveyActivity
= FALSE;
698 if ($this->_activityId
&& CRM_Campaign_BAO_Campaign
::isCampaignEnable() &&
699 CRM_Campaign_BAO_Campaign
::accessCampaign()
702 $this->_isSurveyActivity
= CRM_Campaign_BAO_Survey
::isSurveyActivity($this->_activityId
);
703 if ($this->_isSurveyActivity
) {
704 $surveyId = CRM_Core_DAO
::getFieldValue('CRM_Activity_DAO_Activity',
708 $responseOptions = CRM_Campaign_BAO_Survey
::getResponsesOptions($surveyId);
709 if ($responseOptions) {
710 $this->add('select', 'result', ts('Result'),
711 array('' => ts('- select -')) +
array_combine($responseOptions, $responseOptions)
716 $surveyTitle = CRM_Core_DAO
::getFieldValue('CRM_Campaign_DAO_Survey', $surveyId, 'title');
718 $this->assign('surveyTitle', $surveyTitle);
721 $this->assign('surveyActivity', $this->_isSurveyActivity
);
723 // this option should be available only during add mode
724 if ($this->_action
!= CRM_Core_Action
::UPDATE
) {
725 $this->add('advcheckbox', 'is_multi_activity', ts('Create a separate activity for each contact.'));
728 $this->addRule('duration',
729 ts('Please enter the duration as number of minutes (integers only).'), 'positiveInteger'
731 $this->addDateTime('activity_date_time', ts('Date'), TRUE, array('formatType' => 'activityDateTime'));
734 $this->addDateTime('followup_date', ts('in'), FALSE, array('formatType' => 'activityDateTime'));
736 // Only admins and case-workers can change the activity source
737 if (!CRM_Core_Permission
::check('administer CiviCRM') && $this->_context
!= 'caseActivity') {
738 $this->getElement('source_contact_id')->freeze();
741 //need to assign custom data type and subtype to the template
742 $this->assign('customDataType', 'Activity');
743 $this->assign('customDataSubType', $this->_activityTypeId
);
744 $this->assign('entityID', $this->_activityId
);
746 CRM_Core_BAO_Tag
::getTags('civicrm_activity', $tags, NULL,
747 ' ', TRUE);
750 $this->add('select', 'tag', ts('Tags'), $tags, FALSE,
751 array('id' => 'tags', 'multiple' => 'multiple', 'class' => 'crm-select2 huge')
755 // we need to hide activity tagset for special activities
756 $specialActivities = array('Open Case');
758 if (!in_array($this->_activityTypeName
, $specialActivities)) {
760 $parentNames = CRM_Core_BAO_Tag
::getTagSet('civicrm_activity');
761 CRM_Core_Form_Tag
::buildQuickForm($this, $parentNames, 'civicrm_activity', $this->_activityId
);
764 // if we're viewing, we're assigning different buttons than for adding/editing
765 if ($this->_action
& CRM_Core_Action
::VIEW
) {
766 if (isset($this->_groupTree
)) {
767 CRM_Core_BAO_CustomGroup
::buildCustomDataView($this, $this->_groupTree
);
769 // form should be frozen for view mode
775 'name' => ts('Done'),
777 $this->addButtons($buttons);
781 '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.'),
782 '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.'),
784 $js = array('onclick' => "return activityStatus(" . json_encode($message) . ");");
785 $this->addButtons(array(
788 'name' => ts('Save'),
794 'name' => ts('Cancel'),
800 if ($this->_activityTypeFile
) {
801 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
803 $className::buildQuickForm($this);
804 $this->addFormRule(array($className, 'formRule'), $this);
807 $this->addFormRule(array('CRM_Activity_Form_Activity', 'formRule'), $this);
809 if (CRM_Core_BAO_Setting
::getItem(
810 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
811 'activity_assignee_notification'
814 $this->assign('activityAssigneeNotification', TRUE);
817 $this->assign('activityAssigneeNotification', FALSE);
824 * @param array $fields
825 * The input form values.
826 * @param array $files
827 * The uploaded files if any.
831 * true if no errors, else array of errors
833 public static function formRule($fields, $files, $self) {
834 // skip form rule if deleting
835 if (CRM_Utils_Array
::value('_qf_Activity_next_', $fields) == 'Delete') {
839 if (!$self->_single
&& !$fields['activity_type_id']) {
840 $errors['activity_type_id'] = ts('Activity Type is a required field');
843 //Activity type is mandatory if creating new activity, CRM-4515
844 if (array_key_exists('activity_type_id', $fields) && empty($fields['activity_type_id'])) {
845 $errors['activity_type_id'] = ts('Activity Type is required field.');
848 if (CRM_Utils_Array
::value('activity_type_id', $fields) == 3 &&
849 CRM_Utils_Array
::value('status_id', $fields) == 1
851 $errors['status_id'] = ts('You cannot record scheduled email activity.');
853 elseif (CRM_Utils_Array
::value('activity_type_id', $fields) == 4 &&
854 CRM_Utils_Array
::value('status_id', $fields) == 1
856 $errors['status_id'] = ts('You cannot record scheduled SMS activity.');
859 if (!empty($fields['followup_activity_type_id']) && empty($fields['followup_date'])) {
860 $errors['followup_date_time'] = ts('Followup date is a required field.');
862 //Activity type is mandatory if subject or follow-up date is specified for an Follow-up activity, CRM-4515
863 if ((!empty($fields['followup_activity_subject']) ||
!empty($fields['followup_date'])) && empty($fields['followup_activity_type_id'])) {
864 $errors['followup_activity_subject'] = ts('Follow-up Activity type is a required field.');
870 * Process the form submission.
873 * @param array $params
876 public function postProcess($params = NULL) {
877 if ($this->_action
& CRM_Core_Action
::DELETE
) {
878 $deleteParams = array('id' => $this->_activityId
);
879 $moveToTrash = CRM_Case_BAO_Case
::isCaseActivity($this->_activityId
);
880 CRM_Activity_BAO_Activity
::deleteActivity($deleteParams, $moveToTrash);
882 // delete tags for the entity
884 'entity_table' => 'civicrm_activity',
885 'entity_id' => $this->_activityId
,
888 CRM_Core_BAO_EntityTag
::del($tagParams);
890 CRM_Core_Session
::setStatus(ts("Selected Activity has been deleted successfully."), ts('Record Deleted'), 'success');
894 // store the submitted values in an array
896 $params = $this->controller
->exportValues($this->_name
);
899 //set activity type id
900 if (empty($params['activity_type_id'])) {
901 $params['activity_type_id'] = $this->_activityTypeId
;
904 if (!empty($params['hidden_custom']) &&
905 !isset($params['custom'])
907 $customFields = CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
908 $this->_activityTypeId
910 $customFields = CRM_Utils_Array
::crmArrayMerge($customFields,
911 CRM_Core_BAO_CustomField
::getFields('Activity', FALSE, FALSE,
915 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
922 // store the date with proper format
923 $params['activity_date_time'] = CRM_Utils_Date
::processDate($params['activity_date_time'], $params['activity_date_time_time']);
925 // format params as arrays
926 foreach (array('target', 'assignee', 'followup_assignee') as $name) {
927 if (!empty($params["{$name}_contact_id"])) {
928 $params["{$name}_contact_id"] = explode(',', $params["{$name}_contact_id"]);
931 $params["{$name}_contact_id"] = array();
935 // get ids for associated contacts
936 if (!$params['source_contact_id']) {
937 $params['source_contact_id'] = $this->_currentUserId
;
940 if (isset($this->_activityId
)) {
941 $params['id'] = $this->_activityId
;
944 // add attachments as needed
945 CRM_Core_BAO_File
::formatAttachment($params,
952 if (!empty($params['is_multi_activity']) &&
953 !CRM_Utils_Array
::crmIsEmptyArray($params['target_contact_id'])
955 $targetContacts = $params['target_contact_id'];
956 foreach ($targetContacts as $targetContactId) {
957 $params['target_contact_id'] = array($targetContactId);
959 $activity[] = $this->processActivity($params);
964 $activity = $this->processActivity($params);
967 $activityIds = empty($this->_activityIds
) ?
array($this->_activityId
) : $this->_activityIds
;
968 foreach ($activityIds as $activityId) {
969 // set params for repeat configuration in create mode
970 $params['entity_id'] = $activityId;
971 $params['entity_table'] = 'civicrm_activity';
972 $scheduleReminderDetails = array();
973 if (!empty($params['entity_id']) && !empty($params['entity_table'])) {
974 $checkParentExistsForThisId = CRM_Core_BAO_RecurringEntity
::getParentFor($params['entity_id'], $params['entity_table']);
975 if ($checkParentExistsForThisId) {
976 $params['parent_entity_id'] = $checkParentExistsForThisId;
977 $scheduleReminderDetails = CRM_Core_BAO_RecurringEntity
::getReminderDetailsByEntityId($checkParentExistsForThisId, $params['entity_table']);
980 $params['parent_entity_id'] = $params['entity_id'];
981 $scheduleReminderDetails = CRM_Core_BAO_RecurringEntity
::getReminderDetailsByEntityId($params['entity_id'], $params['entity_table']);
983 if (property_exists($scheduleReminderDetails, 'id')) {
984 $params['schedule_reminder_id'] = $scheduleReminderDetails->id
;
987 $params['dateColumns'] = array('activity_date_time');
990 unset($params['id']);
991 $linkedEntities = array(
993 'table' => 'civicrm_activity_contact',
994 'findCriteria' => array(
995 'activity_id' => $activityId,
997 'linkedColumns' => array('activity_id'),
998 'isRecurringEntityRecord' => FALSE,
1001 CRM_Core_Form_RecurringEntity
::postProcess($params, 'civicrm_activity', $linkedEntities);
1004 return array('activity' => $activity);
1008 * Process activity creation.
1010 * @param array $params
1011 * Associated array of submitted values.
1013 * @return self|null|object
1015 protected function processActivity(&$params) {
1016 $activityAssigned = array();
1017 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1018 $assigneeID = CRM_Utils_Array
::key('Activity Assignees', $activityContacts);
1019 // format assignee params
1020 if (!CRM_Utils_Array
::crmIsEmptyArray($params['assignee_contact_id'])) {
1021 //skip those assignee contacts which are already assigned
1022 //while sending a copy.CRM-4509.
1023 $activityAssigned = array_flip($params['assignee_contact_id']);
1024 if ($this->_activityId
) {
1025 $assigneeContacts = CRM_Activity_BAO_ActivityContact
::getNames($this->_activityId
, $assigneeID);
1026 $activityAssigned = array_diff_key($activityAssigned, $assigneeContacts);
1030 // call begin post process. Idea is to let injecting file do
1031 // any processing before the activity is added/updated.
1032 $this->beginPostProcess($params);
1034 $activity = CRM_Activity_BAO_Activity
::create($params);
1036 // add tags if exists
1037 $tagParams = array();
1038 if (!empty($params['tag'])) {
1039 foreach ($params['tag'] as $tag) {
1040 $tagParams[$tag] = 1;
1045 CRM_Core_BAO_EntityTag
::create($tagParams, 'civicrm_activity', $activity->id
);
1048 if (isset($params['activity_taglist']) && !empty($params['activity_taglist'])) {
1049 CRM_Core_Form_Tag
::postProcess($params['activity_taglist'], $activity->id
, 'civicrm_activity', $this);
1052 // call end post process. Idea is to let injecting file do any
1053 // processing needed, after the activity has been added/updated.
1054 $this->endPostProcess($params, $activity);
1057 if (!empty($params['is_multi_activity'])) {
1058 $this->_activityIds
[] = $activity->id
;
1061 $this->_activityId
= $activity->id
;
1064 // create follow up activity if needed
1065 $followupStatus = '';
1066 $followupActivity = NULL;
1067 if (!empty($params['followup_activity_type_id'])) {
1068 $followupActivity = CRM_Activity_BAO_Activity
::createFollowupActivity($activity->id
, $params);
1069 $followupStatus = ts('A followup activity has been scheduled.');
1072 // send copy to assignee contacts.CRM-4509
1075 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1076 'activity_assignee_notification')
1078 $activityIDs = array($activity->id
);
1079 if ($followupActivity) {
1080 $activityIDs = array_merge($activityIDs, array($followupActivity->id
));
1082 $assigneeContacts = CRM_Activity_BAO_ActivityAssignment
::getAssigneeNames($activityIDs, TRUE, FALSE);
1084 if (!CRM_Utils_Array
::crmIsEmptyArray($params['assignee_contact_id'])) {
1085 $mailToContacts = array();
1087 //build an associative array with unique email addresses.
1088 foreach ($activityAssigned as $id => $dnc) {
1089 if (isset($id) && array_key_exists($id, $assigneeContacts)) {
1090 $mailToContacts[$assigneeContacts[$id]['email']] = $assigneeContacts[$id];
1094 if (!CRM_Utils_array
::crmIsEmptyArray($mailToContacts)) {
1095 //include attachments while sending a copy of activity.
1096 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $activity->id
);
1098 $ics = new CRM_Activity_BAO_ICalendar($activity);
1099 $ics->addAttachment($attachments, $mailToContacts);
1101 // CRM-8400 add param with _currentlyViewedContactId for URL link in mail
1102 CRM_Case_BAO_Case
::sendActivityCopy(NULL, $activity->id
, $mailToContacts, $attachments, NULL);
1106 $mailStatus .= ts("A copy of the activity has also been sent to assignee contacts(s).");
1110 // Also send email to follow-up activity assignees if set
1111 if ($followupActivity) {
1112 $mailToFollowupContacts = array();
1113 foreach ($assigneeContacts as $values) {
1114 if ($values['activity_id'] == $followupActivity->id
) {
1115 $mailToFollowupContacts[$values['email']] = $values;
1119 if (!CRM_Utils_array
::crmIsEmptyArray($mailToFollowupContacts)) {
1120 $ics = new CRM_Activity_BAO_ICalendar($followupActivity);
1121 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_activity', $followupActivity->id
);
1122 $ics->addAttachment($attachments, $mailToFollowupContacts);
1124 CRM_Case_BAO_Case
::sendActivityCopy(NULL, $followupActivity->id
, $mailToFollowupContacts, $attachments, NULL);
1128 $mailStatus .= '<br />' . ts("A copy of the follow-up activity has also been sent to follow-up assignee contacts(s).");
1133 // set status message
1135 if (!empty($params['subject'])) {
1136 $subject = "'" . $params['subject'] . "'";
1139 CRM_Core_Session
::setStatus(ts('Activity %1 has been saved. %2 %3',
1142 2 => $followupStatus,
1145 ), ts('Saved'), 'success');
1151 * Shorthand for getting id by display name (makes code more readable)
1152 * @param $displayName
1153 * @return null|string
1155 protected function _getIdByDisplayName($displayName) {
1156 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1164 * Shorthand for getting display name by id (makes code more readable)
1166 * @return null|string
1168 protected function _getDisplayNameById($id) {
1169 return CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
1177 * Let injecting activity type file do any processing.
1178 * needed, before the activity is added/updated
1180 * @param array $params
1182 public function beginPostProcess(&$params) {
1183 if ($this->_activityTypeFile
) {
1184 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
1185 $className::beginPostProcess($this, $params);
1190 * Let injecting activity type file do any processing
1191 * needed, after the activity has been added/updated
1193 * @param array $params
1196 public function endPostProcess(&$params, &$activity) {
1197 if ($this->_activityTypeFile
) {
1198 $className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
1199 $className::endPostProcess($this, $params, $activity);