| Current File : /home/digitaw/www/wp-content/plugins/event-tickets/src/Tickets/Commerce/Reports/Orders.php |
<?php
namespace TEC\Tickets\Commerce\Reports;
use TEC\Tickets\Commerce\Admin_Tables\Attendees as Attendees_Table;
use TEC\Tickets\Commerce\Admin_Tables\Orders as Orders_Table;
use TEC\Tickets\Commerce\Module;
use TEC\Tickets\Commerce\Reports\Data\Order_Summary;
use TEC\Tickets\Event;
use Tribe__Main;
use Tribe__Tickets__Main as Plugin;
use Tribe__Tickets__Tickets as Tickets;
use WP_Post;
/**
* Class Orders Report.
*
* @since 5.2.0
*
* @package TEC\Tickets\Commerce\Reports
*/
class Orders extends Report_Abstract {
/**
* Slug of the admin page for orders.
*
* @since 5.2.0
*
* @var string
*/
public static $page_slug = 'tickets-commerce-orders';
/**
* @var string
*/
public static $tab_slug = 'tickets-commerce-orders-report';
/**
* Order Pages ID on the menu.
*
* @since 5.2.0
*
* @var string The menu slug of the Orders page.
*/
public $orders_page;
/**
* Gets the Orders Report title.
*
* @since 5.6.2
*
* @param int $post_id
*
* @return string
*/
public function get_title( $post_id ) {
$title = sprintf(
// Translators: %1$s: the post/event title, %2$d: the post/event ID.
_x( 'Orders for: %1$s [#%2$d]', 'orders report screen heading', 'event-tickets' ),
get_the_title( $post_id ),
$post_id
);
/**
* Filters the title on the Order list page for Tickets Commerce.
*
* @since 5.6.2
*
* @param string $title The title.
* @param int $post_id The post ID.
*/
return apply_filters( 'tec_tickets_commerce_order_page_title', $title, $post_id );
}
/**
* Links to the sales report for all tickets in Tickets Commerce for this event.
*
* @since 5.2.0
* @since 5.6.4 `tec_tickets_filter_event_id` filter to normalize the $post_id.
*
* @param int $event_id
* @param bool $url_only
*
* @return string
*/
public function get_event_link( $event_id, $url_only = false ) {
$ticket_ids = (array) tribe( Module::class )->get_tickets_ids( $event_id );
if ( empty( $ticket_ids ) ) {
return '';
}
$post = get_post( $event_id );
$event_id = Event::filter_event_id( $event_id, 'tc-orders-report-link' );
$query = [
'post_type' => $post->post_type,
'page' => static::$page_slug,
'post_id' => $event_id,
];
$report_url = add_query_arg( $query, admin_url( 'admin.php' ) );
/**
* Filter the Reports Events Orders Report URL.
*
* @since 5.2.0
*
* @param string $report_url The Report URL.
* @param int $event_id The post ID.
* @param array $ticket_ids An array of ticket IDs.
*
* @return string
*/
$report_url = apply_filters( 'tec_tickets_commerce_reports_orders_event_link', $report_url, $event_id, $ticket_ids );
return $url_only
? $report_url
: '<small> <a href="' . esc_url( $report_url ) . '">' . esc_html__( 'Sales report', 'event-tickets' ) . '</a> </small>';
}
/**
* Links to the sales report for a given ticket.
*
* @since 5.2.0
*
* @param int|string $event_id The post ID of the event.
* @param int|string $ticket_id The post ID of the ticket.
*
* @return string
*/
public function get_ticket_link( $event_id, $ticket_id ) {
if ( empty( $ticket_id ) ) {
return '';
}
$post = get_post( $event_id );
$query = [
'post_type' => $post->post_type,
'page' => static::$page_slug,
'product_ids' => $ticket_id,
'post_id' => $event_id,
];
$report_url = add_query_arg( $query, admin_url( 'admin.php' ) );
/**
* Filter the Reports Tickets Orders Report URL.
*
* @since 5.2.0
*
* @param string $report_url The Report URL.
* @param int $event_id The post ID.
* @param array $ticket_ids An array of ticket IDs.
*
* @return string
*/
$report_url = apply_filters( 'tec_tickets_commerce_reports_orders_ticket_link', $report_url, $event_id, $ticket_ids );
return '<span><a href="' . esc_url( $report_url ) . '">' . esc_html__( 'Report', 'event-tickets' ) . '</a></span>';
}
/**
* Returns the link to the "Orders" report for this post.
*
* @since 5.2.0
*
* @param WP_Post $post
*
* @return string The absolute URL.
*/
public static function get_tickets_report_link( $post ) {
$url = add_query_arg(
[
'post_type' => $post->post_type,
'page' => static::$page_slug,
'post_id' => $post->ID,
],
admin_url( 'edit.php' )
);
return $url;
}
/**
* Hooks the actions and filter required by the class.
*
* @since 5.2.0
* @since 5.25.0 Add hook for `page_row_actions`.
*
* @return void
*/
public function hook() {
add_filter( 'post_row_actions', [ $this, 'add_orders_row_action' ], 10, 2 );
add_filter( 'page_row_actions', [ $this, 'add_orders_row_action' ], 10, 2 );
// Register before the default priority of 10 to avoid submenu hook issues.
add_action( 'admin_menu', [ $this, 'register_orders_page' ], 5 );
// Register the tabbed view.
$tc_tabbed_view = new Tabbed_View();
$tc_tabbed_view->set_active( self::$tab_slug );
$tc_tabbed_view->register();
}
/**
* Adds order-related actions to the available row actions for the post.
*
* @since 5.2.0
*
* @param array $actions The array of quick actions.
* @param WP_Post $post The post object.
*
* @return array
*/
public function add_orders_row_action( array $actions, $post ) {
$post_id = Tribe__Main::post_id_helper( $post );
$post = get_post( $post_id );
// Only if tickets are active on this post type.
if ( ! in_array( $post->post_type, Plugin::instance()->post_types(), true ) ) {
return $actions;
}
if ( ! $this->can_access_page( $post_id ) ) {
return $actions;
}
$commerce = tribe( Module::class );
if ( ! $commerce->post_has_tickets( $post ) ) {
return $actions;
}
$url = $commerce->get_event_reports_link( $post->ID, true );
$post_labels = get_post_type_labels( get_post_type_object( $post->post_type ) );
$post_type = strtolower( $post_labels->singular_name );
$actions['tickets_orders'] = sprintf(
'<a title="%s" href="%s">%s</a>',
sprintf( esc_html__( 'See Tickets Commerce purchases for this %s', 'event-tickets' ), $post_type ),
esc_url( $url ),
esc_html__( 'Orders', 'event-tickets' )
);
return $actions;
}
/**
* Registers the Tickets Commerce Orders page as a plugin options page.
*
* @since 5.2.0
*/
public function register_orders_page() {
$candidate_post_id = tribe_get_request_var( 'post_id', 0 );
$candidate_post_id = tribe_get_request_var( 'event_id', $candidate_post_id );
if ( ( $post_id = absint( $candidate_post_id ) ) != $candidate_post_id ) {
return;
}
if ( ! $this->can_access_page( $post_id ) ) {
return;
}
$cap = 'edit_posts';
if ( ! current_user_can( 'edit_posts' ) && $post_id ) {
$post = get_post( $post_id );
if ( $post instanceof WP_Post && get_current_user_id() === (int) $post->post_author ) {
$cap = 'read';
}
}
$page_title = __( 'Tickets Commerce Orders', 'event-tickets' );
$this->orders_page = add_submenu_page(
'',
$page_title,
$page_title,
$cap,
static::$page_slug,
[ $this, 'render_page' ]
);
/** @var Attendees_Table $attendees */
$attendees = tribe( Attendees_Table::class );
add_filter( 'tribe_filter_attendee_page_slug', [ $this, 'add_attendee_resources_page_slug' ] );
add_action( 'admin_enqueue_scripts', [ $attendees, 'enqueue_assets' ] );
add_action( 'admin_enqueue_scripts', [ $attendees, 'load_pointers' ] );
add_action( 'load-' . $this->orders_page, [ $this, 'attendees_page_screen_setup' ] );
}
/**
* Filter the page slugs that the attendee resources will load to add the Orders page.
*
* @since 5.2.0
*
* @param array $slugs The slugs.
*
* @return array
*/
public function add_attendee_resources_page_slug( $slugs ) {
$slugs[] = $this->orders_page;
return $slugs;
}
/**
* Sets up the Attendees page screen.
*
* @since 5.2.0
*/
public function attendees_page_screen_setup() {
$orders_table = tribe( Orders_Table::class );
$orders_table->prepare_items();
$orders_table->maybe_generate_csv();
wp_enqueue_script( 'jquery-ui-dialog' );
add_filter( 'admin_title', [ $this, 'filter_admin_title' ] );
}
/**
* Sets the browser title for the Orders admin page.
*
* @since 5.2.0
*
* @param string $admin_title
*
* @return string
*/
public function filter_admin_title( $admin_title ) {
$post_id = tribe_get_request_var( 'post_id' );
$post_id = tribe_get_request_var( 'event_id', $post_id );
if ( ! empty( $post_id ) ) {
$event = get_post( $post_id );
$admin_title = sprintf( esc_html_x( '%s - Tickets Commerce Orders', 'Browser title', 'event-tickets' ), $event->post_title );
}
return $admin_title;
}
/**
* Renders the Orders page.
*
* @since 5.2.0
*/
public function render_page() {
$tc_tabbed_view = new Tabbed_View();
$tc_tabbed_view->set_active( self::$tab_slug );
$tc_tabbed_view->render();
$this->get_template()->template( 'orders', $this->get_template_vars() );
}
/**
* Sets up the template variables used to render the Orders Report page.
*
* @since 5.2.0
* @since 5.6.8 Removed title from template vars, title will be rendered by the Tabbed_View.
*
* @return array
*/
public function setup_template_vars() {
$post_id = tribe_get_request_var( 'post_id' );
$post_id = tribe_get_request_var( 'event_id', $post_id );
$post = get_post( $post_id );
$post_type_object = get_post_type_object( $post->post_type );
$post_singular_label = $post_type_object->labels->singular_name;
$order_summary = new Order_Summary( $post_id );
$order_summary->init();
$this->template_vars = [
'orders_table' => tribe( Orders_Table::class ),
'post' => $post,
'post_id' => $post_id,
'post_type_object' => $post_type_object,
'post_singular_label' => $post_singular_label,
'order_summary' => $order_summary,
];
return $this->template_vars;
}
/**
* Filters the Order Link to Ticket Orders in the ticket editor.
*
* @since 5.2.0
*
* @param string $url URL for the Orders page for ticketed event/post.
* @param int $post_id The post ID for the current event/post.
*
* @return string
*/
public function filter_editor_orders_link( $url, $post_id ) {
$provider = Tickets::get_event_ticket_provider( $post_id );
if ( Module::class !== $provider ) {
return $url;
}
return add_query_arg( [ 'page' => static::get_page_slug() ], $url );
}
}