2019-05-07 18:42:42 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* WC_Admin_Page_Controller
|
|
|
|
*
|
|
|
|
* @package Woocommerce Admin
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* WC_Admin_Page_Controller
|
|
|
|
*/
|
|
|
|
class WC_Admin_Page_Controller {
|
|
|
|
// JS-powered page root.
|
2019-05-07 19:48:34 +00:00
|
|
|
const PAGE_ROOT = 'wc-admin';
|
2019-05-07 18:42:42 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Singleton instance of self.
|
|
|
|
*
|
|
|
|
* @var WC_Admin_Page_Controller
|
|
|
|
*/
|
|
|
|
private static $instance = false;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Registered pages
|
|
|
|
* Contains information (breadcrumbs, menu info) about JS powered pages and classic WooCommerce pages.
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
private $pages = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* We want a single instance of this class so we can accurately track registered menus and pages.
|
|
|
|
*/
|
|
|
|
public static function get_instance() {
|
|
|
|
if ( ! self::$instance ) {
|
|
|
|
self::$instance = new self();
|
|
|
|
}
|
|
|
|
|
|
|
|
return self::$instance;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the path from an ID.
|
|
|
|
*
|
|
|
|
* @param string $id ID to get path for.
|
2019-05-07 19:48:34 +00:00
|
|
|
* @return string Path for the given ID, or the ID on lookup miss.
|
2019-05-07 18:42:42 +00:00
|
|
|
*/
|
|
|
|
public function get_path_from_id( $id ) {
|
|
|
|
if ( isset( $this->pages[ $id ] ) && isset( $this->pages[ $id ]['path'] ) ) {
|
|
|
|
return $this->pages[ $id ]['path'];
|
|
|
|
}
|
2019-05-07 19:48:34 +00:00
|
|
|
return $id;
|
2019-05-07 18:42:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds a JS powered page to wc-admin.
|
|
|
|
*
|
|
|
|
* @param array $options {
|
|
|
|
* Array describing the page.
|
|
|
|
*
|
|
|
|
* @type string id Id to reference the page.
|
|
|
|
* @type string title Page title. Used in menus and breadcrumbs.
|
|
|
|
* @type string|null parent Parent ID. Null for new top level page.
|
|
|
|
* @type string path Path for this page, full path in app context; ex /analytics/report
|
|
|
|
* @type string capability Capability needed to access the page.
|
|
|
|
* @type string icon Icon. Dashicons helper class, base64-encoded SVG, or 'none'.
|
|
|
|
* @type int position Menu item position.
|
|
|
|
* }
|
|
|
|
*/
|
|
|
|
public function register_page( $options ) {
|
|
|
|
$defaults = array(
|
|
|
|
'id' => null,
|
|
|
|
'parent' => null,
|
|
|
|
'title' => '',
|
|
|
|
'capability' => 'manage_options',
|
|
|
|
'path' => '',
|
|
|
|
'icon' => '',
|
|
|
|
'position' => null,
|
|
|
|
);
|
|
|
|
|
2019-05-07 19:48:34 +00:00
|
|
|
$options = wp_parse_args( $options, $defaults );
|
|
|
|
|
|
|
|
if ( 0 !== strpos( $options['path'], self::PAGE_ROOT ) ) {
|
|
|
|
$options['path'] = self::PAGE_ROOT . '#' . $options['path'];
|
|
|
|
}
|
2019-05-07 18:42:42 +00:00
|
|
|
|
|
|
|
// TODO: check for null ID, or collision.
|
|
|
|
$this->pages[ $options['id'] ] = $options;
|
|
|
|
|
|
|
|
if ( is_null( $options['parent'] ) ) {
|
|
|
|
add_menu_page(
|
|
|
|
$options['title'],
|
|
|
|
$options['title'],
|
|
|
|
$options['capability'],
|
|
|
|
$options['path'],
|
|
|
|
array( __CLASS__, 'page_wrapper' ),
|
|
|
|
$options['icon'],
|
|
|
|
$options['position']
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
$parent_path = $this->get_path_from_id( $options['parent'] );
|
|
|
|
// TODO: check for null path.
|
|
|
|
add_submenu_page(
|
|
|
|
$parent_path,
|
|
|
|
$options['title'],
|
|
|
|
$options['title'],
|
|
|
|
$options['capability'],
|
|
|
|
$options['path'],
|
|
|
|
array( __CLASS__, 'page_wrapper' )
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set up a div for the app to render into.
|
|
|
|
*/
|
|
|
|
public static function page_wrapper() {
|
|
|
|
?>
|
|
|
|
<div class="wrap">
|
|
|
|
<div id="root"></div>
|
|
|
|
</div>
|
|
|
|
<?php
|
|
|
|
}
|
|
|
|
}
|