/sites/all/modules/contrib/civicrm/CRM/Report/Form/Contact/CurrentEmployer.php
PHP | 394 lines | 295 code | 37 blank | 62 comment | 21 complexity | 004592e7443cfb980be19059e57b8c19 MD5 | raw file
- <?php
- /*
- +--------------------------------------------------------------------+
- | CiviCRM version 5 |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019 |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM. |
- | |
- | CiviCRM is free software; you can copy, modify, and distribute it |
- | under the terms of the GNU Affero General Public License |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
- | |
- | CiviCRM is distributed in the hope that it will be useful, but |
- | WITHOUT ANY WARRANTY; without even the implied warranty of |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
- | See the GNU Affero General Public License for more details. |
- | |
- | You should have received a copy of the GNU Affero General Public |
- | License and the CiviCRM Licensing Exception along |
- | with this program; if not, contact CiviCRM LLC |
- | at info[AT]civicrm[DOT]org. If you have questions about the |
- | GNU Affero General Public License or the licensing of CiviCRM, |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing |
- +--------------------------------------------------------------------+
- */
- /**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2019
- */
- class CRM_Report_Form_Contact_CurrentEmployer extends CRM_Report_Form {
- /**
- * This report has not been optimised for group filtering.
- *
- * The functionality for group filtering has been improved but not
- * all reports have been adjusted to take care of it. This report has not
- * and will run an inefficient query until fixed.
- *
- * CRM-19170
- *
- * @var bool
- */
- protected $groupFilterNotOptimised = TRUE;
- protected $_summary = NULL;
- protected $_customGroupExtends = [
- 'Contact',
- 'Individual',
- ];
- public $_drilldownReport = ['contact/detail' => 'Link to Detail Report'];
- /**
- * Class constructor.
- */
- public function __construct() {
- $this->_columns = [
- 'civicrm_employer' => [
- 'dao' => 'CRM_Contact_DAO_Contact',
- 'fields' => [
- 'organization_name' => [
- 'title' => ts('Employer Name'),
- 'required' => TRUE,
- 'no_repeat' => TRUE,
- ],
- 'id' => [
- 'no_display' => TRUE,
- 'required' => TRUE,
- ],
- ],
- 'filters' => [
- 'organization_name' => [
- 'title' => ts('Employer Name'),
- 'operatorType' => CRM_Report_Form::OP_STRING,
- ],
- ],
- ],
- 'civicrm_contact' => [
- 'dao' => 'CRM_Contact_DAO_Contact',
- 'fields' => [
- 'sort_name' => [
- 'title' => ts('Employee Name'),
- 'required' => TRUE,
- ],
- 'first_name' => [
- 'title' => ts('First Name'),
- ],
- 'middle_name' => [
- 'title' => ts('Middle Name'),
- ],
- 'last_name' => [
- 'title' => ts('Last Name'),
- ],
- 'id' => [
- 'no_display' => TRUE,
- 'required' => TRUE,
- ],
- 'job_title' => [
- 'title' => ts('Job Title'),
- 'default' => TRUE,
- ],
- 'gender_id' => [
- 'title' => ts('Gender'),
- ],
- 'birth_date' => [
- 'title' => ts('Birth Date'),
- ],
- 'age' => [
- 'title' => ts('Age'),
- 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
- ],
- 'contact_type' => [
- 'title' => ts('Contact Type'),
- ],
- 'contact_sub_type' => [
- 'title' => ts('Contact Subtype'),
- ],
- ],
- 'filters' => array_merge($this->getBasicContactFilters(), ['sort_name' => ['title' => ts('Employee Name')]]),
- 'grouping' => 'contact-fields',
- ],
- 'civicrm_relationship' => [
- 'dao' => 'CRM_Contact_DAO_Relationship',
- 'fields' => [
- 'start_date' => [
- 'title' => ts('Employee Since'),
- 'default' => TRUE,
- ],
- ],
- 'filters' => [
- 'start_date' => [
- 'title' => ts('Employee Since'),
- 'operatorType' => CRM_Report_Form::OP_DATE,
- 'type' => CRM_Utils_Type::T_DATE,
- ],
- ],
- ],
- 'civicrm_phone' => [
- 'dao' => 'CRM_Core_DAO_Phone',
- 'grouping' => 'contact-fields',
- 'fields' => [
- 'phone' => [
- 'title' => ts('Phone'),
- 'default' => TRUE,
- ],
- ],
- ],
- 'civicrm_email' => [
- 'dao' => 'CRM_Core_DAO_Email',
- 'grouping' => 'contact-fields',
- 'fields' => [
- 'email' => [
- 'title' => ts('Email'),
- 'default' => TRUE,
- ],
- ],
- ],
- 'civicrm_address' => [
- 'dao' => 'CRM_Core_DAO_Address',
- 'grouping' => 'contact-fields',
- 'fields' => [
- 'street_address' => NULL,
- 'city' => NULL,
- 'postal_code' => NULL,
- 'state_province_id' => [
- 'title' => ts('State/Province'),
- ],
- 'country_id' => [
- 'title' => ts('Country'),
- ],
- ],
- 'filters' => [
- 'country_id' => [
- 'title' => ts('Country'),
- 'type' => CRM_Utils_Type::T_INT,
- 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
- 'options' => CRM_Core_PseudoConstant::country(NULL, FALSE),
- ],
- 'state_province_id' => [
- 'title' => ts('State/Province'),
- 'type' => CRM_Utils_Type::T_INT,
- 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
- 'options' => CRM_Core_PseudoConstant::stateProvince(),
- ],
- ],
- ],
- ];
- $this->_groupFilter = TRUE;
- $this->_tagFilter = TRUE;
- parent::__construct();
- }
- public function preProcess() {
- parent::preProcess();
- }
- public function select() {
- $select = $this->_columnHeaders = [];
- foreach ($this->_columns as $tableName => $table) {
- if (array_key_exists('fields', $table)) {
- foreach ($table['fields'] as $fieldName => $field) {
- if (!empty($field['required']) ||
- !empty($this->_params['fields'][$fieldName])
- ) {
- $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
- $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
- $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
- }
- }
- }
- }
- $this->_selectClauses = $select;
- $this->_select = "SELECT " . implode(', ', $select) . " ";
- }
- public function from() {
- $relType = civicrm_api3('RelationshipType', 'getvalue', [
- 'return' => "id",
- 'name_a_b' => "Employee of",
- 'name_b_a' => "Employer of",
- ]);
- $this->_from = "
- FROM civicrm_contact {$this->_aliases['civicrm_contact']}
- LEFT JOIN civicrm_contact {$this->_aliases['civicrm_employer']}
- ON {$this->_aliases['civicrm_employer']}.id={$this->_aliases['civicrm_contact']}.employer_id
- {$this->_aclFrom}
- LEFT JOIN civicrm_relationship {$this->_aliases['civicrm_relationship']}
- ON ( {$this->_aliases['civicrm_relationship']}.contact_id_a={$this->_aliases['civicrm_contact']}.id
- AND {$this->_aliases['civicrm_relationship']}.contact_id_b={$this->_aliases['civicrm_contact']}.employer_id
- AND {$this->_aliases['civicrm_relationship']}.relationship_type_id={$relType}) ";
- $this->joinAddressFromContact();
- $this->joinPhoneFromContact();
- $this->joinEmailFromContact();
- }
- public function where() {
- $clauses = [];
- foreach ($this->_columns as $tableName => $table) {
- if (array_key_exists('filters', $table)) {
- foreach ($table['filters'] as $fieldName => $field) {
- $clause = NULL;
- if (CRM_Utils_Array::value('operatorType', $field) & CRM_Report_Form::OP_DATE
- ) {
- $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
- $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
- $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
- $clause = $this->dateClause($field['dbAlias'], $relative, $from, $to, $field['type']);
- }
- else {
- $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
- if ($op) {
- $clause = $this->whereClause($field,
- $op,
- CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
- CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
- CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
- );
- }
- }
- if (!empty($clause)) {
- $clauses[$fieldName] = $clause;
- }
- }
- }
- }
- if (empty($clauses)) {
- $this->_where = "WHERE {$this->_aliases['civicrm_contact']}.employer_id!='null' ";
- }
- else {
- $this->_where = "WHERE ({$this->_aliases['civicrm_contact']}.employer_id!='null') AND " . implode(' AND ', $clauses);
- }
- if ($this->_aclWhere) {
- $this->_where .= " AND {$this->_aclWhere} ";
- }
- }
- public function groupBy() {
- $groupBy = [
- "{$this->_aliases['civicrm_employer']}.id",
- "{$this->_aliases['civicrm_contact']}.id",
- ];
- $this->_groupBy = CRM_Contact_BAO_Query::getGroupByFromSelectColumns($this->_selectClauses, $groupBy);
- }
- public function orderBy() {
- $this->_orderBy = "ORDER BY {$this->_aliases['civicrm_employer']}.organization_name, {$this->_aliases['civicrm_contact']}.display_name";
- }
- public function postProcess() {
- // get the acl clauses built before we assemble the query
- $this->buildACLClause([
- $this->_aliases['civicrm_contact'],
- $this->_aliases['civicrm_employer'],
- ]);
- parent::postProcess();
- }
- /**
- * Alter display of rows.
- *
- * Iterate through the rows retrieved via SQL and make changes for display purposes,
- * such as rendering contacts as links.
- *
- * @param array $rows
- * Rows generated by SQL, with an array for each row.
- */
- public function alterDisplay(&$rows) {
- $checkList = [];
- $entryFound = FALSE;
- foreach ($rows as $rowNum => $row) {
- // convert employer name to links
- if (array_key_exists('civicrm_employer_organization_name', $row) &&
- array_key_exists('civicrm_employer_id', $row)
- ) {
- $url = CRM_Report_Utils_Report::getNextUrl('contact/detail',
- 'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_employer_id'],
- $this->_absoluteUrl, $this->_id, $this->_drilldownReport
- );
- $rows[$rowNum]['civicrm_employer_organization_name_link'] = $url;
- $rows[$rowNum]['civicrm_employer_organization_name_hover'] = ts('View Contact Detail Report for this contact');
- $entryFound = TRUE;
- }
- if (!empty($this->_noRepeats) && $this->_outputMode != 'csv') {
- // not repeat contact display names if it matches with the one
- // in previous row
- foreach ($row as $colName => $colVal) {
- if (!empty($checkList[$colName]) && is_array($checkList[$colName]) &&
- in_array($colVal, $checkList[$colName])
- ) {
- $rows[$rowNum][$colName] = "";
- }
- if (in_array($colName, $this->_noRepeats)) {
- $checkList[$colName][] = $colVal;
- }
- }
- }
- // Handle ID to label conversion for contact fields
- $entryFound = $this->alterDisplayContactFields($row, $rows, $rowNum, 'contact/currentEmployer', 'View Contact Detail') ? TRUE : $entryFound;
- $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, NULL, NULL) ? TRUE : $entryFound;
- // display birthday in the configured custom format
- if (array_key_exists('civicrm_contact_birth_date', $row)) {
- $birthDate = $row['civicrm_contact_birth_date'];
- if ($birthDate) {
- $rows[$rowNum]['civicrm_contact_birth_date'] = CRM_Utils_Date::customFormat($birthDate, '%Y%m%d');
- }
- $entryFound = TRUE;
- }
- // convert employee name to links
- if (array_key_exists('civicrm_contact_sort_name', $row) &&
- array_key_exists('civicrm_contact_id', $row)
- ) {
- $url = CRM_Report_Utils_Report::getNextUrl('contact/detail',
- 'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_contact_id'],
- $this->_absoluteUrl, $this->_id, $this->_drilldownReport
- );
- $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
- $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts('View Contact Detail Report for this contact');
- $entryFound = TRUE;
- }
- // skip looking further in rows, if first row itself doesn't
- // have the column we need
- if (!$entryFound) {
- break;
- }
- }
- }
- }