array(
'_inbound_stock',
),
);
/**
* ListTable Constructor
*
* The child class should call this constructor from its own constructor to override the default $args
*
* @since 1.3.0
*
* @param array|string $args {
* Array or string of arguments.
*
* @type array $table_columns The table columns for the list table
* @type array $group_members The column grouping members
* @type bool $show_cb Optional. Whether to show the row selector checkbox as first table column
* @type bool $show_controlled Optional. Whether to show items controlled by ATUM or not
* @type int $per_page Optional. The number of posts to show per page (-1 for no pagination)
* @type array $selected Optional. The posts selected on the list table
* @type array $excluded Optional. The posts excluded from the list table
* }
*/
public function __construct( $args = array() ) {
// Prevent unmanaged counters.
$this->show_unmanaged_counters = FALSE;
// NAMING CONVENTION: The column names starting by underscore (_) are based on meta keys (the name must match the meta key name),
// the column names starting with "calc_" are calculated fields and the rest are WP's standard fields
// *** Following this convention is necessary for column sorting functionality ***!
$args['table_columns'] = array(
'thumb' => '' . __( 'Thumb', ATUM_TEXT_DOMAIN ) . '',
'ID' => __( 'ID', ATUM_TEXT_DOMAIN ),
'title' => __( 'Product Name', ATUM_TEXT_DOMAIN ),
'calc_type' => '' . __( 'Product Type', ATUM_TEXT_DOMAIN ) . '',
'_sku' => __( 'SKU', ATUM_TEXT_DOMAIN ),
'_inbound_stock' => __( 'Inbound Stock', ATUM_TEXT_DOMAIN ),
'calc_date_ordered' => __( 'Date Ordered', ATUM_TEXT_DOMAIN ),
'calc_date_expected' => __( 'Date Expected', ATUM_TEXT_DOMAIN ),
'calc_purchase_order' => __( 'PO', ATUM_TEXT_DOMAIN ),
);
// Initialize totalizers.
$this->totalizers = apply_filters( 'atum/inbound_stock_list/totalizers', array( '_inbound_stock' => 0 ) );
parent::__construct( $args );
}
/**
* Get an associative array ( id => link ) with the list of available views on this table.
*
* @since 1.4.2
*
* @return array
*/
protected function get_views() {
$views = parent::get_views();
unset( $views['in_stock'], $views['low_stock'], $views['out_stock'], $views['unmanaged'], $views['back_order'] );
return $views;
}
/**
* Extra controls to be displayed in table nav sections
*
* @since 1.4.2
*
* @param string $which 'top' or 'bottom' table nav.
*/
protected function extra_tablenav( $which ) {
// Disable table nav.
}
/**
* Add the filters to the table nav
*
* @since 1.4.2
*/
protected function table_nav_filters() {
// Disable filters.
}
/**
* Get a list of CSS classes for the WP_List_Table table tag. Deleted 'fixed' from standard function
*
* @since 1.1.3.1
*
* @return array List of CSS classes for the table tag
*/
protected function get_table_classes() {
$table_classes = parent::get_table_classes();
$table_classes[] = 'inbound-stock-list';
$table_classes[] = 'striped';
return $table_classes;
}
/**
* Set views for table filtering and calculate total value counters for pagination
*
* @since 1.4.2
*
* @param array $args WP_Query arguments.
*/
protected function set_views_data( $args = array() ) {
$this->count_views = array(
'count_in_stock' => 0,
'count_out_stock' => 0,
'count_back_order' => 0,
'count_low_stock' => 0,
'count_unmanaged' => 0,
);
}
/**
* All columns are sortable by default except cb and thumbnail
*
* Optional. If you want one or more columns to be sortable (ASC/DESC toggle),
* you will need to register it here. This should return an array where the
* key is the column that needs to be sortable, and the value is db column to
* sort by. Often, the key and value will be the same, but this is not always
* the case (as the value is a column name from the database, not the list table).
*
* This method merely defines which columns should be sortable and makes them
* clickable - it does not handle the actual sorting. You still need to detect
* the ORDERBY and ORDER querystring variables within prepare_items() and sort
* your data accordingly (usually by modifying your query).
*
* @since 1.4.2
*
* @return array An associative array containing all the columns that should be sortable: 'slugs' => array('data_values', bool)
*/
protected function get_sortable_columns() {
$sortable_columns = parent::get_sortable_columns();
// Disable SKU sortable.
if ( isset( $sortable_columns['_sku'] ) ) {
unset( $sortable_columns['_sku'] );
}
$sortable_columns['calc_purchase_order'] = array( 'PO', FALSE );
return apply_filters( 'atum/inbound_stock_list/sortable_columns', $sortable_columns );
}
/**
* Post title column
*
* @since 1.4.2
*
* @param \WP_Post $item The WooCommerce product post.
*
* @return string
*/
protected function column_title( $item ) {
$product_id = $this->get_current_product_id();
if ( 'variation' === $this->product->get_type() ) {
/* @noinspection PhpUndefinedMethodInspection */
$parent_data = $this->product->get_parent_data();
$title = $parent_data['title'];
$attributes = wc_get_product_variation_attributes( $product_id );
if ( ! empty( $attributes ) ) {
$title .= ' - ' . ucfirst( implode( ' - ', $attributes ) );
}
// Get the variable product ID to get the right link.
$product_id = $this->product->get_parent_id();
}
else {
$title = $this->product->get_title();
}
$title_length = absint( apply_filters( 'atum/inbound_stock_list/column_title_length', 20 ) );
if ( mb_strlen( $title ) > $title_length ) {
$title = '' . trim( mb_substr( $title, 0, $title_length ) ) .
'...' . $title . '';
}
$title = '' . $title . '';
return apply_filters( 'atum/inbound_stock_list/column_title', $title, $item, $this->product );
}
/**
* Product SKU column
*
* @since 1.4.2
*
* @param \WP_Post $item The WooCommerce product post.
* @param bool $editable Whether the SKU will be editable.
*
* @return string
*/
protected function column__sku( $item, $editable = FALSE ) {
return parent::column__sku( $item, $editable );
}
/**
* Column for product type
*
* @since 1.4.2
*
* @param \WP_Post $item The WooCommerce product post.
*
* @return string
*/
protected function column_calc_type( $item ) {
$type = $this->product->get_type();
$product_types = wc_get_product_types();
switch ( $type ) {
case 'variation':
$type = 'variable';
$product_tip = __( 'Variation Product', ATUM_TEXT_DOMAIN );
break;
case 'variable':
case 'grouped':
$product_tip = $product_types[ $type ];
break;
default:
return parent::column_calc_type( $item );
}
$data_tip = ! $this->is_report ? ' data-tip="' . esc_attr( $product_tip ) . '"' : '';
return apply_filters( 'atum/inbound_stock_list/column_type', '', $item, $this->product );
}
/**
* Column for inbound stock
*
* @since 1.3.0
*
* @param \WP_Post $item The WooCommerce product post to use in calculations.
*
* @return string
*/
protected function column__inbound_stock( $item ) {
// Get the quantity for the ATUM Order Item.
$qty = AtumOrderItemModel::get_item_meta( $item->po_item_id, '_qty' );
$this->increase_total( '_inbound_stock', $qty );
return apply_filters( 'atum/inbound_stock_list/column_inbound_stock', $qty, $item, $this->product );
}
/**
* Column for date ordered
*
* @since 1.3.0
*
* @param \WP_Post $item The WooCommerce product post to use in calculations.
*
* @return string
*/
protected function column_calc_date_ordered( $item ) {
$date_ordered = get_post_meta( $item->po_id, '_date_created', TRUE );
return apply_filters( 'atum/inbound_stock_list/column_date_ordered', $date_ordered, $item, $this->product );
}
/**
* Column for date expected
*
* @since 1.3.0
*
* @param \WP_Post $item The WooCommerce product post to use in calculations.
*
* @return string
*/
protected function column_calc_date_expected( $item ) {
$date_expected = get_post_meta( $item->po_id, '_expected_at_location_date', TRUE );
return apply_filters( 'atum/inbound_stock_list/column_date_expected', $date_expected, $item, $this->product );
}
/**
* Column for purchase order
*
* @since 1.3.0
*
* @param \WP_Post $item The WooCommerce product post to use in calculations.
*
* @return string
*/
protected function column_calc_purchase_order( $item ) {
$po_link = '' . $item->po_id . '';
return apply_filters( 'atum/inbound_stock_list/column_purchase_order', $po_link, $item, $this->product );
}
/**
* Prepare the table data
*
* @since 1.4.2
*/
public function prepare_items() {
global $wpdb;
$search_query = '';
if ( ! empty( $_REQUEST['s'] ) ) {
$search = esc_attr( $_REQUEST['s'] );
if ( is_numeric( $search ) ) {
$search_query .= 'AND `meta_value` = ' . absint( $_REQUEST['s'] );
}
else {
$search_query .= "AND `order_item_name` LIKE '%{$search}%'";
}
}
$order_by = 'ORDER BY `order_id`';
if ( ! empty( $_REQUEST['orderby'] ) ) {
switch ( $_REQUEST['orderby'] ) {
case 'title':
$order_by = 'ORDER BY `order_item_name`';
break;
case 'ID':
$order_by = 'ORDER BY oi.`order_item_id`';
break;
}
}
$order = ( ! empty( $_REQUEST['order'] ) && in_array( strtoupper( $_REQUEST['order'] ), [ 'ASC', 'DESC' ] ) ) ? strtoupper( $_REQUEST['order'] ) : 'DESC';
$statuses = array_diff( array_keys( PurchaseOrders::get_statuses() ), [ PurchaseOrders::FINISHED ] );
$sql = $wpdb->prepare("
SELECT MAX(CAST( `meta_value` AS SIGNED )) AS product_id, oi.`order_item_id`, `order_id`, `order_item_name`
FROM `$wpdb->prefix" . AtumOrderPostType::ORDER_ITEMS_TABLE . "` AS oi
LEFT JOIN `{$wpdb->atum_order_itemmeta}` AS oim ON oi.`order_item_id` = oim.`order_item_id`
LEFT JOIN `{$wpdb->posts}` AS p ON oi.`order_id` = p.`ID`
WHERE `meta_key` IN ('_product_id', '_variation_id') AND `order_item_type` = 'line_item'
AND p.`post_type` = %s AND `meta_value` > 0 AND `post_status` IN ('" . implode( "','", $statuses ) . "')
$search_query
GROUP BY oi.`order_item_id`
$order_by $order;",
PurchaseOrders::POST_TYPE
); // WPCS: unprepared SQL ok.
$po_products = $wpdb->get_results( $sql ); // WPCS: unprepared SQL ok.
if ( ! empty( $po_products ) ) {
$found_posts = count( $po_products );
// Paginate the results (if needed).
if ( -1 !== $this->per_page && $found_posts > $this->per_page ) {
$page = $this->get_pagenum();
$offset = ( $page - 1 ) * $this->per_page;
$po_products = array_slice( $po_products, $offset, $this->per_page );
}
foreach ( $po_products as $po_product ) {
$post = get_post( $po_product->product_id );
if ( $post ) {
$post->po_id = $po_product->order_id;
$post->po_item_id = $po_product->order_item_id;
}
$this->items[] = $post;
}
$this->set_views_data();
$this->count_views['count_all'] = $found_posts;
$this->set_pagination_args( array(
'total_items' => $found_posts,
'per_page' => $this->per_page,
'total_pages' => -1 === $this->per_page ? 0 : ceil( $found_posts / $this->per_page ),
) );
}
}
/**
* Loads the current product
*
* @since 1.4.2
*
* @param \WP_Post $item The WooCommerce product post.
*/
public function single_row( $item ) {
$this->product = Helpers::get_atum_product( $item );
$this->allow_calcs = TRUE;
echo '';
$this->single_row_columns( $item );
echo '
';
// Reset the child value.
$this->is_child = FALSE;
}
/**
* Bulk actions are an associative array in the format 'slug' => 'Visible Title'
*
* @since 1.4.2
*
* @return array An associative array containing all the bulk actions: 'slugs'=>'Visible Titles'.
*/
protected function get_bulk_actions() {
// No bulk actions needed for Inbound Stock.
return apply_filters( 'atum/inbound_stock_list/bulk_actions', array() );
}
}