WC_Admin_Dashboard_Setup{} │ WC 1.0
WC_Admin_Dashboard_Setup Class.
No Hooks.
Usage
$WC_Admin_Dashboard_Setup = new WC_Admin_Dashboard_Setup(); // use class methods
Methods
- public __construct()
- public render()
- public get_button_link( $task )
- public get_task_list()
- public set_task_list( $task_list )
- public get_tasks()
- public get_completed_tasks_count()
- public should_display_widget()
- private get_task_header( $task )
- private get_next_task()
WC_Admin_Dashboard_Setup{} WC Admin Dashboard Setup{} code WC 11.0.1
class WC_Admin_Dashboard_Setup {
/**
* Check for task list initialization.
*/
private bool $initialized = false;
/**
* The task list.
*/
private $task_list = null;
/**
* The tasks.
*/
private $tasks = null;
/**
* # of completed tasks.
*
* @var int
*/
private $completed_tasks_count = 0;
/**
* WC_Admin_Dashboard_Setup constructor.
*/
public function __construct() {
if ( $this->should_display_widget() ) {
add_meta_box(
'wc_admin_dashboard_setup',
__( 'WooCommerce Setup', 'woocommerce' ),
array( $this, 'render' ),
'dashboard',
'normal',
'high'
);
}
}
/**
* Render meta box output.
*/
public function render() {
$version = Constants::get_constant( 'WC_VERSION' );
wp_enqueue_style( 'wc-dashboard-setup', WC()->plugin_url() . '/assets/css/dashboard-setup.css', array(), $version );
$task = $this->get_next_task();
if ( ! $task ) {
return;
}
$button_link = $this->get_button_link( $task );
$task_header = $this->get_task_header( $task );
$task_is_in_progress = $task->is_in_progress();
$task_in_progress_label = $task_is_in_progress ? $task->in_progress_label() : '';
$completed_tasks_count = $this->get_completed_tasks_count();
$step_number = $completed_tasks_count + 1;
$tasks_count = count( $this->get_tasks() );
// Given 'r' (circle element's r attr), dashoffset = ((100-$desired_percentage)/100) * PI * (r*2).
$progress_percentage = ( $completed_tasks_count / $tasks_count ) * 100;
$circle_r = 6.5;
$circle_dashoffset = ( ( 100 - $progress_percentage ) / 100 ) * ( pi() * ( $circle_r * 2 ) );
include __DIR__ . '/views/html-admin-dashboard-setup.php';
}
/**
* Get dashboard widget header data for a task.
*
* @param Task $task Task.
* @return array
*/
private function get_task_header( $task ) {
$asset_url = WC()->plugin_url() . '/assets/';
$task_json = $task->get_json();
$default_task_header = array(
'title' => $task->get_title(),
'content' => $task_json['content'] ?? '',
'button_label' => $task_json['actionLabel'] ?? $task->get_title(),
'image_url' => $asset_url . 'images/dashboard-widget-setup.png',
'image_alt' => __( 'WooCommerce setup illustration', 'woocommerce' ),
);
$task_images = array(
'store_details' => array(
'image_url' => $asset_url . 'images/task_list/store-details-illustration.png',
'image_alt' => __( 'Store location illustration', 'woocommerce' ),
),
'customize-store' => array(
'image_url' => $asset_url . 'images/task_list/customize-store-illustration.svg',
'image_alt' => __( 'Customize your store illustration', 'woocommerce' ),
),
'tax' => array(
'image_url' => $asset_url . 'images/task_list/tax-illustration.svg',
'image_alt' => __( 'Tax illustration', 'woocommerce' ),
),
'shipping' => array(
'image_url' => $asset_url . 'images/task_list/shipping-illustration.svg',
'image_alt' => __( 'Shipping illustration', 'woocommerce' ),
),
'marketing' => array(
'image_url' => $asset_url . 'images/task_list/sales-illustration.svg',
'image_alt' => __( 'Marketing illustration', 'woocommerce' ),
),
'payments' => array(
'image_url' => $asset_url . 'images/task_list/payment-illustration.svg',
'image_alt' => __( 'Payment illustration', 'woocommerce' ),
),
'woocommerce-payments' => array(
'image_url' => $asset_url . 'images/task_list/payment-illustration.svg',
'image_alt' => __( 'Payment illustration', 'woocommerce' ),
),
'products' => array(
'image_url' => $asset_url . 'images/task_list/sales-section-illustration.svg',
'image_alt' => __( 'Products illustration', 'woocommerce' ),
),
'purchase' => array(
'image_url' => $asset_url . 'images/task_list/purchase-illustration.png',
'image_alt' => __( 'Purchase illustration', 'woocommerce' ),
),
'launch-your-store' => array(
'image_url' => $asset_url . 'images/task_list/launch-your-store-illustration.svg',
'image_alt' => __( 'Launch your store illustration', 'woocommerce' ),
),
);
return array_merge( $default_task_header, $task_images[ $task->get_id() ] ?? array() );
}
/**
* Get the button link for a given task.
*
* @param Task $task Task.
* @return string
*/
public function get_button_link( $task ) {
// Check if core profiler needs completion and redirect to it.
if ( class_exists( OnboardingProfile::class ) ) {
if ( OnboardingProfile::needs_completion() ) {
return wc_admin_url( '&path=/setup-wizard' );
}
}
$url = (string) $task->get_json()['actionUrl'];
if ( substr( $url, 0, 4 ) === 'http' ) {
return $url;
} elseif ( $url ) {
return wc_admin_url( '&path=' . $url );
}
return admin_url( 'admin.php?page=wc-admin&task=' . $task->get_id() );
}
/**
* Get the task list.
*
* @return array
*/
public function get_task_list() {
if ( $this->task_list || $this->initialized ) {
return $this->task_list;
}
$this->set_task_list( TaskLists::get_list( 'setup' ) );
$this->initialized = true;
return $this->task_list;
}
/**
* Set the task list.
*/
public function set_task_list( $task_list ) {
return $this->task_list = $task_list;
}
/**
* Get the tasks.
*
* @return array
*/
public function get_tasks() {
if ( $this->tasks ) {
return $this->tasks;
}
$this->tasks = $this->get_task_list()->get_viewable_tasks();
return $this->tasks;
}
/**
* Return # of completed tasks
*
* @return integer
*/
public function get_completed_tasks_count() {
$completed_tasks = array_filter(
$this->get_tasks(),
function( $task ) {
return $task->is_complete();
}
);
return count( $completed_tasks );
}
/**
* Get the next task.
*
* @return Task|null
*/
private function get_next_task() {
foreach ( $this->get_tasks() as $task ) {
if ( false === $task->is_complete() ) {
return $task;
}
}
return null;
}
/**
* Check to see if we should display the widget
*
* @return bool
*/
public function should_display_widget() {
if ( ! class_exists( 'Automattic\WooCommerce\Admin\Features\Features' ) || ! class_exists( 'Automattic\WooCommerce\Admin\Features\OnboardingTasks\TaskLists' ) ) {
return false;
}
if ( ! Features::is_enabled( 'onboarding' ) || ! WC()->is_wc_admin_active() ) {
return false;
}
if ( ! current_user_can( 'manage_woocommerce' ) ) {
return false;
}
if ( ! $this->get_task_list() || $this->get_task_list()->is_hidden() || $this->get_task_list()->is_complete() ) {
return false;
}
return true;
}
}