General code clean up
| <?php | ||
| /** | ||
| * Call Next class. | ||
| * | ||
| * @since 1.0 | ||
| */ | ||
| class CRM_CallNextDashlet_Page_CallNextDashlet extends CRM_Core_Page { | ||
| /** | ||
| * Constructor. | ||
| * | ||
| * @since 1.0 | ||
| */ | ||
| public function __construct() { | ||
| parent::__construct(); | ||
| } | ||
| /** | ||
| * Output markup to template. | ||
| * | ||
| * @since 1.0 | ||
| */ | ||
| public function run() { | ||
| // Get contact ID. | ||
| $contactId = CRM_Core_Session::getLoggedInContactID(); | ||
| // Bail if we don't have one. | ||
| if (!$contactId) { | ||
| return; | ||
| } | ||
| // Get context - either "dashlet" or "dashletFullscreen" | ||
| $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this, FALSE, 'dashlet'); | ||
| $this->assign('context', $context); | ||
| // Begin constructing markup. | ||
| $callNext = ''; | ||
| // Get contacts. | ||
| $contacts = self::get_contacts(); | ||
| if ($contacts) { | ||
| // Get config. | ||
| $config = CRM_Core_Config::singleton(); | ||
| // Init Contacts list. | ||
| $myContacts = []; | ||
| // Open table. | ||
| $callNext .= '<table class="callnext-table">'; | ||
| // Define header row. | ||
| $callNext .= '<tr>' . | ||
| '<th>' . ts('Name') . '</th>' . | ||
| '<th>' . ts('Subject') . '</th>' . | ||
| '<th>' . ts('Date') . '</th>'. | ||
| '<th>' . ts('Time') . '</th>' . | ||
| '</tr>'; | ||
| // Open row. | ||
| $callNext .= '<tr><td>'; | ||
| // Path is common to all Contacts. | ||
| $path = 'civicrm/contact/view'; | ||
| foreach($contacts AS $contact) { | ||
| /* | ||
| //$e = new Exception; | ||
| //$trace = $e->getTraceAsString(); | ||
| error_log( print_r( array( | ||
| 'method' => __METHOD__, | ||
| 'contact' => $contact, | ||
| //'backtrace' => $trace, | ||
| ), true ) ); | ||
| */ | ||
| // Build the query. | ||
| $query = 'reset=1&cid=' . array_shift( $contact['target_contact_id'] ) . '&assignee=' . $contactId; | ||
| // Use CiviCRM to construct link. | ||
| $contactURL = CRM_Utils_System::url( | ||
| $path, // The path being linked to, such as "civicrm/add". | ||
| $query, // A query string to append to the link. | ||
| TRUE, // Whether to force the output to be an absolute link. | ||
| NULL, // A fragment identifier (named anchor) to append to the link. | ||
| TRUE, // This link should be to the CMS front end. | ||
| FALSE // This link should be to the CMS back end. | ||
| ); | ||
| // Build anchor tag. | ||
| $contactLink = sprintf( '<a href="%1$s">%2$s</a>', $contactURL, array_shift( $contact['target_contact_name'] ) ); | ||
| // Build date. | ||
| $date = CRM_Utils_Date::customFormat($contact['activity_date_time'], $config->dateformatFull); | ||
| $time = CRM_Utils_Date::customFormat($contact['activity_date_time'], $config->dateformatTime); | ||
| // Build data. | ||
| $data = $contactLink . '</td>' . | ||
| '<td>' . $contact['subject'] . '</td>' . | ||
| '<td>' . $date . '</td>' . | ||
| '<td>' . $time; | ||
| // Add to list. | ||
| $myContacts[] = $data; | ||
| } | ||
| // Wrap data in <td> tags. | ||
| $callNext .= implode( '</td></tr><tr><td>', $myContacts ); | ||
| // Close row. | ||
| $callNext .= '</td></tr>'; | ||
| // Close table. | ||
| $callNext .= '</table>'; | ||
| } | ||
| $this->assign('callNext', $callNext); | ||
| return parent::run(); | ||
| } | ||
| /** | ||
| * Get the Contacts to call next. | ||
| * | ||
| * The way we do this is to query for all Activities of type "Phone Call" with | ||
| * the custom status "Awaiting Response". These must be either: | ||
| * | ||
| * a) Assigned to the current Contact | ||
| * b) Not yet assigned to anyone | ||
| * | ||
| * There doesn't seem to be a single API query that can achieve this in one go | ||
| * so it's a three-stage process: | ||
| * | ||
| * a) Get those assigned to the current Contact | ||
| * b) Get those not yet assigned to anyone | ||
| * c) Merge and limit results to display in dashlet | ||
| * | ||
| * At this point, I assume that those Activities which have been assigned to a | ||
| * Contact directly will take precedence over those which are unassigned. | ||
| * | ||
| * @since 1.0 | ||
| * | ||
| * @return array|bool $contacts Array of contact data, or false on failure. | ||
| */ | ||
| public static function get_contacts() { | ||
| try { | ||
| // Get Activities assigned to current Contact. | ||
| $activities_me = civicrm_api3('Activity', 'get', [ | ||
| 'sequential' => 1, | ||
| 'return' => ["subject", "activity_date_time", "target_contact_id"], | ||
| 'status_id' => "Awaiting Response", | ||
| 'assignee_contact_id' => "user_contact_id", | ||
| 'options' => [ | ||
| 'sort' => "activity_date_time ASC", | ||
| 'limit' => 10, | ||
| ], | ||
| ]); | ||
| /* | ||
| error_log( print_r( array( | ||
| 'method' => __METHOD__, | ||
| 'activities_me' => $activities_me, | ||
| ), true ) ); | ||
| */ | ||
| } catch (CiviCRM_API3_Exception $e) { | ||
| // Do something if API call fails. | ||
| error_log( print_r( array( | ||
| 'method' => __METHOD__, | ||
| 'activities_me' => $activities_me, | ||
| 'message' => $e->getMessage(), | ||
| ), true ) ); | ||
| // Show a message. | ||
| CRM_Core_Error::debug_log_message( $e->getMessage() ); | ||
| } | ||
| try { | ||
| // Get all Activities with relevant status. | ||
| $activities_none = civicrm_api3('Activity', 'get', [ | ||
| 'sequential' => 1, | ||
| 'return' => ["subject", "activity_date_time", "target_contact_id", "assignee_contact_id"], | ||
| 'status_id' => "Awaiting Response", | ||
| 'options' => [ | ||
| 'sort' => "activity_date_time ASC", | ||
| 'limit' => 0, | ||
| ], | ||
| ]); | ||
| /* | ||
| error_log( print_r( array( | ||
| 'method' => __METHOD__, | ||
| 'activities_none' => $activities_none, | ||
| ), true ) ); | ||
| */ | ||
| } catch (CiviCRM_API3_Exception $e) { | ||
| // Do something if API call fails. | ||
| error_log( print_r( array( | ||
| 'method' => __METHOD__, | ||
| 'activities_none' => $activities_none, | ||
| 'message' => $e->getMessage(), | ||
| ), true ) ); | ||
| // Show a message. | ||
| CRM_Core_Error::debug_log_message( $e->getMessage() ); | ||
| } | ||
| // Merge the arrays. | ||
| $activities = array(); | ||
| foreach($activities_me['values'] AS $activity) { | ||
| $activities[] = $activity; | ||
| } | ||
| foreach($activities_none['values'] AS $activity) { | ||
| if (empty($activity['assignee_contact_id'])) { | ||
| foreach($activity['target_contact_id'] AS $contactID) { | ||
| if (self::can_view_contact($contactID)) { | ||
| $activities[] = $activity; | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // Maybe truncate array to 10 items. | ||
| if (count($activities) > 10) { | ||
| $activities = array_slice($activities, 0, 10); | ||
| } | ||
| /* | ||
| error_log( print_r( array( | ||
| 'method' => __METHOD__, | ||
| 'activities_me' => $activities_me, | ||
| 'activities_none' => $activities_none, | ||
| 'activities' => $activities, | ||
| ), true ) ); | ||
| */ | ||
| // --< | ||
| return $activities; | ||
| } | ||
| /** | ||
| * Check if a Contact can be viewed by the current User. | ||
| * | ||
| </ |