[civicrm-core.git] / CRM / Report / Form / Event / ParticipantListCount.php

<?php
// $Id$

/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.3		                         				  |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2013							      |
 +--------------------------------------------------------------------+
 | 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-2013
 * $Id$
 *
 */
class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event {

  protected $_summary = NULL;

  protected $_customGroupExtends = array(
    'Participant'); 

  public $_drilldownReport = array('event/income' => 'Link to Detail Report');
  function __construct() {
    $this->_columns = array(
      'civicrm_contact' =>
      array(
        'dao' => 'CRM_Contact_DAO_Contact',
        'fields' =>
        array(
          'sort_name' =>
          array('title' => ts('Name'),
            'default' => TRUE,
            'no_repeat' => TRUE,
            'required' => TRUE,
          ),
          'id' =>
          array(
            'no_display' => TRUE,
            'required' => TRUE,
          ),
        ),
        'grouping' => 'contact-fields',
        'filters' => array(
          'sort_name' =>
          array('title' => ts('Participant Name'),
            'operator' => 'like',
          ),
        ),
      ),
      'civicrm_email' =>
      array(
        'dao' => 'CRM_Core_DAO_Email',
        'fields' => array(
          'email' =>
          array('title' => ts('Email'),
            'no_repeat' => TRUE,
          ),
        ),
        'grouping' => 'contact-fields',
        'filters' =>
        array(
          'email' =>
          array('title' => ts('Participant E-mail'),
            'operator' => 'like',
          ),
        ),
      ),
     'civicrm_phone' =>
     array( 
       'dao' => 'CRM_Core_DAO_Phone',
       'grouping' => 'contact-fields',
       'fields' => array( 
         'phone' => array(
           'title' => ts( 'Phone No' ),
           'default' => true,
         ),
       ), 
     ),
     'civicrm_address' =>
      array(
        'dao' => 'CRM_Core_DAO_Address',
        'fields' =>
        array(
          'street_address' => NULL,
        ),
        'grouping' => 'contact-fields',
      ),
      'civicrm_participant' =>
      array(
        'dao' => 'CRM_Event_DAO_Participant',
        'fields' =>
        array(
          'participant_id' =>
          array('title' => ts('Participant ID'),
            'default' => TRUE,
          ),
          'event_id' =>
          array('title' => ts('Event'),
            'type' => CRM_Utils_Type::T_STRING,
          ),
          'role_id' =>
          array('title' => ts('Role'),
            'default' => TRUE,
          ),
          'status_id' =>
          array('title' => ts('Status'),
            'default' => TRUE,
          ),
          'participant_register_date' =>
          array('title' => ts('Registration Date'),
          ),
        ),
        'grouping' => 'event-fields',
        'filters' =>
        array(
          'event_id' =>
          array(
            'name' => 'event_id',
            'title' => ts('Event'),
            'operatorType' => CRM_Report_Form::OP_MULTISELECT,
            'options' => $this->getEventFilterOptions(),
          ),
          'sid' =>
          array(
            'name' => 'status_id',
            'title' => ts('Participant Status'),
            'operatorType' => CRM_Report_Form::OP_MULTISELECT,
            'options' => CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label'),
          ),
          'rid' =>
          array(
            'name' => 'role_id',
            'title' => ts('Participant Role'),
            'operatorType' => CRM_Report_Form::OP_MULTISELECT,
            'options' => CRM_Event_PseudoConstant::participantRole(),
          ),
          'participant_register_date' => array('title' => ts('Registration Date'),
            'operatorType' => CRM_Report_Form::OP_DATE,
          ),
        ),
        'group_bys' =>
        array(
          'event_id' =>
          array('title' => ts('Event'),
          ),
        ),
      ),
      'civicrm_event' =>
      array(
        'dao' => 'CRM_Event_DAO_Event',
        'fields' =>
        array(
          'event_type_id' =>
          array('title' => ts('Event Type'),
          ),
          'start_date' =>
          array('title' => ts('Event Start Date'),
          ),
          'end_date' =>
          array('title' => ts('Event End Date'),
          ),
        ),
        'grouping' => 'event-fields',
        'filters' => array(
          'eid' =>
          array(
            'name' => 'event_type_id',
            'title' => ts('Event Type'),
            'operatorType' => CRM_Report_Form::OP_MULTISELECT,
            'options' => CRM_Core_OptionGroup::values('event_type'),
          ),
          'event_start_date' =>
          array(
            'name' => 'start_date',
            'title' => ts('Event Start Date'),
            'operatorType' => CRM_Report_Form::OP_DATE,
          ),
          'event_end_date' =>
          array(
            'name' => 'end_date',
            'title' => ts('Event End Date'),
            'operatorType' => CRM_Report_Form::OP_DATE,
          ),
        ),
        'group_bys' =>
        array(
          'event_type_id' =>
          array('title' => ts('Event Type '),
          ),
        ),
      ),
      'civicrm_line_item' =>
      array(
        'dao' => 'CRM_Price_DAO_LineItem',
        'fields' =>
        array(
          'line_total' =>
          array('title' => ts('Income'),
            'default' => TRUE,
            'statistics' =>
            array('sum' => ts('Amount'),
              'avg' => ts('Average'),
            ),
          ),
          'participant_count' =>
          array('title' => ts('Count'),
            'default' => TRUE,
            'statistics' =>
            array('sum' => ts('Count'),
            ),
          ),
        ),
      ),
    );

    $this->_options = array(
      'blank_column_begin' =>
      array('title' => ts('Blank column at the Begining'),
        'type' => 'checkbox',
      ),
      'blank_column_end' =>
      array('title' => ts('Blank column at the End'),
        'type' => 'select',
        'options' => array(
          '' => '-select-',
          1 => ts('One'),
          2 => ts('Two'),
          3 => ts('Three'),
        ),
      ),
    );
    parent::__construct();
  }

  function preProcess() {
    parent::preProcess();
  }

  //Add The statistics
  function statistics(&$rows) {

    $statistics = parent::statistics($rows);
    $avg        = NULL;
    $select     = " SELECT SUM( {$this->_aliases['civicrm_line_item']}.participant_count ) as count,
									SUM( {$this->_aliases['civicrm_line_item']}.line_total )	 as amount
						";
    $sql = "{$select} {$this->_from} {$this->_where}";
    $dao = CRM_Core_DAO::executeQuery($sql);
    if ($dao->fetch()) {

      if ($dao->count && $dao->amount) {
        $avg = $dao->amount / $dao->count;
      }
      $statistics['counts']['count'] = array(
        'value' => $dao->count,
        'title' => 'Total Participants',
        'type' => CRM_Utils_Type::T_INT,
      );
      $statistics['counts']['amount'] = array(
        'value' => $dao->amount,
        'title' => 'Total Income',
        'type' => CRM_Utils_Type::T_MONEY,
      );
      $statistics['counts']['avg	  '] = array(
        'value' => $avg,
        'title' => 'Average',
        'type' => CRM_Utils_Type::T_MONEY,
      );
    }

    return $statistics;
  }

  function select() {
    $select = array();
    $this->_columnHeaders = array();

    //add blank column at the Start
    if (array_key_exists('options', $this->_params) && CRM_Utils_Array::value('blank_column_begin', $this->_params['options'])) {
      $select[] = " '' as blankColumnBegin";
      $this->_columnHeaders['blankColumnBegin']['title'] = '_ _ _ _';
    }
    foreach ($this->_columns as $tableName => $table) {
      if (array_key_exists('fields', $table)) {
        foreach ($table['fields'] as $fieldName => $field) {
          if (CRM_Utils_Array::value('required', $field) ||
            CRM_Utils_Array::value($fieldName, $this->_params['fields'])
          ) {
            if (CRM_Utils_Array::value('statistics', $field)) {
              foreach ($field['statistics'] as $stat => $label) {
                switch (strtolower($stat)) {
                  case 'sum':
                    $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
                    $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
                    $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
                    $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}";
                    break;
                }
              }
            }
            else {
              $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
              $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
              $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $field['title'];
            }
          }
        }
      }
    }
    //add blank column at the end
    if ($blankcols = CRM_Utils_Array::value('blank_column_end', $this->_params)) {
      for ($i = 1; $i <= $blankcols; $i++) {
        $select[] = " '' as blankColumnEnd_{$i}";
        $this->_columnHeaders["blank_{$i}"]['title'] = "_ _ _ _";
      }
    }
    $this->_select = "SELECT " . implode(', ', $select) . " ";
  }

  static function formRule($fields, $files, $self) {
    $errors = $grouping = array();
    return $errors;
  }

  function from() {
    $this->_from = "
		  FROM civicrm_participant {$this->_aliases['civicrm_participant']}
				 LEFT JOIN civicrm_event {$this->_aliases['civicrm_event']} 
						  ON ({$this->_aliases['civicrm_event']}.id = {$this->_aliases['civicrm_participant']}.event_id ) AND ({$this->_aliases['civicrm_event']}.is_template IS NULL OR {$this->_aliases['civicrm_event']}.is_template = 0)
				 LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} 
						  ON ({$this->_aliases['civicrm_participant']}.contact_id  = {$this->_aliases['civicrm_contact']}.id	)
				 {$this->_aclFrom}
				 LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
						  ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id AND 
							  {$this->_aliases['civicrm_address']}.is_primary = 1 
				 LEFT JOIN	civicrm_email {$this->_aliases['civicrm_email']} 
						  ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND
							  {$this->_aliases['civicrm_email']}.is_primary = 1) 
         LEFT  JOIN civicrm_phone  {$this->_aliases['civicrm_phone']} 
              ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND
                {$this->_aliases['civicrm_phone']}.is_primary = 1
				 LEFT JOIN civicrm_line_item {$this->_aliases['civicrm_line_item']}
						  ON {$this->_aliases['civicrm_participant']}.id ={$this->_aliases['civicrm_line_item']}.entity_id AND {$this->_aliases['civicrm_line_item']}.entity_table = 'civicrm_participant'";
  }

  function where() {
    $clauses = array();
    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('type', $field) & CRM_Utils_Type::T_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);

            if ($relative || $from || $to) {
              $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
            }
          }
          else {
            $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);

            if ($fieldName == 'rid') {
              $value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
              if (!empty($value)) {
                $clause = "( {$field['dbAlias']} REGEXP '[[:<:]]" . implode('[[:>:]]|[[:<:]]', $value) . "[[:>:]]' )";
              }
              $op = NULL;
            }

            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[] = $clause;
          }
        }
      }
    }

    if (empty($clauses)) {
      $this->_where = "WHERE {$this->_aliases['civicrm_participant']}.is_test = 0 ";
    }
    else {
      $this->_where = "WHERE {$this->_aliases['civicrm_participant']}.is_test = 0 AND " . implode(' AND ', $clauses);
    }
    if ($this->_aclWhere) {
      $this->_where .= " AND {$this->_aclWhere} ";
    }
  }

  function groupBy() {
    $this->_groupBy = "";
    if (CRM_Utils_Array::value('group_bys', $this->_params) &&
      is_array($this->_params['group_bys']) &&
      !empty($this->_params['group_bys'])
    ) {
      foreach ($this->_columns as $tableName => $table) {
        if (array_key_exists('group_bys', $table)) {
          foreach ($table['group_bys'] as $fieldName => $field) {
            if (CRM_Utils_Array::value($fieldName, $this->_params['group_bys'])) {
              $this->_groupBy[] = $field['dbAlias'];
            }
          }
        }
      }
    }

    if (!empty($this->_groupBy)) {
      $this->_groupBy = "ORDER BY " . implode(', ', $this->_groupBy) . ", {$this->_aliases['civicrm_contact']}.sort_name";
    }
    else {
      $this->_groupBy = "ORDER BY {$this->_aliases['civicrm_contact']}.sort_name";
    }
    $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_participant']}.id " . $this->_groupBy;
  }

  function postProcess() {

    // get ready with post process params
    $this->beginPostProcess();

    // get the acl clauses built before we assemble the query
    $this->buildACLClause($this->_aliases['civicrm_contact']);
    // build query
    $sql = $this->buildQuery(TRUE);

    // build array of result based on column headers. This method also allows
    // modifying column headers before using it to build result set i.e $rows.
    $this->buildRows($sql, $rows);

    // format result set.
    $this->formatDisplay($rows);

    // assign variables to templates
    $this->doTemplateAssignment($rows);

    // do print / pdf / instance stuff if needed
    $this->endPostProcess($rows);
  }

  function alterDisplay(&$rows) {

    $entryFound = FALSE;
    $eventType = CRM_Core_OptionGroup::values('event_type');

    foreach ($rows as $rowNum => $row) {

      // convert sort name to links
      if (array_key_exists('civicrm_contact_sort_name', $row) &&
        array_key_exists('civicrm_contact_id', $row)
      ) {
        if ($value = $row['civicrm_contact_sort_name']) {
          $url = CRM_Utils_System::url("civicrm/contact/view",
            'reset=1&cid=' . $row['civicrm_contact_id'],
            $this->_absoluteUrl
          );
          $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
          $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
        }
        $entryFound = TRUE;
      }

      // convert participant ID to links
      if (array_key_exists('civicrm_participant_participant_id', $row) &&
        array_key_exists('civicrm_contact_id', $row)
      ) {
        if ($value = $row['civicrm_participant_participant_id']) {
          $url = CRM_Utils_System::url("civicrm/contact/view/participant",
            'reset=1&id=' . $row['civicrm_participant_participant_id'] . '&cid=' . $row['civicrm_contact_id'] . '&action=view&context=participant',
            $this->_absoluteUrl
          );
          $rows[$rowNum]['civicrm_participant_participant_id_link'] = $url;
          $rows[$rowNum]['civicrm_participant_participant_id_hover'] = ts("View Participant Record for this Contact.");
        }
        $entryFound = TRUE;
      }

      // convert event name to links
      if (array_key_exists('civicrm_participant_event_id', $row)) {
        if ($value = $row['civicrm_participant_event_id']) {
          $rows[$rowNum]['civicrm_participant_event_id'] = CRM_Event_PseudoConstant::event($value, FALSE);
          $url = CRM_Report_Utils_Report::getNextUrl('event/Income',
            'reset=1&force=1&event_id_op=eq&event_id_value=' . $value,
            $this->_absoluteUrl, $this->_id, $this->_drilldownReport
          );
          $rows[$rowNum]['civicrm_participant_event_id_link'] = $url;
          $rows[$rowNum]['civicrm_participant_event_id_hover'] = ts("View Event Income Details for this Event");
        }
        $entryFound = TRUE;
      }

      // handle event type id
      if (array_key_exists('civicrm_event_event_type_id', $row)) {
        if ($value = $row['civicrm_event_event_type_id']) {
          $rows[$rowNum]['civicrm_event_event_type_id'] = $eventType[$value];
        }
        $entryFound = TRUE;
      }

      // handle participant status id
      if (array_key_exists('civicrm_participant_status_id', $row)) {
        if ($value = $row['civicrm_participant_status_id']) {
          $rows[$rowNum]['civicrm_participant_status_id'] = CRM_Event_PseudoConstant::participantStatus($value, FALSE);
        }
        $entryFound = TRUE;
      }

      // handle participant role id
      if (array_key_exists('civicrm_participant_role_id', $row)) {
        if ($value = $row['civicrm_participant_role_id']) {
          $roles = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
          $value = array();
          foreach ($roles as $role) {
            $value[$role] = CRM_Event_PseudoConstant::participantRole($role, FALSE);
          }
          $rows[$rowNum]['civicrm_participant_role_id'] = implode(', ', $value);
        }
        $entryFound = TRUE;
      }


      // skip looking further in rows, if first row itself doesn't
      // have the column we need
      if (!$entryFound) {
        break;
      }
    }
  }
}
Commit	Line	Data
6a488035 TO	1	<?php
	2	// $Id$
	3
	4	/*
	5	+--------------------------------------------------------------------+
	6	\| CiviCRM version 4.3 \|
	7	+--------------------------------------------------------------------+
	8	\| Copyright CiviCRM LLC (c) 2004-2013 \|
	9	+--------------------------------------------------------------------+
	10	\| This file is a part of CiviCRM. \|
	11	\| \|
	12	\| CiviCRM is free software; you can copy, modify, and distribute it \|
	13	\| under the terms of the GNU Affero General Public License \|
	14	\| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. \|
	15	\| \|
	16	\| CiviCRM is distributed in the hope that it will be useful, but \|
	17	\| WITHOUT ANY WARRANTY; without even the implied warranty of \|
	18	\| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. \|
	19	\| See the GNU Affero General Public License for more details. \|
	20	\| \|
	21	\| You should have received a copy of the GNU Affero General Public \|
	22	\| License and the CiviCRM Licensing Exception along \|
	23	\| with this program; if not, contact CiviCRM LLC \|
	24	\| at info[AT]civicrm[DOT]org. If you have questions about the \|
	25	\| GNU Affero General Public License or the licensing of CiviCRM, \|
	26	\| see the CiviCRM license FAQ at http://civicrm.org/licensing \|
	27	+--------------------------------------------------------------------+
	28	*/
	29
	30	/**
	31	*
	32	* @package CRM
	33	* @copyright CiviCRM LLC (c) 2004-2013
	34	* $Id$
	35	*
	36	*/
	37	class CRM_Report_Form_Event_ParticipantListCount extends CRM_Report_Form_Event {
	38
	39	protected $_summary = NULL;
	40
	41	protected $_customGroupExtends = array(
	42	'Participant');
	43
	44	public $_drilldownReport = array('event/income' => 'Link to Detail Report');
	45	function __construct() {
	46	$this->_columns = array(
	47	'civicrm_contact' =>
	48	array(
	49	'dao' => 'CRM_Contact_DAO_Contact',
	50	'fields' =>
	51	array(
	52	'sort_name' =>
	53	array('title' => ts('Name'),
	54	'default' => TRUE,
	55	'no_repeat' => TRUE,
	56	'required' => TRUE,
	57	),
	58	'id' =>
	59	array(
	60	'no_display' => TRUE,
	61	'required' => TRUE,
	62	),
	63	),
	64	'grouping' => 'contact-fields',
65	'filters' => array(
66	'sort_name' =>
67	array('title' => ts('Participant Name'),
68	'operator' => 'like',
69	),
70	),
71	),
72	'civicrm_email' =>
73	array(
74	'dao' => 'CRM_Core_DAO_Email',
75	'fields' => array(
76	'email' =>
77	array('title' => ts('Email'),
78	'no_repeat' => TRUE,
79	),
80	),
81	'grouping' => 'contact-fields',
82	'filters' =>
83	array(
84	'email' =>
85	array('title' => ts('Participant E-mail'),
86	'operator' => 'like',
87	),
88	),
89	),
90	'civicrm_phone' =>
91	array(
92	'dao' => 'CRM_Core_DAO_Phone',
93	'grouping' => 'contact-fields',
94	'fields' => array(
95	'phone' => array(
96	'title' => ts( 'Phone No' ),
97	'default' => true,
98	),
99	),
100	),
101	'civicrm_address' =>
102	array(
103	'dao' => 'CRM_Core_DAO_Address',
104	'fields' =>
105	array(
106	'street_address' => NULL,
107	),
108	'grouping' => 'contact-fields',
109	),
110	'civicrm_participant' =>
111	array(
112	'dao' => 'CRM_Event_DAO_Participant',
113	'fields' =>
114	array(
115	'participant_id' =>
116	array('title' => ts('Participant ID'),
117	'default' => TRUE,
118	),
119	'event_id' =>
120	array('title' => ts('Event'),
121	'type' => CRM_Utils_Type::T_STRING,
122	),
123	'role_id' =>
124	array('title' => ts('Role'),
125	'default' => TRUE,
126	),
127	'status_id' =>
128	array('title' => ts('Status'),
129	'default' => TRUE,
130	),
131	'participant_register_date' =>
132	array('title' => ts('Registration Date'),
133	),
134	),
135	'grouping' => 'event-fields',
136	'filters' =>
137	array(
138	'event_id' =>
139	array(
140	'name' => 'event_id',
141	'title' => ts('Event'),
142	'operatorType' => CRM_Report_Form::OP_MULTISELECT,
143	'options' => $this->getEventFilterOptions(),
144	),
145	'sid' =>
146	array(
147	'name' => 'status_id',
148	'title' => ts('Participant Status'),
149	'operatorType' => CRM_Report_Form::OP_MULTISELECT,
150	'options' => CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label'),
151	),
152	'rid' =>
153	array(
154	'name' => 'role_id',
155	'title' => ts('Participant Role'),
156	'operatorType' => CRM_Report_Form::OP_MULTISELECT,
157	'options' => CRM_Event_PseudoConstant::participantRole(),
158	),
159	'participant_register_date' => array('title' => ts('Registration Date'),
160	'operatorType' => CRM_Report_Form::OP_DATE,
161	),
162	),
163	'group_bys' =>
164	array(
165	'event_id' =>
166	array('title' => ts('Event'),
167	),
168	),
169	),
170	'civicrm_event' =>
171	array(
172	'dao' => 'CRM_Event_DAO_Event',
173	'fields' =>
174	array(
175	'event_type_id' =>
176	array('title' => ts('Event Type'),
177	),
178	'start_date' =>
179	array('title' => ts('Event Start Date'),
180	),
181	'end_date' =>
182	array('title' => ts('Event End Date'),
183	),
184	),
185	'grouping' => 'event-fields',
186	'filters' => array(
187	'eid' =>
188	array(
189	'name' => 'event_type_id',
190	'title' => ts('Event Type'),
191	'operatorType' => CRM_Report_Form::OP_MULTISELECT,
192	'options' => CRM_Core_OptionGroup::values('event_type'),
193	),
194	'event_start_date' =>
195	array(
196	'name' => 'start_date',
197	'title' => ts('Event Start Date'),
198	'operatorType' => CRM_Report_Form::OP_DATE,
199	),
200	'event_end_date' =>
201	array(
202	'name' => 'end_date',
203	'title' => ts('Event End Date'),
204	'operatorType' => CRM_Report_Form::OP_DATE,
205	),
206	),
207	'group_bys' =>
208	array(
209	'event_type_id' =>
210	array('title' => ts('Event Type '),
211	),
212	),
213	),
214	'civicrm_line_item' =>
215	array(
216	'dao' => 'CRM_Price_DAO_LineItem',
217	'fields' =>
218	array(
219	'line_total' =>
220	array('title' => ts('Income'),
221	'default' => TRUE,
222	'statistics' =>
223	array('sum' => ts('Amount'),
224	'avg' => ts('Average'),
225	),
226	),
227	'participant_count' =>
228	array('title' => ts('Count'),
229	'default' => TRUE,
230	'statistics' =>
231	array('sum' => ts('Count'),
232	),
233	),
234	),
235	),
236	);
237
238	$this->_options = array(
239	'blank_column_begin' =>
240	array('title' => ts('Blank column at the Begining'),
241	'type' => 'checkbox',
242	),
243	'blank_column_end' =>
244	array('title' => ts('Blank column at the End'),
245	'type' => 'select',
246	'options' => array(
247	'' => '-select-',
248	1 => ts('One'),
249	2 => ts('Two'),
250	3 => ts('Three'),
251	),
252	),
253	);
254	parent::__construct();
255	}
256
257	function preProcess() {
258	parent::preProcess();
259	}
260
261	//Add The statistics
262	function statistics(&$rows) {
263
264	$statistics = parent::statistics($rows);
265	$avg = NULL;
266	$select = " SELECT SUM( {$this->_aliases['civicrm_line_item']}.participant_count ) as count,
267	SUM( {$this->_aliases['civicrm_line_item']}.line_total ) as amount
268	";
269	$sql = "{$select} {$this->_from} {$this->_where}";
270	$dao = CRM_Core_DAO::executeQuery($sql);
271	if ($dao->fetch()) {
272
273	if ($dao->count && $dao->amount) {
274	$avg = $dao->amount / $dao->count;
275	}
276	$statistics['counts']['count'] = array(
277	'value' => $dao->count,
278	'title' => 'Total Participants',
279	'type' => CRM_Utils_Type::T_INT,
280	);
281	$statistics['counts']['amount'] = array(
282	'value' => $dao->amount,
283	'title' => 'Total Income',
284	'type' => CRM_Utils_Type::T_MONEY,
285	);
286	$statistics['counts']['avg '] = array(
287	'value' => $avg,
288	'title' => 'Average',
289	'type' => CRM_Utils_Type::T_MONEY,
290	);
291	}
292
293	return $statistics;
294	}
295
296	function select() {
297	$select = array();
298	$this->_columnHeaders = array();
299
300	//add blank column at the Start
301	if (array_key_exists('options', $this->_params) && CRM_Utils_Array::value('blank_column_begin', $this->_params['options'])) {
302	$select[] = " '' as blankColumnBegin";
303	$this->_columnHeaders['blankColumnBegin']['title'] = '_ _ _ _';
304	}
305	foreach ($this->_columns as $tableName => $table) {
306	if (array_key_exists('fields', $table)) {
307	foreach ($table['fields'] as $fieldName => $field) {
308	if (CRM_Utils_Array::value('required', $field) \|\|
309	CRM_Utils_Array::value($fieldName, $this->_params['fields'])
310	) {
311	if (CRM_Utils_Array::value('statistics', $field)) {
312	foreach ($field['statistics'] as $stat => $label) {
313	switch (strtolower($stat)) {
314	case 'sum':
315	$select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
316	$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
317	$this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
318	$this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}";
319	break;
320	}
321	}
322	}
323	else {
324	$select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
325	$this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
326	$this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = $field['title'];
327	}
328	}
329	}
330	}
331	}
332	//add blank column at the end
333	if ($blankcols = CRM_Utils_Array::value('blank_column_end', $this->_params)) {
334	for ($i = 1; $i <= $blankcols; $i++) {
335	$select[] = " '' as blankColumnEnd_{$i}";
336	$this->_columnHeaders["blank_{$i}"]['title'] = "_ _ _ _";
337	}
338	}
339	$this->_select = "SELECT " . implode(', ', $select) . " ";
340	}
341
342	static function formRule($fields, $files, $self) {
343	$errors = $grouping = array();
344	return $errors;
345	}
346
347	function from() {
348	$this->_from = "
349	FROM civicrm_participant {$this->_aliases['civicrm_participant']}
350	LEFT JOIN civicrm_event {$this->_aliases['civicrm_event']}
351	ON ({$this->_aliases['civicrm_event']}.id = {$this->_aliases['civicrm_participant']}.event_id ) AND ({$this->_aliases['civicrm_event']}.is_template IS NULL OR {$this->_aliases['civicrm_event']}.is_template = 0)
352	LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']}
353	ON ({$this->_aliases['civicrm_participant']}.contact_id = {$this->_aliases['civicrm_contact']}.id )
354	{$this->_aclFrom}
355	LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
356	ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id AND
357	{$this->_aliases['civicrm_address']}.is_primary = 1
358	LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
359	ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND
360	{$this->_aliases['civicrm_email']}.is_primary = 1)
361	LEFT JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
362	ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND
363	{$this->_aliases['civicrm_phone']}.is_primary = 1
364	LEFT JOIN civicrm_line_item {$this->_aliases['civicrm_line_item']}
365	ON {$this->_aliases['civicrm_participant']}.id ={$this->_aliases['civicrm_line_item']}.entity_id AND {$this->_aliases['civicrm_line_item']}.entity_table = 'civicrm_participant'";
366	}
367
368	function where() {
369	$clauses = array();
370	foreach ($this->_columns as $tableName => $table) {
371	if (array_key_exists('filters', $table)) {
372	foreach ($table['filters'] as $fieldName => $field) {
373	$clause = NULL;
374	if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
375	$relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
376	$from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
377	$to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
378
379	if ($relative \|\| $from \|\| $to) {
380	$clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
381	}
382	}
383	else {
384	$op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
385
386	if ($fieldName == 'rid') {
387	$value = CRM_Utils_Array::value("{$fieldName}_value", $this->_params);
388	if (!empty($value)) {
389	$clause = "( {$field['dbAlias']} REGEXP '[[:<:]]" . implode('[[:>:]]\|[[:<:]]', $value) . "[[:>:]]' )";
390	}
391	$op = NULL;
392	}
393
394	if ($op) {
395	$clause = $this->whereClause($field,
396	$op,
397	CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
398	CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
399	CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
400	);
401	}
402	}
403
404	if (!empty($clause)) {
405	$clauses[] = $clause;
406	}
407	}
408	}
409	}
410
411	if (empty($clauses)) {
412	$this->_where = "WHERE {$this->_aliases['civicrm_participant']}.is_test = 0 ";
413	}
414	else {
415	$this->_where = "WHERE {$this->_aliases['civicrm_participant']}.is_test = 0 AND " . implode(' AND ', $clauses);
416	}
417	if ($this->_aclWhere) {
418	$this->_where .= " AND {$this->_aclWhere} ";
419	}
420	}
421
422	function groupBy() {
423	$this->_groupBy = "";
424	if (CRM_Utils_Array::value('group_bys', $this->_params) &&
425	is_array($this->_params['group_bys']) &&
426	!empty($this->_params['group_bys'])
427	) {
428	foreach ($this->_columns as $tableName => $table) {
429	if (array_key_exists('group_bys', $table)) {
430	foreach ($table['group_bys'] as $fieldName => $field) {
431	if (CRM_Utils_Array::value($fieldName, $this->_params['group_bys'])) {
432	$this->_groupBy[] = $field['dbAlias'];
433	}
434	}
435	}
436	}
437	}
438
439	if (!empty($this->_groupBy)) {
440	$this->_groupBy = "ORDER BY " . implode(', ', $this->_groupBy) . ", {$this->_aliases['civicrm_contact']}.sort_name";
441	}
442	else {
443	$this->_groupBy = "ORDER BY {$this->_aliases['civicrm_contact']}.sort_name";
444	}
445	$this->_groupBy = "GROUP BY {$this->_aliases['civicrm_participant']}.id " . $this->_groupBy;
446	}
447
448	function postProcess() {
449
450	// get ready with post process params
451	$this->beginPostProcess();
452
453	// get the acl clauses built before we assemble the query
454	$this->buildACLClause($this->_aliases['civicrm_contact']);
455	// build query
456	$sql = $this->buildQuery(TRUE);
457
458	// build array of result based on column headers. This method also allows
459	// modifying column headers before using it to build result set i.e $rows.
460	$this->buildRows($sql, $rows);
461
462	// format result set.
463	$this->formatDisplay($rows);
464
465	// assign variables to templates
466	$this->doTemplateAssignment($rows);
467
468	// do print / pdf / instance stuff if needed
469	$this->endPostProcess($rows);
470	}
471
472	function alterDisplay(&$rows) {
473
474	$entryFound = FALSE;
475	$eventType = CRM_Core_OptionGroup::values('event_type');
476
477	foreach ($rows as $rowNum => $row) {
478
479	// convert sort name to links
480	if (array_key_exists('civicrm_contact_sort_name', $row) &&
481	array_key_exists('civicrm_contact_id', $row)
482	) {
483	if ($value = $row['civicrm_contact_sort_name']) {
484	$url = CRM_Utils_System::url("civicrm/contact/view",
485	'reset=1&cid=' . $row['civicrm_contact_id'],
486	$this->_absoluteUrl
487	);
488	$rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
489	$rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
490	}
491	$entryFound = TRUE;
492	}
493
494	// convert participant ID to links
495	if (array_key_exists('civicrm_participant_participant_id', $row) &&
496	array_key_exists('civicrm_contact_id', $row)
497	) {
498	if ($value = $row['civicrm_participant_participant_id']) {
499	$url = CRM_Utils_System::url("civicrm/contact/view/participant",
500	'reset=1&id=' . $row['civicrm_participant_participant_id'] . '&cid=' . $row['civicrm_contact_id'] . '&action=view&context=participant',
501	$this->_absoluteUrl
502	);
503	$rows[$rowNum]['civicrm_participant_participant_id_link'] = $url;
504	$rows[$rowNum]['civicrm_participant_participant_id_hover'] = ts("View Participant Record for this Contact.");
505	}
506	$entryFound = TRUE;
507	}
508
509	// convert event name to links
510	if (array_key_exists('civicrm_participant_event_id', $row)) {
511	if ($value = $row['civicrm_participant_event_id']) {
512	$rows[$rowNum]['civicrm_participant_event_id'] = CRM_Event_PseudoConstant::event($value, FALSE);
513	$url = CRM_Report_Utils_Report::getNextUrl('event/Income',
514	'reset=1&force=1&event_id_op=eq&event_id_value=' . $value,
515	$this->_absoluteUrl, $this->_id, $this->_drilldownReport
516	);
517	$rows[$rowNum]['civicrm_participant_event_id_link'] = $url;
518	$rows[$rowNum]['civicrm_participant_event_id_hover'] = ts("View Event Income Details for this Event");
519	}
520	$entryFound = TRUE;
521	}
522
523	// handle event type id
524	if (array_key_exists('civicrm_event_event_type_id', $row)) {
525	if ($value = $row['civicrm_event_event_type_id']) {
526	$rows[$rowNum]['civicrm_event_event_type_id'] = $eventType[$value];
527	}
528	$entryFound = TRUE;
529	}
530
531	// handle participant status id
532	if (array_key_exists('civicrm_participant_status_id', $row)) {
533	if ($value = $row['civicrm_participant_status_id']) {
534	$rows[$rowNum]['civicrm_participant_status_id'] = CRM_Event_PseudoConstant::participantStatus($value, FALSE);
535	}
536	$entryFound = TRUE;
537	}
538
539	// handle participant role id
540	if (array_key_exists('civicrm_participant_role_id', $row)) {
541	if ($value = $row['civicrm_participant_role_id']) {
542	$roles = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value);
543	$value = array();
544	foreach ($roles as $role) {
545	$value[$role] = CRM_Event_PseudoConstant::participantRole($role, FALSE);
546	}
547	$rows[$rowNum]['civicrm_participant_role_id'] = implode(', ', $value);
548	}
549	$entryFound = TRUE;
550	}
551
552
553	// skip looking further in rows, if first row itself doesn't
554	// have the column we need
555	if (!$entryFound) {
556	break;
557	}
558	}
559	}
560	}
561