Skip to content

Instantly share code, notes, and snippets.

@avishai

avishai/class-wcvendors-pro-dashboard.php Secret

Created February 20, 2017 20:08
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save avishai/78bf8035499712799fb0d91b86a0fb37 to your computer and use it in GitHub Desktop.
Save avishai/78bf8035499712799fb0d91b86a0fb37 to your computer and use it in GitHub Desktop.
Download ZIP
Pro Dashboard - Orders Page Not Working
Raw
class-wcvendors-pro-dashboard.php
<?php
/**
* The main WCVendors Pro Dashboard class
*
* This is the main controller class for the dashboard, all actions are defined in this class.
*
* @package WCVendors_Pro
* @subpackage WCVendors_Pro/public
* @author Jamie Madden <support@wcvendors.com>
*/
class WCVendors_Pro_Dashboard {
/**
* The ID of this plugin.
*
* @since 1.0.0
* @access private
* @var string $wcvendors_pro The ID of this plugin.
*/
private $wcvendors_pro;
/**
* The version of this plugin.
*
* @since 1.0.0
* @access private
* @var string $version The current version of this plugin.
*/
private $version;
/**
* Is the plugin in debug mode
*
* @since 1.0.0
* @access private
* @var bool $debug plugin is in debug mode
*/
private $debug;
/**
* Is the plugin in debug mode
*
* @since 1.0.0
* @access private
* @var array $dashboard_pages an array of dashboard pages
*/
private $dashboard_pages = array();
/**
* Is the plugin base directory
*
* @since 1.0.0
* @access private
* @var string $base_dir string path for the plugin directory
*/
private $base_dir;
/**
* Initialize the class and set its properties.
*
* @since 1.0.0
* @param string $wcvendors_pro The name of the plugin.
* @param string $version The version of this plugin.
*/
public function __construct( $wcvendors_pro, $version, $debug ) {
$this->wcvendors_pro = $wcvendors_pro;
$this->version = $version;
$this->debug = $debug;
$this->base_dir = plugin_dir_path( dirname( __FILE__ ) );
}
/**
* Load the dasboard based on the query vars loaded.
*
* @since 1.0.0
*/
public function load_dashboard( )
{
$dashboard_page_id = WCVendors_Pro::get_option( 'dashboard_page_id' );
if ( $dashboard_page_id == '' ) {
echo __( '<h2>Please ensure you have set a page for the Pro Dashboard.</h2>', 'wcvendors-pro' );
exit;
}
global $wp;
if ( isset( $wp->query_vars[ 'object' ] ) ) {
$type = get_query_var( 'object' );
$action = get_query_var( 'action' );
$id = get_query_var( 'object_id' );
return $this->load_page( $type, $action, $id );
} else {
return $this->load_page();
}
} // load_dashboard()
/**
* Output the requested page for the dashboard
*
* @since 1.0.0
* @param string $page_type page type to output
* @param string $action page action
* @param int $object_id object id this is related to
*/
public function load_page( $object = 'dashboard', $action = '', $object_id = null )
{
// Permission check for all dashboard pages
if ( !$this->can_view_dashboard() ) { return false; }
// Has the page been disabled ?
if ( ! $this->page_disabled() ) {
$return_url = $this->get_dashboard_page_url();
wc_get_template( 'permission.php', array( 'return_url' => $return_url ), 'wc-vendors/dashboard/', $this->base_dir . 'templates/dashboard/' );
return false;
}
// Does the user own this object ?
if ( $object_id != null ) {
if ( $this->check_object_permission( $object, $object_id ) == false ) {
$return_url = $this->get_dashboard_page_url();
wc_get_template( 'permission.php', array( 'return_url' => $return_url ), 'wc-vendors/dashboard/', $this->base_dir . 'templates/dashboard/' );
return false;
}
}
// Include the dashboard wrapper
include_once( apply_filters( 'wcvendors_pro_dashboard_open_path', 'partials/wcvendors-pro-dashboard-open.php' ) );
do_action( 'wcv_pro_before_dashboard' );
// Create the menu
$this->create_nav();
// Print woocommerce notices
wc_print_notices();
// Vendor Store Notice
$vendor_dashboard_notice = WCVendors_Pro::get_option( 'vendor_dashboard_notice' );
if ( $vendor_dashboard_notice ) {
wc_get_template( 'dashboard-notice.php',
array(
'vendor_dashboard_notice' => $vendor_dashboard_notice,
),
'wc-vendors/dashboard/', $this->base_dir . '/templates/dashboard/' );
}
// if action is set send to edit page with or without object_id else list type
if ('edit' == $action ) {
wc_get_template( $object.'-'.$action.'.php',
array(
'action' => $action,
'object_id' => $object_id
),
'wc-vendors/dashboard/', $this->base_dir . '/templates/dashboard/' );
} else {
error_log("------------------------------------------------------");
error_log("WCVendors_Pro_Dashboard Routing Debug:");
error_log($_SERVER['REQUEST_URI']);
error_log(print_r($object, true));
if ($_SERVER['REQUEST_URI'] == '/dashboard/order/') {
error_log("Matched orders page URL!");
$this->load_order_page();
break;
}
// If the object is a post type then generate a table, otherwise load the custom template
if ( post_type_exists( $object ) ) {
// Use the internal table generator to create object list
$object_table = new WCVendors_Pro_Table_Helper( $this->wcvendors_pro, $this->version, $object, $object, get_current_user_id() );
$object_table->display();
} else {
switch ( $object ) {
case 'order':
$this->load_order_page();
break;
case 'rating':
$this->load_rating_page();
break;
case 'settings':
$this->load_settings_page();
break;
default:
$this->dashboard_quick_links();
$store_report = new WCVendors_Pro_Reports_Controller( $this->wcvendors_pro, $this->version, $this->debug );
$store_report->report_init();
$store_report->display();
break;
}
}
}
do_action( 'wcv_pro_after_dashboard' );
include_once( apply_filters( 'wcvendors_pro_dashboard_close_path', 'partials/wcvendors-pro-dashboard-close.php' ) );
} // load_page()
/**
* Generate the page URL based on the dashboard page id set in options
*
* @since 1.0.0
* @param string $page_type page type to output
*/
public static function get_dashboard_page_url( $page = '' )
{
$dashboard_page_id = WCVendors_Pro::get_option( 'dashboard_page_id' );
return get_permalink( $dashboard_page_id ) . $page;
} // dashboard_page_url()
/**
* Provide quick links on the dashboard to reduce click through
*
* @since 1.1.5
*/
public function get_dashboard_quick_links(){
$products_disabled = WCVendors_Pro::get_option( 'product_management_cap' );
$coupons_disabled = WCVendors_Pro::get_option( 'shop_coupon_management_cap' );
$product_ids = WCVendors_Pro_Vendor_Controller::get_products_by_id( get_current_user_id() );
if ( empty( $product_ids )) $coupons_disabled = true;
$quick_links = array();
if ( ! $products_disabled ) $quick_links['product'] = array( 'url' => apply_filters( 'wcv_add_product_url', self::get_dashboard_page_url( 'product/edit' ) ), 'label' => __( 'Add Product', 'wcvendors-pro' ) );
if ( ! $coupons_disabled ) $quick_links['shop_coupon'] = array( 'url' => self::get_dashboard_page_url( 'shop_coupon/edit' ), 'label' => __( 'Add Coupon', 'wcvendors-pro' ) );
return apply_filters( 'wcv_dashboard_quick_links', $quick_links );
} // get_dashboard_quick_links()
/**
* Provide quick links on the dashboard to reduce click through
*
* @since 1.1.5
*/
public function dashboard_quick_links(){
$quick_links = $this->get_dashboard_quick_links();
wc_get_template( 'quick-links.php', array(
'quick_links' => $quick_links ),
'wc-vendors/dashboard/', $this->base_dir . 'templates/dashboard/' );
} //dashboard_quick_links()
/**
* Available dashboard urls for front end functionality
*
* @since 1.0.0
*/
public function get_dashboard_pages() {
$disable_duplicate = WC_Vendors::$pv_options->get_option( 'duplicate_product_cap' );
$this->dashboard_pages[ 'product' ] = array(
'slug' => 'product',
'label' => __('Products', 'wcvendors-pro' ),
'actions' => array(
'edit' => __(' Edit', 'wcvendors-pro' ),
'duplicate' => __(' Duplicate', 'wcvendors-pro' ),
'delete' => __(' Delete', 'wcvendors-pro' )
)
);
if ( $disable_duplicate ) unset( $this->dashboard_pages[ 'product' ][ 'actions' ][ 'duplicate' ] );
$this->dashboard_pages[ 'order' ] = array(
'slug' => 'order',
'label' => __('Orders', 'wcvendors-pro' ),
'actions' => array()
);
$this->dashboard_pages[ 'settings' ] = array(
'slug' => 'settings',
'label' => __('Settings', 'wcvendors-pro' ),
'actions' => array( )
);
$this->dashboard_pages[ 'rating' ] = array(
'slug' => 'rating',
'label' => __('Ratings', 'wcvendors-pro' ),
'actions' => array()
);
if ('yes' == get_option( 'woocommerce_enable_coupons' ) ) {
$this->dashboard_pages[ 'shop_coupon' ] = array(
'slug' => 'shop_coupon',
'label' => __('Coupons', 'wcvendors-pro' ),
'actions' => array(
'edit' => __('Edit', 'wcvendors-pro' ),
'delete' => __('Delete', 'wcvendors-pro' )
)
);
}
return apply_filters( 'wcv_pro_dashboard_urls', $this->dashboard_pages );
} // get_dashboard_pages()
/**
* Load the orders table
*
* @since 1.0.0
*/
public function load_order_page()
{
$wcvendors_pro_order_controller = new WCVendors_Pro_Order_Controller( $this->wcvendors_pro, $this->version, $this->debug );
$wcvendors_pro_order_controller->display();
} // load_order_page()
/**
* Load the orders table
*
* @since 1.0.0
*/
public function load_rating_page()
{
$wcvendors_pro_rating_controller = new WCVendors_Pro_Ratings_Controller( $this->wcvendors_pro, $this->version, $this->debug );
$wcvendors_pro_rating_controller->display();
} // load_order_page()
/**
* Load the orders table
*
* @since 1.1.0
*/
public function load_settings_page()
{
global $woocommerce;
$vendor_id = get_current_user_id();
$store_name = get_user_meta( $vendor_id, 'pv_shop_name', true );
$store_description = get_user_meta( $vendor_id, 'pv_shop_description', true );
$shipping_disabled = WCVendors_Pro::get_option( 'shipping_management_cap' );
$shipping_methods = $woocommerce->shipping->load_shipping_methods();
$shipping_method_enabled = ( array_key_exists( 'wcv_pro_vendor_shipping', $shipping_methods ) && $shipping_methods['wcv_pro_vendor_shipping']->enabled == 'yes' ) ? true : 0;
$shipping_details = get_user_meta( get_current_user_id(), '_wcv_shipping', true );
wc_get_template( 'store-settings.php', array(
'store_name' => $store_name,
'store_description' => $store_description,
'shipping_disabled' => $shipping_disabled,
'shipping_method_enabled' => $shipping_method_enabled,
'shipping_details' => $shipping_details
),
'wc-vendors/dashboard/', $this->base_dir . 'templates/dashboard/' );
} // load_order_page()
/**
* Check object permission to see if the vendor owns the object (this is to stop people messing with URLs)
*
* @since 1.0.0
* @version 1.3.7
* @param string $page_type the page type to test
* @param int $post_id post id to check
*/
public static function check_object_permission( $object, $post_id ) {
$can_edit_live = WC_Vendors::$pv_options->get_option( 'can_edit_published_products' );
$edit_status = apply_filters( 'wcv_edit_object_status', array( 'draft', 'pending' ) );
$post_status = get_post_status( $post_id );
$can_edit = in_array($post_status, $edit_status );
if ( ! $can_edit_live ) $can_edit_live = $can_edit ? true : false;
switch ( $object ) {
// Product permissions
case 'product':
return ( $can_edit_live && WCV_Vendors::get_vendor_from_product( $post_id ) == get_current_user_id() ) ? true : false;
break;
case 'shop_coupon':
return ( WCVendors_Pro_Vendor_Controller::get_vendor_from_object( $post_id ) != get_current_user_id() ) ? false : true;
break;
// Dashboard
default:
return true;
break;
}
} // check_object_permission()
/**
* Check permission before the page loads
*
* @since 1.0.0
*/
public function check_permission()
{
$current_page_id = get_the_ID();
$dashboard_page_id = WCVendors_Pro::get_option( 'dashboard_page_id' );
if ( $current_page_id == $dashboard_page_id ) {
if ( !is_user_logged_in() ) {
$my_account_page = wc_get_page_id( 'myaccount' );
if ( ! is_string( get_post_status( $my_account_page ) ) ){
wc_add_notice( __( '<h2>Please contact the website administrator and instruct them that in order for the Vendor Dashboard to work for logged out users, they must have their My Account page configured and set properly in their WooCommerce settings.</h2>', 'wcvendors-pro' ), 'error');
} else {
wp_redirect( apply_filters( 'wcv_login_redirect', get_permalink( wc_get_page_id( 'myaccount' ) ) ), 302);
exit;
}
}
}
} // check_permission()
/**
* Can the current user view the dashboard ?
*
* @since 1.0.0
*/
public function can_view_dashboard() {
if ( !is_user_logged_in() ) {
return false;
} else if ( !WCV_Vendors::is_vendor( get_current_user_id() ) ) {
// Include the dashboard wrapper
include_once( apply_filters( 'wcvendors_pro_dashboard_open_path', 'partials/wcvendors-pro-dashboard-open.php' ) );
if ( WCVendors_Pro_Vendor_Controller::is_pending_vendor( get_current_user_id() ) ) {
$vendor_pending_notice = WCVendors_Pro::get_option( 'vendor_pending_notice' );
wc_get_template( 'vendor-pending-notice.php', array( 'vendor_pending_notice' => $vendor_pending_notice ), 'wc-vendors/front/', $this->base_dir . '/templates/front/' );
return false;
} elseif ( !current_user_can('administrator') ) {
$vendor_signup_notice = WCVendors_Pro::get_option( 'vendor_signup_notice' );
// Load the new sign up form template
wc_get_template( 'vendor-signup-form.php', array( 'vendor_signup_notice' => $vendor_signup_notice ), 'wc-vendors/front/', $this->base_dir . '/templates/front/' );
return false;
} else {
echo __( 'Admins cannot apply to be vendors. ', 'wcvendors-pro' );
return false;
}
// Close the dashboard wrapper
include_once( apply_filters( 'wcvendors_pro_dashboard_close_path', 'partials/wcvendors-pro-dashboard-close.php' ) );
}
return true;
} // can_view_dashboard()
/**
* Add the query vars for the rewrirte rules add_query_vars function.
*
* @access public
* @since 1.0.0
* @param array $vars query vars array
* @return array $vars new query vars
*/
public function add_query_vars( $vars ) {
$vars[] = "object";
$vars[] = "object_id";
$vars[] = "action";
return $vars;
} // add_query_vars()
/**
* Dashboard rewrite rules
*
* @since 1.0.0
* @param array $rules rules array
*/
public function rewrite_rules( $rules ) {
$dashboard_page_id = WCVendors_Pro::get_option( 'dashboard_page_id' );
// If the dashboard page hasn't been set, don't create the re-write rules
if ( $dashboard_page_id ) {
$dashboard_page_slug = get_post( $dashboard_page_id )->post_name;
$pages = self::get_dashboard_pages();
foreach ( $pages as $page ) {
// Type Rule
$type_rule = array(
$dashboard_page_slug.'/'.$page['slug'].'?$' => 'index.php?pagename='.$dashboard_page_slug.'&object='.$page['slug'],
$dashboard_page_slug.'/'.$page['slug'].'/page/([0-9]+)' => 'index.php?pagename='.$dashboard_page_slug.'&object='.$page['slug'] .'&paged=$matches[1]');
$rules = $type_rule + $rules;
if ( is_array( $page['actions'] ) ) {
foreach ( $page['actions'] as $action => $label ) {
// Actions Rule
$action_rule = array( $dashboard_page_slug.'/'.$page['slug'].'/'.$action.'?$' => 'index.php?pagename='.$dashboard_page_slug.'&object='.$page['slug'].'&action='.$action);
// Id parsed ?
$id_rule = array( $dashboard_page_slug.'/'.$page['slug'].'/'.$action.'/([0-9]+)?$' => 'index.php?pagename='.$dashboard_page_slug.'&object='.$page['slug'].'&action='.$action.'&object_id=$matches[1]');
$rules = $action_rule + $id_rule + $rules;
}
}
}
}
return $rules;
} // rewrite_rules()
/**
* Create the dashboard navigation from available pages.
*
* @since 1.0.0
* @todo Have this menu output better
*/
public function create_nav( ) {
$pages = self::get_dashboard_pages();
$current_page = get_query_var( 'object' );
$products_disabled = WCVendors_Pro::get_option( 'product_management_cap' );
$orders_disabled = WCVendors_Pro::get_option( 'order_management_cap' );
$coupons_disabled = WCVendors_Pro::get_option( 'shop_coupon_management_cap' );
$ratings_disabled = WCVendors_Pro::get_option( 'ratings_management_cap' );
$settings_disabled = WCVendors_Pro::get_option( 'settings_management_cap' );
$viewstore_disabled = WCVendors_Pro::get_option( 'view_store_cap' );
if ( $products_disabled ) unset( $pages['product'] );
if ( $orders_disabled ) unset( $pages['order'] );
if ( $coupons_disabled ) unset( $pages['shop_coupon'] );
if ( $ratings_disabled ) unset( $pages['rating'] );
if ( $settings_disabled) unset( $pages['settings'] );
// Add dashboard home to the pages array
$dashboard_home = apply_filters( 'wcv_dashboard_home_url', array( 'label' => __( 'Dashboard', 'wcvendors-pro' ), 'slug' => '' ) );
if ( !$viewstore_disabled ) {
$store_url = apply_filters( 'wcv_dashboard_view_store_url', array( 'label' => __( 'View Store', 'wcvendors-pro' ),'slug' => WCVendors_Pro_Vendor_Controller::get_vendor_store_url( get_current_user_id() ) ) );
$pages[ 'view_store' ] = $store_url;
}
$pages = array_merge( array( 'dashboard_home' => $dashboard_home ), $pages );
$pages = apply_filters( 'wcv_dashboard_pages_nav', $pages );
$nav_class = apply_filters( 'wcv_dashboard_nav_class', '' );
// Move this into a template
echo '<div class="wcv-cols-group wcv-horizontal-gutters">';
echo '<div class="all-100">';
echo '<nav class="wcv-navigation ' . $nav_class . ' ">';
echo ' <ul class="menu horizontal black flyout">';
foreach ( $pages as $page ) {
if ( filter_var( $page['slug'], FILTER_VALIDATE_URL ) === FALSE ) {
$page_url = $this->get_dashboard_page_url( $page['slug'] );
} else {
$page_url = $page['slug'];
}
$class = ( $current_page === $page['slug'] ) ? 'active' : '';
$page_label = $page['label'];
if(array_key_exists('link_target', $page)) {
$link_target = $page['link_target'];
} else {
$link_target = '_self';
}
wc_get_template( 'nav.php', array(
'page' => $page,
'page_url' => $page_url,
'page_label' => $page_label,
'class' => $class,
'link_target' => $link_target ),
'wc-vendors/dashboard/', $this->base_dir . 'templates/dashboard/' );
}
echo '</ul>';
echo '</div>';
echo '</div>';
} //create_nav()
/**
* Check if a page is disabled and return if it is
*
* @since 1.3.0
*/
public function page_disabled(){
$products_disabled = WCVendors_Pro::get_option( 'product_management_cap' );
$orders_disabled = WCVendors_Pro::get_option( 'order_management_cap' );
$coupons_disabled = WCVendors_Pro::get_option( 'shop_coupon_management_cap' );
$ratings_disabled = WCVendors_Pro::get_option( 'ratings_management_cap' );
$settings_disabled = WCVendors_Pro::get_option( 'settings_management_cap' );
$current_page = get_query_var( 'object' );
switch ( $current_page ) {
case 'product':
return ( $products_disabled ) ? false : true;
break;
case 'order':
return ( $orders_disabled ) ? false : true;
break;
case 'shop_coupon':
return ( $coupons_disabled ) ? false : true;
break;
case 'rating':
return ( $ratings_disabled ) ? false : true;
break;
case 'settings':
return ( $settings_disabled ) ? false : true;
break;
default:
return true;
break;
}
} // page_disabled()
/**
* Shortcode for dashboard navigation
*
* @since 1.3.3
*/
public function load_dashboard_nav( ){
if ( !is_user_logged_in() ) {
return false;
} else if ( WCV_Vendors::is_vendor( get_current_user_id() ) ) {
ob_start();
$this->create_nav();
return ob_get_clean();
}
} // load_dashboard_nav()
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment