Support

September 19, 2023 at 12:58 pm

Continued from the previous thread.

I am looking to add a few additional columns to the Transaction page in Event Espresso 4 and have an additional column be sortable and all columns to be searchable.

So far I have been able to add those columns and their values. However, I am having issues with getting both sorting and searching those new columns and values.

Here is the current version of my code

//Add columns to Transaction page *Under Construction*
/**
 * @param $columns
 * @param $screen
 * @return array|mixed
 */
function tw_custom_columns( $columns, $screen ) {
    // This is for the 'default' transactions list table
    // Event Espresso -> Transactions.
    if( $screen == 'espresso_transactions_default' ){
        // EEH_Array::insert_into_array() allows you to specific a specific key
        // that you want to add your additional column before/after.
        // This adds the custom columns just before 'actions' column.
        $columns = EEH_Array::insert_into_array(
            $columns,
            array( 'company-or-band-name-column' => 'Company or Band Name',
                'billing-first-name-column' => 'Billing First Name',
                'billing-last-name-column' => 'Billing Last Name'
            ),
            'actions'
        );
    }
    // Add a company-or-band-name-column column to the transactions list table.
    if( $screen == 'espresso_transactions_event_transactions' ) {
        //This is another method you can use that just adds the column to the end of the array.
        $columns['company-or-band-name-column'] = 'Company or Band Name';
    }
    return $columns;
}
add_filter('FHEE_manage_event-espresso_page_espresso_transactions_columns', 'tw_custom_columns', 10, 2);

/**
 * @param $item
 * @param $screen
 * @return void
 * @throws EE_Error
 * @throws ReflectionException
 */
function transaction_table_company_or_band_question( $item, $screen ) {
    //Sanity check to confirm we have an EE_Transaction object.
    if( $item instanceof EE_Transaction ){
        //Pull the answer object for Question ID 21 using the current registration.
        $primary_reg = $item->primary_registration();
        $question_id = 21;
        $answer_obj = EEM_Answer::instance()->get_registration_question_answer_object( $primary_reg, $question_id );
        if ( $answer_obj instanceof EE_Answer ){
            //If we have an answer object, echo the 'pretty' value for it.
            echo $answer_obj->pretty_value();
        }
    }
}
// 'company-or-band-name-column'
add_action( 'AHEE__EE_Admin_List_Table__column_company-or-band-name-column__event-espresso_page_espresso_transactions', 'transaction_table_company_or_band_question', 10, 2 );

function transaction_table_billing_first_name_question( $item, $screen ) {
    //Sanity check to confirm we have an EE_Transaction object.
    if( $item instanceof EE_Transaction ){
        //Pull the answer object for Question ID 21 using the current registration.
        $primary_reg = $item->primary_registration();
        $question_id = 13;
        $answer_obj = EEM_Answer::instance()->get_registration_question_answer_object( $primary_reg, $question_id );
        if ( $answer_obj instanceof EE_Answer ){
            //If we have an answer object, echo the 'pretty' value for it.
            echo $answer_obj->pretty_value();
        }
    }
}
// 'billing-first-name-column'
add_action( 'AHEE__EE_Admin_List_Table__column_billing-first-name-column__event-espresso_page_espresso_transactions', 'transaction_table_billing_first_name_question', 10, 2 );

function transaction_table_billing_last_name_question( $item, $screen ) {
    //Sanity check to confirm we have an EE_Transaction object.
    if( $item instanceof EE_Transaction ){
        //Pull the answer object for Question ID 21 using the current registration.
        $primary_reg = $item->primary_registration();
        $question_id = 14;
        $answer_obj = EEM_Answer::instance()->get_registration_question_answer_object( $primary_reg, $question_id );
        if ( $answer_obj instanceof EE_Answer ){
            //If we have an answer object, echo the 'pretty' value for it.
            echo $answer_obj->pretty_value();
        }
    }
}
// 'billing-last-name-column'
add_action( 'AHEE__EE_Admin_List_Table__column_billing-last-name-column__event-espresso_page_espresso_transactions', 'transaction_table_billing_last_name_question', 10, 2 );

/**
 * Enable sorting for the custom column
 * @param $sortable_columns
 * @param $screen
 * @return mixed
 */
function tw_ee_sortable_columns( $sortable_columns, $screen ) {

    if ( $screen == 'espresso_transactions_default' ) {
        $sortable_columns['company-or-band-name-column'] = array( 'company-or-band-name-column' => false );
    }

    return $sortable_columns;
}
add_filter('FHEE_manage_event-espresso_page_espresso_transactions_sortable_columns', 'tw_ee_sortable_columns', 10, 2);

/**
 * The models only accept certain values for orderby, normally the column name is used but if that's custom we'll need to pass a value
 * the models understand. THis sets the order by to 'Answer.ANS_value' when you select the custom column above.
 * @param $order_by
 * @param $request
 * @return array|mixed
 */
function tw_ee_get_orderby_for_transactions_query( $order_by, $request )
{

    write_log( 'Order By' );
    write_log( $order_by );

    if( isset( $order_by['company-or-band-name-column'] ) ) {

        $fixed_order_by = array(
            'Answer.ANS_value' => $order_by['company-or-band-name-column']
        );
        unset( $order_by['company-or-band-name-column'] );

        foreach( $order_by as $key => $value ) {
            $fixed_order_by[$key] = $value;
        }

        return $fixed_order_by;
    }

    //Return the original order_by array.
    return $order_by;
}
add_filter('FHEE__Transactions_Admin_Page___get_transactions_query_params', 'tw_ee_get_orderby_for_transactions_query', 10, 2);

I was referenced to https://gist.github.com/Pebblo/88f2a0a9213c716e4886a249e7709245
as a starting point. One main thing I see from that example is that filter that is used is

FHEE__Registrations_Admin_Page___get_orderby_for_registrations_query

However, I am looking to make adjustments to the Transaction_Admin_Page so I looked for the same filter for the Transaction page but no luck. There doesn’t seem to be a FHEE__Transactions_Admin_Page___get_orderby_for_transactions_query or similar.

The closest filter I could find is

FHEE__Transactions_Admin_Page___get_transactions_query_params

However, when I looked at what was available to alter for order it doesn’t seem like I am in the right place. Here is what is in the $order_by variable.

Array
(
    [0] => Array
        (
            [TXN_timestamp] => Array
                (
                    [0] => BETWEEN
                    [1] => Array
                        (
                            [0] => EventEspresso\core\domain\entities\DbSafeDateTime Object
                                (
                                    [_datetime_string:protected] => 
                                    [_error_log_dir:protected] => 
                                    [date] => 2013-09-19 00:00:00.000000
                                    [timezone_type] => 3
                                    [timezone] => America/Vancouver
                                )

                            [1] => EventEspresso\core\domain\entities\DbSafeDateTime Object
                                (
                                    [_datetime_string:protected] => 
                                    [_error_log_dir:protected] => 
                                    [date] => 2023-09-19 23:59:59.000000
                                    [timezone_type] => 3
                                    [timezone] => America/Vancouver
                                )

                        )

                )

            [Registration.REG_count] => 1
            [STS_ID] => Array
                (
                    [0] => !=
                    [1] => TFL
                )

            [STS_ID*] => Array
                (
                    [0] => !=
                    [1] => TAB
                )

        )

    [order_by] => Array
        (
            [TXN_timestamp] => desc
        )

    [limit] => Array
        (
            [0] => 0
            [1] => 100
        )

    [default_where_conditions] => this_model_only
)

Maybe I am going down the wrong direction here but yes I am still having issues with both the sort and search of a custom added column on the transaction page. Any help would be appreciated.