<?php /** * Adds the Invoices_Element UI to the Admin Panel. * * @package WP_Ultimo * @subpackage UI * @since 2.0.0 */ namespace WP_Ultimo\UI; use WP_Ultimo\UI\Base_Element; // Exit if accessed directly defined('ABSPATH') || exit; /** * Adds the Checkout Element UI to the Admin Panel. * * @since 2.0.0 */ class Invoices_Element extends Base_Element { use \WP_Ultimo\Traits\Singleton; /** * The id of the element. * * Something simple, without prefixes, like 'checkout', or 'pricing-tables'. * * This is used to construct shortcodes by prefixing the id with 'wu_' * e.g. an id checkout becomes the shortcode 'wu_checkout' and * to generate the Gutenberg block by prefixing it with 'wp-ultimo/' * e.g. checkout would become the block 'wp-ultimo/checkout'. * * @since 2.0.0 * @var string */ public $id = 'invoices'; /** * Controls if this is a public element to be used in pages/shortcodes by user. * * @since 2.0.24 * @var boolean */ protected $public = true; /** * The current membership. * * @since 2.2.0 * @var \WP_Ultimo\Models\Membership */ protected $membership; /** * The icon of the UI element. * e.g. return fa fa-search * * @since 2.0.0 * @param string $context One of the values: block, elementor or bb. * @return string */ public function get_icon($context = 'block') { if ('elementor' === $context) { return 'eicon-price-list'; } return 'fa fa-search'; } /** * The title of the UI element. * * This is used on the Blocks list of Gutenberg. * You should return a string with the localized title. * e.g. return __('My Element', 'wp-ultimo'). * * @since 2.0.0 * @return string */ public function get_title() { return __('Invoices', 'wp-ultimo'); } /** * The description of the UI element. * * This is also used on the Gutenberg block list * to explain what this block is about. * You should return a string with the localized title. * e.g. return __('Adds a checkout form to the page', 'wp-ultimo'). * * @since 2.0.0 * @return string */ public function get_description() { return __('Adds a checkout form block to the page.', 'wp-ultimo'); } /** * The list of fields to be added to Gutenberg. * * If you plan to add Gutenberg controls to this block, * you'll need to return an array of fields, following * our fields interface (@see inc/ui/class-field.php). * * You can create new Gutenberg panels by adding fields * with the type 'header'. See the Checkout Elements for reference. * * @see inc/ui/class-checkout-element.php * * Return an empty array if you don't have controls to add. * * @since 2.0.0 * @return array */ public function fields() { $fields = []; $fields['header'] = [ 'title' => __('General', 'wp-ultimo'), 'desc' => __('General', 'wp-ultimo'), 'type' => 'header', ]; $fields['title'] = [ 'type' => 'text', 'title' => __('Title', 'wp-ultimo'), 'value' => __('Invoices', 'wp-ultimo'), 'desc' => __('Leave blank to hide the title completely.', 'wp-ultimo'), 'tooltip' => '', ]; $fields['limit'] = [ 'type' => 'int', 'title' => __('Limit', 'wp-ultimo'), 'value' => 10, 'desc' => __('Limit the number of invoices to show.', 'wp-ultimo'), 'tooltip' => '', ]; return $fields; } /** * The list of keywords for this element. * * Return an array of strings with keywords describing this * element. Gutenberg uses this to help customers find blocks. * * e.g.: * return array( * 'WP Multisite WaaS', * 'Invoices', * 'Form', * 'Cart', * ); * * @since 2.0.0 * @return array */ public function keywords() { return [ 'WP Ultimo', 'WP Multisite WaaS', 'Invoices', 'Form', 'Cart', ]; } /** * List of default parameters for the element. * * If you are planning to add controls using the fields, * it might be a good idea to use this method to set defaults * for the parameters you are expecting. * * These defaults will be used inside a 'wp_parse_args' call * before passing the parameters down to the block render * function and the shortcode render function. * * @since 2.0.0 * @return array */ public function defaults() { return [ 'title' => __('Invoices', 'wp-ultimo'), 'limit' => 0, ]; } /** * Loads the required scripts. * * @since 2.0.0 * @return void */ public function register_scripts(): void { wp_enqueue_script('wu-ajax-list-table'); } /** * Loads dependencies for the render. * * @since 2.0.0 * @return void */ public function dependencies(): void { if ( ! function_exists('convert_to_screen')) { require_once ABSPATH . 'wp-admin/includes/template.php'; } if ( ! function_exists('get_column_headers')) { require_once ABSPATH . 'wp-admin/includes/class-wp-screen.php'; require_once ABSPATH . 'wp-admin/includes/screen.php'; } if ( ! function_exists('wu_responsive_table_row')) { require wu_path('/inc/functions/admin.php'); } } /** * Runs early on the request lifecycle as soon as we detect the shortcode is present. * * @since 2.0.0 * @return void */ public function setup(): void { $this->membership = WP_Ultimo()->currents->get_membership(); if ( ! $this->membership) { $this->set_display(false); return; } } /** * Allows the setup in the context of previews. * * @since 2.0.0 * @return void */ public function setup_preview(): void { $this->membership = wu_mock_membership(); } /** * The content to be output on the screen. * * Should return HTML markup to be used to display the block. * This method is shared between the block render method and * the shortcode implementation. * * @since 2.0.0 * * @param array $atts Parameters of the block/shortcode. * @param string|null $content The content inside the shortcode. * @return string */ public function output($atts, $content = null) { $atts['membership'] = $this->membership; return wu_get_template_contents('dashboard-widgets/invoices', $atts); } }