/**
* This function is a singleton method used to instantiate the EEM_Status object
*
* @access public
* @return EEM_Status instance
*/
public static function instance()
{
// check if instance of EEM_Status already exists
if (!self::$_instance instanceof EEM_Status) {
// instantiate Espresso_model
self::$_instance = new self();
}
// EEM_Status object
return self::$_instance;
}
/**
* This generates the dummy relation objects for use in a new registration.
*
* @since 4.3.0
*
* @param array $args
*/
private function _set_new_relations($args)
{
//transaction
$this->_transaction = empty($args['TXN_ID']) ? $this->factory->transaction->create() : EEM_Transaction::instance()->get_one_by_ID($args['TXN_ID']);
$this->_transaction = empty($this->_transaction) ? $this->factory->transaction->create() : $this->_transaction;
//ticket
$this->_ticket = empty($args['TKT_ID']) ? $this->factory->ticket_chained->create() : EEM_Ticket::instance()->get_one_by_ID($args['TKT_ID']);
$this->_ticket = empty($this->_ticket) ? $this->factory->ticket_chained->create() : $this->_ticket;
//attendee
$this->_attendee = empty($args['ATT_ID']) ? $this->factory->attendee->create() : EEM_Attendee::instance()->get_one_by_ID($args['ATT_ID']);
$this->_attendee = empty($this->_attendee) ? $this->factory->attendee->create() : $this->_attendee;
//status
$this->_status = empty($arg['STS_ID']) ? $this->factory->status->create(array('STS_ID' => EEM_Registration::status_id_pending_payment, 'STS_type' => 'registration', 'STS_code' => 'PENDING_PAYMENT')) : EEM_Status::instance()->get_one_by_ID($args['STS_ID']);
$this->_status = empty($this->_status) ? $this->factory->status->create(array('STS_ID' => EEM_Registration::status_id_pending_payment, 'STS_type' => 'registration', 'STS_code' => 'PENDING_PAYMENT')) : $this->_status;
}
/**
* Export a custom CSV of registration info including: A bunch of the reg fields, the time of the event, the price name,
* and the questions associated with the registrations
* @param int $event_id
*/
function report_registrations_for_event($event_id = NULL)
{
$reg_fields_to_include = array('TXN_ID', 'ATT_ID', 'REG_ID', 'REG_date', 'REG_code', 'REG_count', 'REG_final_price');
$att_fields_to_include = array('ATT_fname', 'ATT_lname', 'ATT_email', 'ATT_address', 'ATT_address2', 'ATT_city', 'STA_ID', 'CNT_ISO', 'ATT_zip', 'ATT_phone');
$registrations_csv_ready_array = array();
$reg_model = EE_Registry::instance()->load_model('Registration');
$query_params = apply_filters('FHEE__EE_Export__report_registration_for_event', array(array('OR' => array('Transaction.STS_ID' => array('NOT IN', array(EEM_Transaction::failed_status_code, EEM_Transaction::abandoned_status_code)), 'STS_ID' => EEM_Registration::status_id_approved), 'Ticket.TKT_deleted' => array('IN', array(true, false))), 'order_by' => array('Transaction.TXN_ID' => 'asc', 'REG_count' => 'asc'), 'force_join' => array('Transaction', 'Ticket', 'Attendee'), 'caps' => EEM_Base::caps_read_admin), $event_id);
if ($event_id) {
$query_params[0]['EVT_ID'] = $event_id;
} else {
$query_params['force_join'][] = 'Event';
}
$registration_rows = $reg_model->get_all_wpdb_results($query_params);
//get all questions which relate to someone in this group
$registration_ids = array();
foreach ($registration_rows as $reg_row) {
$registration_ids[] = intval($reg_row['Registration.REG_ID']);
}
// EEM_Question::instance()->show_next_x_db_queries();
$questions_for_these_regs_rows = EEM_Question::instance()->get_all_wpdb_results(array(array('Answer.REG_ID' => array('IN', $registration_ids))));
foreach ($registration_rows as $reg_row) {
if (is_array($reg_row)) {
$reg_csv_array = array();
if (!$event_id) {
//get the event's name and Id
$reg_csv_array[__('Event', 'event_espresso')] = sprintf(__('%1$s (%2$s)', 'event_espresso'), $this->_prepare_value_from_db_for_display(EEM_Event::instance(), 'EVT_name', $reg_row['Event_CPT.post_title']), $reg_row['Event_CPT.ID']);
}
$is_primary_reg = $reg_row['Registration.REG_count'] == '1' ? true : false;
/*@var $reg_row EE_Registration */
foreach ($reg_fields_to_include as $field_name) {
$field = $reg_model->field_settings_for($field_name);
if ($field_name == 'REG_final_price') {
$value = $this->_prepare_value_from_db_for_display($reg_model, $field_name, $reg_row['Registration.REG_final_price'], 'localized_float');
} elseif ($field_name == 'REG_count') {
$value = sprintf(__('%s of %s', 'event_espresso'), $this->_prepare_value_from_db_for_display($reg_model, 'REG_count', $reg_row['Registration.REG_count']), $this->_prepare_value_from_db_for_display($reg_model, 'REG_group_size', $reg_row['Registration.REG_group_size']));
} elseif ($field_name == 'REG_date') {
$value = $this->_prepare_value_from_db_for_display($reg_model, $field_name, $reg_row['Registration.REG_date'], 'no_html');
} else {
$value = $this->_prepare_value_from_db_for_display($reg_model, $field_name, $reg_row[$field->get_qualified_column()]);
}
$reg_csv_array[$this->_get_column_name_for_field($field)] = $value;
if ($field_name == 'REG_final_price') {
//add a column named Currency after the final price
$reg_csv_array[__("Currency", "event_espresso")] = EE_Config::instance()->currency->code;
}
}
//get pretty status
$stati = EEM_Status::instance()->localized_status(array($reg_row['Registration.STS_ID'] => __('unknown', 'event_espresso'), $reg_row['TransactionTable.STS_ID'] => __('unknown', 'event_espresso')), FALSE, 'sentence');
$reg_csv_array[__("Registration Status", 'event_espresso')] = $stati[$reg_row['Registration.STS_ID']];
//get pretty trnasaction status
$reg_csv_array[__("Transaction Status", 'event_espresso')] = $stati[$reg_row['TransactionTable.STS_ID']];
$reg_csv_array[__('Transaction Amount Due', 'event_espresso')] = $is_primary_reg ? $this->_prepare_value_from_db_for_display(EEM_Transaction::instance(), 'TXN_total', $reg_row['TransactionTable.TXN_total'], 'localized_float') : '0.00';
$reg_csv_array[__('Amount Paid', 'event_espresso')] = $is_primary_reg ? $this->_prepare_value_from_db_for_display(EEM_Transaction::instance(), 'TXN_paid', $reg_row['TransactionTable.TXN_paid'], 'localized_float') : '0.00';
$payment_methods = array();
$gateway_txn_ids_etc = array();
$payment_times = array();
if ($is_primary_reg && $reg_row['TransactionTable.TXN_ID']) {
$payments_info = EEM_Payment::instance()->get_all_wpdb_results(array(array('TXN_ID' => $reg_row['TransactionTable.TXN_ID'], 'STS_ID' => EEM_Payment::status_id_approved), 'force_join' => array('Payment_Method')), ARRAY_A, 'Payment_Method.PMD_admin_name as name, Payment.PAY_txn_id_chq_nmbr as gateway_txn_id, Payment.PAY_timestamp as payment_time');
foreach ($payments_info as $payment_method_and_gateway_txn_id) {
$payment_methods[] = isset($payment_method_and_gateway_txn_id['name']) ? $payment_method_and_gateway_txn_id['name'] : __('Unknown', 'event_espresso');
$gateway_txn_ids_etc[] = isset($payment_method_and_gateway_txn_id['gateway_txn_id']) ? $payment_method_and_gateway_txn_id['gateway_txn_id'] : '';
$payment_times[] = isset($payment_method_and_gateway_txn_id['payment_time']) ? $payment_method_and_gateway_txn_id['payment_time'] : '';
}
}
$reg_csv_array[__('Payment Date(s)', 'event_espresso')] = implode(',', $payment_times);
$reg_csv_array[__('Payment Method(s)', 'event_espresso')] = implode(",", $payment_methods);
$reg_csv_array[__('Gateway Transaction ID(s)', 'event_espresso')] = implode(',', $gateway_txn_ids_etc);
//get whether or not the user has checked in
$reg_csv_array[__("Check-Ins", "event_espresso")] = $reg_model->count_related($reg_row['Registration.REG_ID'], 'Checkin');
//get ticket of registration and its price
$ticket_model = EE_Registry::instance()->load_model('Ticket');
if ($reg_row['Ticket.TKT_ID']) {
$ticket_name = $this->_prepare_value_from_db_for_display($ticket_model, 'TKT_name', $reg_row['Ticket.TKT_name']);
$datetimes_strings = array();
foreach (EEM_Datetime::instance()->get_all_wpdb_results(array(array('Ticket.TKT_ID' => $reg_row['Ticket.TKT_ID']), 'order_by' => array('DTT_EVT_start' => 'ASC'), 'default_where_conditions' => 'none')) as $datetime) {
$datetimes_strings[] = $this->_prepare_value_from_db_for_display(EEM_Datetime::instance(), 'DTT_EVT_start', $datetime['Datetime.DTT_EVT_start']);
}
} else {
$ticket_name = __('Unknown', 'event_espresso');
$datetimes_strings = array(__('Unknown', 'event_espresso'));
}
$reg_csv_array[$ticket_model->field_settings_for('TKT_name')->get_nicename()] = $ticket_name;
$reg_csv_array[__("Datetimes of Ticket", "event_espresso")] = implode(", ", $datetimes_strings);
//get datetime(s) of registration
//add attendee columns
foreach ($att_fields_to_include as $att_field_name) {
$field_obj = EEM_Attendee::instance()->field_settings_for($att_field_name);
if ($reg_row['Attendee_CPT.ID']) {
if ($att_field_name == 'STA_ID') {
$value = EEM_State::instance()->get_var(array(array('STA_ID' => $reg_row['Attendee_Meta.STA_ID'])), 'STA_name');
} elseif ($att_field_name == 'CNT_ISO') {
$value = EEM_Country::instance()->get_var(array(array('CNT_ISO' => $reg_row['Attendee_Meta.CNT_ISO'])), 'CNT_name');
} else {
$value = $this->_prepare_value_from_db_for_display(EEM_Attendee::instance(), $att_field_name, $reg_row[$field_obj->get_qualified_column()]);
}
} else {
$value = '';
}
$reg_csv_array[$this->_get_column_name_for_field($field_obj)] = $value;
}
//make sure each registration has the same questions in the same order
foreach ($questions_for_these_regs_rows as $question_row) {
if (!isset($reg_csv_array[$question_row['Question.QST_admin_label']])) {
$reg_csv_array[$question_row['Question.QST_admin_label']] = null;
}
}
//now fill out the questions THEY answered
foreach (EEM_Answer::instance()->get_all_wpdb_results(array(array('REG_ID' => $reg_row['Registration.REG_ID']), 'force_join' => array('Question'))) as $answer_row) {
/* @var $answer EE_Answer */
if ($answer_row['Question.QST_ID']) {
$question_label = $this->_prepare_value_from_db_for_display(EEM_Question::instance(), 'QST_admin_label', $answer_row['Question.QST_admin_label']);
} else {
$question_label = sprintf(__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
}
if (isset($answer_row['Question.QST_type']) && $answer_row['Question.QST_type'] == EEM_Question::QST_type_state) {
$reg_csv_array[$question_label] = EEM_State::instance()->get_state_name_by_ID($answer_row['Answer.ANS_value']);
} else {
$reg_csv_array[$question_label] = $this->_prepare_value_from_db_for_display(EEM_Answer::instance(), 'ANS_value', $answer_row['Answer.ANS_value']);
}
}
$registrations_csv_ready_array[] = apply_filters('FHEE__EE_Export__report_registrations__reg_csv_array', $reg_csv_array, $reg_row);
}
}
//if we couldn't export anything, we want to at least show the column headers
if (empty($registrations_csv_ready_array)) {
$reg_csv_array = array();
$model_and_fields_to_include = array('Registration' => $reg_fields_to_include, 'Attendee' => $att_fields_to_include);
foreach ($model_and_fields_to_include as $model_name => $field_list) {
$model = EE_Registry::instance()->load_model($model_name);
foreach ($field_list as $field_name) {
$field = $model->field_settings_for($field_name);
$reg_csv_array[$this->_get_column_name_for_field($field)] = null;
//$registration->get($field->get_name());
}
}
$registrations_csv_ready_array[] = $reg_csv_array;
}
if ($event_id) {
$event_slug = EEM_Event::instance()->get_var(array(array('EVT_ID' => $event_id)), 'EVT_slug');
if (!$event_slug) {
$event_slug = __('unknown', 'event_espresso');
}
} else {
$event_slug = __('all', 'event_espresso');
}
$filename = sprintf("registrations-for-%s", $event_slug);
$handle = $this->EE_CSV->begin_sending_csv($filename);
$this->EE_CSV->write_data_array_to_csv($handle, $registrations_csv_ready_array);
$this->EE_CSV->end_sending_csv($handle);
}
/**
* insert_default_status_codes
*
* @access public
* @static
* @return void
*/
public static function insert_default_status_codes()
{
global $wpdb;
if (EEH_Activation::table_exists(EEM_Status::instance()->table())) {
$table_name = EEM_Status::instance()->table();
$SQL = "DELETE FROM {$table_name} WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC' );";
$wpdb->query($SQL);
$SQL = "INSERT INTO {$table_name}\n\t\t\t\t\t(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES\n\t\t\t\t\t('ACT', 'ACTIVE', 'event', 0, NULL, 1),\n\t\t\t\t\t('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),\n\t\t\t\t\t('NOP', 'REGISTRATION_NOT_OPEN', 'event', 0, NULL, 1),\n\t\t\t\t\t('OPN', 'REGISTRATION_OPEN', 'event', 0, NULL, 1),\n\t\t\t\t\t('CLS', 'REGISTRATION_CLOSED', 'event', 0, NULL, 0),\n\t\t\t\t\t('PND', 'PENDING', 'event', 0, NULL, 1),\n\t\t\t\t\t('ONG', 'ONGOING', 'event', 0, NULL, 1),\n\t\t\t\t\t('SEC', 'SECONDARY', 'event', 0, NULL, 1),\n\t\t\t\t\t('DRF', 'DRAFT', 'event', 0, NULL, 0),\n\t\t\t\t\t('DEL', 'DELETED', 'event', 0, NULL, 0),\n\t\t\t\t\t('DEN', 'DENIED', 'event', 0, NULL, 0),\n\t\t\t\t\t('EXP', 'EXPIRED', 'event', 0, NULL, 0),\n\t\t\t\t\t('RPP', 'PENDING_PAYMENT', 'registration', 0, NULL, 1),\n\t\t\t\t\t('RAP', 'APPROVED', 'registration', 0, NULL, 1),\n\t\t\t\t\t('RCN', 'CANCELLED', 'registration', 0, NULL, 0),\n\t\t\t\t\t('RDC', 'DECLINED', 'registration', 0, NULL, 0),\n\t\t\t\t\t('RNA', 'NOT_APPROVED', 'registration', 0, NULL, 1),\n\t\t\t\t\t('RIC', 'INCOMPLETE', 'registration', 0, NULL, 1),\n\t\t\t\t\t('TFL', 'FAILED', 'transaction', 0, NULL, 0),\n\t\t\t\t\t('TAB', 'ABANDONED', 'transaction', 0, NULL, 0),\n\t\t\t\t\t('TIN', 'INCOMPLETE', 'transaction', 0, NULL, 1),\n\t\t\t\t\t('TCM', 'COMPLETE', 'transaction', 0, NULL, 1),\n\t\t\t\t\t('TOP',\t'OVERPAID', 'transaction', 0, NULL, 1),\n\t\t\t\t\t('PAP', 'APPROVED', 'payment', 0, NULL, 1),\n\t\t\t\t\t('PPN', 'PENDING', 'payment', 0, NULL, 1),\n\t\t\t\t\t('PCN', 'CANCELLED', 'payment', 0, NULL, 0),\n\t\t\t\t\t('PFL', 'FAILED', 'payment', 0, NULL, 0),\n\t\t\t\t\t('PDC', 'DECLINED', 'payment', 0, NULL, 0),\n\t\t\t\t\t('EDR', 'DRAFT', 'email', 0, NULL, 0),\n\t\t\t\t\t('ESN', 'SENT', 'email', 0, NULL, 1);";
$wpdb->query($SQL);
}
}
/**
* retrieve the status details from esp_status table as an array IF this model has the status table as a relation.
*
* @param boolean $translated return localized strings or JUST the array.
* @return array
*/
public function status_array($translated = FALSE)
{
if (!array_key_exists('Status', $this->_model_relations)) {
return array();
}
$model_name = $this->get_this_model_name();
$status_type = str_replace(' ', '_', strtolower(str_replace('_', ' ', $model_name)));
$stati = EEM_Status::instance()->get_all(array(array('STS_type' => $status_type)));
$status_array = array();
foreach ($stati as $status) {
$status_array[$status->ID()] = $status->get('STS_code');
}
return $translated ? EEM_Status::instance()->localized_status($status_array, FALSE, 'sentence') : $status_array;
}
/**
* returns a pretty version of the status, good for displaying to users
* @param bool $show_icons
* @return string
*/
public function pretty_status($show_icons = FALSE)
{
$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), FALSE, 'sentence');
$icon = '';
switch ($this->status_ID()) {
case EEM_Transaction::complete_status_code:
$icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
break;
case EEM_Transaction::incomplete_status_code:
$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 lt-blue-text"></span>' : '';
break;
case EEM_Transaction::abandoned_status_code:
$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 red-text"></span>' : '';
break;
case EEM_Transaction::failed_status_code:
$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
break;
case EEM_Transaction::overpaid_status_code:
$icon = $show_icons ? '<span class="dashicons dashicons-plus ee-icon-size-16 orange-text"></span>' : '';
break;
}
return $icon . $status[$this->status_ID()];
}
/**
* Returns a nice version of the status for displaying to customers
* @param bool $show_icons
* @return string
*/
public function pretty_status($show_icons = FALSE)
{
$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), FALSE, 'sentence');
$icon = '';
switch ($this->status_ID()) {
case EEM_Registration::status_id_approved:
$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
break;
case EEM_Registration::status_id_pending_payment:
$icon = $show_icons ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>' : '';
break;
case EEM_Registration::status_id_not_approved:
$icon = $show_icons ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>' : '';
break;
case EEM_Registration::status_id_cancelled:
$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
break;
case EEM_Registration::status_id_incomplete:
$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>' : '';
break;
case EEM_Registration::status_id_declined:
$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
break;
}
return $icon . $status[$this->status_ID()];
}
/**
* get list of registration statuses
*
*
* @access public
* @param array $exclude The status ids to exclude from the returned results
* @param bool $translated If true will return the values as singular localized strings
* @return array
*/
public static function reg_status_array($exclude = array(), $translated = FALSE)
{
EEM_Registration::instance()->_get_registration_status_array($exclude);
return $translated ? EEM_Status::instance()->localized_status(self::$_reg_status, FALSE, 'sentence') : self::$_reg_status;
}
/**
* returns a pretty version of the status, good for displaying to users
* @param bool $show_icons
* @return string
*/
public function pretty_status($show_icons = FALSE)
{
$status = EEM_Status::instance()->localized_status(array($this->STS_ID() => __('unknown', 'event_espresso')), FALSE, 'sentence');
$icon = '';
switch ($this->STS_ID()) {
case EEM_Payment::status_id_approved:
$icon = $show_icons ? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>' : '';
break;
case EEM_Payment::status_id_pending:
$icon = $show_icons ? '<span class="dashicons dashicons-clock ee-icon-size-16 orange-text"></span>' : '';
break;
case EEM_Payment::status_id_cancelled:
$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>' : '';
break;
case EEM_Payment::status_id_declined:
$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
break;
}
return $icon . $status[$this->STS_ID()];
}
/**
* return the status object for a given status ID
*
* @since 4.3.0
*
* @param int $STS_ID the status id for the status to attempt to retrieve
*
* @return mixed null|EE_Status
*/
public function get_object_by_id($STS_ID)
{
return EEM_Status::instance()->get_one_by_ID($STS_ID);
}
/**
* This generates the dummy relation objects for use in a new transaction if the $_chained flag is true. Note this is called just once when create_many() method is used.
*
* @since 4.3.0
*
* @param array $args arguments that are sent to the factory that *may contain registration id.
* @param int $TXN_ID required to make sure that when registration_chained is called, it does not create a new transaction object but uses THIS transaction and sets the relation.
*/
private function _set_repeated_relation($args, $TXN_ID)
{
//status
$this->_status = empty($args['STS_ID']) ? $this->factory->status->create(array('STS_ID' => EEM_Transaction::incomplete_status_code, 'STS_type' => 'transaction', 'STS_code' => 'INCOMPLETE')) : EEM_Status::instance()->get_one_by_ID($args['STS_ID']);
$this->_status = empty($this->_status) ? $this->factory->status->create(array('STS_ID' => EEM_Transaction::incomplete_status_code, 'STS_type' => 'transaction', 'STS_code' => 'INCOMPLETE')) : $this->_status;
}
/**
* Gets code
* @param bool $plural
* @param string $schema
* @return string
*/
function code($plural = FALSE, $schema = 'upper')
{
$id = $this->get('STS_ID');
$code = EEM_Status::instance()->localized_status(array($id => $this->get('STS_code')), $plural, $schema);
return $code[$id];
}