AyeCode /
invoicing
@@ -1,262 +1,262 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | if ( ! class_exists( 'WP_Super_Duper' ) ) { |
| 7 | 7 | |
| 8 | 8 | |
| 9 | - /** |
|
| 10 | - * A Class to be able to create a Widget, Shortcode or Block to be able to output content for WordPress. |
|
| 11 | - * |
|
| 12 | - * Should not be called direct but extended instead. |
|
| 13 | - * |
|
| 14 | - * Class WP_Super_Duper |
|
| 15 | - * @since 1.0.16 change log moved to file change-log.txt - CHANGED |
|
| 16 | - * @ver 1.0.19 |
|
| 17 | - */ |
|
| 18 | - class WP_Super_Duper extends WP_Widget { |
|
| 19 | - |
|
| 20 | - public $version = "1.0.23"; |
|
| 21 | - public $font_awesome_icon_version = "5.11.2"; |
|
| 22 | - public $block_code; |
|
| 23 | - public $options; |
|
| 24 | - public $base_id; |
|
| 25 | - public $settings_hash; |
|
| 26 | - public $arguments = array(); |
|
| 27 | - public $instance = array(); |
|
| 28 | - private $class_name; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * The relative url to the current folder. |
|
| 32 | - * |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 35 | - public $url = ''; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Take the array options and use them to build. |
|
| 39 | - */ |
|
| 40 | - public function __construct( $options ) { |
|
| 41 | - global $sd_widgets; |
|
| 42 | - |
|
| 43 | - $sd_widgets[ $options['base_id'] ] = array( |
|
| 44 | - 'name' => $options['name'], |
|
| 45 | - 'class_name' => $options['class_name'] |
|
| 46 | - ); |
|
| 47 | - $this->base_id = $options['base_id']; |
|
| 48 | - // lets filter the options before we do anything |
|
| 49 | - $options = apply_filters( "wp_super_duper_options", $options ); |
|
| 50 | - $options = apply_filters( "wp_super_duper_options_{$this->base_id}", $options ); |
|
| 51 | - $options = $this->add_name_from_key( $options ); |
|
| 52 | - $this->options = $options; |
|
| 53 | - |
|
| 54 | - $this->base_id = $options['base_id']; |
|
| 55 | - $this->arguments = isset( $options['arguments'] ) ? $options['arguments'] : array(); |
|
| 56 | - |
|
| 57 | - // init parent |
|
| 58 | - parent::__construct( $options['base_id'], $options['name'], $options['widget_ops'] ); |
|
| 59 | - |
|
| 60 | - if ( isset( $options['class_name'] ) ) { |
|
| 61 | - // register widget |
|
| 62 | - $this->class_name = $options['class_name']; |
|
| 63 | - |
|
| 64 | - // register shortcode |
|
| 65 | - $this->register_shortcode(); |
|
| 66 | - |
|
| 67 | - // Fusion Builder (avada) support |
|
| 68 | - if ( function_exists( 'fusion_builder_map' ) ) { |
|
| 69 | - add_action( 'init', array( $this, 'register_fusion_element' ) ); |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - // register block |
|
| 73 | - add_action( 'admin_enqueue_scripts', array( $this, 'register_block' ) ); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - // add the CSS and JS we need ONCE |
|
| 77 | - global $sd_widget_scripts; |
|
| 78 | - |
|
| 79 | - if ( ! $sd_widget_scripts ) { |
|
| 80 | - wp_add_inline_script( 'admin-widgets', $this->widget_js() ); |
|
| 81 | - wp_add_inline_script( 'customize-controls', $this->widget_js() ); |
|
| 82 | - wp_add_inline_style( 'widgets', $this->widget_css() ); |
|
| 83 | - |
|
| 84 | - // maybe add elementor editor styles |
|
| 85 | - add_action( 'elementor/editor/after_enqueue_styles', array( $this, 'elementor_editor_styles' ) ); |
|
| 86 | - |
|
| 87 | - $sd_widget_scripts = true; |
|
| 88 | - |
|
| 89 | - // add shortcode insert button once |
|
| 90 | - add_action( 'media_buttons', array( $this, 'shortcode_insert_button' ) ); |
|
| 91 | - // generatepress theme sections compatibility |
|
| 92 | - if ( function_exists( 'generate_sections_sections_metabox' ) ) { |
|
| 93 | - add_action( 'generate_sections_metabox', array( $this, 'shortcode_insert_button_script' ) ); |
|
| 94 | - } |
|
| 95 | - if ( $this->is_preview() ) { |
|
| 96 | - add_action( 'wp_footer', array( $this, 'shortcode_insert_button_script' ) ); |
|
| 97 | - // this makes the insert button work for elementor |
|
| 98 | - add_action( 'elementor/editor/after_enqueue_scripts', array( |
|
| 99 | - $this, |
|
| 100 | - 'shortcode_insert_button_script' |
|
| 101 | - ) ); // for elementor |
|
| 102 | - } |
|
| 103 | - // this makes the insert button work for cornerstone |
|
| 104 | - add_action( 'wp_print_footer_scripts', array( __CLASS__, 'maybe_cornerstone_builder' ) ); |
|
| 105 | - |
|
| 106 | - add_action( 'wp_ajax_super_duper_get_widget_settings', array( __CLASS__, 'get_widget_settings' ) ); |
|
| 107 | - add_action( 'wp_ajax_super_duper_get_picker', array( __CLASS__, 'get_picker' ) ); |
|
| 108 | - |
|
| 109 | - // add generator text to admin head |
|
| 110 | - add_action( 'admin_head', array( $this, 'generator' ) ); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - do_action( 'wp_super_duper_widget_init', $options, $this ); |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Add our widget CSS to elementor editor. |
|
| 118 | - */ |
|
| 119 | - public function elementor_editor_styles() { |
|
| 120 | - wp_add_inline_style( 'elementor-editor', $this->widget_css( false ) ); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - public function register_fusion_element() { |
|
| 124 | - |
|
| 125 | - $options = $this->options; |
|
| 126 | - |
|
| 127 | - if ( $this->base_id ) { |
|
| 128 | - |
|
| 129 | - $params = $this->get_fusion_params(); |
|
| 130 | - |
|
| 131 | - $args = array( |
|
| 132 | - 'name' => $options['name'], |
|
| 133 | - 'shortcode' => $this->base_id, |
|
| 134 | - 'icon' => $options['block-icon'] ? $options['block-icon'] : 'far fa-square', |
|
| 135 | - 'allow_generator' => true, |
|
| 136 | - ); |
|
| 137 | - |
|
| 138 | - if ( ! empty( $params ) ) { |
|
| 139 | - $args['params'] = $params; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - fusion_builder_map( $args ); |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - public function get_fusion_params() { |
|
| 148 | - $params = array(); |
|
| 149 | - $arguments = $this->get_arguments(); |
|
| 150 | - |
|
| 151 | - if ( ! empty( $arguments ) ) { |
|
| 152 | - foreach ( $arguments as $key => $val ) { |
|
| 153 | - $param = array(); |
|
| 154 | - // type |
|
| 155 | - $param['type'] = str_replace( |
|
| 156 | - array( |
|
| 157 | - "text", |
|
| 158 | - "number", |
|
| 159 | - "email", |
|
| 160 | - "color", |
|
| 161 | - "checkbox" |
|
| 162 | - ), |
|
| 163 | - array( |
|
| 164 | - "textfield", |
|
| 165 | - "textfield", |
|
| 166 | - "textfield", |
|
| 167 | - "colorpicker", |
|
| 168 | - "select", |
|
| 169 | - |
|
| 170 | - ), |
|
| 171 | - $val['type'] ); |
|
| 172 | - |
|
| 173 | - // multiselect |
|
| 174 | - if ( $val['type'] == 'multiselect' || ( ( $param['type'] == 'select' || $val['type'] == 'select' ) && ! empty( $val['multiple'] ) ) ) { |
|
| 175 | - $param['type'] = 'multiple_select'; |
|
| 176 | - $param['multiple'] = true; |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - // heading |
|
| 180 | - $param['heading'] = $val['title']; |
|
| 181 | - |
|
| 182 | - // description |
|
| 183 | - $param['description'] = isset( $val['desc'] ) ? $val['desc'] : ''; |
|
| 184 | - |
|
| 185 | - // param_name |
|
| 186 | - $param['param_name'] = $key; |
|
| 187 | - |
|
| 188 | - // Default |
|
| 189 | - $param['default'] = isset( $val['default'] ) ? $val['default'] : ''; |
|
| 190 | - |
|
| 191 | - // Group |
|
| 192 | - if ( isset( $val['group'] ) ) { |
|
| 193 | - $param['group'] = $val['group']; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - // value |
|
| 197 | - if ( $val['type'] == 'checkbox' ) { |
|
| 198 | - if ( isset( $val['default'] ) && $val['default'] == '0' ) { |
|
| 199 | - unset( $param['default'] ); |
|
| 200 | - } |
|
| 201 | - $param['value'] = array( '' => __( "No" ), '1' => __( "Yes" ) ); |
|
| 202 | - } elseif ( $param['type'] == 'select' || $param['type'] == 'multiple_select' ) { |
|
| 203 | - $param['value'] = isset( $val['options'] ) ? $val['options'] : array(); |
|
| 204 | - } else { |
|
| 205 | - $param['value'] = isset( $val['default'] ) ? $val['default'] : ''; |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - // setup the param |
|
| 209 | - $params[] = $param; |
|
| 210 | - |
|
| 211 | - } |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - |
|
| 215 | - return $params; |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - /** |
|
| 219 | - * Maybe insert the shortcode inserter button in the footer if we are in the cornerstone builder |
|
| 220 | - */ |
|
| 221 | - public static function maybe_cornerstone_builder() { |
|
| 222 | - if ( did_action( 'cornerstone_before_boot_app' ) ) { |
|
| 223 | - self::shortcode_insert_button_script(); |
|
| 224 | - } |
|
| 225 | - } |
|
| 226 | - |
|
| 227 | - /** |
|
| 228 | - * A function to ge the shortcode builder picker html. |
|
| 229 | - * |
|
| 230 | - * @param string $editor_id |
|
| 231 | - * |
|
| 232 | - * @return string |
|
| 233 | - */ |
|
| 234 | - public static function get_picker( $editor_id = '' ) { |
|
| 235 | - |
|
| 236 | - ob_start(); |
|
| 237 | - if ( isset( $_POST['editor_id'] ) ) { |
|
| 238 | - $editor_id = esc_attr( $_POST['editor_id'] ); |
|
| 239 | - } elseif ( isset( $_REQUEST['et_fb'] ) ) { |
|
| 240 | - $editor_id = 'main_content_content_vb_tiny_mce'; |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - global $sd_widgets; |
|
| 244 | - ?> |
|
| 9 | + /** |
|
| 10 | + * A Class to be able to create a Widget, Shortcode or Block to be able to output content for WordPress. |
|
| 11 | + * |
|
| 12 | + * Should not be called direct but extended instead. |
|
| 13 | + * |
|
| 14 | + * Class WP_Super_Duper |
|
| 15 | + * @since 1.0.16 change log moved to file change-log.txt - CHANGED |
|
| 16 | + * @ver 1.0.19 |
|
| 17 | + */ |
|
| 18 | + class WP_Super_Duper extends WP_Widget { |
|
| 19 | + |
|
| 20 | + public $version = "1.0.23"; |
|
| 21 | + public $font_awesome_icon_version = "5.11.2"; |
|
| 22 | + public $block_code; |
|
| 23 | + public $options; |
|
| 24 | + public $base_id; |
|
| 25 | + public $settings_hash; |
|
| 26 | + public $arguments = array(); |
|
| 27 | + public $instance = array(); |
|
| 28 | + private $class_name; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * The relative url to the current folder. |
|
| 32 | + * |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | + public $url = ''; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Take the array options and use them to build. |
|
| 39 | + */ |
|
| 40 | + public function __construct( $options ) { |
|
| 41 | + global $sd_widgets; |
|
| 42 | + |
|
| 43 | + $sd_widgets[ $options['base_id'] ] = array( |
|
| 44 | + 'name' => $options['name'], |
|
| 45 | + 'class_name' => $options['class_name'] |
|
| 46 | + ); |
|
| 47 | + $this->base_id = $options['base_id']; |
|
| 48 | + // lets filter the options before we do anything |
|
| 49 | + $options = apply_filters( "wp_super_duper_options", $options ); |
|
| 50 | + $options = apply_filters( "wp_super_duper_options_{$this->base_id}", $options ); |
|
| 51 | + $options = $this->add_name_from_key( $options ); |
|
| 52 | + $this->options = $options; |
|
| 53 | + |
|
| 54 | + $this->base_id = $options['base_id']; |
|
| 55 | + $this->arguments = isset( $options['arguments'] ) ? $options['arguments'] : array(); |
|
| 56 | + |
|
| 57 | + // init parent |
|
| 58 | + parent::__construct( $options['base_id'], $options['name'], $options['widget_ops'] ); |
|
| 59 | + |
|
| 60 | + if ( isset( $options['class_name'] ) ) { |
|
| 61 | + // register widget |
|
| 62 | + $this->class_name = $options['class_name']; |
|
| 63 | + |
|
| 64 | + // register shortcode |
|
| 65 | + $this->register_shortcode(); |
|
| 66 | + |
|
| 67 | + // Fusion Builder (avada) support |
|
| 68 | + if ( function_exists( 'fusion_builder_map' ) ) { |
|
| 69 | + add_action( 'init', array( $this, 'register_fusion_element' ) ); |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + // register block |
|
| 73 | + add_action( 'admin_enqueue_scripts', array( $this, 'register_block' ) ); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + // add the CSS and JS we need ONCE |
|
| 77 | + global $sd_widget_scripts; |
|
| 78 | + |
|
| 79 | + if ( ! $sd_widget_scripts ) { |
|
| 80 | + wp_add_inline_script( 'admin-widgets', $this->widget_js() ); |
|
| 81 | + wp_add_inline_script( 'customize-controls', $this->widget_js() ); |
|
| 82 | + wp_add_inline_style( 'widgets', $this->widget_css() ); |
|
| 83 | + |
|
| 84 | + // maybe add elementor editor styles |
|
| 85 | + add_action( 'elementor/editor/after_enqueue_styles', array( $this, 'elementor_editor_styles' ) ); |
|
| 86 | + |
|
| 87 | + $sd_widget_scripts = true; |
|
| 88 | + |
|
| 89 | + // add shortcode insert button once |
|
| 90 | + add_action( 'media_buttons', array( $this, 'shortcode_insert_button' ) ); |
|
| 91 | + // generatepress theme sections compatibility |
|
| 92 | + if ( function_exists( 'generate_sections_sections_metabox' ) ) { |
|
| 93 | + add_action( 'generate_sections_metabox', array( $this, 'shortcode_insert_button_script' ) ); |
|
| 94 | + } |
|
| 95 | + if ( $this->is_preview() ) { |
|
| 96 | + add_action( 'wp_footer', array( $this, 'shortcode_insert_button_script' ) ); |
|
| 97 | + // this makes the insert button work for elementor |
|
| 98 | + add_action( 'elementor/editor/after_enqueue_scripts', array( |
|
| 99 | + $this, |
|
| 100 | + 'shortcode_insert_button_script' |
|
| 101 | + ) ); // for elementor |
|
| 102 | + } |
|
| 103 | + // this makes the insert button work for cornerstone |
|
| 104 | + add_action( 'wp_print_footer_scripts', array( __CLASS__, 'maybe_cornerstone_builder' ) ); |
|
| 105 | + |
|
| 106 | + add_action( 'wp_ajax_super_duper_get_widget_settings', array( __CLASS__, 'get_widget_settings' ) ); |
|
| 107 | + add_action( 'wp_ajax_super_duper_get_picker', array( __CLASS__, 'get_picker' ) ); |
|
| 108 | + |
|
| 109 | + // add generator text to admin head |
|
| 110 | + add_action( 'admin_head', array( $this, 'generator' ) ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + do_action( 'wp_super_duper_widget_init', $options, $this ); |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Add our widget CSS to elementor editor. |
|
| 118 | + */ |
|
| 119 | + public function elementor_editor_styles() { |
|
| 120 | + wp_add_inline_style( 'elementor-editor', $this->widget_css( false ) ); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + public function register_fusion_element() { |
|
| 124 | + |
|
| 125 | + $options = $this->options; |
|
| 126 | + |
|
| 127 | + if ( $this->base_id ) { |
|
| 128 | + |
|
| 129 | + $params = $this->get_fusion_params(); |
|
| 130 | + |
|
| 131 | + $args = array( |
|
| 132 | + 'name' => $options['name'], |
|
| 133 | + 'shortcode' => $this->base_id, |
|
| 134 | + 'icon' => $options['block-icon'] ? $options['block-icon'] : 'far fa-square', |
|
| 135 | + 'allow_generator' => true, |
|
| 136 | + ); |
|
| 137 | + |
|
| 138 | + if ( ! empty( $params ) ) { |
|
| 139 | + $args['params'] = $params; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + fusion_builder_map( $args ); |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + public function get_fusion_params() { |
|
| 148 | + $params = array(); |
|
| 149 | + $arguments = $this->get_arguments(); |
|
| 150 | + |
|
| 151 | + if ( ! empty( $arguments ) ) { |
|
| 152 | + foreach ( $arguments as $key => $val ) { |
|
| 153 | + $param = array(); |
|
| 154 | + // type |
|
| 155 | + $param['type'] = str_replace( |
|
| 156 | + array( |
|
| 157 | + "text", |
|
| 158 | + "number", |
|
| 159 | + "email", |
|
| 160 | + "color", |
|
| 161 | + "checkbox" |
|
| 162 | + ), |
|
| 163 | + array( |
|
| 164 | + "textfield", |
|
| 165 | + "textfield", |
|
| 166 | + "textfield", |
|
| 167 | + "colorpicker", |
|
| 168 | + "select", |
|
| 169 | + |
|
| 170 | + ), |
|
| 171 | + $val['type'] ); |
|
| 172 | + |
|
| 173 | + // multiselect |
|
| 174 | + if ( $val['type'] == 'multiselect' || ( ( $param['type'] == 'select' || $val['type'] == 'select' ) && ! empty( $val['multiple'] ) ) ) { |
|
| 175 | + $param['type'] = 'multiple_select'; |
|
| 176 | + $param['multiple'] = true; |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + // heading |
|
| 180 | + $param['heading'] = $val['title']; |
|
| 181 | + |
|
| 182 | + // description |
|
| 183 | + $param['description'] = isset( $val['desc'] ) ? $val['desc'] : ''; |
|
| 184 | + |
|
| 185 | + // param_name |
|
| 186 | + $param['param_name'] = $key; |
|
| 187 | + |
|
| 188 | + // Default |
|
| 189 | + $param['default'] = isset( $val['default'] ) ? $val['default'] : ''; |
|
| 190 | + |
|
| 191 | + // Group |
|
| 192 | + if ( isset( $val['group'] ) ) { |
|
| 193 | + $param['group'] = $val['group']; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + // value |
|
| 197 | + if ( $val['type'] == 'checkbox' ) { |
|
| 198 | + if ( isset( $val['default'] ) && $val['default'] == '0' ) { |
|
| 199 | + unset( $param['default'] ); |
|
| 200 | + } |
|
| 201 | + $param['value'] = array( '' => __( "No" ), '1' => __( "Yes" ) ); |
|
| 202 | + } elseif ( $param['type'] == 'select' || $param['type'] == 'multiple_select' ) { |
|
| 203 | + $param['value'] = isset( $val['options'] ) ? $val['options'] : array(); |
|
| 204 | + } else { |
|
| 205 | + $param['value'] = isset( $val['default'] ) ? $val['default'] : ''; |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + // setup the param |
|
| 209 | + $params[] = $param; |
|
| 210 | + |
|
| 211 | + } |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + |
|
| 215 | + return $params; |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + /** |
|
| 219 | + * Maybe insert the shortcode inserter button in the footer if we are in the cornerstone builder |
|
| 220 | + */ |
|
| 221 | + public static function maybe_cornerstone_builder() { |
|
| 222 | + if ( did_action( 'cornerstone_before_boot_app' ) ) { |
|
| 223 | + self::shortcode_insert_button_script(); |
|
| 224 | + } |
|
| 225 | + } |
|
| 226 | + |
|
| 227 | + /** |
|
| 228 | + * A function to ge the shortcode builder picker html. |
|
| 229 | + * |
|
| 230 | + * @param string $editor_id |
|
| 231 | + * |
|
| 232 | + * @return string |
|
| 233 | + */ |
|
| 234 | + public static function get_picker( $editor_id = '' ) { |
|
| 235 | + |
|
| 236 | + ob_start(); |
|
| 237 | + if ( isset( $_POST['editor_id'] ) ) { |
|
| 238 | + $editor_id = esc_attr( $_POST['editor_id'] ); |
|
| 239 | + } elseif ( isset( $_REQUEST['et_fb'] ) ) { |
|
| 240 | + $editor_id = 'main_content_content_vb_tiny_mce'; |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + global $sd_widgets; |
|
| 244 | + ?> |
|
| 245 | 245 | |
| 246 | 246 | <div class="sd-shortcode-left-wrap"> |
| 247 | 247 | <?php |
| 248 | - ksort( $sd_widgets ); |
|
| 249 | - // print_r($sd_widgets);exit; |
|
| 250 | - if ( ! empty( $sd_widgets ) ) { |
|
| 251 | - echo '<select class="widefat" onchange="sd_get_shortcode_options(this);">'; |
|
| 252 | - echo "<option>" . __( 'Select shortcode' ) . "</option>"; |
|
| 253 | - foreach ( $sd_widgets as $shortcode => $class ) { |
|
| 254 | - echo "<option value='" . esc_attr( $shortcode ) . "'>" . esc_attr( $shortcode ) . " (" . esc_attr( $class['name'] ) . ")</option>"; |
|
| 255 | - } |
|
| 256 | - echo "</select>"; |
|
| 257 | - |
|
| 258 | - } |
|
| 259 | - ?> |
|
| 248 | + ksort( $sd_widgets ); |
|
| 249 | + // print_r($sd_widgets);exit; |
|
| 250 | + if ( ! empty( $sd_widgets ) ) { |
|
| 251 | + echo '<select class="widefat" onchange="sd_get_shortcode_options(this);">'; |
|
| 252 | + echo "<option>" . __( 'Select shortcode' ) . "</option>"; |
|
| 253 | + foreach ( $sd_widgets as $shortcode => $class ) { |
|
| 254 | + echo "<option value='" . esc_attr( $shortcode ) . "'>" . esc_attr( $shortcode ) . " (" . esc_attr( $class['name'] ) . ")</option>"; |
|
| 255 | + } |
|
| 256 | + echo "</select>"; |
|
| 257 | + |
|
| 258 | + } |
|
| 259 | + ?> |
|
| 260 | 260 | <div class="sd-shortcode-settings"></div> |
| 261 | 261 | |
| 262 | 262 | </div> |
@@ -267,8 +267,8 @@ discard block |
||
| 267 | 267 | <?php if ( $editor_id != '' ) { ?> |
| 268 | 268 | <button class="button sd-insert-shortcode-button" |
| 269 | 269 | onclick="sd_insert_shortcode(<?php if ( ! empty( $editor_id ) ) { |
| 270 | - echo "'" . $editor_id . "'"; |
|
| 271 | - } ?>)"><?php _e( 'Insert shortcode' ); ?></button> |
|
| 270 | + echo "'" . $editor_id . "'"; |
|
| 271 | + } ?>)"><?php _e( 'Insert shortcode' ); ?></button> |
|
| 272 | 272 | <?php } ?> |
| 273 | 273 | <button class="button" |
| 274 | 274 | onclick="sd_copy_to_clipboard()"><?php _e( 'Copy shortcode' ); ?></button> |
@@ -276,134 +276,134 @@ discard block |
||
| 276 | 276 | </div> |
| 277 | 277 | <?php |
| 278 | 278 | |
| 279 | - $html = ob_get_clean(); |
|
| 280 | - |
|
| 281 | - if ( wp_doing_ajax() ) { |
|
| 282 | - echo $html; |
|
| 283 | - $should_die = true; |
|
| 284 | - |
|
| 285 | - // some builder get the editor via ajax so we should not die on those ocasions |
|
| 286 | - $dont_die = array( |
|
| 287 | - 'parent_tag',// WP Bakery |
|
| 288 | - 'avia_request' // enfold |
|
| 289 | - ); |
|
| 290 | - |
|
| 291 | - foreach ( $dont_die as $request ) { |
|
| 292 | - if ( isset( $_REQUEST[ $request ] ) ) { |
|
| 293 | - $should_die = false; |
|
| 294 | - } |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - if ( $should_die ) { |
|
| 298 | - wp_die(); |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - } else { |
|
| 302 | - return $html; |
|
| 303 | - } |
|
| 304 | - |
|
| 305 | - return ''; |
|
| 306 | - |
|
| 307 | - } |
|
| 308 | - |
|
| 309 | - /** |
|
| 310 | - * Output the version in the admin header. |
|
| 311 | - */ |
|
| 312 | - public function generator() { |
|
| 313 | - echo '<meta name="generator" content="WP Super Duper v' . $this->version . '" />'; |
|
| 314 | - } |
|
| 315 | - |
|
| 316 | - /** |
|
| 317 | - * Get widget settings. |
|
| 318 | - * |
|
| 319 | - * @since 1.0.0 |
|
| 320 | - */ |
|
| 321 | - public static function get_widget_settings() { |
|
| 322 | - global $sd_widgets; |
|
| 323 | - |
|
| 324 | - $shortcode = isset( $_REQUEST['shortcode'] ) && $_REQUEST['shortcode'] ? sanitize_title_with_dashes( $_REQUEST['shortcode'] ) : ''; |
|
| 325 | - if ( ! $shortcode ) { |
|
| 326 | - wp_die(); |
|
| 327 | - } |
|
| 328 | - $widget_args = isset( $sd_widgets[ $shortcode ] ) ? $sd_widgets[ $shortcode ] : ''; |
|
| 329 | - if ( ! $widget_args ) { |
|
| 330 | - wp_die(); |
|
| 331 | - } |
|
| 332 | - $class_name = isset( $widget_args['class_name'] ) && $widget_args['class_name'] ? $widget_args['class_name'] : ''; |
|
| 333 | - if ( ! $class_name ) { |
|
| 334 | - wp_die(); |
|
| 335 | - } |
|
| 336 | - |
|
| 337 | - // invoke an instance method |
|
| 338 | - $widget = new $class_name; |
|
| 339 | - |
|
| 340 | - ob_start(); |
|
| 341 | - $widget->form( array() ); |
|
| 342 | - $form = ob_get_clean(); |
|
| 343 | - echo "<form id='$shortcode'>" . $form . "<div class=\"widget-control-save\"></div></form>"; |
|
| 344 | - echo "<style>" . $widget->widget_css() . "</style>"; |
|
| 345 | - echo "<script>" . $widget->widget_js() . "</script>"; |
|
| 346 | - ?> |
|
| 279 | + $html = ob_get_clean(); |
|
| 280 | + |
|
| 281 | + if ( wp_doing_ajax() ) { |
|
| 282 | + echo $html; |
|
| 283 | + $should_die = true; |
|
| 284 | + |
|
| 285 | + // some builder get the editor via ajax so we should not die on those ocasions |
|
| 286 | + $dont_die = array( |
|
| 287 | + 'parent_tag',// WP Bakery |
|
| 288 | + 'avia_request' // enfold |
|
| 289 | + ); |
|
| 290 | + |
|
| 291 | + foreach ( $dont_die as $request ) { |
|
| 292 | + if ( isset( $_REQUEST[ $request ] ) ) { |
|
| 293 | + $should_die = false; |
|
| 294 | + } |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + if ( $should_die ) { |
|
| 298 | + wp_die(); |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + } else { |
|
| 302 | + return $html; |
|
| 303 | + } |
|
| 304 | + |
|
| 305 | + return ''; |
|
| 306 | + |
|
| 307 | + } |
|
| 308 | + |
|
| 309 | + /** |
|
| 310 | + * Output the version in the admin header. |
|
| 311 | + */ |
|
| 312 | + public function generator() { |
|
| 313 | + echo '<meta name="generator" content="WP Super Duper v' . $this->version . '" />'; |
|
| 314 | + } |
|
| 315 | + |
|
| 316 | + /** |
|
| 317 | + * Get widget settings. |
|
| 318 | + * |
|
| 319 | + * @since 1.0.0 |
|
| 320 | + */ |
|
| 321 | + public static function get_widget_settings() { |
|
| 322 | + global $sd_widgets; |
|
| 323 | + |
|
| 324 | + $shortcode = isset( $_REQUEST['shortcode'] ) && $_REQUEST['shortcode'] ? sanitize_title_with_dashes( $_REQUEST['shortcode'] ) : ''; |
|
| 325 | + if ( ! $shortcode ) { |
|
| 326 | + wp_die(); |
|
| 327 | + } |
|
| 328 | + $widget_args = isset( $sd_widgets[ $shortcode ] ) ? $sd_widgets[ $shortcode ] : ''; |
|
| 329 | + if ( ! $widget_args ) { |
|
| 330 | + wp_die(); |
|
| 331 | + } |
|
| 332 | + $class_name = isset( $widget_args['class_name'] ) && $widget_args['class_name'] ? $widget_args['class_name'] : ''; |
|
| 333 | + if ( ! $class_name ) { |
|
| 334 | + wp_die(); |
|
| 335 | + } |
|
| 336 | + |
|
| 337 | + // invoke an instance method |
|
| 338 | + $widget = new $class_name; |
|
| 339 | + |
|
| 340 | + ob_start(); |
|
| 341 | + $widget->form( array() ); |
|
| 342 | + $form = ob_get_clean(); |
|
| 343 | + echo "<form id='$shortcode'>" . $form . "<div class=\"widget-control-save\"></div></form>"; |
|
| 344 | + echo "<style>" . $widget->widget_css() . "</style>"; |
|
| 345 | + echo "<script>" . $widget->widget_js() . "</script>"; |
|
| 346 | + ?> |
|
| 347 | 347 | <?php |
| 348 | - wp_die(); |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Insert shortcode builder button to classic editor (not inside Gutenberg, not needed). |
|
| 353 | - * |
|
| 354 | - * @since 1.0.0 |
|
| 355 | - * |
|
| 356 | - * @param string $editor_id Optional. Shortcode editor id. Default null. |
|
| 357 | - * @param string $insert_shortcode_function Optional. Insert shotcode function. Default null. |
|
| 358 | - */ |
|
| 359 | - public static function shortcode_insert_button( $editor_id = '', $insert_shortcode_function = '' ) { |
|
| 360 | - global $sd_widgets, $shortcode_insert_button_once; |
|
| 361 | - if ( $shortcode_insert_button_once ) { |
|
| 362 | - return; |
|
| 363 | - } |
|
| 364 | - add_thickbox(); |
|
| 365 | - |
|
| 366 | - |
|
| 367 | - /** |
|
| 368 | - * Cornerstone makes us play dirty tricks :/ |
|
| 369 | - * All media_buttons are removed via JS unless they are two specific id's so we wrap our content in this ID so it is not removed. |
|
| 370 | - */ |
|
| 371 | - if ( function_exists( 'cornerstone_plugin_init' ) && ! is_admin() ) { |
|
| 372 | - echo '<span id="insert-media-button">'; |
|
| 373 | - } |
|
| 374 | - |
|
| 375 | - echo self::shortcode_button( 'this', 'true' ); |
|
| 376 | - |
|
| 377 | - // see opening note |
|
| 378 | - if ( function_exists( 'cornerstone_plugin_init' ) && ! is_admin() ) { |
|
| 379 | - echo '</span>'; // end #insert-media-button |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - // Add separate script for generatepress theme sections |
|
| 383 | - if ( function_exists( 'generate_sections_sections_metabox' ) && did_action( 'generate_sections_metabox' ) ) { |
|
| 384 | - } else { |
|
| 385 | - self::shortcode_insert_button_script( $editor_id, $insert_shortcode_function ); |
|
| 386 | - } |
|
| 387 | - |
|
| 388 | - $shortcode_insert_button_once = true; |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - /** |
|
| 392 | - * Gets the shortcode insert button html. |
|
| 393 | - * |
|
| 394 | - * @param string $id |
|
| 395 | - * @param string $search_for_id |
|
| 396 | - * |
|
| 397 | - * @return mixed |
|
| 398 | - */ |
|
| 399 | - public static function shortcode_button( $id = '', $search_for_id = '' ) { |
|
| 400 | - ob_start(); |
|
| 401 | - ?> |
|
| 348 | + wp_die(); |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Insert shortcode builder button to classic editor (not inside Gutenberg, not needed). |
|
| 353 | + * |
|
| 354 | + * @since 1.0.0 |
|
| 355 | + * |
|
| 356 | + * @param string $editor_id Optional. Shortcode editor id. Default null. |
|
| 357 | + * @param string $insert_shortcode_function Optional. Insert shotcode function. Default null. |
|
| 358 | + */ |
|
| 359 | + public static function shortcode_insert_button( $editor_id = '', $insert_shortcode_function = '' ) { |
|
| 360 | + global $sd_widgets, $shortcode_insert_button_once; |
|
| 361 | + if ( $shortcode_insert_button_once ) { |
|
| 362 | + return; |
|
| 363 | + } |
|
| 364 | + add_thickbox(); |
|
| 365 | + |
|
| 366 | + |
|
| 367 | + /** |
|
| 368 | + * Cornerstone makes us play dirty tricks :/ |
|
| 369 | + * All media_buttons are removed via JS unless they are two specific id's so we wrap our content in this ID so it is not removed. |
|
| 370 | + */ |
|
| 371 | + if ( function_exists( 'cornerstone_plugin_init' ) && ! is_admin() ) { |
|
| 372 | + echo '<span id="insert-media-button">'; |
|
| 373 | + } |
|
| 374 | + |
|
| 375 | + echo self::shortcode_button( 'this', 'true' ); |
|
| 376 | + |
|
| 377 | + // see opening note |
|
| 378 | + if ( function_exists( 'cornerstone_plugin_init' ) && ! is_admin() ) { |
|
| 379 | + echo '</span>'; // end #insert-media-button |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + // Add separate script for generatepress theme sections |
|
| 383 | + if ( function_exists( 'generate_sections_sections_metabox' ) && did_action( 'generate_sections_metabox' ) ) { |
|
| 384 | + } else { |
|
| 385 | + self::shortcode_insert_button_script( $editor_id, $insert_shortcode_function ); |
|
| 386 | + } |
|
| 387 | + |
|
| 388 | + $shortcode_insert_button_once = true; |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + /** |
|
| 392 | + * Gets the shortcode insert button html. |
|
| 393 | + * |
|
| 394 | + * @param string $id |
|
| 395 | + * @param string $search_for_id |
|
| 396 | + * |
|
| 397 | + * @return mixed |
|
| 398 | + */ |
|
| 399 | + public static function shortcode_button( $id = '', $search_for_id = '' ) { |
|
| 400 | + ob_start(); |
|
| 401 | + ?> |
|
| 402 | 402 | <span class="sd-lable-shortcode-inserter"> |
| 403 | 403 | <a onclick="sd_ajax_get_picker(<?php echo $id; |
| 404 | - if ( $search_for_id ) { |
|
| 405 | - echo "," . $search_for_id; |
|
| 406 | - } ?>);" href="#TB_inline?width=100%&height=550&inlineId=super-duper-content-ajaxed" |
|
| 404 | + if ( $search_for_id ) { |
|
| 405 | + echo "," . $search_for_id; |
|
| 406 | + } ?>);" href="#TB_inline?width=100%&height=550&inlineId=super-duper-content-ajaxed" |
|
| 407 | 407 | class="thickbox button super-duper-content-open" title="Add Shortcode"> |
| 408 | 408 | <span style="vertical-align: middle;line-height: 18px;font-size: 20px;" |
| 409 | 409 | class="dashicons dashicons-screenoptions"></span> |
@@ -414,21 +414,21 @@ discard block |
||
| 414 | 414 | </span> |
| 415 | 415 | |
| 416 | 416 | <?php |
| 417 | - $html = ob_get_clean(); |
|
| 418 | - |
|
| 419 | - // remove line breaks so we can use it in js |
|
| 420 | - return preg_replace( "/\r|\n/", "", trim( $html ) ); |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * Makes SD work with the siteOrigin page builder. |
|
| 425 | - * |
|
| 426 | - * @since 1.0.6 |
|
| 427 | - * @return mixed |
|
| 428 | - */ |
|
| 429 | - public static function siteorigin_js() { |
|
| 430 | - ob_start(); |
|
| 431 | - ?> |
|
| 417 | + $html = ob_get_clean(); |
|
| 418 | + |
|
| 419 | + // remove line breaks so we can use it in js |
|
| 420 | + return preg_replace( "/\r|\n/", "", trim( $html ) ); |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * Makes SD work with the siteOrigin page builder. |
|
| 425 | + * |
|
| 426 | + * @since 1.0.6 |
|
| 427 | + * @return mixed |
|
| 428 | + */ |
|
| 429 | + public static function siteorigin_js() { |
|
| 430 | + ob_start(); |
|
| 431 | + ?> |
|
| 432 | 432 | <script> |
| 433 | 433 | /** |
| 434 | 434 | * Check a form to see what items shoudl be shown or hidden. |
@@ -506,28 +506,28 @@ discard block |
||
| 506 | 506 | }); |
| 507 | 507 | </script> |
| 508 | 508 | <?php |
| 509 | - $output = ob_get_clean(); |
|
| 509 | + $output = ob_get_clean(); |
|
| 510 | 510 | |
| 511 | - /* |
|
| 511 | + /* |
|
| 512 | 512 | * We only add the <script> tags for code highlighting, so we strip them from the output. |
| 513 | 513 | */ |
| 514 | 514 | |
| 515 | - return str_replace( array( |
|
| 516 | - '<script>', |
|
| 517 | - '</script>' |
|
| 518 | - ), '', $output ); |
|
| 519 | - } |
|
| 520 | - |
|
| 521 | - /** |
|
| 522 | - * Output the JS and CSS for the shortcode insert button. |
|
| 523 | - * |
|
| 524 | - * @since 1.0.6 |
|
| 525 | - * |
|
| 526 | - * @param string $editor_id |
|
| 527 | - * @param string $insert_shortcode_function |
|
| 528 | - */ |
|
| 529 | - public static function shortcode_insert_button_script( $editor_id = '', $insert_shortcode_function = '' ) { |
|
| 530 | - ?> |
|
| 515 | + return str_replace( array( |
|
| 516 | + '<script>', |
|
| 517 | + '</script>' |
|
| 518 | + ), '', $output ); |
|
| 519 | + } |
|
| 520 | + |
|
| 521 | + /** |
|
| 522 | + * Output the JS and CSS for the shortcode insert button. |
|
| 523 | + * |
|
| 524 | + * @since 1.0.6 |
|
| 525 | + * |
|
| 526 | + * @param string $editor_id |
|
| 527 | + * @param string $insert_shortcode_function |
|
| 528 | + */ |
|
| 529 | + public static function shortcode_insert_button_script( $editor_id = '', $insert_shortcode_function = '' ) { |
|
| 530 | + ?> |
|
| 531 | 531 | <style> |
| 532 | 532 | .sd-shortcode-left-wrap { |
| 533 | 533 | float: left; |
@@ -653,35 +653,35 @@ discard block |
||
| 653 | 653 | <?php } ?> |
| 654 | 654 | </style> |
| 655 | 655 | <?php |
| 656 | - if ( class_exists( 'SiteOrigin_Panels' ) ) { |
|
| 657 | - echo "<script>" . self::siteorigin_js() . "</script>"; |
|
| 658 | - } |
|
| 659 | - ?> |
|
| 656 | + if ( class_exists( 'SiteOrigin_Panels' ) ) { |
|
| 657 | + echo "<script>" . self::siteorigin_js() . "</script>"; |
|
| 658 | + } |
|
| 659 | + ?> |
|
| 660 | 660 | <script> |
| 661 | 661 | <?php |
| 662 | - if(! empty( $insert_shortcode_function )){ |
|
| 663 | - echo $insert_shortcode_function; |
|
| 664 | - }else{ |
|
| 665 | - |
|
| 666 | - /** |
|
| 667 | - * Function for super duper insert shortcode. |
|
| 668 | - * |
|
| 669 | - * @since 1.0.0 |
|
| 670 | - */ |
|
| 671 | - ?> |
|
| 662 | + if(! empty( $insert_shortcode_function )){ |
|
| 663 | + echo $insert_shortcode_function; |
|
| 664 | + }else{ |
|
| 665 | + |
|
| 666 | + /** |
|
| 667 | + * Function for super duper insert shortcode. |
|
| 668 | + * |
|
| 669 | + * @since 1.0.0 |
|
| 670 | + */ |
|
| 671 | + ?> |
|
| 672 | 672 | function sd_insert_shortcode($editor_id) { |
| 673 | 673 | $shortcode = jQuery('#TB_ajaxContent #sd-shortcode-output').val(); |
| 674 | 674 | if ($shortcode) { |
| 675 | 675 | if (!$editor_id) { |
| 676 | 676 | <?php |
| 677 | - if ( isset( $_REQUEST['et_fb'] ) ) { |
|
| 678 | - echo '$editor_id = "#main_content_content_vb_tiny_mce";'; |
|
| 679 | - } elseif ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) { |
|
| 680 | - echo '$editor_id = "#elementor-controls .wp-editor-container textarea";'; |
|
| 681 | - } else { |
|
| 682 | - echo '$editor_id = "#wp-content-editor-container textarea";'; |
|
| 683 | - } |
|
| 684 | - ?> |
|
| 677 | + if ( isset( $_REQUEST['et_fb'] ) ) { |
|
| 678 | + echo '$editor_id = "#main_content_content_vb_tiny_mce";'; |
|
| 679 | + } elseif ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) { |
|
| 680 | + echo '$editor_id = "#elementor-controls .wp-editor-container textarea";'; |
|
| 681 | + } else { |
|
| 682 | + echo '$editor_id = "#wp-content-editor-container textarea";'; |
|
| 683 | + } |
|
| 684 | + ?> |
|
| 685 | 685 | } else { |
| 686 | 686 | $editor_id = '#' + $editor_id; |
| 687 | 687 | } |
@@ -1007,18 +1007,18 @@ discard block |
||
| 1007 | 1007 | |
| 1008 | 1008 | </script> |
| 1009 | 1009 | <?php |
| 1010 | - } |
|
| 1011 | - |
|
| 1012 | - /** |
|
| 1013 | - * Gets some CSS for the widgets screen. |
|
| 1014 | - * |
|
| 1015 | - * @param bool $advanced If we should include advanced CSS. |
|
| 1016 | - * |
|
| 1017 | - * @return mixed |
|
| 1018 | - */ |
|
| 1019 | - public function widget_css( $advanced = true ) { |
|
| 1020 | - ob_start(); |
|
| 1021 | - ?> |
|
| 1010 | + } |
|
| 1011 | + |
|
| 1012 | + /** |
|
| 1013 | + * Gets some CSS for the widgets screen. |
|
| 1014 | + * |
|
| 1015 | + * @param bool $advanced If we should include advanced CSS. |
|
| 1016 | + * |
|
| 1017 | + * @return mixed |
|
| 1018 | + */ |
|
| 1019 | + public function widget_css( $advanced = true ) { |
|
| 1020 | + ob_start(); |
|
| 1021 | + ?> |
|
| 1022 | 1022 | <style> |
| 1023 | 1023 | <?php if( $advanced ){ ?> |
| 1024 | 1024 | .sd-advanced-setting { |
@@ -1056,26 +1056,26 @@ discard block |
||
| 1056 | 1056 | } |
| 1057 | 1057 | </style> |
| 1058 | 1058 | <?php |
| 1059 | - $output = ob_get_clean(); |
|
| 1059 | + $output = ob_get_clean(); |
|
| 1060 | 1060 | |
| 1061 | - /* |
|
| 1061 | + /* |
|
| 1062 | 1062 | * We only add the <script> tags for code highlighting, so we strip them from the output. |
| 1063 | 1063 | */ |
| 1064 | 1064 | |
| 1065 | - return str_replace( array( |
|
| 1066 | - '<style>', |
|
| 1067 | - '</style>' |
|
| 1068 | - ), '', $output ); |
|
| 1069 | - } |
|
| 1070 | - |
|
| 1071 | - /** |
|
| 1072 | - * Gets some JS for the widgets screen. |
|
| 1073 | - * |
|
| 1074 | - * @return mixed |
|
| 1075 | - */ |
|
| 1076 | - public function widget_js() { |
|
| 1077 | - ob_start(); |
|
| 1078 | - ?> |
|
| 1065 | + return str_replace( array( |
|
| 1066 | + '<style>', |
|
| 1067 | + '</style>' |
|
| 1068 | + ), '', $output ); |
|
| 1069 | + } |
|
| 1070 | + |
|
| 1071 | + /** |
|
| 1072 | + * Gets some JS for the widgets screen. |
|
| 1073 | + * |
|
| 1074 | + * @return mixed |
|
| 1075 | + */ |
|
| 1076 | + public function widget_js() { |
|
| 1077 | + ob_start(); |
|
| 1078 | + ?> |
|
| 1079 | 1079 | <script> |
| 1080 | 1080 | |
| 1081 | 1081 | /** |
@@ -1230,402 +1230,402 @@ discard block |
||
| 1230 | 1230 | <?php do_action( 'wp_super_duper_widget_js', $this ); ?> |
| 1231 | 1231 | </script> |
| 1232 | 1232 | <?php |
| 1233 | - $output = ob_get_clean(); |
|
| 1233 | + $output = ob_get_clean(); |
|
| 1234 | 1234 | |
| 1235 | - /* |
|
| 1235 | + /* |
|
| 1236 | 1236 | * We only add the <script> tags for code highlighting, so we strip them from the output. |
| 1237 | 1237 | */ |
| 1238 | 1238 | |
| 1239 | - return str_replace( array( |
|
| 1240 | - '<script>', |
|
| 1241 | - '</script>' |
|
| 1242 | - ), '', $output ); |
|
| 1243 | - } |
|
| 1244 | - |
|
| 1245 | - |
|
| 1246 | - /** |
|
| 1247 | - * Set the name from the argument key. |
|
| 1248 | - * |
|
| 1249 | - * @param $options |
|
| 1250 | - * |
|
| 1251 | - * @return mixed |
|
| 1252 | - */ |
|
| 1253 | - private function add_name_from_key( $options, $arguments = false ) { |
|
| 1254 | - if ( ! empty( $options['arguments'] ) ) { |
|
| 1255 | - foreach ( $options['arguments'] as $key => $val ) { |
|
| 1256 | - $options['arguments'][ $key ]['name'] = $key; |
|
| 1257 | - } |
|
| 1258 | - } elseif ( $arguments && is_array( $options ) && ! empty( $options ) ) { |
|
| 1259 | - foreach ( $options as $key => $val ) { |
|
| 1260 | - $options[ $key ]['name'] = $key; |
|
| 1261 | - } |
|
| 1262 | - } |
|
| 1263 | - |
|
| 1264 | - return $options; |
|
| 1265 | - } |
|
| 1266 | - |
|
| 1267 | - /** |
|
| 1268 | - * Register the parent shortcode. |
|
| 1269 | - * |
|
| 1270 | - * @since 1.0.0 |
|
| 1271 | - */ |
|
| 1272 | - public function register_shortcode() { |
|
| 1273 | - add_shortcode( $this->base_id, array( $this, 'shortcode_output' ) ); |
|
| 1274 | - add_action( 'wp_ajax_super_duper_output_shortcode', array( __CLASS__, 'render_shortcode' ) ); |
|
| 1275 | - } |
|
| 1276 | - |
|
| 1277 | - /** |
|
| 1278 | - * Render the shortcode via ajax so we can return it to Gutenberg. |
|
| 1279 | - * |
|
| 1280 | - * @since 1.0.0 |
|
| 1281 | - */ |
|
| 1282 | - public static function render_shortcode() { |
|
| 1283 | - |
|
| 1284 | - check_ajax_referer( 'super_duper_output_shortcode', '_ajax_nonce', true ); |
|
| 1285 | - if ( ! current_user_can( 'manage_options' ) ) { |
|
| 1286 | - wp_die(); |
|
| 1287 | - } |
|
| 1288 | - |
|
| 1289 | - // we might need the $post value here so lets set it. |
|
| 1290 | - if ( isset( $_POST['post_id'] ) && $_POST['post_id'] ) { |
|
| 1291 | - $post_obj = get_post( absint( $_POST['post_id'] ) ); |
|
| 1292 | - if ( ! empty( $post_obj ) && empty( $post ) ) { |
|
| 1293 | - global $post; |
|
| 1294 | - $post = $post_obj; |
|
| 1295 | - } |
|
| 1296 | - } |
|
| 1297 | - |
|
| 1298 | - if ( isset( $_POST['shortcode'] ) && $_POST['shortcode'] ) { |
|
| 1299 | - $shortcode_name = sanitize_title_with_dashes( $_POST['shortcode'] ); |
|
| 1300 | - $attributes_array = isset( $_POST['attributes'] ) && $_POST['attributes'] ? $_POST['attributes'] : array(); |
|
| 1301 | - $attributes = ''; |
|
| 1302 | - if ( ! empty( $attributes_array ) ) { |
|
| 1303 | - foreach ( $attributes_array as $key => $value ) { |
|
| 1304 | - $attributes .= " " . sanitize_title_with_dashes( $key ) . "='" . wp_slash( $value ) . "' "; |
|
| 1305 | - } |
|
| 1306 | - } |
|
| 1307 | - |
|
| 1308 | - $shortcode = "[" . $shortcode_name . " " . $attributes . "]"; |
|
| 1309 | - |
|
| 1310 | - echo do_shortcode( $shortcode ); |
|
| 1311 | - |
|
| 1312 | - } |
|
| 1313 | - wp_die(); |
|
| 1314 | - } |
|
| 1315 | - |
|
| 1316 | - /** |
|
| 1317 | - * Output the shortcode. |
|
| 1318 | - * |
|
| 1319 | - * @param array $args |
|
| 1320 | - * @param string $content |
|
| 1321 | - * |
|
| 1322 | - * @return string |
|
| 1323 | - */ |
|
| 1324 | - public function shortcode_output( $args = array(), $content = '' ) { |
|
| 1325 | - $args = $this->argument_values( $args ); |
|
| 1326 | - |
|
| 1327 | - // add extra argument so we know its a output to gutenberg |
|
| 1328 | - //$args |
|
| 1329 | - $args = $this->string_to_bool( $args ); |
|
| 1330 | - |
|
| 1331 | - // if we have a enclosed shortcode we add it to the special `html` argument |
|
| 1332 | - if ( ! empty( $content ) ) { |
|
| 1333 | - $args['html'] = $content; |
|
| 1334 | - } |
|
| 1335 | - |
|
| 1336 | - $class = isset( $this->options['widget_ops']['classname'] ) ? esc_attr( $this->options['widget_ops']['classname'] ) : ''; |
|
| 1337 | - $class .= " sdel-".$this->get_instance_hash(); |
|
| 1338 | - |
|
| 1339 | - $class = apply_filters( 'wp_super_duper_div_classname', $class, $args, $this ); |
|
| 1340 | - $class = apply_filters( 'wp_super_duper_div_classname_' . $this->base_id, $class, $args, $this ); |
|
| 1341 | - |
|
| 1342 | - $attrs = apply_filters( 'wp_super_duper_div_attrs', '', $args, $this ); |
|
| 1343 | - $attrs = apply_filters( 'wp_super_duper_div_attrs_' . $this->base_id, '', $args, $this ); //@todo this does not seem right @kiran? |
|
| 1344 | - |
|
| 1345 | - $shortcode_args = array(); |
|
| 1346 | - $output = ''; |
|
| 1347 | - $no_wrap = isset( $this->options['no_wrap'] ) && $this->options['no_wrap'] ? true : false; |
|
| 1348 | - if ( isset( $args['no_wrap'] ) && $args['no_wrap'] ) { |
|
| 1349 | - $no_wrap = true; |
|
| 1350 | - } |
|
| 1351 | - $main_content = $this->output( $args, $shortcode_args, $content ); |
|
| 1352 | - if ( $main_content && ! $no_wrap ) { |
|
| 1353 | - // wrap the shortcode in a div with the same class as the widget |
|
| 1354 | - $output .= '<div class="' . $class . '" ' . $attrs . '>'; |
|
| 1355 | - if ( ! empty( $args['title'] ) ) { |
|
| 1356 | - // if its a shortcode and there is a title try to grab the title wrappers |
|
| 1357 | - $shortcode_args = array( 'before_title' => '', 'after_title' => '' ); |
|
| 1358 | - if ( empty( $instance ) ) { |
|
| 1359 | - global $wp_registered_sidebars; |
|
| 1360 | - if ( ! empty( $wp_registered_sidebars ) ) { |
|
| 1361 | - foreach ( $wp_registered_sidebars as $sidebar ) { |
|
| 1362 | - if ( ! empty( $sidebar['before_title'] ) ) { |
|
| 1363 | - $shortcode_args['before_title'] = $sidebar['before_title']; |
|
| 1364 | - $shortcode_args['after_title'] = $sidebar['after_title']; |
|
| 1365 | - break; |
|
| 1366 | - } |
|
| 1367 | - } |
|
| 1368 | - } |
|
| 1369 | - } |
|
| 1370 | - $output .= $this->output_title( $shortcode_args, $args ); |
|
| 1371 | - } |
|
| 1372 | - $output .= $main_content; |
|
| 1373 | - $output .= '</div>'; |
|
| 1374 | - } elseif ( $main_content && $no_wrap ) { |
|
| 1375 | - $output .= $main_content; |
|
| 1376 | - } |
|
| 1377 | - |
|
| 1378 | - // if preview show a placeholder if empty |
|
| 1379 | - if ( $this->is_preview() && $output == '' ) { |
|
| 1380 | - $output = $this->preview_placeholder_text( "{{" . $this->base_id . "}}" ); |
|
| 1381 | - } |
|
| 1382 | - |
|
| 1383 | - return apply_filters( 'wp_super_duper_widget_output', $output, $args, $shortcode_args, $this ); |
|
| 1384 | - } |
|
| 1385 | - |
|
| 1386 | - /** |
|
| 1387 | - * Placeholder text to show if output is empty and we are on a preview/builder page. |
|
| 1388 | - * |
|
| 1389 | - * @param string $name |
|
| 1390 | - * |
|
| 1391 | - * @return string |
|
| 1392 | - */ |
|
| 1393 | - public function preview_placeholder_text( $name = '' ) { |
|
| 1394 | - return "<div style='background:#0185ba33;padding: 10px;border: 4px #ccc dashed;'>" . sprintf( __( 'Placeholder for: %s' ), $name ) . "</div>"; |
|
| 1395 | - } |
|
| 1396 | - |
|
| 1397 | - /** |
|
| 1398 | - * Sometimes booleans values can be turned to strings, so we fix that. |
|
| 1399 | - * |
|
| 1400 | - * @param $options |
|
| 1401 | - * |
|
| 1402 | - * @return mixed |
|
| 1403 | - */ |
|
| 1404 | - public function string_to_bool( $options ) { |
|
| 1405 | - // convert bool strings to booleans |
|
| 1406 | - foreach ( $options as $key => $val ) { |
|
| 1407 | - if ( $val == 'false' ) { |
|
| 1408 | - $options[ $key ] = false; |
|
| 1409 | - } elseif ( $val == 'true' ) { |
|
| 1410 | - $options[ $key ] = true; |
|
| 1411 | - } |
|
| 1412 | - } |
|
| 1413 | - |
|
| 1414 | - return $options; |
|
| 1415 | - } |
|
| 1416 | - |
|
| 1417 | - /** |
|
| 1418 | - * Get the argument values that are also filterable. |
|
| 1419 | - * |
|
| 1420 | - * @param $instance |
|
| 1421 | - * |
|
| 1422 | - * @since 1.0.12 Don't set checkbox default value if the value is empty. |
|
| 1423 | - * |
|
| 1424 | - * @return array |
|
| 1425 | - */ |
|
| 1426 | - public function argument_values( $instance ) { |
|
| 1427 | - $argument_values = array(); |
|
| 1428 | - |
|
| 1429 | - // set widget instance |
|
| 1430 | - $this->instance = $instance; |
|
| 1431 | - |
|
| 1432 | - if ( empty( $this->arguments ) ) { |
|
| 1433 | - $this->arguments = $this->get_arguments(); |
|
| 1434 | - } |
|
| 1435 | - |
|
| 1436 | - if ( ! empty( $this->arguments ) ) { |
|
| 1437 | - foreach ( $this->arguments as $key => $args ) { |
|
| 1438 | - // set the input name from the key |
|
| 1439 | - $args['name'] = $key; |
|
| 1440 | - // |
|
| 1441 | - $argument_values[ $key ] = isset( $instance[ $key ] ) ? $instance[ $key ] : ''; |
|
| 1442 | - if ( $args['type'] == 'checkbox' && $argument_values[ $key ] == '' ) { |
|
| 1443 | - // don't set default for an empty checkbox |
|
| 1444 | - } elseif ( $argument_values[ $key ] == '' && isset( $args['default'] ) ) { |
|
| 1445 | - $argument_values[ $key ] = $args['default']; |
|
| 1446 | - } |
|
| 1447 | - } |
|
| 1448 | - } |
|
| 1449 | - |
|
| 1450 | - return $argument_values; |
|
| 1451 | - } |
|
| 1452 | - |
|
| 1453 | - /** |
|
| 1454 | - * Set arguments in super duper. |
|
| 1455 | - * |
|
| 1456 | - * @since 1.0.0 |
|
| 1457 | - * |
|
| 1458 | - * @return array Set arguments. |
|
| 1459 | - */ |
|
| 1460 | - public function set_arguments() { |
|
| 1461 | - return $this->arguments; |
|
| 1462 | - } |
|
| 1463 | - |
|
| 1464 | - /** |
|
| 1465 | - * Get arguments in super duper. |
|
| 1466 | - * |
|
| 1467 | - * @since 1.0.0 |
|
| 1468 | - * |
|
| 1469 | - * @return array Get arguments. |
|
| 1470 | - */ |
|
| 1471 | - public function get_arguments() { |
|
| 1472 | - if ( empty( $this->arguments ) ) { |
|
| 1473 | - $this->arguments = $this->set_arguments(); |
|
| 1474 | - } |
|
| 1475 | - |
|
| 1476 | - $this->arguments = apply_filters( 'wp_super_duper_arguments', $this->arguments, $this->options, $this->instance ); |
|
| 1477 | - $this->arguments = $this->add_name_from_key( $this->arguments, true ); |
|
| 1478 | - |
|
| 1479 | - return $this->arguments; |
|
| 1480 | - } |
|
| 1481 | - |
|
| 1482 | - /** |
|
| 1483 | - * This is the main output class for all 3 items, widget, shortcode and block, it is extended in the calling class. |
|
| 1484 | - * |
|
| 1485 | - * @param array $args |
|
| 1486 | - * @param array $widget_args |
|
| 1487 | - * @param string $content |
|
| 1488 | - */ |
|
| 1489 | - public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 1490 | - |
|
| 1491 | - } |
|
| 1492 | - |
|
| 1493 | - /** |
|
| 1494 | - * Add the dynamic block code inline when the wp-block in enqueued. |
|
| 1495 | - */ |
|
| 1496 | - public function register_block() { |
|
| 1497 | - wp_add_inline_script( 'wp-blocks', $this->block() ); |
|
| 1498 | - if ( class_exists( 'SiteOrigin_Panels' ) ) { |
|
| 1499 | - wp_add_inline_script( 'wp-blocks', $this->siteorigin_js() ); |
|
| 1500 | - } |
|
| 1501 | - } |
|
| 1502 | - |
|
| 1503 | - /** |
|
| 1504 | - * Check if we need to show advanced options. |
|
| 1505 | - * |
|
| 1506 | - * @return bool |
|
| 1507 | - */ |
|
| 1508 | - public function block_show_advanced() { |
|
| 1509 | - |
|
| 1510 | - $show = false; |
|
| 1511 | - $arguments = $this->arguments; |
|
| 1512 | - |
|
| 1513 | - if ( empty( $arguments ) ) { |
|
| 1514 | - $arguments = $this->get_arguments(); |
|
| 1515 | - } |
|
| 1516 | - |
|
| 1517 | - if ( ! empty( $arguments ) ) { |
|
| 1518 | - foreach ( $arguments as $argument ) { |
|
| 1519 | - if ( isset( $argument['advanced'] ) && $argument['advanced'] ) { |
|
| 1520 | - $show = true; |
|
| 1521 | - break; // no need to continue if we know we have it |
|
| 1522 | - } |
|
| 1523 | - } |
|
| 1524 | - } |
|
| 1525 | - |
|
| 1526 | - return $show; |
|
| 1527 | - } |
|
| 1528 | - |
|
| 1529 | - /** |
|
| 1530 | - * Get the url path to the current folder. |
|
| 1531 | - * |
|
| 1532 | - * @return string |
|
| 1533 | - */ |
|
| 1534 | - public function get_url() { |
|
| 1535 | - |
|
| 1536 | - $url = $this->url; |
|
| 1537 | - |
|
| 1538 | - if ( ! $url ) { |
|
| 1539 | - // check if we are inside a plugin |
|
| 1540 | - $file_dir = str_replace( "/includes", "", dirname( __FILE__ ) ); |
|
| 1541 | - |
|
| 1542 | - $dir_parts = explode( "/wp-content/", $file_dir ); |
|
| 1543 | - $url_parts = explode( "/wp-content/", plugins_url() ); |
|
| 1544 | - |
|
| 1545 | - if ( ! empty( $url_parts[0] ) && ! empty( $dir_parts[1] ) ) { |
|
| 1546 | - $url = trailingslashit( $url_parts[0] . "/wp-content/" . $dir_parts[1] ); |
|
| 1547 | - $this->url = $url; |
|
| 1548 | - } |
|
| 1549 | - } |
|
| 1550 | - |
|
| 1551 | - |
|
| 1552 | - return $url; |
|
| 1553 | - } |
|
| 1554 | - |
|
| 1555 | - /** |
|
| 1556 | - * Generate the block icon. |
|
| 1557 | - * |
|
| 1558 | - * Enables the use of Font Awesome icons. |
|
| 1559 | - * |
|
| 1560 | - * @note xlink:href is actually deprecated but href is not supported by all so we use both. |
|
| 1561 | - * |
|
| 1562 | - * @param $icon |
|
| 1563 | - * |
|
| 1564 | - * @since 1.1.0 |
|
| 1565 | - * @return string |
|
| 1566 | - */ |
|
| 1567 | - public function get_block_icon( $icon ) { |
|
| 1568 | - |
|
| 1569 | - // check if we have a Font Awesome icon |
|
| 1570 | - $fa_type = ''; |
|
| 1571 | - if ( substr( $icon, 0, 7 ) === "fas fa-" ) { |
|
| 1572 | - $fa_type = 'solid'; |
|
| 1573 | - } elseif ( substr( $icon, 0, 7 ) === "far fa-" ) { |
|
| 1574 | - $fa_type = 'regular'; |
|
| 1575 | - } elseif ( substr( $icon, 0, 7 ) === "fab fa-" ) { |
|
| 1576 | - $fa_type = 'brands'; |
|
| 1577 | - } else { |
|
| 1578 | - $icon = "'" . $icon . "'"; |
|
| 1579 | - } |
|
| 1580 | - |
|
| 1581 | - // set the icon if we found one |
|
| 1582 | - if ( $fa_type ) { |
|
| 1583 | - $fa_icon = str_replace( array( "fas fa-", "far fa-", "fab fa-" ), "", $icon ); |
|
| 1584 | - $icon = "el('svg',{width: 20, height: 20, viewBox: '0 0 20 20'},el('use', {'xlink:href': '" . $this->get_url() . "icons/" . $fa_type . ".svg#" . $fa_icon . "','href': '" . $this->get_url() . "icons/" . $fa_type . ".svg#" . $fa_icon . "'}))"; |
|
| 1585 | - } |
|
| 1586 | - |
|
| 1587 | - return $icon; |
|
| 1588 | - } |
|
| 1589 | - |
|
| 1590 | - public function group_arguments( $arguments ) { |
|
| 1239 | + return str_replace( array( |
|
| 1240 | + '<script>', |
|
| 1241 | + '</script>' |
|
| 1242 | + ), '', $output ); |
|
| 1243 | + } |
|
| 1244 | + |
|
| 1245 | + |
|
| 1246 | + /** |
|
| 1247 | + * Set the name from the argument key. |
|
| 1248 | + * |
|
| 1249 | + * @param $options |
|
| 1250 | + * |
|
| 1251 | + * @return mixed |
|
| 1252 | + */ |
|
| 1253 | + private function add_name_from_key( $options, $arguments = false ) { |
|
| 1254 | + if ( ! empty( $options['arguments'] ) ) { |
|
| 1255 | + foreach ( $options['arguments'] as $key => $val ) { |
|
| 1256 | + $options['arguments'][ $key ]['name'] = $key; |
|
| 1257 | + } |
|
| 1258 | + } elseif ( $arguments && is_array( $options ) && ! empty( $options ) ) { |
|
| 1259 | + foreach ( $options as $key => $val ) { |
|
| 1260 | + $options[ $key ]['name'] = $key; |
|
| 1261 | + } |
|
| 1262 | + } |
|
| 1263 | + |
|
| 1264 | + return $options; |
|
| 1265 | + } |
|
| 1266 | + |
|
| 1267 | + /** |
|
| 1268 | + * Register the parent shortcode. |
|
| 1269 | + * |
|
| 1270 | + * @since 1.0.0 |
|
| 1271 | + */ |
|
| 1272 | + public function register_shortcode() { |
|
| 1273 | + add_shortcode( $this->base_id, array( $this, 'shortcode_output' ) ); |
|
| 1274 | + add_action( 'wp_ajax_super_duper_output_shortcode', array( __CLASS__, 'render_shortcode' ) ); |
|
| 1275 | + } |
|
| 1276 | + |
|
| 1277 | + /** |
|
| 1278 | + * Render the shortcode via ajax so we can return it to Gutenberg. |
|
| 1279 | + * |
|
| 1280 | + * @since 1.0.0 |
|
| 1281 | + */ |
|
| 1282 | + public static function render_shortcode() { |
|
| 1283 | + |
|
| 1284 | + check_ajax_referer( 'super_duper_output_shortcode', '_ajax_nonce', true ); |
|
| 1285 | + if ( ! current_user_can( 'manage_options' ) ) { |
|
| 1286 | + wp_die(); |
|
| 1287 | + } |
|
| 1288 | + |
|
| 1289 | + // we might need the $post value here so lets set it. |
|
| 1290 | + if ( isset( $_POST['post_id'] ) && $_POST['post_id'] ) { |
|
| 1291 | + $post_obj = get_post( absint( $_POST['post_id'] ) ); |
|
| 1292 | + if ( ! empty( $post_obj ) && empty( $post ) ) { |
|
| 1293 | + global $post; |
|
| 1294 | + $post = $post_obj; |
|
| 1295 | + } |
|
| 1296 | + } |
|
| 1297 | + |
|
| 1298 | + if ( isset( $_POST['shortcode'] ) && $_POST['shortcode'] ) { |
|
| 1299 | + $shortcode_name = sanitize_title_with_dashes( $_POST['shortcode'] ); |
|
| 1300 | + $attributes_array = isset( $_POST['attributes'] ) && $_POST['attributes'] ? $_POST['attributes'] : array(); |
|
| 1301 | + $attributes = ''; |
|
| 1302 | + if ( ! empty( $attributes_array ) ) { |
|
| 1303 | + foreach ( $attributes_array as $key => $value ) { |
|
| 1304 | + $attributes .= " " . sanitize_title_with_dashes( $key ) . "='" . wp_slash( $value ) . "' "; |
|
| 1305 | + } |
|
| 1306 | + } |
|
| 1307 | + |
|
| 1308 | + $shortcode = "[" . $shortcode_name . " " . $attributes . "]"; |
|
| 1309 | + |
|
| 1310 | + echo do_shortcode( $shortcode ); |
|
| 1311 | + |
|
| 1312 | + } |
|
| 1313 | + wp_die(); |
|
| 1314 | + } |
|
| 1315 | + |
|
| 1316 | + /** |
|
| 1317 | + * Output the shortcode. |
|
| 1318 | + * |
|
| 1319 | + * @param array $args |
|
| 1320 | + * @param string $content |
|
| 1321 | + * |
|
| 1322 | + * @return string |
|
| 1323 | + */ |
|
| 1324 | + public function shortcode_output( $args = array(), $content = '' ) { |
|
| 1325 | + $args = $this->argument_values( $args ); |
|
| 1326 | + |
|
| 1327 | + // add extra argument so we know its a output to gutenberg |
|
| 1328 | + //$args |
|
| 1329 | + $args = $this->string_to_bool( $args ); |
|
| 1330 | + |
|
| 1331 | + // if we have a enclosed shortcode we add it to the special `html` argument |
|
| 1332 | + if ( ! empty( $content ) ) { |
|
| 1333 | + $args['html'] = $content; |
|
| 1334 | + } |
|
| 1335 | + |
|
| 1336 | + $class = isset( $this->options['widget_ops']['classname'] ) ? esc_attr( $this->options['widget_ops']['classname'] ) : ''; |
|
| 1337 | + $class .= " sdel-".$this->get_instance_hash(); |
|
| 1338 | + |
|
| 1339 | + $class = apply_filters( 'wp_super_duper_div_classname', $class, $args, $this ); |
|
| 1340 | + $class = apply_filters( 'wp_super_duper_div_classname_' . $this->base_id, $class, $args, $this ); |
|
| 1341 | + |
|
| 1342 | + $attrs = apply_filters( 'wp_super_duper_div_attrs', '', $args, $this ); |
|
| 1343 | + $attrs = apply_filters( 'wp_super_duper_div_attrs_' . $this->base_id, '', $args, $this ); //@todo this does not seem right @kiran? |
|
| 1344 | + |
|
| 1345 | + $shortcode_args = array(); |
|
| 1346 | + $output = ''; |
|
| 1347 | + $no_wrap = isset( $this->options['no_wrap'] ) && $this->options['no_wrap'] ? true : false; |
|
| 1348 | + if ( isset( $args['no_wrap'] ) && $args['no_wrap'] ) { |
|
| 1349 | + $no_wrap = true; |
|
| 1350 | + } |
|
| 1351 | + $main_content = $this->output( $args, $shortcode_args, $content ); |
|
| 1352 | + if ( $main_content && ! $no_wrap ) { |
|
| 1353 | + // wrap the shortcode in a div with the same class as the widget |
|
| 1354 | + $output .= '<div class="' . $class . '" ' . $attrs . '>'; |
|
| 1355 | + if ( ! empty( $args['title'] ) ) { |
|
| 1356 | + // if its a shortcode and there is a title try to grab the title wrappers |
|
| 1357 | + $shortcode_args = array( 'before_title' => '', 'after_title' => '' ); |
|
| 1358 | + if ( empty( $instance ) ) { |
|
| 1359 | + global $wp_registered_sidebars; |
|
| 1360 | + if ( ! empty( $wp_registered_sidebars ) ) { |
|
| 1361 | + foreach ( $wp_registered_sidebars as $sidebar ) { |
|
| 1362 | + if ( ! empty( $sidebar['before_title'] ) ) { |
|
| 1363 | + $shortcode_args['before_title'] = $sidebar['before_title']; |
|
| 1364 | + $shortcode_args['after_title'] = $sidebar['after_title']; |
|
| 1365 | + break; |
|
| 1366 | + } |
|
| 1367 | + } |
|
| 1368 | + } |
|
| 1369 | + } |
|
| 1370 | + $output .= $this->output_title( $shortcode_args, $args ); |
|
| 1371 | + } |
|
| 1372 | + $output .= $main_content; |
|
| 1373 | + $output .= '</div>'; |
|
| 1374 | + } elseif ( $main_content && $no_wrap ) { |
|
| 1375 | + $output .= $main_content; |
|
| 1376 | + } |
|
| 1377 | + |
|
| 1378 | + // if preview show a placeholder if empty |
|
| 1379 | + if ( $this->is_preview() && $output == '' ) { |
|
| 1380 | + $output = $this->preview_placeholder_text( "{{" . $this->base_id . "}}" ); |
|
| 1381 | + } |
|
| 1382 | + |
|
| 1383 | + return apply_filters( 'wp_super_duper_widget_output', $output, $args, $shortcode_args, $this ); |
|
| 1384 | + } |
|
| 1385 | + |
|
| 1386 | + /** |
|
| 1387 | + * Placeholder text to show if output is empty and we are on a preview/builder page. |
|
| 1388 | + * |
|
| 1389 | + * @param string $name |
|
| 1390 | + * |
|
| 1391 | + * @return string |
|
| 1392 | + */ |
|
| 1393 | + public function preview_placeholder_text( $name = '' ) { |
|
| 1394 | + return "<div style='background:#0185ba33;padding: 10px;border: 4px #ccc dashed;'>" . sprintf( __( 'Placeholder for: %s' ), $name ) . "</div>"; |
|
| 1395 | + } |
|
| 1396 | + |
|
| 1397 | + /** |
|
| 1398 | + * Sometimes booleans values can be turned to strings, so we fix that. |
|
| 1399 | + * |
|
| 1400 | + * @param $options |
|
| 1401 | + * |
|
| 1402 | + * @return mixed |
|
| 1403 | + */ |
|
| 1404 | + public function string_to_bool( $options ) { |
|
| 1405 | + // convert bool strings to booleans |
|
| 1406 | + foreach ( $options as $key => $val ) { |
|
| 1407 | + if ( $val == 'false' ) { |
|
| 1408 | + $options[ $key ] = false; |
|
| 1409 | + } elseif ( $val == 'true' ) { |
|
| 1410 | + $options[ $key ] = true; |
|
| 1411 | + } |
|
| 1412 | + } |
|
| 1413 | + |
|
| 1414 | + return $options; |
|
| 1415 | + } |
|
| 1416 | + |
|
| 1417 | + /** |
|
| 1418 | + * Get the argument values that are also filterable. |
|
| 1419 | + * |
|
| 1420 | + * @param $instance |
|
| 1421 | + * |
|
| 1422 | + * @since 1.0.12 Don't set checkbox default value if the value is empty. |
|
| 1423 | + * |
|
| 1424 | + * @return array |
|
| 1425 | + */ |
|
| 1426 | + public function argument_values( $instance ) { |
|
| 1427 | + $argument_values = array(); |
|
| 1428 | + |
|
| 1429 | + // set widget instance |
|
| 1430 | + $this->instance = $instance; |
|
| 1431 | + |
|
| 1432 | + if ( empty( $this->arguments ) ) { |
|
| 1433 | + $this->arguments = $this->get_arguments(); |
|
| 1434 | + } |
|
| 1435 | + |
|
| 1436 | + if ( ! empty( $this->arguments ) ) { |
|
| 1437 | + foreach ( $this->arguments as $key => $args ) { |
|
| 1438 | + // set the input name from the key |
|
| 1439 | + $args['name'] = $key; |
|
| 1440 | + // |
|
| 1441 | + $argument_values[ $key ] = isset( $instance[ $key ] ) ? $instance[ $key ] : ''; |
|
| 1442 | + if ( $args['type'] == 'checkbox' && $argument_values[ $key ] == '' ) { |
|
| 1443 | + // don't set default for an empty checkbox |
|
| 1444 | + } elseif ( $argument_values[ $key ] == '' && isset( $args['default'] ) ) { |
|
| 1445 | + $argument_values[ $key ] = $args['default']; |
|
| 1446 | + } |
|
| 1447 | + } |
|
| 1448 | + } |
|
| 1449 | + |
|
| 1450 | + return $argument_values; |
|
| 1451 | + } |
|
| 1452 | + |
|
| 1453 | + /** |
|
| 1454 | + * Set arguments in super duper. |
|
| 1455 | + * |
|
| 1456 | + * @since 1.0.0 |
|
| 1457 | + * |
|
| 1458 | + * @return array Set arguments. |
|
| 1459 | + */ |
|
| 1460 | + public function set_arguments() { |
|
| 1461 | + return $this->arguments; |
|
| 1462 | + } |
|
| 1463 | + |
|
| 1464 | + /** |
|
| 1465 | + * Get arguments in super duper. |
|
| 1466 | + * |
|
| 1467 | + * @since 1.0.0 |
|
| 1468 | + * |
|
| 1469 | + * @return array Get arguments. |
|
| 1470 | + */ |
|
| 1471 | + public function get_arguments() { |
|
| 1472 | + if ( empty( $this->arguments ) ) { |
|
| 1473 | + $this->arguments = $this->set_arguments(); |
|
| 1474 | + } |
|
| 1475 | + |
|
| 1476 | + $this->arguments = apply_filters( 'wp_super_duper_arguments', $this->arguments, $this->options, $this->instance ); |
|
| 1477 | + $this->arguments = $this->add_name_from_key( $this->arguments, true ); |
|
| 1478 | + |
|
| 1479 | + return $this->arguments; |
|
| 1480 | + } |
|
| 1481 | + |
|
| 1482 | + /** |
|
| 1483 | + * This is the main output class for all 3 items, widget, shortcode and block, it is extended in the calling class. |
|
| 1484 | + * |
|
| 1485 | + * @param array $args |
|
| 1486 | + * @param array $widget_args |
|
| 1487 | + * @param string $content |
|
| 1488 | + */ |
|
| 1489 | + public function output( $args = array(), $widget_args = array(), $content = '' ) { |
|
| 1490 | + |
|
| 1491 | + } |
|
| 1492 | + |
|
| 1493 | + /** |
|
| 1494 | + * Add the dynamic block code inline when the wp-block in enqueued. |
|
| 1495 | + */ |
|
| 1496 | + public function register_block() { |
|
| 1497 | + wp_add_inline_script( 'wp-blocks', $this->block() ); |
|
| 1498 | + if ( class_exists( 'SiteOrigin_Panels' ) ) { |
|
| 1499 | + wp_add_inline_script( 'wp-blocks', $this->siteorigin_js() ); |
|
| 1500 | + } |
|
| 1501 | + } |
|
| 1502 | + |
|
| 1503 | + /** |
|
| 1504 | + * Check if we need to show advanced options. |
|
| 1505 | + * |
|
| 1506 | + * @return bool |
|
| 1507 | + */ |
|
| 1508 | + public function block_show_advanced() { |
|
| 1509 | + |
|
| 1510 | + $show = false; |
|
| 1511 | + $arguments = $this->arguments; |
|
| 1512 | + |
|
| 1513 | + if ( empty( $arguments ) ) { |
|
| 1514 | + $arguments = $this->get_arguments(); |
|
| 1515 | + } |
|
| 1516 | + |
|
| 1517 | + if ( ! empty( $arguments ) ) { |
|
| 1518 | + foreach ( $arguments as $argument ) { |
|
| 1519 | + if ( isset( $argument['advanced'] ) && $argument['advanced'] ) { |
|
| 1520 | + $show = true; |
|
| 1521 | + break; // no need to continue if we know we have it |
|
| 1522 | + } |
|
| 1523 | + } |
|
| 1524 | + } |
|
| 1525 | + |
|
| 1526 | + return $show; |
|
| 1527 | + } |
|
| 1528 | + |
|
| 1529 | + /** |
|
| 1530 | + * Get the url path to the current folder. |
|
| 1531 | + * |
|
| 1532 | + * @return string |
|
| 1533 | + */ |
|
| 1534 | + public function get_url() { |
|
| 1535 | + |
|
| 1536 | + $url = $this->url; |
|
| 1537 | + |
|
| 1538 | + if ( ! $url ) { |
|
| 1539 | + // check if we are inside a plugin |
|
| 1540 | + $file_dir = str_replace( "/includes", "", dirname( __FILE__ ) ); |
|
| 1541 | + |
|
| 1542 | + $dir_parts = explode( "/wp-content/", $file_dir ); |
|
| 1543 | + $url_parts = explode( "/wp-content/", plugins_url() ); |
|
| 1544 | + |
|
| 1545 | + if ( ! empty( $url_parts[0] ) && ! empty( $dir_parts[1] ) ) { |
|
| 1546 | + $url = trailingslashit( $url_parts[0] . "/wp-content/" . $dir_parts[1] ); |
|
| 1547 | + $this->url = $url; |
|
| 1548 | + } |
|
| 1549 | + } |
|
| 1550 | + |
|
| 1551 | + |
|
| 1552 | + return $url; |
|
| 1553 | + } |
|
| 1554 | + |
|
| 1555 | + /** |
|
| 1556 | + * Generate the block icon. |
|
| 1557 | + * |
|
| 1558 | + * Enables the use of Font Awesome icons. |
|
| 1559 | + * |
|
| 1560 | + * @note xlink:href is actually deprecated but href is not supported by all so we use both. |
|
| 1561 | + * |
|
| 1562 | + * @param $icon |
|
| 1563 | + * |
|
| 1564 | + * @since 1.1.0 |
|
| 1565 | + * @return string |
|
| 1566 | + */ |
|
| 1567 | + public function get_block_icon( $icon ) { |
|
| 1568 | + |
|
| 1569 | + // check if we have a Font Awesome icon |
|
| 1570 | + $fa_type = ''; |
|
| 1571 | + if ( substr( $icon, 0, 7 ) === "fas fa-" ) { |
|
| 1572 | + $fa_type = 'solid'; |
|
| 1573 | + } elseif ( substr( $icon, 0, 7 ) === "far fa-" ) { |
|
| 1574 | + $fa_type = 'regular'; |
|
| 1575 | + } elseif ( substr( $icon, 0, 7 ) === "fab fa-" ) { |
|
| 1576 | + $fa_type = 'brands'; |
|
| 1577 | + } else { |
|
| 1578 | + $icon = "'" . $icon . "'"; |
|
| 1579 | + } |
|
| 1580 | + |
|
| 1581 | + // set the icon if we found one |
|
| 1582 | + if ( $fa_type ) { |
|
| 1583 | + $fa_icon = str_replace( array( "fas fa-", "far fa-", "fab fa-" ), "", $icon ); |
|
| 1584 | + $icon = "el('svg',{width: 20, height: 20, viewBox: '0 0 20 20'},el('use', {'xlink:href': '" . $this->get_url() . "icons/" . $fa_type . ".svg#" . $fa_icon . "','href': '" . $this->get_url() . "icons/" . $fa_type . ".svg#" . $fa_icon . "'}))"; |
|
| 1585 | + } |
|
| 1586 | + |
|
| 1587 | + return $icon; |
|
| 1588 | + } |
|
| 1589 | + |
|
| 1590 | + public function group_arguments( $arguments ) { |
|
| 1591 | 1591 | // echo '###';print_r($arguments); |
| 1592 | - if ( ! empty( $arguments ) ) { |
|
| 1593 | - $temp_arguments = array(); |
|
| 1594 | - $general = __( "General" ); |
|
| 1595 | - $add_sections = false; |
|
| 1596 | - foreach ( $arguments as $key => $args ) { |
|
| 1597 | - if ( isset( $args['group'] ) ) { |
|
| 1598 | - $temp_arguments[ $args['group'] ][ $key ] = $args; |
|
| 1599 | - $add_sections = true; |
|
| 1600 | - } else { |
|
| 1601 | - $temp_arguments[ $general ][ $key ] = $args; |
|
| 1602 | - } |
|
| 1603 | - } |
|
| 1604 | - |
|
| 1605 | - // only add sections if more than one |
|
| 1606 | - if ( $add_sections ) { |
|
| 1607 | - $arguments = $temp_arguments; |
|
| 1608 | - } |
|
| 1609 | - } |
|
| 1592 | + if ( ! empty( $arguments ) ) { |
|
| 1593 | + $temp_arguments = array(); |
|
| 1594 | + $general = __( "General" ); |
|
| 1595 | + $add_sections = false; |
|
| 1596 | + foreach ( $arguments as $key => $args ) { |
|
| 1597 | + if ( isset( $args['group'] ) ) { |
|
| 1598 | + $temp_arguments[ $args['group'] ][ $key ] = $args; |
|
| 1599 | + $add_sections = true; |
|
| 1600 | + } else { |
|
| 1601 | + $temp_arguments[ $general ][ $key ] = $args; |
|
| 1602 | + } |
|
| 1603 | + } |
|
| 1604 | + |
|
| 1605 | + // only add sections if more than one |
|
| 1606 | + if ( $add_sections ) { |
|
| 1607 | + $arguments = $temp_arguments; |
|
| 1608 | + } |
|
| 1609 | + } |
|
| 1610 | 1610 | |
| 1611 | 1611 | // echo '###';print_r($arguments); |
| 1612 | - return $arguments; |
|
| 1613 | - } |
|
| 1614 | - |
|
| 1615 | - |
|
| 1616 | - /** |
|
| 1617 | - * Output the JS for building the dynamic Guntenberg block. |
|
| 1618 | - * |
|
| 1619 | - * @since 1.0.4 Added block_wrap property which will set the block wrapping output element ie: div, span, p or empty for no wrap. |
|
| 1620 | - * @since 1.0.9 Save numbers as numbers and not strings. |
|
| 1621 | - * @since 1.1.0 Font Awesome classes can be used for icons. |
|
| 1622 | - * @return mixed |
|
| 1623 | - */ |
|
| 1624 | - public function block() { |
|
| 1625 | - ob_start(); |
|
| 1626 | - |
|
| 1627 | - $show_advanced = $this->block_show_advanced(); |
|
| 1628 | - ?> |
|
| 1612 | + return $arguments; |
|
| 1613 | + } |
|
| 1614 | + |
|
| 1615 | + |
|
| 1616 | + /** |
|
| 1617 | + * Output the JS for building the dynamic Guntenberg block. |
|
| 1618 | + * |
|
| 1619 | + * @since 1.0.4 Added block_wrap property which will set the block wrapping output element ie: div, span, p or empty for no wrap. |
|
| 1620 | + * @since 1.0.9 Save numbers as numbers and not strings. |
|
| 1621 | + * @since 1.1.0 Font Awesome classes can be used for icons. |
|
| 1622 | + * @return mixed |
|
| 1623 | + */ |
|
| 1624 | + public function block() { |
|
| 1625 | + ob_start(); |
|
| 1626 | + |
|
| 1627 | + $show_advanced = $this->block_show_advanced(); |
|
| 1628 | + ?> |
|
| 1629 | 1629 | <script> |
| 1630 | 1630 | /** |
| 1631 | 1631 | * BLOCK: Basic |
@@ -1669,97 +1669,97 @@ discard block |
||
| 1669 | 1669 | icon: <?php echo $this->get_block_icon( $this->options['block-icon'] );?>,//'<?php echo isset( $this->options['block-icon'] ) ? esc_attr( $this->options['block-icon'] ) : 'shield-alt';?>', // Block icon from Dashicons → https://developer.wordpress.org/resource/dashicons/. |
| 1670 | 1670 | supports: { |
| 1671 | 1671 | <?php |
| 1672 | - if ( isset( $this->options['block-supports'] ) ) { |
|
| 1673 | - echo $this->array_to_attributes( $this->options['block-supports'] ); |
|
| 1674 | - } |
|
| 1675 | - ?> |
|
| 1672 | + if ( isset( $this->options['block-supports'] ) ) { |
|
| 1673 | + echo $this->array_to_attributes( $this->options['block-supports'] ); |
|
| 1674 | + } |
|
| 1675 | + ?> |
|
| 1676 | 1676 | }, |
| 1677 | 1677 | category: '<?php echo isset( $this->options['block-category'] ) ? esc_attr( $this->options['block-category'] ) : 'common';?>', // Block category — Group blocks together based on common traits E.g. common, formatting, layout widgets, embed. |
| 1678 | 1678 | <?php if ( isset( $this->options['block-keywords'] ) ) { |
| 1679 | - echo "keywords : " . $this->options['block-keywords'] . ","; |
|
| 1680 | - }?> |
|
| 1679 | + echo "keywords : " . $this->options['block-keywords'] . ","; |
|
| 1680 | + }?> |
|
| 1681 | 1681 | |
| 1682 | 1682 | <?php |
| 1683 | 1683 | |
| 1684 | - // maybe set no_wrap |
|
| 1685 | - $no_wrap = isset( $this->options['no_wrap'] ) && $this->options['no_wrap'] ? true : false; |
|
| 1686 | - if ( isset( $this->arguments['no_wrap'] ) && $this->arguments['no_wrap'] ) { |
|
| 1687 | - $no_wrap = true; |
|
| 1688 | - } |
|
| 1689 | - if ( $no_wrap ) { |
|
| 1690 | - $this->options['block-wrap'] = ''; |
|
| 1691 | - } |
|
| 1684 | + // maybe set no_wrap |
|
| 1685 | + $no_wrap = isset( $this->options['no_wrap'] ) && $this->options['no_wrap'] ? true : false; |
|
| 1686 | + if ( isset( $this->arguments['no_wrap'] ) && $this->arguments['no_wrap'] ) { |
|
| 1687 | + $no_wrap = true; |
|
| 1688 | + } |
|
| 1689 | + if ( $no_wrap ) { |
|
| 1690 | + $this->options['block-wrap'] = ''; |
|
| 1691 | + } |
|
| 1692 | 1692 | |
| 1693 | 1693 | |
| 1694 | 1694 | |
| 1695 | - $show_alignment = false; |
|
| 1696 | - // align feature |
|
| 1697 | - /*echo "supports: {"; |
|
| 1695 | + $show_alignment = false; |
|
| 1696 | + // align feature |
|
| 1697 | + /*echo "supports: {"; |
|
| 1698 | 1698 | echo " align: true,"; |
| 1699 | 1699 | echo " html: false"; |
| 1700 | 1700 | echo "},";*/ |
| 1701 | 1701 | |
| 1702 | - if ( ! empty( $this->arguments ) ) { |
|
| 1703 | - echo "attributes : {"; |
|
| 1704 | - |
|
| 1705 | - if ( $show_advanced ) { |
|
| 1706 | - echo "show_advanced: {"; |
|
| 1707 | - echo " type: 'boolean',"; |
|
| 1708 | - echo " default: false,"; |
|
| 1709 | - echo "},"; |
|
| 1710 | - } |
|
| 1711 | - |
|
| 1712 | - // block wrap element |
|
| 1713 | - if ( ! empty( $this->options['block-wrap'] ) ) { //@todo we should validate this? |
|
| 1714 | - echo "block_wrap: {"; |
|
| 1715 | - echo " type: 'string',"; |
|
| 1716 | - echo " default: '" . esc_attr( $this->options['block-wrap'] ) . "',"; |
|
| 1717 | - echo "},"; |
|
| 1718 | - } |
|
| 1719 | - |
|
| 1720 | - foreach ( $this->arguments as $key => $args ) { |
|
| 1721 | - |
|
| 1722 | - // set if we should show alignment |
|
| 1723 | - if ( $key == 'alignment' ) { |
|
| 1724 | - $show_alignment = true; |
|
| 1725 | - } |
|
| 1726 | - |
|
| 1727 | - $extra = ''; |
|
| 1728 | - |
|
| 1729 | - if ( $args['type'] == 'checkbox' ) { |
|
| 1730 | - $type = 'boolean'; |
|
| 1731 | - $default = isset( $args['default'] ) && $args['default'] ? 'true' : 'false'; |
|
| 1732 | - } elseif ( $args['type'] == 'number' ) { |
|
| 1733 | - $type = 'number'; |
|
| 1734 | - $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1735 | - } elseif ( $args['type'] == 'select' && ! empty( $args['multiple'] ) ) { |
|
| 1736 | - $type = 'array'; |
|
| 1737 | - if ( is_array( $args['default'] ) ) { |
|
| 1738 | - $default = isset( $args['default'] ) ? "['" . implode( "','", $args['default'] ) . "']" : "[]"; |
|
| 1739 | - } else { |
|
| 1740 | - $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1741 | - } |
|
| 1742 | - } elseif ( $args['type'] == 'multiselect' ) { |
|
| 1743 | - $type = 'array'; |
|
| 1744 | - $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1745 | - } else { |
|
| 1746 | - $type = 'string'; |
|
| 1747 | - $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1748 | - } |
|
| 1749 | - echo $key . " : {"; |
|
| 1750 | - echo "type : '$type',"; |
|
| 1751 | - echo "default : $default,"; |
|
| 1752 | - echo "},"; |
|
| 1753 | - } |
|
| 1754 | - |
|
| 1755 | - echo "content : {type : 'string',default: 'Please select the attributes in the block settings'},"; |
|
| 1756 | - echo "className: { type: 'string', default: '' },"; |
|
| 1757 | - |
|
| 1758 | - echo "},"; |
|
| 1759 | - |
|
| 1760 | - } |
|
| 1761 | - |
|
| 1762 | - ?> |
|
| 1702 | + if ( ! empty( $this->arguments ) ) { |
|
| 1703 | + echo "attributes : {"; |
|
| 1704 | + |
|
| 1705 | + if ( $show_advanced ) { |
|
| 1706 | + echo "show_advanced: {"; |
|
| 1707 | + echo " type: 'boolean',"; |
|
| 1708 | + echo " default: false,"; |
|
| 1709 | + echo "},"; |
|
| 1710 | + } |
|
| 1711 | + |
|
| 1712 | + // block wrap element |
|
| 1713 | + if ( ! empty( $this->options['block-wrap'] ) ) { //@todo we should validate this? |
|
| 1714 | + echo "block_wrap: {"; |
|
| 1715 | + echo " type: 'string',"; |
|
| 1716 | + echo " default: '" . esc_attr( $this->options['block-wrap'] ) . "',"; |
|
| 1717 | + echo "},"; |
|
| 1718 | + } |
|
| 1719 | + |
|
| 1720 | + foreach ( $this->arguments as $key => $args ) { |
|
| 1721 | + |
|
| 1722 | + // set if we should show alignment |
|
| 1723 | + if ( $key == 'alignment' ) { |
|
| 1724 | + $show_alignment = true; |
|
| 1725 | + } |
|
| 1726 | + |
|
| 1727 | + $extra = ''; |
|
| 1728 | + |
|
| 1729 | + if ( $args['type'] == 'checkbox' ) { |
|
| 1730 | + $type = 'boolean'; |
|
| 1731 | + $default = isset( $args['default'] ) && $args['default'] ? 'true' : 'false'; |
|
| 1732 | + } elseif ( $args['type'] == 'number' ) { |
|
| 1733 | + $type = 'number'; |
|
| 1734 | + $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1735 | + } elseif ( $args['type'] == 'select' && ! empty( $args['multiple'] ) ) { |
|
| 1736 | + $type = 'array'; |
|
| 1737 | + if ( is_array( $args['default'] ) ) { |
|
| 1738 | + $default = isset( $args['default'] ) ? "['" . implode( "','", $args['default'] ) . "']" : "[]"; |
|
| 1739 | + } else { |
|
| 1740 | + $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1741 | + } |
|
| 1742 | + } elseif ( $args['type'] == 'multiselect' ) { |
|
| 1743 | + $type = 'array'; |
|
| 1744 | + $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1745 | + } else { |
|
| 1746 | + $type = 'string'; |
|
| 1747 | + $default = isset( $args['default'] ) ? "'" . $args['default'] . "'" : "''"; |
|
| 1748 | + } |
|
| 1749 | + echo $key . " : {"; |
|
| 1750 | + echo "type : '$type',"; |
|
| 1751 | + echo "default : $default,"; |
|
| 1752 | + echo "},"; |
|
| 1753 | + } |
|
| 1754 | + |
|
| 1755 | + echo "content : {type : 'string',default: 'Please select the attributes in the block settings'},"; |
|
| 1756 | + echo "className: { type: 'string', default: '' },"; |
|
| 1757 | + |
|
| 1758 | + echo "},"; |
|
| 1759 | + |
|
| 1760 | + } |
|
| 1761 | + |
|
| 1762 | + ?> |
|
| 1763 | 1763 | |
| 1764 | 1764 | // The "edit" property must be a valid function. |
| 1765 | 1765 | edit: function (props) { |
@@ -1767,9 +1767,9 @@ discard block |
||
| 1767 | 1767 | |
| 1768 | 1768 | var $value = ''; |
| 1769 | 1769 | <?php |
| 1770 | - // if we have a post_type and a category then link them |
|
| 1771 | - if( isset($this->arguments['post_type']) && isset($this->arguments['category']) && !empty($this->arguments['category']['post_type_linked']) ){ |
|
| 1772 | - ?> |
|
| 1770 | + // if we have a post_type and a category then link them |
|
| 1771 | + if( isset($this->arguments['post_type']) && isset($this->arguments['category']) && !empty($this->arguments['category']['post_type_linked']) ){ |
|
| 1772 | + ?> |
|
| 1773 | 1773 | if(typeof(prev_attributes[props.id]) != 'undefined' ){ |
| 1774 | 1774 | $pt = props.attributes.post_type; |
| 1775 | 1775 | if(post_type_rest_slugs.length){ |
@@ -1853,8 +1853,8 @@ discard block |
||
| 1853 | 1853 | 'shortcode': '<?php echo $this->options['base_id'];?>', |
| 1854 | 1854 | 'attributes': props.attributes, |
| 1855 | 1855 | 'post_id': <?php global $post; if ( isset( $post->ID ) ) { |
| 1856 | - echo $post->ID; |
|
| 1857 | - }?>, |
|
| 1856 | + echo $post->ID; |
|
| 1857 | + }?>, |
|
| 1858 | 1858 | '_ajax_nonce': '<?php echo wp_create_nonce( 'super_duper_output_shortcode' );?>' |
| 1859 | 1859 | }; |
| 1860 | 1860 | |
@@ -1906,10 +1906,10 @@ discard block |
||
| 1906 | 1906 | |
| 1907 | 1907 | <?php |
| 1908 | 1908 | |
| 1909 | - if(! empty( $this->arguments )){ |
|
| 1909 | + if(! empty( $this->arguments )){ |
|
| 1910 | 1910 | |
| 1911 | - if ( $show_advanced ) { |
|
| 1912 | - ?> |
|
| 1911 | + if ( $show_advanced ) { |
|
| 1912 | + ?> |
|
| 1913 | 1913 | el('div', { |
| 1914 | 1914 | style: {'padding-left': '16px','padding-right': '16px'} |
| 1915 | 1915 | }, |
@@ -1927,79 +1927,79 @@ discard block |
||
| 1927 | 1927 | , |
| 1928 | 1928 | <?php |
| 1929 | 1929 | |
| 1930 | - } |
|
| 1930 | + } |
|
| 1931 | 1931 | |
| 1932 | - $arguments = $this->group_arguments( $this->arguments ); |
|
| 1932 | + $arguments = $this->group_arguments( $this->arguments ); |
|
| 1933 | 1933 | |
| 1934 | - // Do we have sections? |
|
| 1935 | - $has_sections = $arguments == $this->arguments ? false : true; |
|
| 1934 | + // Do we have sections? |
|
| 1935 | + $has_sections = $arguments == $this->arguments ? false : true; |
|
| 1936 | 1936 | |
| 1937 | 1937 | |
| 1938 | - if($has_sections){ |
|
| 1939 | - $panel_count = 0; |
|
| 1940 | - foreach($arguments as $key => $args){ |
|
| 1941 | - ?> |
|
| 1938 | + if($has_sections){ |
|
| 1939 | + $panel_count = 0; |
|
| 1940 | + foreach($arguments as $key => $args){ |
|
| 1941 | + ?> |
|
| 1942 | 1942 | el(wp.components.PanelBody, { |
| 1943 | 1943 | title: '<?php esc_attr_e( $key ); ?>', |
| 1944 | 1944 | initialOpen: <?php if ( $panel_count ) { |
| 1945 | - echo "false"; |
|
| 1946 | - } else { |
|
| 1947 | - echo "true"; |
|
| 1948 | - }?> |
|
| 1945 | + echo "false"; |
|
| 1946 | + } else { |
|
| 1947 | + echo "true"; |
|
| 1948 | + }?> |
|
| 1949 | 1949 | }, |
| 1950 | 1950 | <?php |
| 1951 | 1951 | |
| 1952 | 1952 | |
| 1953 | 1953 | |
| 1954 | - foreach ( $args as $k => $a ) { |
|
| 1954 | + foreach ( $args as $k => $a ) { |
|
| 1955 | 1955 | |
| 1956 | - $this->block_row_start( $k, $a ); |
|
| 1957 | - $this->build_block_arguments( $k, $a ); |
|
| 1958 | - $this->block_row_end( $k, $a ); |
|
| 1959 | - } |
|
| 1960 | - ?> |
|
| 1956 | + $this->block_row_start( $k, $a ); |
|
| 1957 | + $this->build_block_arguments( $k, $a ); |
|
| 1958 | + $this->block_row_end( $k, $a ); |
|
| 1959 | + } |
|
| 1960 | + ?> |
|
| 1961 | 1961 | ), |
| 1962 | 1962 | <?php |
| 1963 | - $panel_count ++; |
|
| 1963 | + $panel_count ++; |
|
| 1964 | 1964 | |
| 1965 | - } |
|
| 1966 | - }else { |
|
| 1967 | - ?> |
|
| 1965 | + } |
|
| 1966 | + }else { |
|
| 1967 | + ?> |
|
| 1968 | 1968 | el(wp.components.PanelBody, { |
| 1969 | 1969 | title: '<?php esc_attr_e( "Settings" ); ?>', |
| 1970 | 1970 | initialOpen: true |
| 1971 | 1971 | }, |
| 1972 | 1972 | <?php |
| 1973 | - foreach ( $this->arguments as $key => $args ) { |
|
| 1974 | - $this->block_row_start( $key, $args ); |
|
| 1975 | - $this->build_block_arguments( $key, $args ); |
|
| 1976 | - $this->block_row_end( $key, $args ); |
|
| 1977 | - } |
|
| 1978 | - ?> |
|
| 1973 | + foreach ( $this->arguments as $key => $args ) { |
|
| 1974 | + $this->block_row_start( $key, $args ); |
|
| 1975 | + $this->build_block_arguments( $key, $args ); |
|
| 1976 | + $this->block_row_end( $key, $args ); |
|
| 1977 | + } |
|
| 1978 | + ?> |
|
| 1979 | 1979 | ), |
| 1980 | 1980 | <?php |
| 1981 | - } |
|
| 1981 | + } |
|
| 1982 | 1982 | |
| 1983 | - } |
|
| 1984 | - ?> |
|
| 1983 | + } |
|
| 1984 | + ?> |
|
| 1985 | 1985 | |
| 1986 | 1986 | ), |
| 1987 | 1987 | |
| 1988 | 1988 | <?php |
| 1989 | - // If the user sets block-output array then build it |
|
| 1990 | - if ( ! empty( $this->options['block-output'] ) ) { |
|
| 1991 | - $this->block_element( $this->options['block-output'] ); |
|
| 1992 | - }else{ |
|
| 1993 | - // if no block-output is set then we try and get the shortcode html output via ajax. |
|
| 1994 | - ?> |
|
| 1989 | + // If the user sets block-output array then build it |
|
| 1990 | + if ( ! empty( $this->options['block-output'] ) ) { |
|
| 1991 | + $this->block_element( $this->options['block-output'] ); |
|
| 1992 | + }else{ |
|
| 1993 | + // if no block-output is set then we try and get the shortcode html output via ajax. |
|
| 1994 | + ?> |
|
| 1995 | 1995 | el('div', { |
| 1996 | 1996 | dangerouslySetInnerHTML: {__html: onChangeContent()}, |
| 1997 | 1997 | className: props.className, |
| 1998 | 1998 | style: {'minHeight': '30px'} |
| 1999 | 1999 | }) |
| 2000 | 2000 | <?php |
| 2001 | - } |
|
| 2002 | - ?> |
|
| 2001 | + } |
|
| 2002 | + ?> |
|
| 2003 | 2003 | ]; // end return |
| 2004 | 2004 | }, |
| 2005 | 2005 | |
@@ -2017,10 +2017,10 @@ discard block |
||
| 2017 | 2017 | $html = ''; |
| 2018 | 2018 | <?php |
| 2019 | 2019 | |
| 2020 | - if(! empty( $this->arguments )){ |
|
| 2020 | + if(! empty( $this->arguments )){ |
|
| 2021 | 2021 | |
| 2022 | - foreach($this->arguments as $key => $args){ |
|
| 2023 | - ?> |
|
| 2022 | + foreach($this->arguments as $key => $args){ |
|
| 2023 | + ?> |
|
| 2024 | 2024 | if (attr.hasOwnProperty("<?php echo esc_attr( $key );?>")) { |
| 2025 | 2025 | if ('<?php echo esc_attr( $key );?>' == 'html') { |
| 2026 | 2026 | $html = attr.<?php echo esc_attr( $key );?>; |
@@ -2029,10 +2029,10 @@ discard block |
||
| 2029 | 2029 | } |
| 2030 | 2030 | } |
| 2031 | 2031 | <?php |
| 2032 | - } |
|
| 2033 | - } |
|
| 2032 | + } |
|
| 2033 | + } |
|
| 2034 | 2034 | |
| 2035 | - ?> |
|
| 2035 | + ?> |
|
| 2036 | 2036 | content += "]"; |
| 2037 | 2037 | |
| 2038 | 2038 | // if has html element |
@@ -2055,20 +2055,20 @@ discard block |
||
| 2055 | 2055 | } |
| 2056 | 2056 | |
| 2057 | 2057 | <?php |
| 2058 | - if(isset( $this->options['block-wrap'] ) && $this->options['block-wrap'] == ''){ |
|
| 2059 | - ?> |
|
| 2058 | + if(isset( $this->options['block-wrap'] ) && $this->options['block-wrap'] == ''){ |
|
| 2059 | + ?> |
|
| 2060 | 2060 | return content; |
| 2061 | 2061 | <?php |
| 2062 | - }else{ |
|
| 2063 | - ?> |
|
| 2062 | + }else{ |
|
| 2063 | + ?> |
|
| 2064 | 2064 | var block_wrap = 'div'; |
| 2065 | 2065 | if (attr.hasOwnProperty("block_wrap")) { |
| 2066 | 2066 | block_wrap = attr.block_wrap; |
| 2067 | 2067 | } |
| 2068 | 2068 | return el(block_wrap, {dangerouslySetInnerHTML: {__html: content}, className: align}); |
| 2069 | 2069 | <?php |
| 2070 | - } |
|
| 2071 | - ?> |
|
| 2070 | + } |
|
| 2071 | + ?> |
|
| 2072 | 2072 | |
| 2073 | 2073 | |
| 2074 | 2074 | } |
@@ -2076,30 +2076,30 @@ discard block |
||
| 2076 | 2076 | })(); |
| 2077 | 2077 | </script> |
| 2078 | 2078 | <?php |
| 2079 | - $output = ob_get_clean(); |
|
| 2079 | + $output = ob_get_clean(); |
|
| 2080 | 2080 | |
| 2081 | - /* |
|
| 2081 | + /* |
|
| 2082 | 2082 | * We only add the <script> tags for code highlighting, so we strip them from the output. |
| 2083 | 2083 | */ |
| 2084 | 2084 | |
| 2085 | - return str_replace( array( |
|
| 2086 | - '<script>', |
|
| 2087 | - '</script>' |
|
| 2088 | - ), '', $output ); |
|
| 2089 | - } |
|
| 2085 | + return str_replace( array( |
|
| 2086 | + '<script>', |
|
| 2087 | + '</script>' |
|
| 2088 | + ), '', $output ); |
|
| 2089 | + } |
|
| 2090 | 2090 | |
| 2091 | - public function block_row_start($key, $args){ |
|
| 2091 | + public function block_row_start($key, $args){ |
|
| 2092 | 2092 | |
| 2093 | - // check for row |
|
| 2094 | - if(!empty($args['row'])){ |
|
| 2093 | + // check for row |
|
| 2094 | + if(!empty($args['row'])){ |
|
| 2095 | 2095 | |
| 2096 | - if(!empty($args['row']['open'])){ |
|
| 2096 | + if(!empty($args['row']['open'])){ |
|
| 2097 | 2097 | |
| 2098 | - // element require |
|
| 2099 | - $element_require = ! empty( $args['element_require'] ) ? $this->block_props_replace( $args['element_require'], true ) . " && " : ""; |
|
| 2100 | - echo $element_require; |
|
| 2098 | + // element require |
|
| 2099 | + $element_require = ! empty( $args['element_require'] ) ? $this->block_props_replace( $args['element_require'], true ) . " && " : ""; |
|
| 2100 | + echo $element_require; |
|
| 2101 | 2101 | |
| 2102 | - if(false){?><script><?php }?> |
|
| 2102 | + if(false){?><script><?php }?> |
|
| 2103 | 2103 | el('div', { |
| 2104 | 2104 | className: 'bsui components-base-control', |
| 2105 | 2105 | }, |
@@ -2129,87 +2129,87 @@ discard block |
||
| 2129 | 2129 | }, |
| 2130 | 2130 | |
| 2131 | 2131 | <?php |
| 2132 | - if(false){?></script><?php } |
|
| 2133 | - }elseif(!empty($args['row']['close'])){ |
|
| 2134 | - if(false){?><script><?php }?> |
|
| 2132 | + if(false){?></script><?php } |
|
| 2133 | + }elseif(!empty($args['row']['close'])){ |
|
| 2134 | + if(false){?><script><?php }?> |
|
| 2135 | 2135 | el( |
| 2136 | 2136 | 'div', |
| 2137 | 2137 | { |
| 2138 | 2138 | className: 'col pl-0', |
| 2139 | 2139 | }, |
| 2140 | 2140 | <?php |
| 2141 | - if(false){?></script><?php } |
|
| 2142 | - }else{ |
|
| 2143 | - if(false){?><script><?php }?> |
|
| 2141 | + if(false){?></script><?php } |
|
| 2142 | + }else{ |
|
| 2143 | + if(false){?><script><?php }?> |
|
| 2144 | 2144 | el( |
| 2145 | 2145 | 'div', |
| 2146 | 2146 | { |
| 2147 | 2147 | className: 'col pl-0 pr-2', |
| 2148 | 2148 | }, |
| 2149 | 2149 | <?php |
| 2150 | - if(false){?></script><?php } |
|
| 2151 | - } |
|
| 2152 | - |
|
| 2153 | - } |
|
| 2154 | - |
|
| 2155 | - } |
|
| 2156 | - |
|
| 2157 | - public function block_row_end($key, $args){ |
|
| 2158 | - |
|
| 2159 | - if(!empty($args['row'])){ |
|
| 2160 | - // maybe close |
|
| 2161 | - if(!empty($args['row']['close'])){ |
|
| 2162 | - echo "))"; |
|
| 2163 | - } |
|
| 2164 | - |
|
| 2165 | - echo "),"; |
|
| 2166 | - } |
|
| 2167 | - } |
|
| 2168 | - |
|
| 2169 | - public function build_block_arguments( $key, $args ) { |
|
| 2170 | - $custom_attributes = ! empty( $args['custom_attributes'] ) ? $this->array_to_attributes( $args['custom_attributes'] ) : ''; |
|
| 2171 | - $options = ''; |
|
| 2172 | - $extra = ''; |
|
| 2173 | - $require = ''; |
|
| 2174 | - |
|
| 2175 | - // `content` is a protected and special argument |
|
| 2176 | - if ( $key == 'content' ) { |
|
| 2177 | - return; |
|
| 2178 | - } |
|
| 2179 | - |
|
| 2180 | - |
|
| 2181 | - // icon |
|
| 2182 | - $icon = ''; |
|
| 2183 | - if( !empty( $args['icon'] ) ){ |
|
| 2184 | - $icon .= "el('div', {"; |
|
| 2185 | - $icon .= "dangerouslySetInnerHTML: {__html: '".self::get_widget_icon( esc_attr($args['icon']))."'},"; |
|
| 2186 | - $icon .= "className: 'text-center',"; |
|
| 2187 | - $icon .= "title: '".addslashes( $args['title'] )."',"; |
|
| 2188 | - $icon .= "}),"; |
|
| 2189 | - |
|
| 2190 | - // blank title as its added to the icon. |
|
| 2191 | - $args['title'] = ''; |
|
| 2192 | - } |
|
| 2193 | - |
|
| 2194 | - // require advanced |
|
| 2195 | - $require_advanced = ! empty( $args['advanced'] ) ? "props.attributes.show_advanced && " : ""; |
|
| 2196 | - |
|
| 2197 | - // element require |
|
| 2198 | - $element_require = ! empty( $args['element_require'] ) ? $this->block_props_replace( $args['element_require'], true ) . " && " : ""; |
|
| 2199 | - |
|
| 2200 | - |
|
| 2201 | - $onchange = "props.setAttributes({ $key: $key } )"; |
|
| 2202 | - $onchangecomplete = ""; |
|
| 2203 | - $value = "props.attributes.$key"; |
|
| 2204 | - $text_type = array( 'text', 'password', 'number', 'email', 'tel', 'url', 'colorx' ); |
|
| 2205 | - if ( in_array( $args['type'], $text_type ) ) { |
|
| 2206 | - $type = 'TextControl'; |
|
| 2207 | - // Save numbers as numbers and not strings |
|
| 2208 | - if ( $args['type'] == 'number' ) { |
|
| 2209 | - $onchange = "props.setAttributes({ $key: Number($key) } )"; |
|
| 2210 | - } |
|
| 2211 | - } |
|
| 2212 | - /* |
|
| 2150 | + if(false){?></script><?php } |
|
| 2151 | + } |
|
| 2152 | + |
|
| 2153 | + } |
|
| 2154 | + |
|
| 2155 | + } |
|
| 2156 | + |
|
| 2157 | + public function block_row_end($key, $args){ |
|
| 2158 | + |
|
| 2159 | + if(!empty($args['row'])){ |
|
| 2160 | + // maybe close |
|
| 2161 | + if(!empty($args['row']['close'])){ |
|
| 2162 | + echo "))"; |
|
| 2163 | + } |
|
| 2164 | + |
|
| 2165 | + echo "),"; |
|
| 2166 | + } |
|
| 2167 | + } |
|
| 2168 | + |
|
| 2169 | + public function build_block_arguments( $key, $args ) { |
|
| 2170 | + $custom_attributes = ! empty( $args['custom_attributes'] ) ? $this->array_to_attributes( $args['custom_attributes'] ) : ''; |
|
| 2171 | + $options = ''; |
|
| 2172 | + $extra = ''; |
|
| 2173 | + $require = ''; |
|
| 2174 | + |
|
| 2175 | + // `content` is a protected and special argument |
|
| 2176 | + if ( $key == 'content' ) { |
|
| 2177 | + return; |
|
| 2178 | + } |
|
| 2179 | + |
|
| 2180 | + |
|
| 2181 | + // icon |
|
| 2182 | + $icon = ''; |
|
| 2183 | + if( !empty( $args['icon'] ) ){ |
|
| 2184 | + $icon .= "el('div', {"; |
|
| 2185 | + $icon .= "dangerouslySetInnerHTML: {__html: '".self::get_widget_icon( esc_attr($args['icon']))."'},"; |
|
| 2186 | + $icon .= "className: 'text-center',"; |
|
| 2187 | + $icon .= "title: '".addslashes( $args['title'] )."',"; |
|
| 2188 | + $icon .= "}),"; |
|
| 2189 | + |
|
| 2190 | + // blank title as its added to the icon. |
|
| 2191 | + $args['title'] = ''; |
|
| 2192 | + } |
|
| 2193 | + |
|
| 2194 | + // require advanced |
|
| 2195 | + $require_advanced = ! empty( $args['advanced'] ) ? "props.attributes.show_advanced && " : ""; |
|
| 2196 | + |
|
| 2197 | + // element require |
|
| 2198 | + $element_require = ! empty( $args['element_require'] ) ? $this->block_props_replace( $args['element_require'], true ) . " && " : ""; |
|
| 2199 | + |
|
| 2200 | + |
|
| 2201 | + $onchange = "props.setAttributes({ $key: $key } )"; |
|
| 2202 | + $onchangecomplete = ""; |
|
| 2203 | + $value = "props.attributes.$key"; |
|
| 2204 | + $text_type = array( 'text', 'password', 'number', 'email', 'tel', 'url', 'colorx' ); |
|
| 2205 | + if ( in_array( $args['type'], $text_type ) ) { |
|
| 2206 | + $type = 'TextControl'; |
|
| 2207 | + // Save numbers as numbers and not strings |
|
| 2208 | + if ( $args['type'] == 'number' ) { |
|
| 2209 | + $onchange = "props.setAttributes({ $key: Number($key) } )"; |
|
| 2210 | + } |
|
| 2211 | + } |
|
| 2212 | + /* |
|
| 2213 | 2213 | * https://www.wptricks.com/question/set-current-tab-on-a-gutenberg-tabpanel-component-from-outside-that-component/ es5 layout |
| 2214 | 2214 | elseif($args['type']=='tabs'){ |
| 2215 | 2215 | ?> |
@@ -2243,85 +2243,85 @@ discard block |
||
| 2243 | 2243 | return; |
| 2244 | 2244 | } |
| 2245 | 2245 | */ |
| 2246 | - elseif ( $args['type'] == 'color' ) { |
|
| 2247 | - $type = 'ColorPicker'; |
|
| 2248 | - $onchange = ""; |
|
| 2249 | - $extra = "color: $value,"; |
|
| 2250 | - if(!empty($args['disable_alpha'])){ |
|
| 2251 | - $extra .= "disableAlpha: true,"; |
|
| 2252 | - } |
|
| 2253 | - $onchangecomplete = "onChangeComplete: function($key) { |
|
| 2246 | + elseif ( $args['type'] == 'color' ) { |
|
| 2247 | + $type = 'ColorPicker'; |
|
| 2248 | + $onchange = ""; |
|
| 2249 | + $extra = "color: $value,"; |
|
| 2250 | + if(!empty($args['disable_alpha'])){ |
|
| 2251 | + $extra .= "disableAlpha: true,"; |
|
| 2252 | + } |
|
| 2253 | + $onchangecomplete = "onChangeComplete: function($key) { |
|
| 2254 | 2254 | value = $key.rgb.a && $key.rgb.a < 1 ? \"rgba(\"+$key.rgb.r+\",\"+$key.rgb.g+\",\"+$key.rgb.b+\",\"+$key.rgb.a+\")\" : $key.hex; |
| 2255 | 2255 | props.setAttributes({ |
| 2256 | 2256 | $key: value |
| 2257 | 2257 | }); |
| 2258 | 2258 | },"; |
| 2259 | - } |
|
| 2260 | - elseif ( $args['type'] == 'checkbox' ) { |
|
| 2261 | - $type = 'CheckboxControl'; |
|
| 2262 | - $extra .= "checked: props.attributes.$key,"; |
|
| 2263 | - $onchange = "props.setAttributes({ $key: ! props.attributes.$key } )"; |
|
| 2264 | - } elseif ( $args['type'] == 'textarea' ) { |
|
| 2265 | - $type = 'TextareaControl'; |
|
| 2266 | - } elseif ( $args['type'] == 'select' || $args['type'] == 'multiselect' ) { |
|
| 2267 | - $type = 'SelectControl'; |
|
| 2268 | - |
|
| 2269 | - if($args['name'] == 'category' && !empty($args['post_type_linked'])){ |
|
| 2270 | - $options .= "options: taxonomies_".str_replace("-","_", $this->id).","; |
|
| 2271 | - }elseif($args['name'] == 'sort_by' && !empty($args['post_type_linked'])){ |
|
| 2272 | - $options .= "options: sort_by_".str_replace("-","_", $this->id).","; |
|
| 2273 | - }else { |
|
| 2274 | - |
|
| 2275 | - if ( ! empty( $args['options'] ) ) { |
|
| 2276 | - $options .= "options: ["; |
|
| 2277 | - foreach ( $args['options'] as $option_val => $option_label ) { |
|
| 2278 | - $options .= "{ value: '" . esc_attr( $option_val ) . "', label: '" . addslashes( $option_label ) . "' },"; |
|
| 2279 | - } |
|
| 2280 | - $options .= "],"; |
|
| 2281 | - } |
|
| 2282 | - } |
|
| 2283 | - if ( isset( $args['multiple'] ) && $args['multiple'] ) { //@todo multiselect does not work at the moment: https://github.com/WordPress/gutenberg/issues/5550 |
|
| 2284 | - $extra .= ' multiple: true, '; |
|
| 2285 | - } |
|
| 2286 | - } elseif ( $args['type'] == 'alignment' ) { |
|
| 2287 | - $type = 'AlignmentToolbar'; // @todo this does not seem to work but cant find a example |
|
| 2288 | - }elseif ( $args['type'] == 'margins' ) { |
|
| 2289 | - |
|
| 2290 | - } else { |
|
| 2291 | - return;// if we have not implemented the control then don't break the JS. |
|
| 2292 | - } |
|
| 2293 | - |
|
| 2294 | - |
|
| 2295 | - |
|
| 2296 | - // color input does not show the labels so we add them |
|
| 2297 | - if($args['type']=='color'){ |
|
| 2298 | - // add show only if advanced |
|
| 2299 | - echo $require_advanced; |
|
| 2300 | - // add setting require if defined |
|
| 2301 | - echo $element_require; |
|
| 2302 | - echo "el('div', {style: {'marginBottom': '8px'}}, '".addslashes( $args['title'] )."'),"; |
|
| 2303 | - } |
|
| 2304 | - |
|
| 2305 | - // add show only if advanced |
|
| 2306 | - echo $require_advanced; |
|
| 2307 | - // add setting require if defined |
|
| 2308 | - echo $element_require; |
|
| 2309 | - |
|
| 2310 | - // icon |
|
| 2311 | - echo $icon; |
|
| 2312 | - ?> |
|
| 2259 | + } |
|
| 2260 | + elseif ( $args['type'] == 'checkbox' ) { |
|
| 2261 | + $type = 'CheckboxControl'; |
|
| 2262 | + $extra .= "checked: props.attributes.$key,"; |
|
| 2263 | + $onchange = "props.setAttributes({ $key: ! props.attributes.$key } )"; |
|
| 2264 | + } elseif ( $args['type'] == 'textarea' ) { |
|
| 2265 | + $type = 'TextareaControl'; |
|
| 2266 | + } elseif ( $args['type'] == 'select' || $args['type'] == 'multiselect' ) { |
|
| 2267 | + $type = 'SelectControl'; |
|
| 2268 | + |
|
| 2269 | + if($args['name'] == 'category' && !empty($args['post_type_linked'])){ |
|
| 2270 | + $options .= "options: taxonomies_".str_replace("-","_", $this->id).","; |
|
| 2271 | + }elseif($args['name'] == 'sort_by' && !empty($args['post_type_linked'])){ |
|
| 2272 | + $options .= "options: sort_by_".str_replace("-","_", $this->id).","; |
|
| 2273 | + }else { |
|
| 2274 | + |
|
| 2275 | + if ( ! empty( $args['options'] ) ) { |
|
| 2276 | + $options .= "options: ["; |
|
| 2277 | + foreach ( $args['options'] as $option_val => $option_label ) { |
|
| 2278 | + $options .= "{ value: '" . esc_attr( $option_val ) . "', label: '" . addslashes( $option_label ) . "' },"; |
|
| 2279 | + } |
|
| 2280 | + $options .= "],"; |
|
| 2281 | + } |
|
| 2282 | + } |
|
| 2283 | + if ( isset( $args['multiple'] ) && $args['multiple'] ) { //@todo multiselect does not work at the moment: https://github.com/WordPress/gutenberg/issues/5550 |
|
| 2284 | + $extra .= ' multiple: true, '; |
|
| 2285 | + } |
|
| 2286 | + } elseif ( $args['type'] == 'alignment' ) { |
|
| 2287 | + $type = 'AlignmentToolbar'; // @todo this does not seem to work but cant find a example |
|
| 2288 | + }elseif ( $args['type'] == 'margins' ) { |
|
| 2289 | + |
|
| 2290 | + } else { |
|
| 2291 | + return;// if we have not implemented the control then don't break the JS. |
|
| 2292 | + } |
|
| 2293 | + |
|
| 2294 | + |
|
| 2295 | + |
|
| 2296 | + // color input does not show the labels so we add them |
|
| 2297 | + if($args['type']=='color'){ |
|
| 2298 | + // add show only if advanced |
|
| 2299 | + echo $require_advanced; |
|
| 2300 | + // add setting require if defined |
|
| 2301 | + echo $element_require; |
|
| 2302 | + echo "el('div', {style: {'marginBottom': '8px'}}, '".addslashes( $args['title'] )."'),"; |
|
| 2303 | + } |
|
| 2304 | + |
|
| 2305 | + // add show only if advanced |
|
| 2306 | + echo $require_advanced; |
|
| 2307 | + // add setting require if defined |
|
| 2308 | + echo $element_require; |
|
| 2309 | + |
|
| 2310 | + // icon |
|
| 2311 | + echo $icon; |
|
| 2312 | + ?> |
|
| 2313 | 2313 | el( wp.components.<?php echo $type; ?>, { |
| 2314 | 2314 | label: '<?php echo addslashes( $args['title'] ); ?>', |
| 2315 | 2315 | help: '<?php if ( isset( $args['desc'] ) ) { |
| 2316 | - echo addslashes( $args['desc'] ); |
|
| 2317 | - } ?>', |
|
| 2316 | + echo addslashes( $args['desc'] ); |
|
| 2317 | + } ?>', |
|
| 2318 | 2318 | value: <?php echo $value; ?>, |
| 2319 | 2319 | <?php if ( $type == 'TextControl' && $args['type'] != 'text' ) { |
| 2320 | - echo "type: '" . addslashes( $args['type'] ) . "',"; |
|
| 2321 | - } ?> |
|
| 2320 | + echo "type: '" . addslashes( $args['type'] ) . "',"; |
|
| 2321 | + } ?> |
|
| 2322 | 2322 | <?php if ( ! empty( $args['placeholder'] ) ) { |
| 2323 | - echo "placeholder: '" . addslashes( $args['placeholder'] ) . "',"; |
|
| 2324 | - } ?> |
|
| 2323 | + echo "placeholder: '" . addslashes( $args['placeholder'] ) . "',"; |
|
| 2324 | + } ?> |
|
| 2325 | 2325 | <?php echo $options; ?> |
| 2326 | 2326 | <?php echo $extra; ?> |
| 2327 | 2327 | <?php echo $custom_attributes; ?> |
@@ -2333,601 +2333,601 @@ discard block |
||
| 2333 | 2333 | <?php |
| 2334 | 2334 | |
| 2335 | 2335 | |
| 2336 | - } |
|
| 2337 | - |
|
| 2338 | - /** |
|
| 2339 | - * Convert an array of attributes to block string. |
|
| 2340 | - * |
|
| 2341 | - * @todo there is prob a faster way to do this, also we could add some validation here. |
|
| 2342 | - * |
|
| 2343 | - * @param $custom_attributes |
|
| 2344 | - * |
|
| 2345 | - * @return string |
|
| 2346 | - */ |
|
| 2347 | - public function array_to_attributes( $custom_attributes, $html = false ) { |
|
| 2348 | - $attributes = ''; |
|
| 2349 | - if ( ! empty( $custom_attributes ) ) { |
|
| 2350 | - |
|
| 2351 | - if ( $html ) { |
|
| 2352 | - foreach ( $custom_attributes as $key => $val ) { |
|
| 2353 | - $attributes .= " $key='$val' "; |
|
| 2354 | - } |
|
| 2355 | - } else { |
|
| 2356 | - foreach ( $custom_attributes as $key => $val ) { |
|
| 2357 | - $attributes .= "'$key': '$val',"; |
|
| 2358 | - } |
|
| 2359 | - } |
|
| 2360 | - } |
|
| 2361 | - |
|
| 2362 | - return $attributes; |
|
| 2363 | - } |
|
| 2364 | - |
|
| 2365 | - /** |
|
| 2366 | - * A self looping function to create the output for JS block elements. |
|
| 2367 | - * |
|
| 2368 | - * This is what is output in the WP Editor visual view. |
|
| 2369 | - * |
|
| 2370 | - * @param $args |
|
| 2371 | - */ |
|
| 2372 | - public function block_element( $args ) { |
|
| 2373 | - |
|
| 2374 | - |
|
| 2375 | - if ( ! empty( $args ) ) { |
|
| 2376 | - foreach ( $args as $element => $new_args ) { |
|
| 2377 | - |
|
| 2378 | - if ( is_array( $new_args ) ) { // its an element |
|
| 2379 | - |
|
| 2380 | - |
|
| 2381 | - if ( isset( $new_args['element'] ) ) { |
|
| 2382 | - |
|
| 2383 | - if ( isset( $new_args['element_require'] ) ) { |
|
| 2384 | - echo str_replace( array( |
|
| 2385 | - "'+", |
|
| 2386 | - "+'" |
|
| 2387 | - ), '', $this->block_props_replace( $new_args['element_require'] ) ) . " && "; |
|
| 2388 | - unset( $new_args['element_require'] ); |
|
| 2389 | - } |
|
| 2390 | - |
|
| 2391 | - echo "\n el( '" . $new_args['element'] . "', {"; |
|
| 2392 | - |
|
| 2393 | - // get the attributes |
|
| 2394 | - foreach ( $new_args as $new_key => $new_value ) { |
|
| 2395 | - |
|
| 2396 | - |
|
| 2397 | - if ( $new_key == 'element' || $new_key == 'content' || $new_key == 'element_require' || $new_key == 'element_repeat' || is_array( $new_value ) ) { |
|
| 2398 | - // do nothing |
|
| 2399 | - } else { |
|
| 2400 | - echo $this->block_element( array( $new_key => $new_value ) ); |
|
| 2401 | - } |
|
| 2402 | - } |
|
| 2403 | - |
|
| 2404 | - echo "},";// end attributes |
|
| 2405 | - |
|
| 2406 | - // get the content |
|
| 2407 | - $first_item = 0; |
|
| 2408 | - foreach ( $new_args as $new_key => $new_value ) { |
|
| 2409 | - if ( $new_key === 'content' || is_array( $new_value ) ) { |
|
| 2410 | - |
|
| 2411 | - if ( $new_key === 'content' ) { |
|
| 2412 | - echo "'" . $this->block_props_replace( wp_slash( $new_value ) ) . "'"; |
|
| 2413 | - } |
|
| 2414 | - |
|
| 2415 | - if ( is_array( $new_value ) ) { |
|
| 2416 | - |
|
| 2417 | - if ( isset( $new_value['element_require'] ) ) { |
|
| 2418 | - echo str_replace( array( |
|
| 2419 | - "'+", |
|
| 2420 | - "+'" |
|
| 2421 | - ), '', $this->block_props_replace( $new_value['element_require'] ) ) . " && "; |
|
| 2422 | - unset( $new_value['element_require'] ); |
|
| 2423 | - } |
|
| 2424 | - |
|
| 2425 | - if ( isset( $new_value['element_repeat'] ) ) { |
|
| 2426 | - $x = 1; |
|
| 2427 | - while ( $x <= absint( $new_value['element_repeat'] ) ) { |
|
| 2428 | - $this->block_element( array( '' => $new_value ) ); |
|
| 2429 | - $x ++; |
|
| 2430 | - } |
|
| 2431 | - } else { |
|
| 2432 | - $this->block_element( array( '' => $new_value ) ); |
|
| 2433 | - } |
|
| 2434 | - } |
|
| 2435 | - $first_item ++; |
|
| 2436 | - } |
|
| 2437 | - } |
|
| 2438 | - |
|
| 2439 | - echo ")";// end content |
|
| 2440 | - |
|
| 2441 | - echo ", \n"; |
|
| 2442 | - |
|
| 2443 | - } |
|
| 2444 | - } else { |
|
| 2445 | - |
|
| 2446 | - if ( substr( $element, 0, 3 ) === "if_" ) { |
|
| 2447 | - echo str_replace( "if_", "", $element ) . ": " . $this->block_props_replace( $new_args, true ) . ","; |
|
| 2448 | - } elseif ( $element == 'style' ) { |
|
| 2449 | - echo $element . ": " . $this->block_props_replace( $new_args ) . ","; |
|
| 2450 | - } else { |
|
| 2451 | - echo $element . ": '" . $this->block_props_replace( $new_args ) . "',"; |
|
| 2452 | - } |
|
| 2453 | - |
|
| 2454 | - } |
|
| 2455 | - } |
|
| 2456 | - } |
|
| 2457 | - } |
|
| 2458 | - |
|
| 2459 | - /** |
|
| 2460 | - * Replace block attributes placeholders with the proper naming. |
|
| 2461 | - * |
|
| 2462 | - * @param $string |
|
| 2463 | - * |
|
| 2464 | - * @return mixed |
|
| 2465 | - */ |
|
| 2466 | - public function block_props_replace( $string, $no_wrap = false ) { |
|
| 2467 | - |
|
| 2468 | - if ( $no_wrap ) { |
|
| 2469 | - $string = str_replace( array( "[%", "%]" ), array( "props.attributes.", "" ), $string ); |
|
| 2470 | - } else { |
|
| 2471 | - $string = str_replace( array( "[%", "%]" ), array( "'+props.attributes.", "+'" ), $string ); |
|
| 2472 | - } |
|
| 2473 | - |
|
| 2474 | - return $string; |
|
| 2475 | - } |
|
| 2476 | - |
|
| 2477 | - /** |
|
| 2478 | - * Outputs the content of the widget |
|
| 2479 | - * |
|
| 2480 | - * @param array $args |
|
| 2481 | - * @param array $instance |
|
| 2482 | - */ |
|
| 2483 | - public function widget( $args, $instance ) { |
|
| 2484 | - |
|
| 2485 | - // get the filtered values |
|
| 2486 | - $argument_values = $this->argument_values( $instance ); |
|
| 2487 | - $argument_values = $this->string_to_bool( $argument_values ); |
|
| 2488 | - $output = $this->output( $argument_values, $args ); |
|
| 2489 | - |
|
| 2490 | - $no_wrap = false; |
|
| 2491 | - if ( isset( $argument_values['no_wrap'] ) && $argument_values['no_wrap'] ) { |
|
| 2492 | - $no_wrap = true; |
|
| 2493 | - } |
|
| 2494 | - |
|
| 2495 | - ob_start(); |
|
| 2496 | - if ( $output && ! $no_wrap ) { |
|
| 2497 | - |
|
| 2498 | - $class_original = $this->options['widget_ops']['classname']; |
|
| 2499 | - $class = $this->options['widget_ops']['classname']." sdel-".$this->get_instance_hash(); |
|
| 2500 | - |
|
| 2501 | - // Before widget |
|
| 2502 | - $before_widget = $args['before_widget']; |
|
| 2503 | - $before_widget = str_replace($class_original,$class,$before_widget); |
|
| 2504 | - $before_widget = apply_filters( 'wp_super_duper_before_widget', $before_widget, $args, $instance, $this ); |
|
| 2505 | - $before_widget = apply_filters( 'wp_super_duper_before_widget_' . $this->base_id, $before_widget, $args, $instance, $this ); |
|
| 2506 | - |
|
| 2507 | - // After widget |
|
| 2508 | - $after_widget = $args['after_widget']; |
|
| 2509 | - $after_widget = apply_filters( 'wp_super_duper_after_widget', $after_widget, $args, $instance, $this ); |
|
| 2510 | - $after_widget = apply_filters( 'wp_super_duper_after_widget_' . $this->base_id, $after_widget, $args, $instance, $this ); |
|
| 2511 | - |
|
| 2512 | - echo $before_widget; |
|
| 2513 | - // elementor strips the widget wrapping div so we check for and add it back if needed |
|
| 2514 | - if ( $this->is_elementor_widget_output() ) { |
|
| 2515 | - echo ! empty( $this->options['widget_ops']['classname'] ) ? "<span class='" . esc_attr( $class ) . "'>" : ''; |
|
| 2516 | - } |
|
| 2517 | - echo $this->output_title( $args, $instance ); |
|
| 2518 | - echo $output; |
|
| 2519 | - if ( $this->is_elementor_widget_output() ) { |
|
| 2520 | - echo ! empty( $this->options['widget_ops']['classname'] ) ? "</span>" : ''; |
|
| 2521 | - } |
|
| 2522 | - echo $after_widget; |
|
| 2523 | - } elseif ( $this->is_preview() && $output == '' ) {// if preview show a placeholder if empty |
|
| 2524 | - $output = $this->preview_placeholder_text( "{{" . $this->base_id . "}}" ); |
|
| 2525 | - echo $output; |
|
| 2526 | - } elseif ( $output && $no_wrap ) { |
|
| 2527 | - echo $output; |
|
| 2528 | - } |
|
| 2529 | - $output = ob_get_clean(); |
|
| 2530 | - |
|
| 2531 | - $output = apply_filters( 'wp_super_duper_widget_output', $output, $instance, $args, $this ); |
|
| 2532 | - |
|
| 2533 | - echo $output; |
|
| 2534 | - } |
|
| 2535 | - |
|
| 2536 | - /** |
|
| 2537 | - * Tests if the current output is inside a elementor container. |
|
| 2538 | - * |
|
| 2539 | - * @since 1.0.4 |
|
| 2540 | - * @return bool |
|
| 2541 | - */ |
|
| 2542 | - public function is_elementor_widget_output() { |
|
| 2543 | - $result = false; |
|
| 2544 | - if ( defined( 'ELEMENTOR_VERSION' ) && isset( $this->number ) && $this->number == 'REPLACE_TO_ID' ) { |
|
| 2545 | - $result = true; |
|
| 2546 | - } |
|
| 2547 | - |
|
| 2548 | - return $result; |
|
| 2549 | - } |
|
| 2550 | - |
|
| 2551 | - /** |
|
| 2552 | - * Tests if the current output is inside a elementor preview. |
|
| 2553 | - * |
|
| 2554 | - * @since 1.0.4 |
|
| 2555 | - * @return bool |
|
| 2556 | - */ |
|
| 2557 | - public function is_elementor_preview() { |
|
| 2558 | - $result = false; |
|
| 2559 | - if ( isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' ) ) { |
|
| 2560 | - $result = true; |
|
| 2561 | - } |
|
| 2562 | - |
|
| 2563 | - return $result; |
|
| 2564 | - } |
|
| 2565 | - |
|
| 2566 | - /** |
|
| 2567 | - * Tests if the current output is inside a Divi preview. |
|
| 2568 | - * |
|
| 2569 | - * @since 1.0.6 |
|
| 2570 | - * @return bool |
|
| 2571 | - */ |
|
| 2572 | - public function is_divi_preview() { |
|
| 2573 | - $result = false; |
|
| 2574 | - if ( isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) ) { |
|
| 2575 | - $result = true; |
|
| 2576 | - } |
|
| 2577 | - |
|
| 2578 | - return $result; |
|
| 2579 | - } |
|
| 2580 | - |
|
| 2581 | - /** |
|
| 2582 | - * Tests if the current output is inside a Beaver builder preview. |
|
| 2583 | - * |
|
| 2584 | - * @since 1.0.6 |
|
| 2585 | - * @return bool |
|
| 2586 | - */ |
|
| 2587 | - public function is_beaver_preview() { |
|
| 2588 | - $result = false; |
|
| 2589 | - if ( isset( $_REQUEST['fl_builder'] ) ) { |
|
| 2590 | - $result = true; |
|
| 2591 | - } |
|
| 2592 | - |
|
| 2593 | - return $result; |
|
| 2594 | - } |
|
| 2595 | - |
|
| 2596 | - /** |
|
| 2597 | - * Tests if the current output is inside a siteorigin builder preview. |
|
| 2598 | - * |
|
| 2599 | - * @since 1.0.6 |
|
| 2600 | - * @return bool |
|
| 2601 | - */ |
|
| 2602 | - public function is_siteorigin_preview() { |
|
| 2603 | - $result = false; |
|
| 2604 | - if ( ! empty( $_REQUEST['siteorigin_panels_live_editor'] ) ) { |
|
| 2605 | - $result = true; |
|
| 2606 | - } |
|
| 2607 | - |
|
| 2608 | - return $result; |
|
| 2609 | - } |
|
| 2610 | - |
|
| 2611 | - /** |
|
| 2612 | - * Tests if the current output is inside a cornerstone builder preview. |
|
| 2613 | - * |
|
| 2614 | - * @since 1.0.8 |
|
| 2615 | - * @return bool |
|
| 2616 | - */ |
|
| 2617 | - public function is_cornerstone_preview() { |
|
| 2618 | - $result = false; |
|
| 2619 | - if ( ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint' ) { |
|
| 2620 | - $result = true; |
|
| 2621 | - } |
|
| 2622 | - |
|
| 2623 | - return $result; |
|
| 2624 | - } |
|
| 2625 | - |
|
| 2626 | - /** |
|
| 2627 | - * Tests if the current output is inside a fusion builder preview. |
|
| 2628 | - * |
|
| 2629 | - * @since 1.1.0 |
|
| 2630 | - * @return bool |
|
| 2631 | - */ |
|
| 2632 | - public function is_fusion_preview() { |
|
| 2633 | - $result = false; |
|
| 2634 | - if ( ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] ) ) { |
|
| 2635 | - $result = true; |
|
| 2636 | - } |
|
| 2637 | - |
|
| 2638 | - return $result; |
|
| 2639 | - } |
|
| 2640 | - |
|
| 2641 | - /** |
|
| 2642 | - * Tests if the current output is inside a Oxygen builder preview. |
|
| 2643 | - * |
|
| 2644 | - * @since 1.0.18 |
|
| 2645 | - * @return bool |
|
| 2646 | - */ |
|
| 2647 | - public function is_oxygen_preview() { |
|
| 2648 | - $result = false; |
|
| 2649 | - if ( ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === "oxy_render_" || substr( $_REQUEST['action'], 0, 10 ) === "ct_render_" ) ) ) { |
|
| 2650 | - $result = true; |
|
| 2651 | - } |
|
| 2652 | - |
|
| 2653 | - return $result; |
|
| 2654 | - } |
|
| 2655 | - |
|
| 2656 | - /** |
|
| 2657 | - * General function to check if we are in a preview situation. |
|
| 2658 | - * |
|
| 2659 | - * @since 1.0.6 |
|
| 2660 | - * @return bool |
|
| 2661 | - */ |
|
| 2662 | - public function is_preview() { |
|
| 2663 | - $preview = false; |
|
| 2664 | - if ( $this->is_divi_preview() ) { |
|
| 2665 | - $preview = true; |
|
| 2666 | - } elseif ( $this->is_elementor_preview() ) { |
|
| 2667 | - $preview = true; |
|
| 2668 | - } elseif ( $this->is_beaver_preview() ) { |
|
| 2669 | - $preview = true; |
|
| 2670 | - } elseif ( $this->is_siteorigin_preview() ) { |
|
| 2671 | - $preview = true; |
|
| 2672 | - } elseif ( $this->is_cornerstone_preview() ) { |
|
| 2673 | - $preview = true; |
|
| 2674 | - } elseif ( $this->is_fusion_preview() ) { |
|
| 2675 | - $preview = true; |
|
| 2676 | - } elseif ( $this->is_oxygen_preview() ) { |
|
| 2677 | - $preview = true; |
|
| 2678 | - } elseif( $this->is_block_content_call() ) { |
|
| 2679 | - $preview = true; |
|
| 2680 | - } |
|
| 2681 | - |
|
| 2682 | - return $preview; |
|
| 2683 | - } |
|
| 2684 | - |
|
| 2685 | - /** |
|
| 2686 | - * Output the super title. |
|
| 2687 | - * |
|
| 2688 | - * @param $args |
|
| 2689 | - * @param array $instance |
|
| 2690 | - * |
|
| 2691 | - * @return string |
|
| 2692 | - */ |
|
| 2693 | - public function output_title( $args, $instance = array() ) { |
|
| 2694 | - $output = ''; |
|
| 2695 | - if ( ! empty( $instance['title'] ) ) { |
|
| 2696 | - /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ |
|
| 2697 | - $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ); |
|
| 2698 | - |
|
| 2699 | - if(empty($instance['widget_title_tag'])){ |
|
| 2700 | - $output = $args['before_title'] . $title . $args['after_title']; |
|
| 2701 | - }else{ |
|
| 2702 | - $title_tag = esc_attr( $instance['widget_title_tag'] ); |
|
| 2703 | - |
|
| 2704 | - // classes |
|
| 2705 | - $title_classes = array(); |
|
| 2706 | - $title_classes[] = !empty( $instance['widget_title_size_class'] ) ? sanitize_html_class( $instance['widget_title_size_class'] ) : ''; |
|
| 2707 | - $title_classes[] = !empty( $instance['widget_title_align_class'] ) ? sanitize_html_class( $instance['widget_title_align_class'] ) : ''; |
|
| 2708 | - $title_classes[] = !empty( $instance['widget_title_color_class'] ) ? "text-".sanitize_html_class( $instance['widget_title_color_class'] ) : ''; |
|
| 2709 | - $title_classes[] = !empty( $instance['widget_title_border_class'] ) ? sanitize_html_class( $instance['widget_title_border_class'] ) : ''; |
|
| 2710 | - $title_classes[] = !empty( $instance['widget_title_border_color_class'] ) ? "border-".sanitize_html_class( $instance['widget_title_border_color_class'] ) : ''; |
|
| 2711 | - $title_classes[] = !empty( $instance['widget_title_mt_class'] ) ? "mt-".absint( $instance['widget_title_mt_class'] ) : ''; |
|
| 2712 | - $title_classes[] = !empty( $instance['widget_title_mr_class'] ) ? "mr-".absint( $instance['widget_title_mr_class'] ) : ''; |
|
| 2713 | - $title_classes[] = !empty( $instance['widget_title_mb_class'] ) ? "mb-".absint( $instance['widget_title_mb_class'] ) : ''; |
|
| 2714 | - $title_classes[] = !empty( $instance['widget_title_ml_class'] ) ? "ml-".absint( $instance['widget_title_ml_class'] ) : ''; |
|
| 2715 | - $title_classes[] = !empty( $instance['widget_title_pt_class'] ) ? "pt-".absint( $instance['widget_title_pt_class'] ) : ''; |
|
| 2716 | - $title_classes[] = !empty( $instance['widget_title_pr_class'] ) ? "pr-".absint( $instance['widget_title_pr_class'] ) : ''; |
|
| 2717 | - $title_classes[] = !empty( $instance['widget_title_pb_class'] ) ? "pb-".absint( $instance['widget_title_pb_class'] ) : ''; |
|
| 2718 | - $title_classes[] = !empty( $instance['widget_title_pl_class'] ) ? "pl-".absint( $instance['widget_title_pl_class'] ) : ''; |
|
| 2719 | - |
|
| 2720 | - $class = !empty( $title_classes ) ? implode(" ",$title_classes) : ''; |
|
| 2721 | - $output = "<$title_tag class='$class' >$title</$title_tag>"; |
|
| 2722 | - } |
|
| 2723 | - |
|
| 2724 | - } |
|
| 2725 | - |
|
| 2726 | - return $output; |
|
| 2727 | - } |
|
| 2728 | - |
|
| 2729 | - /** |
|
| 2730 | - * Outputs the options form inputs for the widget. |
|
| 2731 | - * |
|
| 2732 | - * @param array $instance The widget options. |
|
| 2733 | - */ |
|
| 2734 | - public function form( $instance ) { |
|
| 2735 | - |
|
| 2736 | - // set widget instance |
|
| 2737 | - $this->instance = $instance; |
|
| 2738 | - |
|
| 2739 | - // set it as a SD widget |
|
| 2740 | - echo $this->widget_advanced_toggle(); |
|
| 2741 | - |
|
| 2742 | - echo "<p>" . esc_attr( $this->options['widget_ops']['description'] ) . "</p>"; |
|
| 2743 | - $arguments_raw = $this->get_arguments(); |
|
| 2744 | - |
|
| 2745 | - if ( is_array( $arguments_raw ) ) { |
|
| 2746 | - |
|
| 2747 | - $arguments = $this->group_arguments( $arguments_raw ); |
|
| 2748 | - |
|
| 2749 | - // Do we have sections? |
|
| 2750 | - $has_sections = $arguments == $arguments_raw ? false : true; |
|
| 2751 | - |
|
| 2752 | - |
|
| 2753 | - if ( $has_sections ) { |
|
| 2754 | - $panel_count = 0; |
|
| 2755 | - foreach ( $arguments as $key => $args ) { |
|
| 2756 | - |
|
| 2757 | - ?> |
|
| 2336 | + } |
|
| 2337 | + |
|
| 2338 | + /** |
|
| 2339 | + * Convert an array of attributes to block string. |
|
| 2340 | + * |
|
| 2341 | + * @todo there is prob a faster way to do this, also we could add some validation here. |
|
| 2342 | + * |
|
| 2343 | + * @param $custom_attributes |
|
| 2344 | + * |
|
| 2345 | + * @return string |
|
| 2346 | + */ |
|
| 2347 | + public function array_to_attributes( $custom_attributes, $html = false ) { |
|
| 2348 | + $attributes = ''; |
|
| 2349 | + if ( ! empty( $custom_attributes ) ) { |
|
| 2350 | + |
|
| 2351 | + if ( $html ) { |
|
| 2352 | + foreach ( $custom_attributes as $key => $val ) { |
|
| 2353 | + $attributes .= " $key='$val' "; |
|
| 2354 | + } |
|
| 2355 | + } else { |
|
| 2356 | + foreach ( $custom_attributes as $key => $val ) { |
|
| 2357 | + $attributes .= "'$key': '$val',"; |
|
| 2358 | + } |
|
| 2359 | + } |
|
| 2360 | + } |
|
| 2361 | + |
|
| 2362 | + return $attributes; |
|
| 2363 | + } |
|
| 2364 | + |
|
| 2365 | + /** |
|
| 2366 | + * A self looping function to create the output for JS block elements. |
|
| 2367 | + * |
|
| 2368 | + * This is what is output in the WP Editor visual view. |
|
| 2369 | + * |
|
| 2370 | + * @param $args |
|
| 2371 | + */ |
|
| 2372 | + public function block_element( $args ) { |
|
| 2373 | + |
|
| 2374 | + |
|
| 2375 | + if ( ! empty( $args ) ) { |
|
| 2376 | + foreach ( $args as $element => $new_args ) { |
|
| 2377 | + |
|
| 2378 | + if ( is_array( $new_args ) ) { // its an element |
|
| 2379 | + |
|
| 2380 | + |
|
| 2381 | + if ( isset( $new_args['element'] ) ) { |
|
| 2382 | + |
|
| 2383 | + if ( isset( $new_args['element_require'] ) ) { |
|
| 2384 | + echo str_replace( array( |
|
| 2385 | + "'+", |
|
| 2386 | + "+'" |
|
| 2387 | + ), '', $this->block_props_replace( $new_args['element_require'] ) ) . " && "; |
|
| 2388 | + unset( $new_args['element_require'] ); |
|
| 2389 | + } |
|
| 2390 | + |
|
| 2391 | + echo "\n el( '" . $new_args['element'] . "', {"; |
|
| 2392 | + |
|
| 2393 | + // get the attributes |
|
| 2394 | + foreach ( $new_args as $new_key => $new_value ) { |
|
| 2395 | + |
|
| 2396 | + |
|
| 2397 | + if ( $new_key == 'element' || $new_key == 'content' || $new_key == 'element_require' || $new_key == 'element_repeat' || is_array( $new_value ) ) { |
|
| 2398 | + // do nothing |
|
| 2399 | + } else { |
|
| 2400 | + echo $this->block_element( array( $new_key => $new_value ) ); |
|
| 2401 | + } |
|
| 2402 | + } |
|
| 2403 | + |
|
| 2404 | + echo "},";// end attributes |
|
| 2405 | + |
|
| 2406 | + // get the content |
|
| 2407 | + $first_item = 0; |
|
| 2408 | + foreach ( $new_args as $new_key => $new_value ) { |
|
| 2409 | + if ( $new_key === 'content' || is_array( $new_value ) ) { |
|
| 2410 | + |
|
| 2411 | + if ( $new_key === 'content' ) { |
|
| 2412 | + echo "'" . $this->block_props_replace( wp_slash( $new_value ) ) . "'"; |
|
| 2413 | + } |
|
| 2414 | + |
|
| 2415 | + if ( is_array( $new_value ) ) { |
|
| 2416 | + |
|
| 2417 | + if ( isset( $new_value['element_require'] ) ) { |
|
| 2418 | + echo str_replace( array( |
|
| 2419 | + "'+", |
|
| 2420 | + "+'" |
|
| 2421 | + ), '', $this->block_props_replace( $new_value['element_require'] ) ) . " && "; |
|
| 2422 | + unset( $new_value['element_require'] ); |
|
| 2423 | + } |
|
| 2424 | + |
|
| 2425 | + if ( isset( $new_value['element_repeat'] ) ) { |
|
| 2426 | + $x = 1; |
|
| 2427 | + while ( $x <= absint( $new_value['element_repeat'] ) ) { |
|
| 2428 | + $this->block_element( array( '' => $new_value ) ); |
|
| 2429 | + $x ++; |
|
| 2430 | + } |
|
| 2431 | + } else { |
|
| 2432 | + $this->block_element( array( '' => $new_value ) ); |
|
| 2433 | + } |
|
| 2434 | + } |
|
| 2435 | + $first_item ++; |
|
| 2436 | + } |
|
| 2437 | + } |
|
| 2438 | + |
|
| 2439 | + echo ")";// end content |
|
| 2440 | + |
|
| 2441 | + echo ", \n"; |
|
| 2442 | + |
|
| 2443 | + } |
|
| 2444 | + } else { |
|
| 2445 | + |
|
| 2446 | + if ( substr( $element, 0, 3 ) === "if_" ) { |
|
| 2447 | + echo str_replace( "if_", "", $element ) . ": " . $this->block_props_replace( $new_args, true ) . ","; |
|
| 2448 | + } elseif ( $element == 'style' ) { |
|
| 2449 | + echo $element . ": " . $this->block_props_replace( $new_args ) . ","; |
|
| 2450 | + } else { |
|
| 2451 | + echo $element . ": '" . $this->block_props_replace( $new_args ) . "',"; |
|
| 2452 | + } |
|
| 2453 | + |
|
| 2454 | + } |
|
| 2455 | + } |
|
| 2456 | + } |
|
| 2457 | + } |
|
| 2458 | + |
|
| 2459 | + /** |
|
| 2460 | + * Replace block attributes placeholders with the proper naming. |
|
| 2461 | + * |
|
| 2462 | + * @param $string |
|
| 2463 | + * |
|
| 2464 | + * @return mixed |
|
| 2465 | + */ |
|
| 2466 | + public function block_props_replace( $string, $no_wrap = false ) { |
|
| 2467 | + |
|
| 2468 | + if ( $no_wrap ) { |
|
| 2469 | + $string = str_replace( array( "[%", "%]" ), array( "props.attributes.", "" ), $string ); |
|
| 2470 | + } else { |
|
| 2471 | + $string = str_replace( array( "[%", "%]" ), array( "'+props.attributes.", "+'" ), $string ); |
|
| 2472 | + } |
|
| 2473 | + |
|
| 2474 | + return $string; |
|
| 2475 | + } |
|
| 2476 | + |
|
| 2477 | + /** |
|
| 2478 | + * Outputs the content of the widget |
|
| 2479 | + * |
|
| 2480 | + * @param array $args |
|
| 2481 | + * @param array $instance |
|
| 2482 | + */ |
|
| 2483 | + public function widget( $args, $instance ) { |
|
| 2484 | + |
|
| 2485 | + // get the filtered values |
|
| 2486 | + $argument_values = $this->argument_values( $instance ); |
|
| 2487 | + $argument_values = $this->string_to_bool( $argument_values ); |
|
| 2488 | + $output = $this->output( $argument_values, $args ); |
|
| 2489 | + |
|
| 2490 | + $no_wrap = false; |
|
| 2491 | + if ( isset( $argument_values['no_wrap'] ) && $argument_values['no_wrap'] ) { |
|
| 2492 | + $no_wrap = true; |
|
| 2493 | + } |
|
| 2494 | + |
|
| 2495 | + ob_start(); |
|
| 2496 | + if ( $output && ! $no_wrap ) { |
|
| 2497 | + |
|
| 2498 | + $class_original = $this->options['widget_ops']['classname']; |
|
| 2499 | + $class = $this->options['widget_ops']['classname']." sdel-".$this->get_instance_hash(); |
|
| 2500 | + |
|
| 2501 | + // Before widget |
|
| 2502 | + $before_widget = $args['before_widget']; |
|
| 2503 | + $before_widget = str_replace($class_original,$class,$before_widget); |
|
| 2504 | + $before_widget = apply_filters( 'wp_super_duper_before_widget', $before_widget, $args, $instance, $this ); |
|
| 2505 | + $before_widget = apply_filters( 'wp_super_duper_before_widget_' . $this->base_id, $before_widget, $args, $instance, $this ); |
|
| 2506 | + |
|
| 2507 | + // After widget |
|
| 2508 | + $after_widget = $args['after_widget']; |
|
| 2509 | + $after_widget = apply_filters( 'wp_super_duper_after_widget', $after_widget, $args, $instance, $this ); |
|
| 2510 | + $after_widget = apply_filters( 'wp_super_duper_after_widget_' . $this->base_id, $after_widget, $args, $instance, $this ); |
|
| 2511 | + |
|
| 2512 | + echo $before_widget; |
|
| 2513 | + // elementor strips the widget wrapping div so we check for and add it back if needed |
|
| 2514 | + if ( $this->is_elementor_widget_output() ) { |
|
| 2515 | + echo ! empty( $this->options['widget_ops']['classname'] ) ? "<span class='" . esc_attr( $class ) . "'>" : ''; |
|
| 2516 | + } |
|
| 2517 | + echo $this->output_title( $args, $instance ); |
|
| 2518 | + echo $output; |
|
| 2519 | + if ( $this->is_elementor_widget_output() ) { |
|
| 2520 | + echo ! empty( $this->options['widget_ops']['classname'] ) ? "</span>" : ''; |
|
| 2521 | + } |
|
| 2522 | + echo $after_widget; |
|
| 2523 | + } elseif ( $this->is_preview() && $output == '' ) {// if preview show a placeholder if empty |
|
| 2524 | + $output = $this->preview_placeholder_text( "{{" . $this->base_id . "}}" ); |
|
| 2525 | + echo $output; |
|
| 2526 | + } elseif ( $output && $no_wrap ) { |
|
| 2527 | + echo $output; |
|
| 2528 | + } |
|
| 2529 | + $output = ob_get_clean(); |
|
| 2530 | + |
|
| 2531 | + $output = apply_filters( 'wp_super_duper_widget_output', $output, $instance, $args, $this ); |
|
| 2532 | + |
|
| 2533 | + echo $output; |
|
| 2534 | + } |
|
| 2535 | + |
|
| 2536 | + /** |
|
| 2537 | + * Tests if the current output is inside a elementor container. |
|
| 2538 | + * |
|
| 2539 | + * @since 1.0.4 |
|
| 2540 | + * @return bool |
|
| 2541 | + */ |
|
| 2542 | + public function is_elementor_widget_output() { |
|
| 2543 | + $result = false; |
|
| 2544 | + if ( defined( 'ELEMENTOR_VERSION' ) && isset( $this->number ) && $this->number == 'REPLACE_TO_ID' ) { |
|
| 2545 | + $result = true; |
|
| 2546 | + } |
|
| 2547 | + |
|
| 2548 | + return $result; |
|
| 2549 | + } |
|
| 2550 | + |
|
| 2551 | + /** |
|
| 2552 | + * Tests if the current output is inside a elementor preview. |
|
| 2553 | + * |
|
| 2554 | + * @since 1.0.4 |
|
| 2555 | + * @return bool |
|
| 2556 | + */ |
|
| 2557 | + public function is_elementor_preview() { |
|
| 2558 | + $result = false; |
|
| 2559 | + if ( isset( $_REQUEST['elementor-preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) || ( isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor_ajax' ) ) { |
|
| 2560 | + $result = true; |
|
| 2561 | + } |
|
| 2562 | + |
|
| 2563 | + return $result; |
|
| 2564 | + } |
|
| 2565 | + |
|
| 2566 | + /** |
|
| 2567 | + * Tests if the current output is inside a Divi preview. |
|
| 2568 | + * |
|
| 2569 | + * @since 1.0.6 |
|
| 2570 | + * @return bool |
|
| 2571 | + */ |
|
| 2572 | + public function is_divi_preview() { |
|
| 2573 | + $result = false; |
|
| 2574 | + if ( isset( $_REQUEST['et_fb'] ) || isset( $_REQUEST['et_pb_preview'] ) || ( is_admin() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'elementor' ) ) { |
|
| 2575 | + $result = true; |
|
| 2576 | + } |
|
| 2577 | + |
|
| 2578 | + return $result; |
|
| 2579 | + } |
|
| 2580 | + |
|
| 2581 | + /** |
|
| 2582 | + * Tests if the current output is inside a Beaver builder preview. |
|
| 2583 | + * |
|
| 2584 | + * @since 1.0.6 |
|
| 2585 | + * @return bool |
|
| 2586 | + */ |
|
| 2587 | + public function is_beaver_preview() { |
|
| 2588 | + $result = false; |
|
| 2589 | + if ( isset( $_REQUEST['fl_builder'] ) ) { |
|
| 2590 | + $result = true; |
|
| 2591 | + } |
|
| 2592 | + |
|
| 2593 | + return $result; |
|
| 2594 | + } |
|
| 2595 | + |
|
| 2596 | + /** |
|
| 2597 | + * Tests if the current output is inside a siteorigin builder preview. |
|
| 2598 | + * |
|
| 2599 | + * @since 1.0.6 |
|
| 2600 | + * @return bool |
|
| 2601 | + */ |
|
| 2602 | + public function is_siteorigin_preview() { |
|
| 2603 | + $result = false; |
|
| 2604 | + if ( ! empty( $_REQUEST['siteorigin_panels_live_editor'] ) ) { |
|
| 2605 | + $result = true; |
|
| 2606 | + } |
|
| 2607 | + |
|
| 2608 | + return $result; |
|
| 2609 | + } |
|
| 2610 | + |
|
| 2611 | + /** |
|
| 2612 | + * Tests if the current output is inside a cornerstone builder preview. |
|
| 2613 | + * |
|
| 2614 | + * @since 1.0.8 |
|
| 2615 | + * @return bool |
|
| 2616 | + */ |
|
| 2617 | + public function is_cornerstone_preview() { |
|
| 2618 | + $result = false; |
|
| 2619 | + if ( ! empty( $_REQUEST['cornerstone_preview'] ) || basename( $_SERVER['REQUEST_URI'] ) == 'cornerstone-endpoint' ) { |
|
| 2620 | + $result = true; |
|
| 2621 | + } |
|
| 2622 | + |
|
| 2623 | + return $result; |
|
| 2624 | + } |
|
| 2625 | + |
|
| 2626 | + /** |
|
| 2627 | + * Tests if the current output is inside a fusion builder preview. |
|
| 2628 | + * |
|
| 2629 | + * @since 1.1.0 |
|
| 2630 | + * @return bool |
|
| 2631 | + */ |
|
| 2632 | + public function is_fusion_preview() { |
|
| 2633 | + $result = false; |
|
| 2634 | + if ( ! empty( $_REQUEST['fb-edit'] ) || ! empty( $_REQUEST['fusion_load_nonce'] ) ) { |
|
| 2635 | + $result = true; |
|
| 2636 | + } |
|
| 2637 | + |
|
| 2638 | + return $result; |
|
| 2639 | + } |
|
| 2640 | + |
|
| 2641 | + /** |
|
| 2642 | + * Tests if the current output is inside a Oxygen builder preview. |
|
| 2643 | + * |
|
| 2644 | + * @since 1.0.18 |
|
| 2645 | + * @return bool |
|
| 2646 | + */ |
|
| 2647 | + public function is_oxygen_preview() { |
|
| 2648 | + $result = false; |
|
| 2649 | + if ( ! empty( $_REQUEST['ct_builder'] ) || ( ! empty( $_REQUEST['action'] ) && ( substr( $_REQUEST['action'], 0, 11 ) === "oxy_render_" || substr( $_REQUEST['action'], 0, 10 ) === "ct_render_" ) ) ) { |
|
| 2650 | + $result = true; |
|
| 2651 | + } |
|
| 2652 | + |
|
| 2653 | + return $result; |
|
| 2654 | + } |
|
| 2655 | + |
|
| 2656 | + /** |
|
| 2657 | + * General function to check if we are in a preview situation. |
|
| 2658 | + * |
|
| 2659 | + * @since 1.0.6 |
|
| 2660 | + * @return bool |
|
| 2661 | + */ |
|
| 2662 | + public function is_preview() { |
|
| 2663 | + $preview = false; |
|
| 2664 | + if ( $this->is_divi_preview() ) { |
|
| 2665 | + $preview = true; |
|
| 2666 | + } elseif ( $this->is_elementor_preview() ) { |
|
| 2667 | + $preview = true; |
|
| 2668 | + } elseif ( $this->is_beaver_preview() ) { |
|
| 2669 | + $preview = true; |
|
| 2670 | + } elseif ( $this->is_siteorigin_preview() ) { |
|
| 2671 | + $preview = true; |
|
| 2672 | + } elseif ( $this->is_cornerstone_preview() ) { |
|
| 2673 | + $preview = true; |
|
| 2674 | + } elseif ( $this->is_fusion_preview() ) { |
|
| 2675 | + $preview = true; |
|
| 2676 | + } elseif ( $this->is_oxygen_preview() ) { |
|
| 2677 | + $preview = true; |
|
| 2678 | + } elseif( $this->is_block_content_call() ) { |
|
| 2679 | + $preview = true; |
|
| 2680 | + } |
|
| 2681 | + |
|
| 2682 | + return $preview; |
|
| 2683 | + } |
|
| 2684 | + |
|
| 2685 | + /** |
|
| 2686 | + * Output the super title. |
|
| 2687 | + * |
|
| 2688 | + * @param $args |
|
| 2689 | + * @param array $instance |
|
| 2690 | + * |
|
| 2691 | + * @return string |
|
| 2692 | + */ |
|
| 2693 | + public function output_title( $args, $instance = array() ) { |
|
| 2694 | + $output = ''; |
|
| 2695 | + if ( ! empty( $instance['title'] ) ) { |
|
| 2696 | + /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ |
|
| 2697 | + $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base ); |
|
| 2698 | + |
|
| 2699 | + if(empty($instance['widget_title_tag'])){ |
|
| 2700 | + $output = $args['before_title'] . $title . $args['after_title']; |
|
| 2701 | + }else{ |
|
| 2702 | + $title_tag = esc_attr( $instance['widget_title_tag'] ); |
|
| 2703 | + |
|
| 2704 | + // classes |
|
| 2705 | + $title_classes = array(); |
|
| 2706 | + $title_classes[] = !empty( $instance['widget_title_size_class'] ) ? sanitize_html_class( $instance['widget_title_size_class'] ) : ''; |
|
| 2707 | + $title_classes[] = !empty( $instance['widget_title_align_class'] ) ? sanitize_html_class( $instance['widget_title_align_class'] ) : ''; |
|
| 2708 | + $title_classes[] = !empty( $instance['widget_title_color_class'] ) ? "text-".sanitize_html_class( $instance['widget_title_color_class'] ) : ''; |
|
| 2709 | + $title_classes[] = !empty( $instance['widget_title_border_class'] ) ? sanitize_html_class( $instance['widget_title_border_class'] ) : ''; |
|
| 2710 | + $title_classes[] = !empty( $instance['widget_title_border_color_class'] ) ? "border-".sanitize_html_class( $instance['widget_title_border_color_class'] ) : ''; |
|
| 2711 | + $title_classes[] = !empty( $instance['widget_title_mt_class'] ) ? "mt-".absint( $instance['widget_title_mt_class'] ) : ''; |
|
| 2712 | + $title_classes[] = !empty( $instance['widget_title_mr_class'] ) ? "mr-".absint( $instance['widget_title_mr_class'] ) : ''; |
|
| 2713 | + $title_classes[] = !empty( $instance['widget_title_mb_class'] ) ? "mb-".absint( $instance['widget_title_mb_class'] ) : ''; |
|
| 2714 | + $title_classes[] = !empty( $instance['widget_title_ml_class'] ) ? "ml-".absint( $instance['widget_title_ml_class'] ) : ''; |
|
| 2715 | + $title_classes[] = !empty( $instance['widget_title_pt_class'] ) ? "pt-".absint( $instance['widget_title_pt_class'] ) : ''; |
|
| 2716 | + $title_classes[] = !empty( $instance['widget_title_pr_class'] ) ? "pr-".absint( $instance['widget_title_pr_class'] ) : ''; |
|
| 2717 | + $title_classes[] = !empty( $instance['widget_title_pb_class'] ) ? "pb-".absint( $instance['widget_title_pb_class'] ) : ''; |
|
| 2718 | + $title_classes[] = !empty( $instance['widget_title_pl_class'] ) ? "pl-".absint( $instance['widget_title_pl_class'] ) : ''; |
|
| 2719 | + |
|
| 2720 | + $class = !empty( $title_classes ) ? implode(" ",$title_classes) : ''; |
|
| 2721 | + $output = "<$title_tag class='$class' >$title</$title_tag>"; |
|
| 2722 | + } |
|
| 2723 | + |
|
| 2724 | + } |
|
| 2725 | + |
|
| 2726 | + return $output; |
|
| 2727 | + } |
|
| 2728 | + |
|
| 2729 | + /** |
|
| 2730 | + * Outputs the options form inputs for the widget. |
|
| 2731 | + * |
|
| 2732 | + * @param array $instance The widget options. |
|
| 2733 | + */ |
|
| 2734 | + public function form( $instance ) { |
|
| 2735 | + |
|
| 2736 | + // set widget instance |
|
| 2737 | + $this->instance = $instance; |
|
| 2738 | + |
|
| 2739 | + // set it as a SD widget |
|
| 2740 | + echo $this->widget_advanced_toggle(); |
|
| 2741 | + |
|
| 2742 | + echo "<p>" . esc_attr( $this->options['widget_ops']['description'] ) . "</p>"; |
|
| 2743 | + $arguments_raw = $this->get_arguments(); |
|
| 2744 | + |
|
| 2745 | + if ( is_array( $arguments_raw ) ) { |
|
| 2746 | + |
|
| 2747 | + $arguments = $this->group_arguments( $arguments_raw ); |
|
| 2748 | + |
|
| 2749 | + // Do we have sections? |
|
| 2750 | + $has_sections = $arguments == $arguments_raw ? false : true; |
|
| 2751 | + |
|
| 2752 | + |
|
| 2753 | + if ( $has_sections ) { |
|
| 2754 | + $panel_count = 0; |
|
| 2755 | + foreach ( $arguments as $key => $args ) { |
|
| 2756 | + |
|
| 2757 | + ?> |
|
| 2758 | 2758 | <script> |
| 2759 | 2759 | // jQuery(this).find("i").toggleClass("fas fa-chevron-up fas fa-chevron-down");jQuery(this).next().toggle(); |
| 2760 | 2760 | </script> |
| 2761 | 2761 | <?php |
| 2762 | 2762 | |
| 2763 | - $hide = $panel_count ? ' style="display:none;" ' : ''; |
|
| 2764 | - $icon_class = $panel_count ? 'fas fa-chevron-up' : 'fas fa-chevron-down'; |
|
| 2765 | - echo "<button onclick='jQuery(this).find(\"i\").toggleClass(\"fas fa-chevron-up fas fa-chevron-down\");jQuery(this).next().slideToggle();' type='button' class='sd-toggle-group-button sd-input-group-toggle" . sanitize_title_with_dashes( $key ) . "'>" . esc_attr( $key ) . " <i style='float:right;' class='" . $icon_class . "'></i></button>"; |
|
| 2766 | - echo "<div class='sd-toggle-group sd-input-group-" . sanitize_title_with_dashes( $key ) . "' $hide>"; |
|
| 2763 | + $hide = $panel_count ? ' style="display:none;" ' : ''; |
|
| 2764 | + $icon_class = $panel_count ? 'fas fa-chevron-up' : 'fas fa-chevron-down'; |
|
| 2765 | + echo "<button onclick='jQuery(this).find(\"i\").toggleClass(\"fas fa-chevron-up fas fa-chevron-down\");jQuery(this).next().slideToggle();' type='button' class='sd-toggle-group-button sd-input-group-toggle" . sanitize_title_with_dashes( $key ) . "'>" . esc_attr( $key ) . " <i style='float:right;' class='" . $icon_class . "'></i></button>"; |
|
| 2766 | + echo "<div class='sd-toggle-group sd-input-group-" . sanitize_title_with_dashes( $key ) . "' $hide>"; |
|
| 2767 | 2767 | |
| 2768 | - foreach ( $args as $k => $a ) { |
|
| 2768 | + foreach ( $args as $k => $a ) { |
|
| 2769 | 2769 | |
| 2770 | - $this->widget_inputs_row_start($k, $a); |
|
| 2771 | - $this->widget_inputs( $a, $instance ); |
|
| 2772 | - $this->widget_inputs_row_end($k, $a); |
|
| 2770 | + $this->widget_inputs_row_start($k, $a); |
|
| 2771 | + $this->widget_inputs( $a, $instance ); |
|
| 2772 | + $this->widget_inputs_row_end($k, $a); |
|
| 2773 | 2773 | |
| 2774 | - } |
|
| 2774 | + } |
|
| 2775 | 2775 | |
| 2776 | - echo "</div>"; |
|
| 2776 | + echo "</div>"; |
|
| 2777 | 2777 | |
| 2778 | - $panel_count ++; |
|
| 2778 | + $panel_count ++; |
|
| 2779 | 2779 | |
| 2780 | - } |
|
| 2781 | - } else { |
|
| 2782 | - foreach ( $arguments as $key => $args ) { |
|
| 2783 | - $this->widget_inputs_row_start($key, $args); |
|
| 2784 | - $this->widget_inputs( $args, $instance ); |
|
| 2785 | - $this->widget_inputs_row_end($key, $args); |
|
| 2786 | - } |
|
| 2787 | - } |
|
| 2780 | + } |
|
| 2781 | + } else { |
|
| 2782 | + foreach ( $arguments as $key => $args ) { |
|
| 2783 | + $this->widget_inputs_row_start($key, $args); |
|
| 2784 | + $this->widget_inputs( $args, $instance ); |
|
| 2785 | + $this->widget_inputs_row_end($key, $args); |
|
| 2786 | + } |
|
| 2787 | + } |
|
| 2788 | 2788 | |
| 2789 | - } |
|
| 2790 | - } |
|
| 2789 | + } |
|
| 2790 | + } |
|
| 2791 | 2791 | |
| 2792 | - public function widget_inputs_row_start($key, $args){ |
|
| 2793 | - if(!empty($args['row'])){ |
|
| 2794 | - // maybe open |
|
| 2795 | - if(!empty($args['row']['open'])){ |
|
| 2796 | - ?> |
|
| 2792 | + public function widget_inputs_row_start($key, $args){ |
|
| 2793 | + if(!empty($args['row'])){ |
|
| 2794 | + // maybe open |
|
| 2795 | + if(!empty($args['row']['open'])){ |
|
| 2796 | + ?> |
|
| 2797 | 2797 | <div class='bsui sd-argument ' data-argument='<?php echo esc_attr( $args['row']['key'] ); ?>' data-element_require='<?php if ( !empty($args['row']['element_require'])) { |
| 2798 | - echo $this->convert_element_require( $args['row']['element_require'] ); |
|
| 2799 | - } ?>'> |
|
| 2798 | + echo $this->convert_element_require( $args['row']['element_require'] ); |
|
| 2799 | + } ?>'> |
|
| 2800 | 2800 | <?php if(!empty($args['row']['title'])){ ?> |
| 2801 | 2801 | <label class="mb-0 "><?php echo esc_attr( $args['row']['title'] ); ?><?php echo $this->widget_field_desc( $args['row'] ); ?></label> |
| 2802 | 2802 | <?php }?> |
| 2803 | 2803 | <div class='row <?php if(!empty($args['row']['class'])){ echo esc_attr($args['row']['class']);} ?>'> |
| 2804 | 2804 | <div class='col pr-2'> |
| 2805 | 2805 | <?php |
| 2806 | - }elseif(!empty($args['row']['close'])){ |
|
| 2807 | - echo "<div class='col pl-0'>"; |
|
| 2808 | - }else{ |
|
| 2809 | - echo "<div class='col pl-0 pr-2'>"; |
|
| 2810 | - } |
|
| 2811 | - } |
|
| 2812 | - } |
|
| 2813 | - |
|
| 2814 | - public function widget_inputs_row_end($key, $args){ |
|
| 2815 | - |
|
| 2816 | - if(!empty($args['row'])){ |
|
| 2817 | - // maybe close |
|
| 2818 | - if(!empty($args['row']['close'])){ |
|
| 2819 | - echo "</div></div>"; |
|
| 2820 | - } |
|
| 2821 | - |
|
| 2822 | - echo "</div>"; |
|
| 2823 | - } |
|
| 2824 | - } |
|
| 2825 | - |
|
| 2826 | - /** |
|
| 2827 | - * Get the hidden input that when added makes the advanced button show on widget settings. |
|
| 2828 | - * |
|
| 2829 | - * @return string |
|
| 2830 | - */ |
|
| 2831 | - public function widget_advanced_toggle() { |
|
| 2832 | - |
|
| 2833 | - $output = ''; |
|
| 2834 | - if ( $this->block_show_advanced() ) { |
|
| 2835 | - $val = 1; |
|
| 2836 | - } else { |
|
| 2837 | - $val = 0; |
|
| 2838 | - } |
|
| 2839 | - |
|
| 2840 | - $output .= "<input type='hidden' class='sd-show-advanced' value='$val' />"; |
|
| 2841 | - |
|
| 2842 | - return $output; |
|
| 2843 | - } |
|
| 2844 | - |
|
| 2845 | - /** |
|
| 2846 | - * Convert require element. |
|
| 2847 | - * |
|
| 2848 | - * @since 1.0.0 |
|
| 2849 | - * |
|
| 2850 | - * @param string $input Input element. |
|
| 2851 | - * |
|
| 2852 | - * @return string $output |
|
| 2853 | - */ |
|
| 2854 | - public function convert_element_require( $input ) { |
|
| 2855 | - |
|
| 2856 | - $input = str_replace( "'", '"', $input );// we only want double quotes |
|
| 2857 | - |
|
| 2858 | - $output = esc_attr( str_replace( array( "[%", "%]" ), array( |
|
| 2859 | - "jQuery(form).find('[data-argument=\"", |
|
| 2860 | - "\"]').find('input,select,textarea').val()" |
|
| 2861 | - ), $input ) ); |
|
| 2862 | - |
|
| 2863 | - return $output; |
|
| 2864 | - } |
|
| 2865 | - |
|
| 2866 | - /** |
|
| 2867 | - * Builds the inputs for the widget options. |
|
| 2868 | - * |
|
| 2869 | - * @param $args |
|
| 2870 | - * @param $instance |
|
| 2871 | - */ |
|
| 2872 | - public function widget_inputs( $args, $instance ) { |
|
| 2873 | - |
|
| 2874 | - $class = ""; |
|
| 2875 | - $element_require = ""; |
|
| 2876 | - $custom_attributes = ""; |
|
| 2877 | - |
|
| 2878 | - // get value |
|
| 2879 | - if ( isset( $instance[ $args['name'] ] ) ) { |
|
| 2880 | - $value = $instance[ $args['name'] ]; |
|
| 2881 | - } elseif ( ! isset( $instance[ $args['name'] ] ) && ! empty( $args['default'] ) ) { |
|
| 2882 | - $value = is_array( $args['default'] ) ? array_map( "esc_html", $args['default'] ) : esc_html( $args['default'] ); |
|
| 2883 | - } else { |
|
| 2884 | - $value = ''; |
|
| 2885 | - } |
|
| 2886 | - |
|
| 2887 | - // get placeholder |
|
| 2888 | - if ( ! empty( $args['placeholder'] ) ) { |
|
| 2889 | - $placeholder = "placeholder='" . esc_html( $args['placeholder'] ) . "'"; |
|
| 2890 | - } else { |
|
| 2891 | - $placeholder = ''; |
|
| 2892 | - } |
|
| 2893 | - |
|
| 2894 | - // get if advanced |
|
| 2895 | - if ( isset( $args['advanced'] ) && $args['advanced'] ) { |
|
| 2896 | - $class .= " sd-advanced-setting "; |
|
| 2897 | - } |
|
| 2898 | - |
|
| 2899 | - // element_require |
|
| 2900 | - if ( isset( $args['element_require'] ) && $args['element_require'] ) { |
|
| 2901 | - $element_require = $args['element_require']; |
|
| 2902 | - } |
|
| 2903 | - |
|
| 2904 | - // custom_attributes |
|
| 2905 | - if ( isset( $args['custom_attributes'] ) && $args['custom_attributes'] ) { |
|
| 2906 | - $custom_attributes = $this->array_to_attributes( $args['custom_attributes'], true ); |
|
| 2907 | - } |
|
| 2908 | - |
|
| 2909 | - |
|
| 2910 | - // before wrapper |
|
| 2911 | - ?> |
|
| 2806 | + }elseif(!empty($args['row']['close'])){ |
|
| 2807 | + echo "<div class='col pl-0'>"; |
|
| 2808 | + }else{ |
|
| 2809 | + echo "<div class='col pl-0 pr-2'>"; |
|
| 2810 | + } |
|
| 2811 | + } |
|
| 2812 | + } |
|
| 2813 | + |
|
| 2814 | + public function widget_inputs_row_end($key, $args){ |
|
| 2815 | + |
|
| 2816 | + if(!empty($args['row'])){ |
|
| 2817 | + // maybe close |
|
| 2818 | + if(!empty($args['row']['close'])){ |
|
| 2819 | + echo "</div></div>"; |
|
| 2820 | + } |
|
| 2821 | + |
|
| 2822 | + echo "</div>"; |
|
| 2823 | + } |
|
| 2824 | + } |
|
| 2825 | + |
|
| 2826 | + /** |
|
| 2827 | + * Get the hidden input that when added makes the advanced button show on widget settings. |
|
| 2828 | + * |
|
| 2829 | + * @return string |
|
| 2830 | + */ |
|
| 2831 | + public function widget_advanced_toggle() { |
|
| 2832 | + |
|
| 2833 | + $output = ''; |
|
| 2834 | + if ( $this->block_show_advanced() ) { |
|
| 2835 | + $val = 1; |
|
| 2836 | + } else { |
|
| 2837 | + $val = 0; |
|
| 2838 | + } |
|
| 2839 | + |
|
| 2840 | + $output .= "<input type='hidden' class='sd-show-advanced' value='$val' />"; |
|
| 2841 | + |
|
| 2842 | + return $output; |
|
| 2843 | + } |
|
| 2844 | + |
|
| 2845 | + /** |
|
| 2846 | + * Convert require element. |
|
| 2847 | + * |
|
| 2848 | + * @since 1.0.0 |
|
| 2849 | + * |
|
| 2850 | + * @param string $input Input element. |
|
| 2851 | + * |
|
| 2852 | + * @return string $output |
|
| 2853 | + */ |
|
| 2854 | + public function convert_element_require( $input ) { |
|
| 2855 | + |
|
| 2856 | + $input = str_replace( "'", '"', $input );// we only want double quotes |
|
| 2857 | + |
|
| 2858 | + $output = esc_attr( str_replace( array( "[%", "%]" ), array( |
|
| 2859 | + "jQuery(form).find('[data-argument=\"", |
|
| 2860 | + "\"]').find('input,select,textarea').val()" |
|
| 2861 | + ), $input ) ); |
|
| 2862 | + |
|
| 2863 | + return $output; |
|
| 2864 | + } |
|
| 2865 | + |
|
| 2866 | + /** |
|
| 2867 | + * Builds the inputs for the widget options. |
|
| 2868 | + * |
|
| 2869 | + * @param $args |
|
| 2870 | + * @param $instance |
|
| 2871 | + */ |
|
| 2872 | + public function widget_inputs( $args, $instance ) { |
|
| 2873 | + |
|
| 2874 | + $class = ""; |
|
| 2875 | + $element_require = ""; |
|
| 2876 | + $custom_attributes = ""; |
|
| 2877 | + |
|
| 2878 | + // get value |
|
| 2879 | + if ( isset( $instance[ $args['name'] ] ) ) { |
|
| 2880 | + $value = $instance[ $args['name'] ]; |
|
| 2881 | + } elseif ( ! isset( $instance[ $args['name'] ] ) && ! empty( $args['default'] ) ) { |
|
| 2882 | + $value = is_array( $args['default'] ) ? array_map( "esc_html", $args['default'] ) : esc_html( $args['default'] ); |
|
| 2883 | + } else { |
|
| 2884 | + $value = ''; |
|
| 2885 | + } |
|
| 2886 | + |
|
| 2887 | + // get placeholder |
|
| 2888 | + if ( ! empty( $args['placeholder'] ) ) { |
|
| 2889 | + $placeholder = "placeholder='" . esc_html( $args['placeholder'] ) . "'"; |
|
| 2890 | + } else { |
|
| 2891 | + $placeholder = ''; |
|
| 2892 | + } |
|
| 2893 | + |
|
| 2894 | + // get if advanced |
|
| 2895 | + if ( isset( $args['advanced'] ) && $args['advanced'] ) { |
|
| 2896 | + $class .= " sd-advanced-setting "; |
|
| 2897 | + } |
|
| 2898 | + |
|
| 2899 | + // element_require |
|
| 2900 | + if ( isset( $args['element_require'] ) && $args['element_require'] ) { |
|
| 2901 | + $element_require = $args['element_require']; |
|
| 2902 | + } |
|
| 2903 | + |
|
| 2904 | + // custom_attributes |
|
| 2905 | + if ( isset( $args['custom_attributes'] ) && $args['custom_attributes'] ) { |
|
| 2906 | + $custom_attributes = $this->array_to_attributes( $args['custom_attributes'], true ); |
|
| 2907 | + } |
|
| 2908 | + |
|
| 2909 | + |
|
| 2910 | + // before wrapper |
|
| 2911 | + ?> |
|
| 2912 | 2912 | <p class="sd-argument <?php echo esc_attr( $class ); ?>" |
| 2913 | 2913 | data-argument='<?php echo esc_attr( $args['name'] ); ?>' |
| 2914 | 2914 | data-element_require='<?php if ( $element_require ) { |
| 2915 | - echo $this->convert_element_require( $element_require ); |
|
| 2916 | - } ?>' |
|
| 2915 | + echo $this->convert_element_require( $element_require ); |
|
| 2916 | + } ?>' |
|
| 2917 | 2917 | > |
| 2918 | 2918 | <?php |
| 2919 | 2919 | |
| 2920 | 2920 | |
| 2921 | - switch ( $args['type'] ) { |
|
| 2922 | - //array('text','password','number','email','tel','url','color') |
|
| 2923 | - case "text": |
|
| 2924 | - case "password": |
|
| 2925 | - case "number": |
|
| 2926 | - case "email": |
|
| 2927 | - case "tel": |
|
| 2928 | - case "url": |
|
| 2929 | - case "color": |
|
| 2930 | - ?> |
|
| 2921 | + switch ( $args['type'] ) { |
|
| 2922 | + //array('text','password','number','email','tel','url','color') |
|
| 2923 | + case "text": |
|
| 2924 | + case "password": |
|
| 2925 | + case "number": |
|
| 2926 | + case "email": |
|
| 2927 | + case "tel": |
|
| 2928 | + case "url": |
|
| 2929 | + case "color": |
|
| 2930 | + ?> |
|
| 2931 | 2931 | <label |
| 2932 | 2932 | for="<?php echo esc_attr( $this->get_field_id( $args['name'] ) ); ?>"><?php echo $this->widget_field_title( $args );?><?php echo $this->widget_field_desc( $args ); ?></label> |
| 2933 | 2933 | <input <?php echo $placeholder; ?> class="widefat" |
@@ -2938,47 +2938,47 @@ discard block |
||
| 2938 | 2938 | value="<?php echo esc_attr( $value ); ?>"> |
| 2939 | 2939 | <?php |
| 2940 | 2940 | |
| 2941 | - break; |
|
| 2942 | - case "select": |
|
| 2943 | - $multiple = isset( $args['multiple'] ) && $args['multiple'] ? true : false; |
|
| 2944 | - if ( $multiple ) { |
|
| 2945 | - if ( empty( $value ) ) { |
|
| 2946 | - $value = array(); |
|
| 2947 | - } |
|
| 2948 | - } |
|
| 2949 | - ?> |
|
| 2941 | + break; |
|
| 2942 | + case "select": |
|
| 2943 | + $multiple = isset( $args['multiple'] ) && $args['multiple'] ? true : false; |
|
| 2944 | + if ( $multiple ) { |
|
| 2945 | + if ( empty( $value ) ) { |
|
| 2946 | + $value = array(); |
|
| 2947 | + } |
|
| 2948 | + } |
|
| 2949 | + ?> |
|
| 2950 | 2950 | <label |
| 2951 | 2951 | for="<?php echo esc_attr( $this->get_field_id( $args['name'] ) ); ?>"><?php echo $this->widget_field_title( $args ); ?><?php echo $this->widget_field_desc( $args ); ?></label> |
| 2952 | 2952 | <select <?php echo $placeholder; ?> class="widefat" |
| 2953 | 2953 | <?php echo $custom_attributes; ?> |
| 2954 | 2954 | id="<?php echo esc_attr( $this->get_field_id( $args['name'] ) ); ?>" |
| 2955 | 2955 | name="<?php echo esc_attr( $this->get_field_name( $args['name'] ) ); |
| 2956 | - if ( $multiple ) { |
|
| 2957 | - echo "[]"; |
|
| 2958 | - } ?>" |
|
| 2956 | + if ( $multiple ) { |
|
| 2957 | + echo "[]"; |
|
| 2958 | + } ?>" |
|
| 2959 | 2959 | <?php if ( $multiple ) { |
| 2960 | - echo "multiple"; |
|
| 2961 | - } //@todo not implemented yet due to gutenberg not supporting it |
|
| 2962 | - ?> |
|
| 2960 | + echo "multiple"; |
|
| 2961 | + } //@todo not implemented yet due to gutenberg not supporting it |
|
| 2962 | + ?> |
|
| 2963 | 2963 | > |
| 2964 | 2964 | <?php |
| 2965 | 2965 | |
| 2966 | - if ( ! empty( $args['options'] ) ) { |
|
| 2967 | - foreach ( $args['options'] as $val => $label ) { |
|
| 2968 | - if ( $multiple ) { |
|
| 2969 | - $selected = in_array( $val, $value ) ? 'selected="selected"' : ''; |
|
| 2970 | - } else { |
|
| 2971 | - $selected = selected( $value, $val, false ); |
|
| 2972 | - } |
|
| 2973 | - echo "<option value='$val' " . $selected . ">$label</option>"; |
|
| 2974 | - } |
|
| 2975 | - } |
|
| 2976 | - ?> |
|
| 2966 | + if ( ! empty( $args['options'] ) ) { |
|
| 2967 | + foreach ( $args['options'] as $val => $label ) { |
|
| 2968 | + if ( $multiple ) { |
|
| 2969 | + $selected = in_array( $val, $value ) ? 'selected="selected"' : ''; |
|
| 2970 | + } else { |
|
| 2971 | + $selected = selected( $value, $val, false ); |
|
| 2972 | + } |
|
| 2973 | + echo "<option value='$val' " . $selected . ">$label</option>"; |
|
| 2974 | + } |
|
| 2975 | + } |
|
| 2976 | + ?> |
|
| 2977 | 2977 | </select> |
| 2978 | 2978 | <?php |
| 2979 | - break; |
|
| 2980 | - case "checkbox": |
|
| 2981 | - ?> |
|
| 2979 | + break; |
|
| 2980 | + case "checkbox": |
|
| 2981 | + ?> |
|
| 2982 | 2982 | <input <?php echo $placeholder; ?> |
| 2983 | 2983 | <?php checked( 1, $value, true ) ?> |
| 2984 | 2984 | <?php echo $custom_attributes; ?> |
@@ -2988,9 +2988,9 @@ discard block |
||
| 2988 | 2988 | <label |
| 2989 | 2989 | for="<?php echo esc_attr( $this->get_field_id( $args['name'] ) ); ?>"><?php echo $this->widget_field_title( $args );?><?php echo $this->widget_field_desc( $args ); ?></label> |
| 2990 | 2990 | <?php |
| 2991 | - break; |
|
| 2992 | - case "textarea": |
|
| 2993 | - ?> |
|
| 2991 | + break; |
|
| 2992 | + case "textarea": |
|
| 2993 | + ?> |
|
| 2994 | 2994 | <label |
| 2995 | 2995 | for="<?php echo esc_attr( $this->get_field_id( $args['name'] ) ); ?>"><?php echo $this->widget_field_title( $args ); ?><?php echo $this->widget_field_desc( $args ); ?></label> |
| 2996 | 2996 | <textarea <?php echo $placeholder; ?> class="widefat" |
@@ -3000,207 +3000,207 @@ discard block |
||
| 3000 | 3000 | ><?php echo esc_attr( $value ); ?></textarea> |
| 3001 | 3001 | <?php |
| 3002 | 3002 | |
| 3003 | - break; |
|
| 3004 | - case "hidden": |
|
| 3005 | - ?> |
|
| 3003 | + break; |
|
| 3004 | + case "hidden": |
|
| 3005 | + ?> |
|
| 3006 | 3006 | <input id="<?php echo esc_attr( $this->get_field_id( $args['name'] ) ); ?>" |
| 3007 | 3007 | name="<?php echo esc_attr( $this->get_field_name( $args['name'] ) ); ?>" type="hidden" |
| 3008 | 3008 | value="<?php echo esc_attr( $value ); ?>"> |
| 3009 | 3009 | <?php |
| 3010 | - break; |
|
| 3011 | - default: |
|
| 3012 | - echo "No input type found!"; // @todo we need to add more input types. |
|
| 3013 | - } |
|
| 3010 | + break; |
|
| 3011 | + default: |
|
| 3012 | + echo "No input type found!"; // @todo we need to add more input types. |
|
| 3013 | + } |
|
| 3014 | 3014 | |
| 3015 | - // after wrapper |
|
| 3016 | - ?> |
|
| 3015 | + // after wrapper |
|
| 3016 | + ?> |
|
| 3017 | 3017 | </p> |
| 3018 | 3018 | <?php |
| 3019 | 3019 | |
| 3020 | 3020 | |
| 3021 | - } |
|
| 3022 | - |
|
| 3023 | - public function get_widget_icon($icon = 'box-top', $title = ''){ |
|
| 3024 | - if($icon=='box-top'){ |
|
| 3025 | - return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.714" y="5.492" width="1.048" height="9.017" fill="#555D66"></rect><rect x="16.265" y="5.498" width="1.023" height="9.003" fill="#555D66"></rect><rect x="5.518" y="2.186" width="8.964" height="2.482" fill="#272B2F"></rect><rect x="5.487" y="16.261" width="9.026" height="1.037" fill="#555D66"></rect></svg>'; |
|
| 3026 | - }elseif($icon=='box-right'){ |
|
| 3027 | - return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.714" y="5.492" width="1.046" height="9.017" fill="#555D66"></rect><rect x="15.244" y="5.498" width="2.518" height="9.003" fill="#272B2F"></rect><rect x="5.518" y="2.719" width="8.964" height="0.954" fill="#555D66"></rect><rect x="5.487" y="16.308" width="9.026" height="0.99" fill="#555D66"></rect></svg>'; |
|
| 3028 | - }elseif($icon=='box-bottom'){ |
|
| 3029 | - return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.714" y="5.492" width="1" height="9.017" fill="#555D66"></rect><rect x="16.261" y="5.498" width="1.027" height="9.003" fill="#555D66"></rect><rect x="5.518" y="2.719" width="8.964" height="0.968" fill="#555D66"></rect><rect x="5.487" y="15.28" width="9.026" height="2.499" fill="#272B2F"></rect></svg>'; |
|
| 3030 | - }elseif($icon=='box-left'){ |
|
| 3031 | - return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.202" y="5.492" width="2.503" height="9.017" fill="#272B2F"></rect><rect x="16.276" y="5.498" width="1.012" height="9.003" fill="#555D66"></rect><rect x="5.518" y="2.719" width="8.964" height="0.966" fill="#555D66"></rect><rect x="5.487" y="16.303" width="9.026" height="0.995" fill="#555D66"></rect></svg>'; |
|
| 3032 | - } |
|
| 3033 | - } |
|
| 3034 | - |
|
| 3035 | - /** |
|
| 3036 | - * Get the widget input description html. |
|
| 3037 | - * |
|
| 3038 | - * @param $args |
|
| 3039 | - * |
|
| 3040 | - * @return string |
|
| 3041 | - * @todo, need to make its own tooltip script |
|
| 3042 | - */ |
|
| 3043 | - public function widget_field_desc( $args ) { |
|
| 3044 | - |
|
| 3045 | - $description = ''; |
|
| 3046 | - if ( isset( $args['desc'] ) && $args['desc'] ) { |
|
| 3047 | - if ( isset( $args['desc_tip'] ) && $args['desc_tip'] ) { |
|
| 3048 | - $description = $this->desc_tip( $args['desc'] ); |
|
| 3049 | - } else { |
|
| 3050 | - $description = '<span class="description">' . wp_kses_post( $args['desc'] ) . '</span>'; |
|
| 3051 | - } |
|
| 3052 | - } |
|
| 3053 | - |
|
| 3054 | - return $description; |
|
| 3055 | - } |
|
| 3056 | - |
|
| 3057 | - /** |
|
| 3058 | - * Get the widget input title html. |
|
| 3059 | - * |
|
| 3060 | - * @param $args |
|
| 3061 | - * |
|
| 3062 | - * @return string |
|
| 3063 | - */ |
|
| 3064 | - public function widget_field_title( $args ) { |
|
| 3065 | - |
|
| 3066 | - $title = ''; |
|
| 3067 | - if ( isset( $args['title'] ) && $args['title'] ) { |
|
| 3068 | - if ( isset( $args['icon'] ) && $args['icon'] ) { |
|
| 3069 | - $title = self::get_widget_icon( $args['icon'], $args['title'] ); |
|
| 3070 | - } else { |
|
| 3071 | - $title = esc_attr($args['title']); |
|
| 3072 | - } |
|
| 3073 | - } |
|
| 3074 | - |
|
| 3075 | - return $title; |
|
| 3076 | - } |
|
| 3077 | - |
|
| 3078 | - /** |
|
| 3079 | - * Get the tool tip html. |
|
| 3080 | - * |
|
| 3081 | - * @param $tip |
|
| 3082 | - * @param bool $allow_html |
|
| 3083 | - * |
|
| 3084 | - * @return string |
|
| 3085 | - */ |
|
| 3086 | - function desc_tip( $tip, $allow_html = false ) { |
|
| 3087 | - if ( $allow_html ) { |
|
| 3088 | - $tip = $this->sanitize_tooltip( $tip ); |
|
| 3089 | - } else { |
|
| 3090 | - $tip = esc_attr( $tip ); |
|
| 3091 | - } |
|
| 3092 | - |
|
| 3093 | - return '<span class="gd-help-tip dashicons dashicons-editor-help" title="' . $tip . '"></span>'; |
|
| 3094 | - } |
|
| 3095 | - |
|
| 3096 | - /** |
|
| 3097 | - * Sanitize a string destined to be a tooltip. |
|
| 3098 | - * |
|
| 3099 | - * @param string $var |
|
| 3100 | - * |
|
| 3101 | - * @return string |
|
| 3102 | - */ |
|
| 3103 | - public function sanitize_tooltip( $var ) { |
|
| 3104 | - return htmlspecialchars( wp_kses( html_entity_decode( $var ), array( |
|
| 3105 | - 'br' => array(), |
|
| 3106 | - 'em' => array(), |
|
| 3107 | - 'strong' => array(), |
|
| 3108 | - 'small' => array(), |
|
| 3109 | - 'span' => array(), |
|
| 3110 | - 'ul' => array(), |
|
| 3111 | - 'li' => array(), |
|
| 3112 | - 'ol' => array(), |
|
| 3113 | - 'p' => array(), |
|
| 3114 | - ) ) ); |
|
| 3115 | - } |
|
| 3116 | - |
|
| 3117 | - /** |
|
| 3118 | - * Processing widget options on save |
|
| 3119 | - * |
|
| 3120 | - * @param array $new_instance The new options |
|
| 3121 | - * @param array $old_instance The previous options |
|
| 3122 | - * |
|
| 3123 | - * @return array |
|
| 3124 | - * @todo we should add some sanitation here. |
|
| 3125 | - */ |
|
| 3126 | - public function update( $new_instance, $old_instance ) { |
|
| 3127 | - |
|
| 3128 | - //save the widget |
|
| 3129 | - $instance = array_merge( (array) $old_instance, (array) $new_instance ); |
|
| 3130 | - |
|
| 3131 | - // set widget instance |
|
| 3132 | - $this->instance = $instance; |
|
| 3133 | - |
|
| 3134 | - if ( empty( $this->arguments ) ) { |
|
| 3135 | - $this->get_arguments(); |
|
| 3136 | - } |
|
| 3137 | - |
|
| 3138 | - // check for checkboxes |
|
| 3139 | - if ( ! empty( $this->arguments ) ) { |
|
| 3140 | - foreach ( $this->arguments as $argument ) { |
|
| 3141 | - if ( isset( $argument['type'] ) && $argument['type'] == 'checkbox' && ! isset( $new_instance[ $argument['name'] ] ) ) { |
|
| 3142 | - $instance[ $argument['name'] ] = '0'; |
|
| 3143 | - } |
|
| 3144 | - } |
|
| 3145 | - } |
|
| 3146 | - |
|
| 3147 | - return $instance; |
|
| 3148 | - } |
|
| 3149 | - |
|
| 3150 | - /** |
|
| 3151 | - * Checks if the current call is a ajax call to get the block content. |
|
| 3152 | - * |
|
| 3153 | - * This can be used in your widget to return different content as the block content. |
|
| 3154 | - * |
|
| 3155 | - * @since 1.0.3 |
|
| 3156 | - * @return bool |
|
| 3157 | - */ |
|
| 3158 | - public function is_block_content_call() { |
|
| 3159 | - $result = false; |
|
| 3160 | - if ( wp_doing_ajax() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'super_duper_output_shortcode' ) { |
|
| 3161 | - $result = true; |
|
| 3162 | - } |
|
| 3163 | - |
|
| 3164 | - return $result; |
|
| 3165 | - } |
|
| 3166 | - |
|
| 3167 | - /** |
|
| 3168 | - * Get an instance hash that will be unique to the type and settings. |
|
| 3169 | - * |
|
| 3170 | - * @since 1.0.20 |
|
| 3171 | - * @return string |
|
| 3172 | - */ |
|
| 3173 | - public function get_instance_hash(){ |
|
| 3174 | - $instance_string = $this->base_id.serialize($this->instance); |
|
| 3175 | - return hash('crc32b',$instance_string); |
|
| 3176 | - } |
|
| 3177 | - |
|
| 3178 | - /** |
|
| 3179 | - * Generate and return inline styles from CSS rules that will match the unique class of the instance. |
|
| 3180 | - * |
|
| 3181 | - * @param array $rules |
|
| 3182 | - * |
|
| 3183 | - * @since 1.0.20 |
|
| 3184 | - * @return string |
|
| 3185 | - */ |
|
| 3186 | - public function get_instance_style($rules = array()){ |
|
| 3187 | - $css = ''; |
|
| 3188 | - |
|
| 3189 | - if(!empty($rules)){ |
|
| 3190 | - $rules = array_unique($rules); |
|
| 3191 | - $instance_hash = $this->get_instance_hash(); |
|
| 3192 | - $css .= "<style>"; |
|
| 3193 | - foreach($rules as $rule){ |
|
| 3194 | - $css .= ".sdel-$instance_hash $rule"; |
|
| 3195 | - } |
|
| 3196 | - $css .= "</style>"; |
|
| 3197 | - } |
|
| 3198 | - |
|
| 3199 | - |
|
| 3200 | - return $css; |
|
| 3201 | - |
|
| 3202 | - } |
|
| 3203 | - |
|
| 3204 | - } |
|
| 3021 | + } |
|
| 3022 | + |
|
| 3023 | + public function get_widget_icon($icon = 'box-top', $title = ''){ |
|
| 3024 | + if($icon=='box-top'){ |
|
| 3025 | + return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.714" y="5.492" width="1.048" height="9.017" fill="#555D66"></rect><rect x="16.265" y="5.498" width="1.023" height="9.003" fill="#555D66"></rect><rect x="5.518" y="2.186" width="8.964" height="2.482" fill="#272B2F"></rect><rect x="5.487" y="16.261" width="9.026" height="1.037" fill="#555D66"></rect></svg>'; |
|
| 3026 | + }elseif($icon=='box-right'){ |
|
| 3027 | + return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.714" y="5.492" width="1.046" height="9.017" fill="#555D66"></rect><rect x="15.244" y="5.498" width="2.518" height="9.003" fill="#272B2F"></rect><rect x="5.518" y="2.719" width="8.964" height="0.954" fill="#555D66"></rect><rect x="5.487" y="16.308" width="9.026" height="0.99" fill="#555D66"></rect></svg>'; |
|
| 3028 | + }elseif($icon=='box-bottom'){ |
|
| 3029 | + return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.714" y="5.492" width="1" height="9.017" fill="#555D66"></rect><rect x="16.261" y="5.498" width="1.027" height="9.003" fill="#555D66"></rect><rect x="5.518" y="2.719" width="8.964" height="0.968" fill="#555D66"></rect><rect x="5.487" y="15.28" width="9.026" height="2.499" fill="#272B2F"></rect></svg>'; |
|
| 3030 | + }elseif($icon=='box-left'){ |
|
| 3031 | + return '<svg title="'.esc_attr($title).'" width="20px" height="20px" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" role="img" aria-hidden="true" focusable="false"><rect x="2.202" y="5.492" width="2.503" height="9.017" fill="#272B2F"></rect><rect x="16.276" y="5.498" width="1.012" height="9.003" fill="#555D66"></rect><rect x="5.518" y="2.719" width="8.964" height="0.966" fill="#555D66"></rect><rect x="5.487" y="16.303" width="9.026" height="0.995" fill="#555D66"></rect></svg>'; |
|
| 3032 | + } |
|
| 3033 | + } |
|
| 3034 | + |
|
| 3035 | + /** |
|
| 3036 | + * Get the widget input description html. |
|
| 3037 | + * |
|
| 3038 | + * @param $args |
|
| 3039 | + * |
|
| 3040 | + * @return string |
|
| 3041 | + * @todo, need to make its own tooltip script |
|
| 3042 | + */ |
|
| 3043 | + public function widget_field_desc( $args ) { |
|
| 3044 | + |
|
| 3045 | + $description = ''; |
|
| 3046 | + if ( isset( $args['desc'] ) && $args['desc'] ) { |
|
| 3047 | + if ( isset( $args['desc_tip'] ) && $args['desc_tip'] ) { |
|
| 3048 | + $description = $this->desc_tip( $args['desc'] ); |
|
| 3049 | + } else { |
|
| 3050 | + $description = '<span class="description">' . wp_kses_post( $args['desc'] ) . '</span>'; |
|
| 3051 | + } |
|
| 3052 | + } |
|
| 3053 | + |
|
| 3054 | + return $description; |
|
| 3055 | + } |
|
| 3056 | + |
|
| 3057 | + /** |
|
| 3058 | + * Get the widget input title html. |
|
| 3059 | + * |
|
| 3060 | + * @param $args |
|
| 3061 | + * |
|
| 3062 | + * @return string |
|
| 3063 | + */ |
|
| 3064 | + public function widget_field_title( $args ) { |
|
| 3065 | + |
|
| 3066 | + $title = ''; |
|
| 3067 | + if ( isset( $args['title'] ) && $args['title'] ) { |
|
| 3068 | + if ( isset( $args['icon'] ) && $args['icon'] ) { |
|
| 3069 | + $title = self::get_widget_icon( $args['icon'], $args['title'] ); |
|
| 3070 | + } else { |
|
| 3071 | + $title = esc_attr($args['title']); |
|
| 3072 | + } |
|
| 3073 | + } |
|
| 3074 | + |
|
| 3075 | + return $title; |
|
| 3076 | + } |
|
| 3077 | + |
|
| 3078 | + /** |
|
| 3079 | + * Get the tool tip html. |
|
| 3080 | + * |
|
| 3081 | + * @param $tip |
|
| 3082 | + * @param bool $allow_html |
|
| 3083 | + * |
|
| 3084 | + * @return string |
|
| 3085 | + */ |
|
| 3086 | + function desc_tip( $tip, $allow_html = false ) { |
|
| 3087 | + if ( $allow_html ) { |
|
| 3088 | + $tip = $this->sanitize_tooltip( $tip ); |
|
| 3089 | + } else { |
|
| 3090 | + $tip = esc_attr( $tip ); |
|
| 3091 | + } |
|
| 3092 | + |
|
| 3093 | + return '<span class="gd-help-tip dashicons dashicons-editor-help" title="' . $tip . '"></span>'; |
|
| 3094 | + } |
|
| 3095 | + |
|
| 3096 | + /** |
|
| 3097 | + * Sanitize a string destined to be a tooltip. |
|
| 3098 | + * |
|
| 3099 | + * @param string $var |
|
| 3100 | + * |
|
| 3101 | + * @return string |
|
| 3102 | + */ |
|
| 3103 | + public function sanitize_tooltip( $var ) { |
|
| 3104 | + return htmlspecialchars( wp_kses( html_entity_decode( $var ), array( |
|
| 3105 | + 'br' => array(), |
|
| 3106 | + 'em' => array(), |
|
| 3107 | + 'strong' => array(), |
|
| 3108 | + 'small' => array(), |
|
| 3109 | + 'span' => array(), |
|
| 3110 | + 'ul' => array(), |
|
| 3111 | + 'li' => array(), |
|
| 3112 | + 'ol' => array(), |
|
| 3113 | + 'p' => array(), |
|
| 3114 | + ) ) ); |
|
| 3115 | + } |
|
| 3116 | + |
|
| 3117 | + /** |
|
| 3118 | + * Processing widget options on save |
|
| 3119 | + * |
|
| 3120 | + * @param array $new_instance The new options |
|
| 3121 | + * @param array $old_instance The previous options |
|
| 3122 | + * |
|
| 3123 | + * @return array |
|
| 3124 | + * @todo we should add some sanitation here. |
|
| 3125 | + */ |
|
| 3126 | + public function update( $new_instance, $old_instance ) { |
|
| 3127 | + |
|
| 3128 | + //save the widget |
|
| 3129 | + $instance = array_merge( (array) $old_instance, (array) $new_instance ); |
|
| 3130 | + |
|
| 3131 | + // set widget instance |
|
| 3132 | + $this->instance = $instance; |
|
| 3133 | + |
|
| 3134 | + if ( empty( $this->arguments ) ) { |
|
| 3135 | + $this->get_arguments(); |
|
| 3136 | + } |
|
| 3137 | + |
|
| 3138 | + // check for checkboxes |
|
| 3139 | + if ( ! empty( $this->arguments ) ) { |
|
| 3140 | + foreach ( $this->arguments as $argument ) { |
|
| 3141 | + if ( isset( $argument['type'] ) && $argument['type'] == 'checkbox' && ! isset( $new_instance[ $argument['name'] ] ) ) { |
|
| 3142 | + $instance[ $argument['name'] ] = '0'; |
|
| 3143 | + } |
|
| 3144 | + } |
|
| 3145 | + } |
|
| 3146 | + |
|
| 3147 | + return $instance; |
|
| 3148 | + } |
|
| 3149 | + |
|
| 3150 | + /** |
|
| 3151 | + * Checks if the current call is a ajax call to get the block content. |
|
| 3152 | + * |
|
| 3153 | + * This can be used in your widget to return different content as the block content. |
|
| 3154 | + * |
|
| 3155 | + * @since 1.0.3 |
|
| 3156 | + * @return bool |
|
| 3157 | + */ |
|
| 3158 | + public function is_block_content_call() { |
|
| 3159 | + $result = false; |
|
| 3160 | + if ( wp_doing_ajax() && isset( $_REQUEST['action'] ) && $_REQUEST['action'] == 'super_duper_output_shortcode' ) { |
|
| 3161 | + $result = true; |
|
| 3162 | + } |
|
| 3163 | + |
|
| 3164 | + return $result; |
|
| 3165 | + } |
|
| 3166 | + |
|
| 3167 | + /** |
|
| 3168 | + * Get an instance hash that will be unique to the type and settings. |
|
| 3169 | + * |
|
| 3170 | + * @since 1.0.20 |
|
| 3171 | + * @return string |
|
| 3172 | + */ |
|
| 3173 | + public function get_instance_hash(){ |
|
| 3174 | + $instance_string = $this->base_id.serialize($this->instance); |
|
| 3175 | + return hash('crc32b',$instance_string); |
|
| 3176 | + } |
|
| 3177 | + |
|
| 3178 | + /** |
|
| 3179 | + * Generate and return inline styles from CSS rules that will match the unique class of the instance. |
|
| 3180 | + * |
|
| 3181 | + * @param array $rules |
|
| 3182 | + * |
|
| 3183 | + * @since 1.0.20 |
|
| 3184 | + * @return string |
|
| 3185 | + */ |
|
| 3186 | + public function get_instance_style($rules = array()){ |
|
| 3187 | + $css = ''; |
|
| 3188 | + |
|
| 3189 | + if(!empty($rules)){ |
|
| 3190 | + $rules = array_unique($rules); |
|
| 3191 | + $instance_hash = $this->get_instance_hash(); |
|
| 3192 | + $css .= "<style>"; |
|
| 3193 | + foreach($rules as $rule){ |
|
| 3194 | + $css .= ".sdel-$instance_hash $rule"; |
|
| 3195 | + } |
|
| 3196 | + $css .= "</style>"; |
|
| 3197 | + } |
|
| 3198 | + |
|
| 3199 | + |
|
| 3200 | + return $css; |
|
| 3201 | + |
|
| 3202 | + } |
|
| 3203 | + |
|
| 3204 | + } |
|
| 3205 | 3205 | |
| 3206 | 3206 | } |
@@ -12,8 +12,8 @@ discard block |
||
| 12 | 12 | class InstalledVersions |
| 13 | 13 | { |
| 14 | 14 | private static $installed = array ( |
| 15 | - 'root' => |
|
| 16 | - array ( |
|
| 15 | + 'root' => |
|
| 16 | + array ( |
|
| 17 | 17 | 'pretty_version' => 'dev-master', |
| 18 | 18 | 'version' => 'dev-master', |
| 19 | 19 | 'aliases' => |
@@ -21,87 +21,87 @@ discard block |
||
| 21 | 21 | ), |
| 22 | 22 | 'reference' => '2dc6617c620fa607652b525655f93bb849086724', |
| 23 | 23 | 'name' => 'ayecode/invoicing', |
| 24 | - ), |
|
| 25 | - 'versions' => |
|
| 26 | - array ( |
|
| 24 | + ), |
|
| 25 | + 'versions' => |
|
| 26 | + array ( |
|
| 27 | 27 | 'ayecode/ayecode-connect-helper' => |
| 28 | 28 | array ( |
| 29 | - 'pretty_version' => '1.0.3', |
|
| 30 | - 'version' => '1.0.3.0', |
|
| 31 | - 'aliases' => |
|
| 32 | - array ( |
|
| 33 | - ), |
|
| 34 | - 'reference' => '1af7cdefdbd20d4443a3ab4834e4c1cd8fe57fb4', |
|
| 29 | + 'pretty_version' => '1.0.3', |
|
| 30 | + 'version' => '1.0.3.0', |
|
| 31 | + 'aliases' => |
|
| 32 | + array ( |
|
| 33 | + ), |
|
| 34 | + 'reference' => '1af7cdefdbd20d4443a3ab4834e4c1cd8fe57fb4', |
|
| 35 | 35 | ), |
| 36 | 36 | 'ayecode/invoicing' => |
| 37 | 37 | array ( |
| 38 | - 'pretty_version' => 'dev-master', |
|
| 39 | - 'version' => 'dev-master', |
|
| 40 | - 'aliases' => |
|
| 41 | - array ( |
|
| 42 | - ), |
|
| 43 | - 'reference' => '2dc6617c620fa607652b525655f93bb849086724', |
|
| 38 | + 'pretty_version' => 'dev-master', |
|
| 39 | + 'version' => 'dev-master', |
|
| 40 | + 'aliases' => |
|
| 41 | + array ( |
|
| 42 | + ), |
|
| 43 | + 'reference' => '2dc6617c620fa607652b525655f93bb849086724', |
|
| 44 | 44 | ), |
| 45 | 45 | 'ayecode/wp-ayecode-ui' => |
| 46 | 46 | array ( |
| 47 | - 'pretty_version' => '0.1.38', |
|
| 48 | - 'version' => '0.1.38.0', |
|
| 49 | - 'aliases' => |
|
| 50 | - array ( |
|
| 51 | - ), |
|
| 52 | - 'reference' => '9e4660c69735e18fd49762a7a230fd2ba070c5ec', |
|
| 47 | + 'pretty_version' => '0.1.38', |
|
| 48 | + 'version' => '0.1.38.0', |
|
| 49 | + 'aliases' => |
|
| 50 | + array ( |
|
| 51 | + ), |
|
| 52 | + 'reference' => '9e4660c69735e18fd49762a7a230fd2ba070c5ec', |
|
| 53 | 53 | ), |
| 54 | 54 | 'ayecode/wp-font-awesome-settings' => |
| 55 | 55 | array ( |
| 56 | - 'pretty_version' => '1.0.12', |
|
| 57 | - 'version' => '1.0.12.0', |
|
| 58 | - 'aliases' => |
|
| 59 | - array ( |
|
| 60 | - ), |
|
| 61 | - 'reference' => '754cca6fda775f3e0b56b90a810dfcaea62ea288', |
|
| 56 | + 'pretty_version' => '1.0.12', |
|
| 57 | + 'version' => '1.0.12.0', |
|
| 58 | + 'aliases' => |
|
| 59 | + array ( |
|
| 60 | + ), |
|
| 61 | + 'reference' => '754cca6fda775f3e0b56b90a810dfcaea62ea288', |
|
| 62 | 62 | ), |
| 63 | 63 | 'ayecode/wp-super-duper' => |
| 64 | 64 | array ( |
| 65 | - 'pretty_version' => '1.0.23', |
|
| 66 | - 'version' => '1.0.23.0', |
|
| 67 | - 'aliases' => |
|
| 68 | - array ( |
|
| 69 | - ), |
|
| 70 | - 'reference' => '9473c0b7cf3ef4c32374222994a3e4613cdaeb48', |
|
| 65 | + 'pretty_version' => '1.0.23', |
|
| 66 | + 'version' => '1.0.23.0', |
|
| 67 | + 'aliases' => |
|
| 68 | + array ( |
|
| 69 | + ), |
|
| 70 | + 'reference' => '9473c0b7cf3ef4c32374222994a3e4613cdaeb48', |
|
| 71 | 71 | ), |
| 72 | 72 | 'composer/installers' => |
| 73 | 73 | array ( |
| 74 | - 'pretty_version' => 'v1.9.0', |
|
| 75 | - 'version' => '1.9.0.0', |
|
| 76 | - 'aliases' => |
|
| 77 | - array ( |
|
| 78 | - ), |
|
| 79 | - 'reference' => 'b93bcf0fa1fccb0b7d176b0967d969691cd74cca', |
|
| 74 | + 'pretty_version' => 'v1.9.0', |
|
| 75 | + 'version' => '1.9.0.0', |
|
| 76 | + 'aliases' => |
|
| 77 | + array ( |
|
| 78 | + ), |
|
| 79 | + 'reference' => 'b93bcf0fa1fccb0b7d176b0967d969691cd74cca', |
|
| 80 | 80 | ), |
| 81 | 81 | 'maxmind-db/reader' => |
| 82 | 82 | array ( |
| 83 | - 'pretty_version' => 'v1.6.0', |
|
| 84 | - 'version' => '1.6.0.0', |
|
| 85 | - 'aliases' => |
|
| 86 | - array ( |
|
| 87 | - ), |
|
| 88 | - 'reference' => 'febd4920bf17c1da84cef58e56a8227dfb37fbe4', |
|
| 83 | + 'pretty_version' => 'v1.6.0', |
|
| 84 | + 'version' => '1.6.0.0', |
|
| 85 | + 'aliases' => |
|
| 86 | + array ( |
|
| 87 | + ), |
|
| 88 | + 'reference' => 'febd4920bf17c1da84cef58e56a8227dfb37fbe4', |
|
| 89 | 89 | ), |
| 90 | 90 | 'roundcube/plugin-installer' => |
| 91 | 91 | array ( |
| 92 | - 'replaced' => |
|
| 93 | - array ( |
|
| 92 | + 'replaced' => |
|
| 93 | + array ( |
|
| 94 | 94 | 0 => '*', |
| 95 | - ), |
|
| 95 | + ), |
|
| 96 | 96 | ), |
| 97 | 97 | 'shama/baton' => |
| 98 | 98 | array ( |
| 99 | - 'replaced' => |
|
| 100 | - array ( |
|
| 99 | + 'replaced' => |
|
| 100 | + array ( |
|
| 101 | 101 | 0 => '*', |
| 102 | - ), |
|
| 102 | + ), |
|
| 103 | + ), |
|
| 103 | 104 | ), |
| 104 | - ), |
|
| 105 | 105 | ); |
| 106 | 106 | |
| 107 | 107 | |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php return array ( |
| 2 | - 'root' => |
|
| 3 | - array ( |
|
| 2 | + 'root' => |
|
| 3 | + array ( |
|
| 4 | 4 | 'pretty_version' => 'dev-master', |
| 5 | 5 | 'version' => 'dev-master', |
| 6 | 6 | 'aliases' => |
@@ -8,85 +8,85 @@ discard block |
||
| 8 | 8 | ), |
| 9 | 9 | 'reference' => '2dc6617c620fa607652b525655f93bb849086724', |
| 10 | 10 | 'name' => 'ayecode/invoicing', |
| 11 | - ), |
|
| 12 | - 'versions' => |
|
| 13 | - array ( |
|
| 11 | + ), |
|
| 12 | + 'versions' => |
|
| 13 | + array ( |
|
| 14 | 14 | 'ayecode/ayecode-connect-helper' => |
| 15 | 15 | array ( |
| 16 | - 'pretty_version' => '1.0.3', |
|
| 17 | - 'version' => '1.0.3.0', |
|
| 18 | - 'aliases' => |
|
| 19 | - array ( |
|
| 20 | - ), |
|
| 21 | - 'reference' => '1af7cdefdbd20d4443a3ab4834e4c1cd8fe57fb4', |
|
| 16 | + 'pretty_version' => '1.0.3', |
|
| 17 | + 'version' => '1.0.3.0', |
|
| 18 | + 'aliases' => |
|
| 19 | + array ( |
|
| 20 | + ), |
|
| 21 | + 'reference' => '1af7cdefdbd20d4443a3ab4834e4c1cd8fe57fb4', |
|
| 22 | 22 | ), |
| 23 | 23 | 'ayecode/invoicing' => |
| 24 | 24 | array ( |
| 25 | - 'pretty_version' => 'dev-master', |
|
| 26 | - 'version' => 'dev-master', |
|
| 27 | - 'aliases' => |
|
| 28 | - array ( |
|
| 29 | - ), |
|
| 30 | - 'reference' => '2dc6617c620fa607652b525655f93bb849086724', |
|
| 25 | + 'pretty_version' => 'dev-master', |
|
| 26 | + 'version' => 'dev-master', |
|
| 27 | + 'aliases' => |
|
| 28 | + array ( |
|
| 29 | + ), |
|
| 30 | + 'reference' => '2dc6617c620fa607652b525655f93bb849086724', |
|
| 31 | 31 | ), |
| 32 | 32 | 'ayecode/wp-ayecode-ui' => |
| 33 | 33 | array ( |
| 34 | - 'pretty_version' => '0.1.38', |
|
| 35 | - 'version' => '0.1.38.0', |
|
| 36 | - 'aliases' => |
|
| 37 | - array ( |
|
| 38 | - ), |
|
| 39 | - 'reference' => '9e4660c69735e18fd49762a7a230fd2ba070c5ec', |
|
| 34 | + 'pretty_version' => '0.1.38', |
|
| 35 | + 'version' => '0.1.38.0', |
|
| 36 | + 'aliases' => |
|
| 37 | + array ( |
|
| 38 | + ), |
|
| 39 | + 'reference' => '9e4660c69735e18fd49762a7a230fd2ba070c5ec', |
|
| 40 | 40 | ), |
| 41 | 41 | 'ayecode/wp-font-awesome-settings' => |
| 42 | 42 | array ( |
| 43 | - 'pretty_version' => '1.0.12', |
|
| 44 | - 'version' => '1.0.12.0', |
|
| 45 | - 'aliases' => |
|
| 46 | - array ( |
|
| 47 | - ), |
|
| 48 | - 'reference' => '754cca6fda775f3e0b56b90a810dfcaea62ea288', |
|
| 43 | + 'pretty_version' => '1.0.12', |
|
| 44 | + 'version' => '1.0.12.0', |
|
| 45 | + 'aliases' => |
|
| 46 | + array ( |
|
| 47 | + ), |
|
| 48 | + 'reference' => '754cca6fda775f3e0b56b90a810dfcaea62ea288', |
|
| 49 | 49 | ), |
| 50 | 50 | 'ayecode/wp-super-duper' => |
| 51 | 51 | array ( |
| 52 | - 'pretty_version' => '1.0.23', |
|
| 53 | - 'version' => '1.0.23.0', |
|
| 54 | - 'aliases' => |
|
| 55 | - array ( |
|
| 56 | - ), |
|
| 57 | - 'reference' => '9473c0b7cf3ef4c32374222994a3e4613cdaeb48', |
|
| 52 | + 'pretty_version' => '1.0.23', |
|
| 53 | + 'version' => '1.0.23.0', |
|
| 54 | + 'aliases' => |
|
| 55 | + array ( |
|
| 56 | + ), |
|
| 57 | + 'reference' => '9473c0b7cf3ef4c32374222994a3e4613cdaeb48', |
|
| 58 | 58 | ), |
| 59 | 59 | 'composer/installers' => |
| 60 | 60 | array ( |
| 61 | - 'pretty_version' => 'v1.9.0', |
|
| 62 | - 'version' => '1.9.0.0', |
|
| 63 | - 'aliases' => |
|
| 64 | - array ( |
|
| 65 | - ), |
|
| 66 | - 'reference' => 'b93bcf0fa1fccb0b7d176b0967d969691cd74cca', |
|
| 61 | + 'pretty_version' => 'v1.9.0', |
|
| 62 | + 'version' => '1.9.0.0', |
|
| 63 | + 'aliases' => |
|
| 64 | + array ( |
|
| 65 | + ), |
|
| 66 | + 'reference' => 'b93bcf0fa1fccb0b7d176b0967d969691cd74cca', |
|
| 67 | 67 | ), |
| 68 | 68 | 'maxmind-db/reader' => |
| 69 | 69 | array ( |
| 70 | - 'pretty_version' => 'v1.6.0', |
|
| 71 | - 'version' => '1.6.0.0', |
|
| 72 | - 'aliases' => |
|
| 73 | - array ( |
|
| 74 | - ), |
|
| 75 | - 'reference' => 'febd4920bf17c1da84cef58e56a8227dfb37fbe4', |
|
| 70 | + 'pretty_version' => 'v1.6.0', |
|
| 71 | + 'version' => '1.6.0.0', |
|
| 72 | + 'aliases' => |
|
| 73 | + array ( |
|
| 74 | + ), |
|
| 75 | + 'reference' => 'febd4920bf17c1da84cef58e56a8227dfb37fbe4', |
|
| 76 | 76 | ), |
| 77 | 77 | 'roundcube/plugin-installer' => |
| 78 | 78 | array ( |
| 79 | - 'replaced' => |
|
| 80 | - array ( |
|
| 79 | + 'replaced' => |
|
| 80 | + array ( |
|
| 81 | 81 | 0 => '*', |
| 82 | - ), |
|
| 82 | + ), |
|
| 83 | 83 | ), |
| 84 | 84 | 'shama/baton' => |
| 85 | 85 | array ( |
| 86 | - 'replaced' => |
|
| 87 | - array ( |
|
| 86 | + 'replaced' => |
|
| 87 | + array ( |
|
| 88 | 88 | 0 => '*', |
| 89 | - ), |
|
| 89 | + ), |
|
| 90 | + ), |
|
| 90 | 91 | ), |
| 91 | - ), |
|
| 92 | 92 | ); |
@@ -18,176 +18,176 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Reports_Controller extends GetPaid_REST_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Registers the routes for the objects of the controller. |
|
| 30 | - * |
|
| 31 | - * @since 2.0.0 |
|
| 32 | - * |
|
| 33 | - * @see register_rest_route() |
|
| 34 | - */ |
|
| 35 | - public function register_namespace_routes( $namespace ) { |
|
| 36 | - |
|
| 37 | - // List all available reports. |
|
| 38 | - register_rest_route( |
|
| 39 | - $namespace, |
|
| 40 | - $this->rest_base, |
|
| 41 | - array( |
|
| 42 | - array( |
|
| 43 | - 'methods' => WP_REST_Server::READABLE, |
|
| 44 | - 'callback' => array( $this, 'get_items' ), |
|
| 45 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | - 'args' => $this->get_collection_params(), |
|
| 47 | - ), |
|
| 48 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | - ) |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Makes sure the current user has access to READ the report APIs. |
|
| 56 | - * |
|
| 57 | - * @since 2.0.0 |
|
| 58 | - * @param WP_REST_Request $request Full data about the request. |
|
| 59 | - * @return WP_Error|boolean |
|
| 60 | - */ |
|
| 61 | - public function get_items_permissions_check( $request ) { |
|
| 62 | - |
|
| 63 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - return true; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Get reports list. |
|
| 72 | - * |
|
| 73 | - * @since 2.0.0 |
|
| 74 | - * @return array |
|
| 75 | - */ |
|
| 76 | - protected function get_reports() { |
|
| 77 | - |
|
| 78 | - $reports = array( |
|
| 79 | - array( |
|
| 80 | - 'slug' => 'sales', |
|
| 81 | - 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | - ), |
|
| 83 | - array( |
|
| 84 | - 'slug' => 'top_sellers', |
|
| 85 | - 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | - ), |
|
| 87 | - array( |
|
| 88 | - 'slug' => 'top_earners', |
|
| 89 | - 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | - ), |
|
| 91 | - array( |
|
| 92 | - 'slug' => 'invoices/counts', |
|
| 93 | - 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | - ), |
|
| 95 | - ); |
|
| 96 | - |
|
| 97 | - return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | - |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Get all reports. |
|
| 103 | - * |
|
| 104 | - * @since 2.0.0 |
|
| 105 | - * @param WP_REST_Request $request |
|
| 106 | - * @return array|WP_Error |
|
| 107 | - */ |
|
| 108 | - public function get_items( $request ) { |
|
| 109 | - $data = array(); |
|
| 110 | - $reports = $this->get_reports(); |
|
| 111 | - |
|
| 112 | - foreach ( $reports as $report ) { |
|
| 113 | - $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - return rest_ensure_response( $data ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * Prepare a report object for serialization. |
|
| 122 | - * |
|
| 123 | - * @since 2.0.0 |
|
| 124 | - * @param stdClass $report Report data. |
|
| 125 | - * @param WP_REST_Request $request Request object. |
|
| 126 | - * @return WP_REST_Response $response Response data. |
|
| 127 | - */ |
|
| 128 | - public function prepare_item_for_response( $report, $request ) { |
|
| 129 | - $data = array( |
|
| 130 | - 'slug' => $report->slug, |
|
| 131 | - 'description' => $report->description, |
|
| 132 | - ); |
|
| 133 | - |
|
| 134 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | - |
|
| 138 | - // Wrap the data in a response object. |
|
| 139 | - $response = rest_ensure_response( $data ); |
|
| 140 | - $response->add_links( array( |
|
| 141 | - 'self' => array( |
|
| 142 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | - ), |
|
| 144 | - 'collection' => array( |
|
| 145 | - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | - ), |
|
| 147 | - ) ); |
|
| 148 | - |
|
| 149 | - return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 154 | - * |
|
| 155 | - * @since 2.0.0 |
|
| 156 | - * @return array |
|
| 157 | - */ |
|
| 158 | - public function get_item_schema() { |
|
| 159 | - $schema = array( |
|
| 160 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 161 | - 'title' => 'report', |
|
| 162 | - 'type' => 'object', |
|
| 163 | - 'properties' => array( |
|
| 164 | - 'slug' => array( |
|
| 165 | - 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 166 | - 'type' => 'string', |
|
| 167 | - 'context' => array( 'view' ), |
|
| 168 | - 'readonly' => true, |
|
| 169 | - ), |
|
| 170 | - 'description' => array( |
|
| 171 | - 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 172 | - 'type' => 'string', |
|
| 173 | - 'context' => array( 'view' ), |
|
| 174 | - 'readonly' => true, |
|
| 175 | - ), |
|
| 176 | - ), |
|
| 177 | - ); |
|
| 178 | - |
|
| 179 | - return $this->add_additional_fields_schema( $schema ); |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - /** |
|
| 183 | - * Get the query params for collections. |
|
| 184 | - * |
|
| 185 | - * @since 2.0.0 |
|
| 186 | - * @return array |
|
| 187 | - */ |
|
| 188 | - public function get_collection_params() { |
|
| 189 | - return array( |
|
| 190 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 191 | - ); |
|
| 192 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Registers the routes for the objects of the controller. |
|
| 30 | + * |
|
| 31 | + * @since 2.0.0 |
|
| 32 | + * |
|
| 33 | + * @see register_rest_route() |
|
| 34 | + */ |
|
| 35 | + public function register_namespace_routes( $namespace ) { |
|
| 36 | + |
|
| 37 | + // List all available reports. |
|
| 38 | + register_rest_route( |
|
| 39 | + $namespace, |
|
| 40 | + $this->rest_base, |
|
| 41 | + array( |
|
| 42 | + array( |
|
| 43 | + 'methods' => WP_REST_Server::READABLE, |
|
| 44 | + 'callback' => array( $this, 'get_items' ), |
|
| 45 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 46 | + 'args' => $this->get_collection_params(), |
|
| 47 | + ), |
|
| 48 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 49 | + ) |
|
| 50 | + ); |
|
| 51 | + |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Makes sure the current user has access to READ the report APIs. |
|
| 56 | + * |
|
| 57 | + * @since 2.0.0 |
|
| 58 | + * @param WP_REST_Request $request Full data about the request. |
|
| 59 | + * @return WP_Error|boolean |
|
| 60 | + */ |
|
| 61 | + public function get_items_permissions_check( $request ) { |
|
| 62 | + |
|
| 63 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 64 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + return true; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Get reports list. |
|
| 72 | + * |
|
| 73 | + * @since 2.0.0 |
|
| 74 | + * @return array |
|
| 75 | + */ |
|
| 76 | + protected function get_reports() { |
|
| 77 | + |
|
| 78 | + $reports = array( |
|
| 79 | + array( |
|
| 80 | + 'slug' => 'sales', |
|
| 81 | + 'description' => __( 'List of sales reports.', 'invoicing' ), |
|
| 82 | + ), |
|
| 83 | + array( |
|
| 84 | + 'slug' => 'top_sellers', |
|
| 85 | + 'description' => __( 'List of top selling items.', 'invoicing' ), |
|
| 86 | + ), |
|
| 87 | + array( |
|
| 88 | + 'slug' => 'top_earners', |
|
| 89 | + 'description' => __( 'List of top earning items.', 'invoicing' ), |
|
| 90 | + ), |
|
| 91 | + array( |
|
| 92 | + 'slug' => 'invoices/counts', |
|
| 93 | + 'description' => __( 'Invoice counts.', 'invoicing' ), |
|
| 94 | + ), |
|
| 95 | + ); |
|
| 96 | + |
|
| 97 | + return apply_filters( 'getpaid_available_api_reports', $reports ); |
|
| 98 | + |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Get all reports. |
|
| 103 | + * |
|
| 104 | + * @since 2.0.0 |
|
| 105 | + * @param WP_REST_Request $request |
|
| 106 | + * @return array|WP_Error |
|
| 107 | + */ |
|
| 108 | + public function get_items( $request ) { |
|
| 109 | + $data = array(); |
|
| 110 | + $reports = $this->get_reports(); |
|
| 111 | + |
|
| 112 | + foreach ( $reports as $report ) { |
|
| 113 | + $item = $this->prepare_item_for_response( (object) $report, $request ); |
|
| 114 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + return rest_ensure_response( $data ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * Prepare a report object for serialization. |
|
| 122 | + * |
|
| 123 | + * @since 2.0.0 |
|
| 124 | + * @param stdClass $report Report data. |
|
| 125 | + * @param WP_REST_Request $request Request object. |
|
| 126 | + * @return WP_REST_Response $response Response data. |
|
| 127 | + */ |
|
| 128 | + public function prepare_item_for_response( $report, $request ) { |
|
| 129 | + $data = array( |
|
| 130 | + 'slug' => $report->slug, |
|
| 131 | + 'description' => $report->description, |
|
| 132 | + ); |
|
| 133 | + |
|
| 134 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 135 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 136 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 137 | + |
|
| 138 | + // Wrap the data in a response object. |
|
| 139 | + $response = rest_ensure_response( $data ); |
|
| 140 | + $response->add_links( array( |
|
| 141 | + 'self' => array( |
|
| 142 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), |
|
| 143 | + ), |
|
| 144 | + 'collection' => array( |
|
| 145 | + 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), |
|
| 146 | + ), |
|
| 147 | + ) ); |
|
| 148 | + |
|
| 149 | + return apply_filters( 'getpaid_rest_prepare_report', $response, $report, $request ); |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 154 | + * |
|
| 155 | + * @since 2.0.0 |
|
| 156 | + * @return array |
|
| 157 | + */ |
|
| 158 | + public function get_item_schema() { |
|
| 159 | + $schema = array( |
|
| 160 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 161 | + 'title' => 'report', |
|
| 162 | + 'type' => 'object', |
|
| 163 | + 'properties' => array( |
|
| 164 | + 'slug' => array( |
|
| 165 | + 'description' => __( 'An alphanumeric identifier for the resource.', 'invoicing' ), |
|
| 166 | + 'type' => 'string', |
|
| 167 | + 'context' => array( 'view' ), |
|
| 168 | + 'readonly' => true, |
|
| 169 | + ), |
|
| 170 | + 'description' => array( |
|
| 171 | + 'description' => __( 'A human-readable description of the resource.', 'invoicing' ), |
|
| 172 | + 'type' => 'string', |
|
| 173 | + 'context' => array( 'view' ), |
|
| 174 | + 'readonly' => true, |
|
| 175 | + ), |
|
| 176 | + ), |
|
| 177 | + ); |
|
| 178 | + |
|
| 179 | + return $this->add_additional_fields_schema( $schema ); |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + /** |
|
| 183 | + * Get the query params for collections. |
|
| 184 | + * |
|
| 185 | + * @since 2.0.0 |
|
| 186 | + * @return array |
|
| 187 | + */ |
|
| 188 | + public function get_collection_params() { |
|
| 189 | + return array( |
|
| 190 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 191 | + ); |
|
| 192 | + } |
|
| 193 | 193 | } |
@@ -12,43 +12,43 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Report_Earnings extends GetPaid_Reports_Abstract_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Retrieves the earning graphs. |
|
| 17 | - * |
|
| 18 | - */ |
|
| 19 | - public function get_graphs() { |
|
| 15 | + /** |
|
| 16 | + * Retrieves the earning graphs. |
|
| 17 | + * |
|
| 18 | + */ |
|
| 19 | + public function get_graphs() { |
|
| 20 | 20 | |
| 21 | - $graphs = array( |
|
| 21 | + $graphs = array( |
|
| 22 | 22 | |
| 23 | 23 | 'total' => __( 'Earnings', 'invoicing' ), |
| 24 | 24 | 'discount' => __( 'Discount', 'invoicing' ), |
| 25 | - 'fees_total' => __( 'Fees', 'invoicing' ), |
|
| 26 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
| 25 | + 'fees_total' => __( 'Fees', 'invoicing' ), |
|
| 26 | + 'tax' => __( 'Tax', 'invoicing' ), |
|
| 27 | 27 | |
| 28 | - ); |
|
| 28 | + ); |
|
| 29 | 29 | |
| 30 | - return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
| 30 | + return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
| 31 | 31 | |
| 32 | - } |
|
| 32 | + } |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Retrieves the earning sql. |
|
| 36 | - * |
|
| 37 | - */ |
|
| 38 | - public function get_sql( $range ) { |
|
| 39 | - global $wpdb; |
|
| 34 | + /** |
|
| 35 | + * Retrieves the earning sql. |
|
| 36 | + * |
|
| 37 | + */ |
|
| 38 | + public function get_sql( $range ) { |
|
| 39 | + global $wpdb; |
|
| 40 | 40 | |
| 41 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 42 | - $clauses = $this->get_range_sql( $range ); |
|
| 43 | - $graphs = array_keys( $this->get_graphs() ); |
|
| 44 | - $graphs_sql = array(); |
|
| 41 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 42 | + $clauses = $this->get_range_sql( $range ); |
|
| 43 | + $graphs = array_keys( $this->get_graphs() ); |
|
| 44 | + $graphs_sql = array(); |
|
| 45 | 45 | |
| 46 | - foreach ( $graphs as $graph ) { |
|
| 47 | - $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
| 48 | - } |
|
| 46 | + foreach ( $graphs as $graph ) { |
|
| 47 | + $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - $graphs_sql = implode( ', ', $graphs_sql ); |
|
| 51 | - $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
| 50 | + $graphs_sql = implode( ', ', $graphs_sql ); |
|
| 51 | + $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
| 52 | 52 | FROM $wpdb->posts |
| 53 | 53 | LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID |
| 54 | 54 | WHERE meta.post_id IS NOT NULL |
@@ -58,94 +58,94 @@ discard block |
||
| 58 | 58 | GROUP BY {$clauses[0]} |
| 59 | 59 | "; |
| 60 | 60 | |
| 61 | - return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
| 62 | - |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Prepares the report stats. |
|
| 67 | - * |
|
| 68 | - */ |
|
| 69 | - public function prepare_stats() { |
|
| 70 | - global $wpdb; |
|
| 71 | - $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Retrieves report labels. |
|
| 76 | - * |
|
| 77 | - */ |
|
| 78 | - public function get_labels( $range ) { |
|
| 79 | - |
|
| 80 | - $labels = array( |
|
| 81 | - 'today' => $this->get_hours_in_a_day(), |
|
| 82 | - 'yesterday' => $this->get_hours_in_a_day(), |
|
| 83 | - '7_days' => $this->get_days_in_period( 7 ), |
|
| 84 | - '30_days' => $this->get_days_in_period( 30 ), |
|
| 85 | - '60_days' => $this->get_days_in_period( 60 ), |
|
| 86 | - '90_days' => $this->get_weeks_in_period( 90 ), |
|
| 87 | - '180_days' => $this->get_weeks_in_period( 180 ), |
|
| 88 | - '360_days' => $this->get_weeks_in_period( 360 ), |
|
| 89 | - ); |
|
| 90 | - |
|
| 91 | - $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
| 92 | - return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Retrieves report datasets. |
|
| 97 | - * |
|
| 98 | - */ |
|
| 99 | - public function get_datasets( $labels ) { |
|
| 100 | - |
|
| 101 | - $datasets = array(); |
|
| 102 | - |
|
| 103 | - foreach ( $this->get_graphs() as $key => $label ) { |
|
| 104 | - $datasets[ $key ] = array( |
|
| 105 | - 'label' => $label, |
|
| 106 | - 'data' => $this->get_data( $key, $labels ) |
|
| 107 | - ); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Retrieves report data. |
|
| 115 | - * |
|
| 116 | - */ |
|
| 117 | - public function get_data( $key, $labels ) { |
|
| 118 | - |
|
| 119 | - $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
| 120 | - $prepared = array(); |
|
| 121 | - |
|
| 122 | - foreach ( $labels as $label ) { |
|
| 123 | - |
|
| 124 | - $value = 0; |
|
| 125 | - if ( isset( $data[ $label ] ) ) { |
|
| 126 | - $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - $prepared[] = $value; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
| 133 | - |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Displays the report card. |
|
| 138 | - * |
|
| 139 | - */ |
|
| 140 | - public function display() { |
|
| 141 | - |
|
| 142 | - $labels = $this->get_labels( $this->get_range() ); |
|
| 143 | - $chart_data = array( |
|
| 144 | - 'labels' => array_values( $labels ), |
|
| 145 | - 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - ?> |
|
| 61 | + return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
| 62 | + |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Prepares the report stats. |
|
| 67 | + * |
|
| 68 | + */ |
|
| 69 | + public function prepare_stats() { |
|
| 70 | + global $wpdb; |
|
| 71 | + $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Retrieves report labels. |
|
| 76 | + * |
|
| 77 | + */ |
|
| 78 | + public function get_labels( $range ) { |
|
| 79 | + |
|
| 80 | + $labels = array( |
|
| 81 | + 'today' => $this->get_hours_in_a_day(), |
|
| 82 | + 'yesterday' => $this->get_hours_in_a_day(), |
|
| 83 | + '7_days' => $this->get_days_in_period( 7 ), |
|
| 84 | + '30_days' => $this->get_days_in_period( 30 ), |
|
| 85 | + '60_days' => $this->get_days_in_period( 60 ), |
|
| 86 | + '90_days' => $this->get_weeks_in_period( 90 ), |
|
| 87 | + '180_days' => $this->get_weeks_in_period( 180 ), |
|
| 88 | + '360_days' => $this->get_weeks_in_period( 360 ), |
|
| 89 | + ); |
|
| 90 | + |
|
| 91 | + $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
| 92 | + return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Retrieves report datasets. |
|
| 97 | + * |
|
| 98 | + */ |
|
| 99 | + public function get_datasets( $labels ) { |
|
| 100 | + |
|
| 101 | + $datasets = array(); |
|
| 102 | + |
|
| 103 | + foreach ( $this->get_graphs() as $key => $label ) { |
|
| 104 | + $datasets[ $key ] = array( |
|
| 105 | + 'label' => $label, |
|
| 106 | + 'data' => $this->get_data( $key, $labels ) |
|
| 107 | + ); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Retrieves report data. |
|
| 115 | + * |
|
| 116 | + */ |
|
| 117 | + public function get_data( $key, $labels ) { |
|
| 118 | + |
|
| 119 | + $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
| 120 | + $prepared = array(); |
|
| 121 | + |
|
| 122 | + foreach ( $labels as $label ) { |
|
| 123 | + |
|
| 124 | + $value = 0; |
|
| 125 | + if ( isset( $data[ $label ] ) ) { |
|
| 126 | + $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + $prepared[] = $value; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
| 133 | + |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Displays the report card. |
|
| 138 | + * |
|
| 139 | + */ |
|
| 140 | + public function display() { |
|
| 141 | + |
|
| 142 | + $labels = $this->get_labels( $this->get_range() ); |
|
| 143 | + $chart_data = array( |
|
| 144 | + 'labels' => array_values( $labels ), |
|
| 145 | + 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + ?> |
|
| 149 | 149 | |
| 150 | 150 | <?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?> |
| 151 | 151 | <div class="row mb-4"> |
@@ -165,15 +165,15 @@ discard block |
||
| 165 | 165 | |
| 166 | 166 | <?php |
| 167 | 167 | |
| 168 | - } |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - /** |
|
| 171 | - * Displays the actual report. |
|
| 172 | - * |
|
| 173 | - */ |
|
| 174 | - public function display_graph( $key, $dataset, $labels ) { |
|
| 170 | + /** |
|
| 171 | + * Displays the actual report. |
|
| 172 | + * |
|
| 173 | + */ |
|
| 174 | + public function display_graph( $key, $dataset, $labels ) { |
|
| 175 | 175 | |
| 176 | - ?> |
|
| 176 | + ?> |
|
| 177 | 177 | |
| 178 | 178 | <canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas> |
| 179 | 179 | |
@@ -223,20 +223,20 @@ discard block |
||
| 223 | 223 | </script> |
| 224 | 224 | |
| 225 | 225 | <?php |
| 226 | - } |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - /** |
|
| 229 | - * Displays the actual report. |
|
| 230 | - * |
|
| 231 | - */ |
|
| 232 | - public function display_stats() {} |
|
| 228 | + /** |
|
| 229 | + * Displays the actual report. |
|
| 230 | + * |
|
| 231 | + */ |
|
| 232 | + public function display_stats() {} |
|
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Displays the range selector. |
|
| 236 | - * |
|
| 237 | - */ |
|
| 238 | - public function display_range_selector() { |
|
| 234 | + /** |
|
| 235 | + * Displays the range selector. |
|
| 236 | + * |
|
| 237 | + */ |
|
| 238 | + public function display_range_selector() { |
|
| 239 | 239 | |
| 240 | - } |
|
| 240 | + } |
|
| 241 | 241 | |
| 242 | 242 | } |
@@ -18,664 +18,664 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/sales'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * The report data. |
|
| 30 | - * |
|
| 31 | - * @var stdClass |
|
| 32 | - */ |
|
| 33 | - protected $report_data; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * The report range. |
|
| 37 | - * |
|
| 38 | - * @var array |
|
| 39 | - */ |
|
| 40 | - protected $report_range; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Registers the routes for the objects of the controller. |
|
| 44 | - * |
|
| 45 | - * @since 2.0.0 |
|
| 46 | - * |
|
| 47 | - * @see register_rest_route() |
|
| 48 | - */ |
|
| 49 | - public function register_namespace_routes( $namespace ) { |
|
| 50 | - |
|
| 51 | - // Get sales report. |
|
| 52 | - register_rest_route( |
|
| 53 | - $namespace, |
|
| 54 | - $this->rest_base, |
|
| 55 | - array( |
|
| 56 | - array( |
|
| 57 | - 'methods' => WP_REST_Server::READABLE, |
|
| 58 | - 'callback' => array( $this, 'get_items' ), |
|
| 59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | - 'args' => $this->get_collection_params(), |
|
| 61 | - ), |
|
| 62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Makes sure the current user has access to READ the report APIs. |
|
| 70 | - * |
|
| 71 | - * @since 2.0.0 |
|
| 72 | - * @param WP_REST_Request $request Full data about the request. |
|
| 73 | - * @return WP_Error|boolean |
|
| 74 | - */ |
|
| 75 | - public function get_items_permissions_check( $request ) { |
|
| 76 | - |
|
| 77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Get sales reports. |
|
| 86 | - * |
|
| 87 | - * @param WP_REST_Request $request |
|
| 88 | - * @return array|WP_Error |
|
| 89 | - */ |
|
| 90 | - public function get_items( $request ) { |
|
| 91 | - $data = array(); |
|
| 92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | - |
|
| 95 | - return rest_ensure_response( $data ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Prepare a report sales object for serialization. |
|
| 100 | - * |
|
| 101 | - * @param null $_ |
|
| 102 | - * @param WP_REST_Request $request Request object. |
|
| 103 | - * @return WP_REST_Response $response Response data. |
|
| 104 | - */ |
|
| 105 | - public function prepare_item_for_response( $_, $request ) { |
|
| 106 | - |
|
| 107 | - // Set report range. |
|
| 108 | - $this->report_range = $this->get_date_range( $request ); |
|
| 109 | - |
|
| 110 | - $report_data = $this->get_report_data(); |
|
| 111 | - $period_totals = array(); |
|
| 112 | - |
|
| 113 | - // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | - $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | - |
|
| 116 | - if ( 'month' === $this->groupby ) { |
|
| 117 | - $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | - |
|
| 122 | - switch ( $this->groupby ) { |
|
| 123 | - case 'day' : |
|
| 124 | - $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | - break; |
|
| 126 | - default : |
|
| 127 | - $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | - break; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - // Set the defaults for each period. |
|
| 132 | - $period_totals[ $time ] = array( |
|
| 133 | - 'sales' => wpinv_round_amount( 0.00 ), |
|
| 134 | - 'invoices' => 0, |
|
| 135 | - 'refunds' => wpinv_round_amount( 0.00 ), |
|
| 136 | - 'items' => 0, |
|
| 137 | - 'refunded_items' => 0, |
|
| 138 | - 'tax' => wpinv_round_amount( 0.00 ), |
|
| 139 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 140 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 141 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 142 | - 'fees' => wpinv_round_amount( 0.00 ), |
|
| 143 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 144 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
| 145 | - ); |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - // add total sales, total invoice count, total tax for each period |
|
| 150 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 151 | - foreach ( $report_data->invoices as $invoice ) { |
|
| 152 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 153 | - |
|
| 154 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 155 | - continue; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 159 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 160 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 161 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 162 | - |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - foreach ( $report_data->refunds as $invoice ) { |
|
| 166 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 167 | - |
|
| 168 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 169 | - continue; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 173 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 174 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 175 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 176 | - |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 180 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 181 | - |
|
| 182 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 183 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - // Add total invoice items for each period. |
|
| 189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 190 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 191 | - |
|
| 192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - // Add total discount for each period. |
|
| 199 | - foreach ( $report_data->coupons as $discount ) { |
|
| 200 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 201 | - |
|
| 202 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 203 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - $report_data->totals = $period_totals; |
|
| 209 | - $report_data->grouped_by = $this->groupby; |
|
| 210 | - $report_data->interval = max( $this->interval, 1 ); |
|
| 211 | - $report_data->currency = wpinv_get_currency(); |
|
| 212 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 213 | - $report_data->currency_position = wpinv_currency_position(); |
|
| 214 | - $report_data->decimal_places = wpinv_decimals(); |
|
| 215 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 216 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 217 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 218 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 219 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 220 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 221 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 222 | - |
|
| 223 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 224 | - $data = $report_data; |
|
| 225 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 226 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 227 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 228 | - |
|
| 229 | - // Wrap the data in a response object. |
|
| 230 | - $response = rest_ensure_response( $data ); |
|
| 231 | - $response->add_links( array( |
|
| 232 | - 'about' => array( |
|
| 233 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 234 | - ), |
|
| 235 | - ) ); |
|
| 236 | - |
|
| 237 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * Get report data. |
|
| 242 | - * |
|
| 243 | - * @return stdClass |
|
| 244 | - */ |
|
| 245 | - public function get_report_data() { |
|
| 246 | - if ( empty( $this->report_data ) ) { |
|
| 247 | - $this->query_report_data(); |
|
| 248 | - } |
|
| 249 | - return $this->report_data; |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Get all data needed for this report and store in the class. |
|
| 254 | - */ |
|
| 255 | - protected function query_report_data() { |
|
| 256 | - |
|
| 257 | - // Prepare reports. |
|
| 258 | - $this->report_data = (object) array( |
|
| 259 | - 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 260 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 261 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 262 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 263 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 264 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 265 | - 'previous_range' => $this->previous_range, |
|
| 266 | - ); |
|
| 267 | - |
|
| 268 | - // Calculated totals. |
|
| 269 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 270 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 271 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 272 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 273 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 274 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 275 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 276 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 277 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 278 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 279 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 280 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 281 | - |
|
| 282 | - |
|
| 283 | - // Calculate average based on net. |
|
| 284 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 285 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 286 | - |
|
| 287 | - // Total invoices in this period, even if refunded. |
|
| 288 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 289 | - |
|
| 290 | - // Items invoiced in this period, even if refunded. |
|
| 291 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 292 | - |
|
| 293 | - // 3rd party filtering of report data |
|
| 294 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Prepares invoice counts. |
|
| 299 | - * |
|
| 300 | - * @return array. |
|
| 301 | - */ |
|
| 302 | - protected function query_invoice_counts() { |
|
| 303 | - |
|
| 304 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 305 | - array( |
|
| 306 | - 'data' => array( |
|
| 307 | - 'ID' => array( |
|
| 308 | - 'type' => 'post_data', |
|
| 309 | - 'function' => 'COUNT', |
|
| 310 | - 'name' => 'count', |
|
| 311 | - 'distinct' => true, |
|
| 312 | - ), |
|
| 313 | - 'post_date' => array( |
|
| 314 | - 'type' => 'post_data', |
|
| 315 | - 'function' => '', |
|
| 316 | - 'name' => 'post_date', |
|
| 317 | - ), |
|
| 318 | - ), |
|
| 319 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 320 | - 'order_by' => 'post_date ASC', |
|
| 321 | - 'query_type' => 'get_results', |
|
| 322 | - 'filter_range' => $this->report_range, |
|
| 323 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 324 | - ) |
|
| 325 | - ); |
|
| 326 | - |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - /** |
|
| 330 | - * Prepares coupon counts. |
|
| 331 | - * |
|
| 332 | - * @return array. |
|
| 333 | - */ |
|
| 334 | - protected function query_coupon_counts() { |
|
| 335 | - |
|
| 336 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 337 | - array( |
|
| 338 | - 'data' => array( |
|
| 339 | - 'discount' => array( |
|
| 340 | - 'type' => 'invoice_data', |
|
| 341 | - 'function' => 'SUM', |
|
| 342 | - 'name' => 'discount_amount', |
|
| 343 | - ), |
|
| 344 | - 'post_date' => array( |
|
| 345 | - 'type' => 'post_data', |
|
| 346 | - 'function' => '', |
|
| 347 | - 'name' => 'post_date', |
|
| 348 | - ), |
|
| 349 | - ), |
|
| 350 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 351 | - 'order_by' => 'post_date ASC', |
|
| 352 | - 'query_type' => 'get_results', |
|
| 353 | - 'filter_range' => $this->report_range, |
|
| 354 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 355 | - ) |
|
| 356 | - ); |
|
| 357 | - |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * Prepares item counts. |
|
| 362 | - * |
|
| 363 | - * @return array. |
|
| 364 | - */ |
|
| 365 | - protected function query_item_counts() { |
|
| 366 | - |
|
| 367 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 368 | - array( |
|
| 369 | - 'data' => array( |
|
| 370 | - 'quantity' => array( |
|
| 371 | - 'type' => 'invoice_item', |
|
| 372 | - 'function' => 'SUM', |
|
| 373 | - 'name' => 'invoice_item_count', |
|
| 374 | - ), |
|
| 375 | - 'post_date' => array( |
|
| 376 | - 'type' => 'post_data', |
|
| 377 | - 'function' => '', |
|
| 378 | - 'name' => 'post_date', |
|
| 379 | - ), |
|
| 380 | - ), |
|
| 381 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 382 | - 'order_by' => 'post_date ASC', |
|
| 383 | - 'query_type' => 'get_results', |
|
| 384 | - 'filter_range' => $this->report_range, |
|
| 385 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 386 | - ) |
|
| 387 | - ); |
|
| 388 | - |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - /** |
|
| 392 | - * Prepares refunded item counts. |
|
| 393 | - * |
|
| 394 | - * @return array. |
|
| 395 | - */ |
|
| 396 | - protected function count_refunded_items() { |
|
| 397 | - |
|
| 398 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 399 | - array( |
|
| 400 | - 'data' => array( |
|
| 401 | - 'quantity' => array( |
|
| 402 | - 'type' => 'invoice_item', |
|
| 403 | - 'function' => 'SUM', |
|
| 404 | - 'name' => 'invoice_item_count', |
|
| 405 | - ), |
|
| 406 | - ), |
|
| 407 | - 'query_type' => 'get_var', |
|
| 408 | - 'filter_range' => $this->report_range, |
|
| 409 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 410 | - ) |
|
| 411 | - ); |
|
| 412 | - |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - /** |
|
| 416 | - * Prepares daily invoice totals. |
|
| 417 | - * |
|
| 418 | - * @return array. |
|
| 419 | - */ |
|
| 420 | - protected function query_invoice_totals() { |
|
| 421 | - |
|
| 422 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 423 | - array( |
|
| 424 | - 'data' => array( |
|
| 425 | - 'total' => array( |
|
| 426 | - 'type' => 'invoice_data', |
|
| 427 | - 'function' => 'SUM', |
|
| 428 | - 'name' => 'total_sales', |
|
| 429 | - ), |
|
| 430 | - 'tax' => array( |
|
| 431 | - 'type' => 'invoice_data', |
|
| 432 | - 'function' => 'SUM', |
|
| 433 | - 'name' => 'total_tax', |
|
| 434 | - ), |
|
| 435 | - 'discount' => array( |
|
| 436 | - 'type' => 'invoice_data', |
|
| 437 | - 'function' => 'SUM', |
|
| 438 | - 'name' => 'total_discount', |
|
| 439 | - ), |
|
| 440 | - 'fees_total' => array( |
|
| 441 | - 'type' => 'invoice_data', |
|
| 442 | - 'function' => 'SUM', |
|
| 443 | - 'name' => 'total_fees', |
|
| 444 | - ), |
|
| 445 | - 'subtotal' => array( |
|
| 446 | - 'type' => 'invoice_data', |
|
| 447 | - 'function' => 'SUM', |
|
| 448 | - 'name' => 'subtotal', |
|
| 449 | - ), |
|
| 450 | - 'post_date' => array( |
|
| 451 | - 'type' => 'post_data', |
|
| 452 | - 'function' => '', |
|
| 453 | - 'name' => 'post_date', |
|
| 454 | - ), |
|
| 455 | - ), |
|
| 456 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 457 | - 'order_by' => 'post_date ASC', |
|
| 458 | - 'query_type' => 'get_results', |
|
| 459 | - 'filter_range' => $this->report_range, |
|
| 460 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 461 | - ) |
|
| 462 | - ); |
|
| 463 | - |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - /** |
|
| 467 | - * Prepares daily invoice totals. |
|
| 468 | - * |
|
| 469 | - * @return array. |
|
| 470 | - */ |
|
| 471 | - protected function query_refunded_totals() { |
|
| 472 | - |
|
| 473 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 474 | - array( |
|
| 475 | - 'data' => array( |
|
| 476 | - 'total' => array( |
|
| 477 | - 'type' => 'invoice_data', |
|
| 478 | - 'function' => 'SUM', |
|
| 479 | - 'name' => 'total_sales', |
|
| 480 | - ), |
|
| 481 | - 'tax' => array( |
|
| 482 | - 'type' => 'invoice_data', |
|
| 483 | - 'function' => 'SUM', |
|
| 484 | - 'name' => 'total_tax', |
|
| 485 | - ), |
|
| 486 | - 'discount' => array( |
|
| 487 | - 'type' => 'invoice_data', |
|
| 488 | - 'function' => 'SUM', |
|
| 489 | - 'name' => 'total_discount', |
|
| 490 | - ), |
|
| 491 | - 'fees_total' => array( |
|
| 492 | - 'type' => 'invoice_data', |
|
| 493 | - 'function' => 'SUM', |
|
| 494 | - 'name' => 'total_fees', |
|
| 495 | - ), |
|
| 496 | - 'subtotal' => array( |
|
| 497 | - 'type' => 'invoice_data', |
|
| 498 | - 'function' => 'SUM', |
|
| 499 | - 'name' => 'subtotal', |
|
| 500 | - ), |
|
| 501 | - 'post_date' => array( |
|
| 502 | - 'type' => 'post_data', |
|
| 503 | - 'function' => '', |
|
| 504 | - 'name' => 'post_date', |
|
| 505 | - ), |
|
| 506 | - ), |
|
| 507 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 508 | - 'order_by' => 'post_date ASC', |
|
| 509 | - 'query_type' => 'get_results', |
|
| 510 | - 'filter_range' => $this->report_range, |
|
| 511 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 512 | - ) |
|
| 513 | - ); |
|
| 514 | - |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - /** |
|
| 518 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 519 | - * |
|
| 520 | - * @return array |
|
| 521 | - */ |
|
| 522 | - public function get_item_schema() { |
|
| 523 | - |
|
| 524 | - $schema = array( |
|
| 525 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 526 | - 'title' => 'sales_report', |
|
| 527 | - 'type' => 'object', |
|
| 528 | - 'properties' => array( |
|
| 529 | - 'total_sales' => array( |
|
| 530 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 531 | - 'type' => 'string', |
|
| 532 | - 'context' => array( 'view' ), |
|
| 533 | - 'readonly' => true, |
|
| 534 | - ), |
|
| 535 | - 'net_sales' => array( |
|
| 536 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 537 | - 'type' => 'string', |
|
| 538 | - 'context' => array( 'view' ), |
|
| 539 | - 'readonly' => true, |
|
| 540 | - ), |
|
| 541 | - 'average_sales' => array( |
|
| 542 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 543 | - 'type' => 'string', |
|
| 544 | - 'context' => array( 'view' ), |
|
| 545 | - 'readonly' => true, |
|
| 546 | - ), |
|
| 547 | - 'average_total_sales' => array( |
|
| 548 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 549 | - 'type' => 'string', |
|
| 550 | - 'context' => array( 'view' ), |
|
| 551 | - 'readonly' => true, |
|
| 552 | - ), |
|
| 553 | - 'total_invoices' => array( |
|
| 554 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 555 | - 'type' => 'integer', |
|
| 556 | - 'context' => array( 'view' ), |
|
| 557 | - 'readonly' => true, |
|
| 558 | - ), |
|
| 559 | - 'total_items' => array( |
|
| 560 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 561 | - 'type' => 'integer', |
|
| 562 | - 'context' => array( 'view' ), |
|
| 563 | - 'readonly' => true, |
|
| 564 | - ), |
|
| 565 | - 'refunded_items' => array( |
|
| 566 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 567 | - 'type' => 'integer', |
|
| 568 | - 'context' => array( 'view' ), |
|
| 569 | - 'readonly' => true, |
|
| 570 | - ), |
|
| 571 | - 'total_tax' => array( |
|
| 572 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 573 | - 'type' => 'string', |
|
| 574 | - 'context' => array( 'view' ), |
|
| 575 | - 'readonly' => true, |
|
| 576 | - ), |
|
| 577 | - 'total_refunded_tax' => array( |
|
| 578 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 579 | - 'type' => 'string', |
|
| 580 | - 'context' => array( 'view' ), |
|
| 581 | - 'readonly' => true, |
|
| 582 | - ), |
|
| 583 | - 'total_fees' => array( |
|
| 584 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 585 | - 'type' => 'string', |
|
| 586 | - 'context' => array( 'view' ), |
|
| 587 | - 'readonly' => true, |
|
| 588 | - ), |
|
| 589 | - 'total_refunds' => array( |
|
| 590 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 591 | - 'type' => 'integer', |
|
| 592 | - 'context' => array( 'view' ), |
|
| 593 | - 'readonly' => true, |
|
| 594 | - ), |
|
| 595 | - 'net_refunds' => array( |
|
| 596 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 597 | - 'type' => 'integer', |
|
| 598 | - 'context' => array( 'view' ), |
|
| 599 | - 'readonly' => true, |
|
| 600 | - ), |
|
| 601 | - 'total_discount' => array( |
|
| 602 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 603 | - 'type' => 'integer', |
|
| 604 | - 'context' => array( 'view' ), |
|
| 605 | - 'readonly' => true, |
|
| 606 | - ), |
|
| 607 | - 'totals' => array( |
|
| 608 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
| 609 | - 'type' => 'array', |
|
| 610 | - 'items' => array( |
|
| 611 | - 'type' => 'array', |
|
| 612 | - ), |
|
| 613 | - 'context' => array( 'view' ), |
|
| 614 | - 'readonly' => true, |
|
| 615 | - ), |
|
| 616 | - 'interval' => array( |
|
| 617 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 618 | - 'type' => 'integer', |
|
| 619 | - 'context' => array( 'view' ), |
|
| 620 | - 'readonly' => true, |
|
| 621 | - ), |
|
| 622 | - 'previous_range' => array( |
|
| 623 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 624 | - 'type' => 'array', |
|
| 625 | - 'items' => array( |
|
| 626 | - 'type' => 'string', |
|
| 627 | - ), |
|
| 628 | - 'context' => array( 'view' ), |
|
| 629 | - 'readonly' => true, |
|
| 630 | - ), |
|
| 631 | - 'grouped_by' => array( |
|
| 632 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 633 | - 'type' => 'string', |
|
| 634 | - 'context' => array( 'view' ), |
|
| 635 | - 'enum' => array( 'day', 'month' ), |
|
| 636 | - 'readonly' => true, |
|
| 637 | - ), |
|
| 638 | - 'currency' => array( |
|
| 639 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 640 | - 'type' => 'string', |
|
| 641 | - 'context' => array( 'view' ), |
|
| 642 | - 'readonly' => true, |
|
| 643 | - ), |
|
| 644 | - 'currency_symbol' => array( |
|
| 645 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 646 | - 'type' => 'string', |
|
| 647 | - 'context' => array( 'view' ), |
|
| 648 | - 'readonly' => true, |
|
| 649 | - ), |
|
| 650 | - 'currency_position' => array( |
|
| 651 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 652 | - 'type' => 'string', |
|
| 653 | - 'context' => array( 'view' ), |
|
| 654 | - 'readonly' => true, |
|
| 655 | - ), |
|
| 656 | - 'decimal_places' => array( |
|
| 657 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 658 | - 'type' => 'string', |
|
| 659 | - 'context' => array( 'view' ), |
|
| 660 | - 'readonly' => true, |
|
| 661 | - ), |
|
| 662 | - 'thousands_sep' => array( |
|
| 663 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 664 | - 'type' => 'string', |
|
| 665 | - 'context' => array( 'view' ), |
|
| 666 | - 'readonly' => true, |
|
| 667 | - ), |
|
| 668 | - 'decimals_sep' => array( |
|
| 669 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 670 | - 'type' => 'string', |
|
| 671 | - 'context' => array( 'view' ), |
|
| 672 | - 'readonly' => true, |
|
| 673 | - ), |
|
| 674 | - ), |
|
| 675 | - ); |
|
| 676 | - |
|
| 677 | - return $this->add_additional_fields_schema( $schema ); |
|
| 678 | - |
|
| 679 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/sales'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * The report data. |
|
| 30 | + * |
|
| 31 | + * @var stdClass |
|
| 32 | + */ |
|
| 33 | + protected $report_data; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * The report range. |
|
| 37 | + * |
|
| 38 | + * @var array |
|
| 39 | + */ |
|
| 40 | + protected $report_range; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Registers the routes for the objects of the controller. |
|
| 44 | + * |
|
| 45 | + * @since 2.0.0 |
|
| 46 | + * |
|
| 47 | + * @see register_rest_route() |
|
| 48 | + */ |
|
| 49 | + public function register_namespace_routes( $namespace ) { |
|
| 50 | + |
|
| 51 | + // Get sales report. |
|
| 52 | + register_rest_route( |
|
| 53 | + $namespace, |
|
| 54 | + $this->rest_base, |
|
| 55 | + array( |
|
| 56 | + array( |
|
| 57 | + 'methods' => WP_REST_Server::READABLE, |
|
| 58 | + 'callback' => array( $this, 'get_items' ), |
|
| 59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | + 'args' => $this->get_collection_params(), |
|
| 61 | + ), |
|
| 62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Makes sure the current user has access to READ the report APIs. |
|
| 70 | + * |
|
| 71 | + * @since 2.0.0 |
|
| 72 | + * @param WP_REST_Request $request Full data about the request. |
|
| 73 | + * @return WP_Error|boolean |
|
| 74 | + */ |
|
| 75 | + public function get_items_permissions_check( $request ) { |
|
| 76 | + |
|
| 77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Get sales reports. |
|
| 86 | + * |
|
| 87 | + * @param WP_REST_Request $request |
|
| 88 | + * @return array|WP_Error |
|
| 89 | + */ |
|
| 90 | + public function get_items( $request ) { |
|
| 91 | + $data = array(); |
|
| 92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | + |
|
| 95 | + return rest_ensure_response( $data ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Prepare a report sales object for serialization. |
|
| 100 | + * |
|
| 101 | + * @param null $_ |
|
| 102 | + * @param WP_REST_Request $request Request object. |
|
| 103 | + * @return WP_REST_Response $response Response data. |
|
| 104 | + */ |
|
| 105 | + public function prepare_item_for_response( $_, $request ) { |
|
| 106 | + |
|
| 107 | + // Set report range. |
|
| 108 | + $this->report_range = $this->get_date_range( $request ); |
|
| 109 | + |
|
| 110 | + $report_data = $this->get_report_data(); |
|
| 111 | + $period_totals = array(); |
|
| 112 | + |
|
| 113 | + // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | + $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | + |
|
| 116 | + if ( 'month' === $this->groupby ) { |
|
| 117 | + $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | + |
|
| 122 | + switch ( $this->groupby ) { |
|
| 123 | + case 'day' : |
|
| 124 | + $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | + break; |
|
| 126 | + default : |
|
| 127 | + $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | + break; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + // Set the defaults for each period. |
|
| 132 | + $period_totals[ $time ] = array( |
|
| 133 | + 'sales' => wpinv_round_amount( 0.00 ), |
|
| 134 | + 'invoices' => 0, |
|
| 135 | + 'refunds' => wpinv_round_amount( 0.00 ), |
|
| 136 | + 'items' => 0, |
|
| 137 | + 'refunded_items' => 0, |
|
| 138 | + 'tax' => wpinv_round_amount( 0.00 ), |
|
| 139 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 140 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 141 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 142 | + 'fees' => wpinv_round_amount( 0.00 ), |
|
| 143 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 144 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
| 145 | + ); |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + // add total sales, total invoice count, total tax for each period |
|
| 150 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 151 | + foreach ( $report_data->invoices as $invoice ) { |
|
| 152 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 153 | + |
|
| 154 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 155 | + continue; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 159 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 160 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 161 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 162 | + |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + foreach ( $report_data->refunds as $invoice ) { |
|
| 166 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 167 | + |
|
| 168 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 169 | + continue; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 173 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 174 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 175 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 176 | + |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 180 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 181 | + |
|
| 182 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 183 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + // Add total invoice items for each period. |
|
| 189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 190 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 191 | + |
|
| 192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + // Add total discount for each period. |
|
| 199 | + foreach ( $report_data->coupons as $discount ) { |
|
| 200 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 201 | + |
|
| 202 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 203 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + $report_data->totals = $period_totals; |
|
| 209 | + $report_data->grouped_by = $this->groupby; |
|
| 210 | + $report_data->interval = max( $this->interval, 1 ); |
|
| 211 | + $report_data->currency = wpinv_get_currency(); |
|
| 212 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 213 | + $report_data->currency_position = wpinv_currency_position(); |
|
| 214 | + $report_data->decimal_places = wpinv_decimals(); |
|
| 215 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 216 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 217 | + $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 218 | + $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 219 | + $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 220 | + $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 221 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 222 | + |
|
| 223 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 224 | + $data = $report_data; |
|
| 225 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 226 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 227 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 228 | + |
|
| 229 | + // Wrap the data in a response object. |
|
| 230 | + $response = rest_ensure_response( $data ); |
|
| 231 | + $response->add_links( array( |
|
| 232 | + 'about' => array( |
|
| 233 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 234 | + ), |
|
| 235 | + ) ); |
|
| 236 | + |
|
| 237 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Get report data. |
|
| 242 | + * |
|
| 243 | + * @return stdClass |
|
| 244 | + */ |
|
| 245 | + public function get_report_data() { |
|
| 246 | + if ( empty( $this->report_data ) ) { |
|
| 247 | + $this->query_report_data(); |
|
| 248 | + } |
|
| 249 | + return $this->report_data; |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Get all data needed for this report and store in the class. |
|
| 254 | + */ |
|
| 255 | + protected function query_report_data() { |
|
| 256 | + |
|
| 257 | + // Prepare reports. |
|
| 258 | + $this->report_data = (object) array( |
|
| 259 | + 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 260 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 261 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 262 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 263 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 264 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 265 | + 'previous_range' => $this->previous_range, |
|
| 266 | + ); |
|
| 267 | + |
|
| 268 | + // Calculated totals. |
|
| 269 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 270 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 271 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 272 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 273 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 274 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 275 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 276 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 277 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 278 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 279 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 280 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 281 | + |
|
| 282 | + |
|
| 283 | + // Calculate average based on net. |
|
| 284 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 285 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 286 | + |
|
| 287 | + // Total invoices in this period, even if refunded. |
|
| 288 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 289 | + |
|
| 290 | + // Items invoiced in this period, even if refunded. |
|
| 291 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 292 | + |
|
| 293 | + // 3rd party filtering of report data |
|
| 294 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Prepares invoice counts. |
|
| 299 | + * |
|
| 300 | + * @return array. |
|
| 301 | + */ |
|
| 302 | + protected function query_invoice_counts() { |
|
| 303 | + |
|
| 304 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 305 | + array( |
|
| 306 | + 'data' => array( |
|
| 307 | + 'ID' => array( |
|
| 308 | + 'type' => 'post_data', |
|
| 309 | + 'function' => 'COUNT', |
|
| 310 | + 'name' => 'count', |
|
| 311 | + 'distinct' => true, |
|
| 312 | + ), |
|
| 313 | + 'post_date' => array( |
|
| 314 | + 'type' => 'post_data', |
|
| 315 | + 'function' => '', |
|
| 316 | + 'name' => 'post_date', |
|
| 317 | + ), |
|
| 318 | + ), |
|
| 319 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 320 | + 'order_by' => 'post_date ASC', |
|
| 321 | + 'query_type' => 'get_results', |
|
| 322 | + 'filter_range' => $this->report_range, |
|
| 323 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 324 | + ) |
|
| 325 | + ); |
|
| 326 | + |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + /** |
|
| 330 | + * Prepares coupon counts. |
|
| 331 | + * |
|
| 332 | + * @return array. |
|
| 333 | + */ |
|
| 334 | + protected function query_coupon_counts() { |
|
| 335 | + |
|
| 336 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 337 | + array( |
|
| 338 | + 'data' => array( |
|
| 339 | + 'discount' => array( |
|
| 340 | + 'type' => 'invoice_data', |
|
| 341 | + 'function' => 'SUM', |
|
| 342 | + 'name' => 'discount_amount', |
|
| 343 | + ), |
|
| 344 | + 'post_date' => array( |
|
| 345 | + 'type' => 'post_data', |
|
| 346 | + 'function' => '', |
|
| 347 | + 'name' => 'post_date', |
|
| 348 | + ), |
|
| 349 | + ), |
|
| 350 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 351 | + 'order_by' => 'post_date ASC', |
|
| 352 | + 'query_type' => 'get_results', |
|
| 353 | + 'filter_range' => $this->report_range, |
|
| 354 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 355 | + ) |
|
| 356 | + ); |
|
| 357 | + |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * Prepares item counts. |
|
| 362 | + * |
|
| 363 | + * @return array. |
|
| 364 | + */ |
|
| 365 | + protected function query_item_counts() { |
|
| 366 | + |
|
| 367 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 368 | + array( |
|
| 369 | + 'data' => array( |
|
| 370 | + 'quantity' => array( |
|
| 371 | + 'type' => 'invoice_item', |
|
| 372 | + 'function' => 'SUM', |
|
| 373 | + 'name' => 'invoice_item_count', |
|
| 374 | + ), |
|
| 375 | + 'post_date' => array( |
|
| 376 | + 'type' => 'post_data', |
|
| 377 | + 'function' => '', |
|
| 378 | + 'name' => 'post_date', |
|
| 379 | + ), |
|
| 380 | + ), |
|
| 381 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 382 | + 'order_by' => 'post_date ASC', |
|
| 383 | + 'query_type' => 'get_results', |
|
| 384 | + 'filter_range' => $this->report_range, |
|
| 385 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 386 | + ) |
|
| 387 | + ); |
|
| 388 | + |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + /** |
|
| 392 | + * Prepares refunded item counts. |
|
| 393 | + * |
|
| 394 | + * @return array. |
|
| 395 | + */ |
|
| 396 | + protected function count_refunded_items() { |
|
| 397 | + |
|
| 398 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 399 | + array( |
|
| 400 | + 'data' => array( |
|
| 401 | + 'quantity' => array( |
|
| 402 | + 'type' => 'invoice_item', |
|
| 403 | + 'function' => 'SUM', |
|
| 404 | + 'name' => 'invoice_item_count', |
|
| 405 | + ), |
|
| 406 | + ), |
|
| 407 | + 'query_type' => 'get_var', |
|
| 408 | + 'filter_range' => $this->report_range, |
|
| 409 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 410 | + ) |
|
| 411 | + ); |
|
| 412 | + |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + /** |
|
| 416 | + * Prepares daily invoice totals. |
|
| 417 | + * |
|
| 418 | + * @return array. |
|
| 419 | + */ |
|
| 420 | + protected function query_invoice_totals() { |
|
| 421 | + |
|
| 422 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 423 | + array( |
|
| 424 | + 'data' => array( |
|
| 425 | + 'total' => array( |
|
| 426 | + 'type' => 'invoice_data', |
|
| 427 | + 'function' => 'SUM', |
|
| 428 | + 'name' => 'total_sales', |
|
| 429 | + ), |
|
| 430 | + 'tax' => array( |
|
| 431 | + 'type' => 'invoice_data', |
|
| 432 | + 'function' => 'SUM', |
|
| 433 | + 'name' => 'total_tax', |
|
| 434 | + ), |
|
| 435 | + 'discount' => array( |
|
| 436 | + 'type' => 'invoice_data', |
|
| 437 | + 'function' => 'SUM', |
|
| 438 | + 'name' => 'total_discount', |
|
| 439 | + ), |
|
| 440 | + 'fees_total' => array( |
|
| 441 | + 'type' => 'invoice_data', |
|
| 442 | + 'function' => 'SUM', |
|
| 443 | + 'name' => 'total_fees', |
|
| 444 | + ), |
|
| 445 | + 'subtotal' => array( |
|
| 446 | + 'type' => 'invoice_data', |
|
| 447 | + 'function' => 'SUM', |
|
| 448 | + 'name' => 'subtotal', |
|
| 449 | + ), |
|
| 450 | + 'post_date' => array( |
|
| 451 | + 'type' => 'post_data', |
|
| 452 | + 'function' => '', |
|
| 453 | + 'name' => 'post_date', |
|
| 454 | + ), |
|
| 455 | + ), |
|
| 456 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 457 | + 'order_by' => 'post_date ASC', |
|
| 458 | + 'query_type' => 'get_results', |
|
| 459 | + 'filter_range' => $this->report_range, |
|
| 460 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 461 | + ) |
|
| 462 | + ); |
|
| 463 | + |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + /** |
|
| 467 | + * Prepares daily invoice totals. |
|
| 468 | + * |
|
| 469 | + * @return array. |
|
| 470 | + */ |
|
| 471 | + protected function query_refunded_totals() { |
|
| 472 | + |
|
| 473 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 474 | + array( |
|
| 475 | + 'data' => array( |
|
| 476 | + 'total' => array( |
|
| 477 | + 'type' => 'invoice_data', |
|
| 478 | + 'function' => 'SUM', |
|
| 479 | + 'name' => 'total_sales', |
|
| 480 | + ), |
|
| 481 | + 'tax' => array( |
|
| 482 | + 'type' => 'invoice_data', |
|
| 483 | + 'function' => 'SUM', |
|
| 484 | + 'name' => 'total_tax', |
|
| 485 | + ), |
|
| 486 | + 'discount' => array( |
|
| 487 | + 'type' => 'invoice_data', |
|
| 488 | + 'function' => 'SUM', |
|
| 489 | + 'name' => 'total_discount', |
|
| 490 | + ), |
|
| 491 | + 'fees_total' => array( |
|
| 492 | + 'type' => 'invoice_data', |
|
| 493 | + 'function' => 'SUM', |
|
| 494 | + 'name' => 'total_fees', |
|
| 495 | + ), |
|
| 496 | + 'subtotal' => array( |
|
| 497 | + 'type' => 'invoice_data', |
|
| 498 | + 'function' => 'SUM', |
|
| 499 | + 'name' => 'subtotal', |
|
| 500 | + ), |
|
| 501 | + 'post_date' => array( |
|
| 502 | + 'type' => 'post_data', |
|
| 503 | + 'function' => '', |
|
| 504 | + 'name' => 'post_date', |
|
| 505 | + ), |
|
| 506 | + ), |
|
| 507 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 508 | + 'order_by' => 'post_date ASC', |
|
| 509 | + 'query_type' => 'get_results', |
|
| 510 | + 'filter_range' => $this->report_range, |
|
| 511 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 512 | + ) |
|
| 513 | + ); |
|
| 514 | + |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + /** |
|
| 518 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 519 | + * |
|
| 520 | + * @return array |
|
| 521 | + */ |
|
| 522 | + public function get_item_schema() { |
|
| 523 | + |
|
| 524 | + $schema = array( |
|
| 525 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 526 | + 'title' => 'sales_report', |
|
| 527 | + 'type' => 'object', |
|
| 528 | + 'properties' => array( |
|
| 529 | + 'total_sales' => array( |
|
| 530 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 531 | + 'type' => 'string', |
|
| 532 | + 'context' => array( 'view' ), |
|
| 533 | + 'readonly' => true, |
|
| 534 | + ), |
|
| 535 | + 'net_sales' => array( |
|
| 536 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 537 | + 'type' => 'string', |
|
| 538 | + 'context' => array( 'view' ), |
|
| 539 | + 'readonly' => true, |
|
| 540 | + ), |
|
| 541 | + 'average_sales' => array( |
|
| 542 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 543 | + 'type' => 'string', |
|
| 544 | + 'context' => array( 'view' ), |
|
| 545 | + 'readonly' => true, |
|
| 546 | + ), |
|
| 547 | + 'average_total_sales' => array( |
|
| 548 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 549 | + 'type' => 'string', |
|
| 550 | + 'context' => array( 'view' ), |
|
| 551 | + 'readonly' => true, |
|
| 552 | + ), |
|
| 553 | + 'total_invoices' => array( |
|
| 554 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 555 | + 'type' => 'integer', |
|
| 556 | + 'context' => array( 'view' ), |
|
| 557 | + 'readonly' => true, |
|
| 558 | + ), |
|
| 559 | + 'total_items' => array( |
|
| 560 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 561 | + 'type' => 'integer', |
|
| 562 | + 'context' => array( 'view' ), |
|
| 563 | + 'readonly' => true, |
|
| 564 | + ), |
|
| 565 | + 'refunded_items' => array( |
|
| 566 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 567 | + 'type' => 'integer', |
|
| 568 | + 'context' => array( 'view' ), |
|
| 569 | + 'readonly' => true, |
|
| 570 | + ), |
|
| 571 | + 'total_tax' => array( |
|
| 572 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 573 | + 'type' => 'string', |
|
| 574 | + 'context' => array( 'view' ), |
|
| 575 | + 'readonly' => true, |
|
| 576 | + ), |
|
| 577 | + 'total_refunded_tax' => array( |
|
| 578 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 579 | + 'type' => 'string', |
|
| 580 | + 'context' => array( 'view' ), |
|
| 581 | + 'readonly' => true, |
|
| 582 | + ), |
|
| 583 | + 'total_fees' => array( |
|
| 584 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 585 | + 'type' => 'string', |
|
| 586 | + 'context' => array( 'view' ), |
|
| 587 | + 'readonly' => true, |
|
| 588 | + ), |
|
| 589 | + 'total_refunds' => array( |
|
| 590 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 591 | + 'type' => 'integer', |
|
| 592 | + 'context' => array( 'view' ), |
|
| 593 | + 'readonly' => true, |
|
| 594 | + ), |
|
| 595 | + 'net_refunds' => array( |
|
| 596 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 597 | + 'type' => 'integer', |
|
| 598 | + 'context' => array( 'view' ), |
|
| 599 | + 'readonly' => true, |
|
| 600 | + ), |
|
| 601 | + 'total_discount' => array( |
|
| 602 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 603 | + 'type' => 'integer', |
|
| 604 | + 'context' => array( 'view' ), |
|
| 605 | + 'readonly' => true, |
|
| 606 | + ), |
|
| 607 | + 'totals' => array( |
|
| 608 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
| 609 | + 'type' => 'array', |
|
| 610 | + 'items' => array( |
|
| 611 | + 'type' => 'array', |
|
| 612 | + ), |
|
| 613 | + 'context' => array( 'view' ), |
|
| 614 | + 'readonly' => true, |
|
| 615 | + ), |
|
| 616 | + 'interval' => array( |
|
| 617 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 618 | + 'type' => 'integer', |
|
| 619 | + 'context' => array( 'view' ), |
|
| 620 | + 'readonly' => true, |
|
| 621 | + ), |
|
| 622 | + 'previous_range' => array( |
|
| 623 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 624 | + 'type' => 'array', |
|
| 625 | + 'items' => array( |
|
| 626 | + 'type' => 'string', |
|
| 627 | + ), |
|
| 628 | + 'context' => array( 'view' ), |
|
| 629 | + 'readonly' => true, |
|
| 630 | + ), |
|
| 631 | + 'grouped_by' => array( |
|
| 632 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 633 | + 'type' => 'string', |
|
| 634 | + 'context' => array( 'view' ), |
|
| 635 | + 'enum' => array( 'day', 'month' ), |
|
| 636 | + 'readonly' => true, |
|
| 637 | + ), |
|
| 638 | + 'currency' => array( |
|
| 639 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 640 | + 'type' => 'string', |
|
| 641 | + 'context' => array( 'view' ), |
|
| 642 | + 'readonly' => true, |
|
| 643 | + ), |
|
| 644 | + 'currency_symbol' => array( |
|
| 645 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 646 | + 'type' => 'string', |
|
| 647 | + 'context' => array( 'view' ), |
|
| 648 | + 'readonly' => true, |
|
| 649 | + ), |
|
| 650 | + 'currency_position' => array( |
|
| 651 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 652 | + 'type' => 'string', |
|
| 653 | + 'context' => array( 'view' ), |
|
| 654 | + 'readonly' => true, |
|
| 655 | + ), |
|
| 656 | + 'decimal_places' => array( |
|
| 657 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 658 | + 'type' => 'string', |
|
| 659 | + 'context' => array( 'view' ), |
|
| 660 | + 'readonly' => true, |
|
| 661 | + ), |
|
| 662 | + 'thousands_sep' => array( |
|
| 663 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 664 | + 'type' => 'string', |
|
| 665 | + 'context' => array( 'view' ), |
|
| 666 | + 'readonly' => true, |
|
| 667 | + ), |
|
| 668 | + 'decimals_sep' => array( |
|
| 669 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 670 | + 'type' => 'string', |
|
| 671 | + 'context' => array( 'view' ), |
|
| 672 | + 'readonly' => true, |
|
| 673 | + ), |
|
| 674 | + ), |
|
| 675 | + ); |
|
| 676 | + |
|
| 677 | + return $this->add_additional_fields_schema( $schema ); |
|
| 678 | + |
|
| 679 | + } |
|
| 680 | 680 | |
| 681 | 681 | } |
@@ -16,577 +16,577 @@ |
||
| 16 | 16 | */ |
| 17 | 17 | class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Group response items by day or month. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - public $groupby = 'day'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Returns an array with arguments to request the previous report. |
|
| 28 | - * |
|
| 29 | - * @var array |
|
| 30 | - */ |
|
| 31 | - public $previous_range = array(); |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * The period interval. |
|
| 35 | - * |
|
| 36 | - * @var int |
|
| 37 | - */ |
|
| 38 | - public $interval; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Retrieves the before and after dates. |
|
| 42 | - * |
|
| 43 | - * @param WP_REST_Request $request Request object. |
|
| 44 | - * @return array The appropriate date range. |
|
| 45 | - */ |
|
| 46 | - public function get_date_range( $request ) { |
|
| 47 | - |
|
| 48 | - // If not supported, assume all time. |
|
| 49 | - if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
| 50 | - $request['period'] = '7_days'; |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
| 54 | - $this->prepare_interval( $date_range ); |
|
| 55 | - |
|
| 56 | - return $date_range; |
|
| 57 | - |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Groups by month or days. |
|
| 62 | - * |
|
| 63 | - * @param array $range Date range. |
|
| 64 | - * @return array The appropriate date range. |
|
| 65 | - */ |
|
| 66 | - public function prepare_interval( $range ) { |
|
| 67 | - |
|
| 68 | - $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
| 69 | - $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
| 70 | - if ( 'day' === $this->groupby ) { |
|
| 71 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
| 72 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
| 73 | - return; |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - $this->interval = 0; |
|
| 77 | - $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
| 78 | - |
|
| 79 | - while ( $min_date <= $before ) { |
|
| 80 | - $this->interval ++; |
|
| 81 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - $this->interval = max( 1, $this->interval ); |
|
| 85 | - |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Retrieves a custom date range. |
|
| 90 | - * |
|
| 91 | - * @param WP_REST_Request $request Request object. |
|
| 92 | - * @return array The appropriate date range. |
|
| 93 | - */ |
|
| 94 | - public function get_custom_date_range( $request ) { |
|
| 95 | - |
|
| 96 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
| 97 | - $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
| 98 | - |
|
| 99 | - if ( ! empty( $request['before'] ) ) { |
|
| 100 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - // 3 months max for day view |
|
| 104 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
| 105 | - $this->groupby = 'month'; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - // Set the previous date range. |
|
| 109 | - $difference = $before - $after; |
|
| 110 | - $this->previous_range = array( |
|
| 111 | - 'period' => 'custom', |
|
| 112 | - 'before' => date( 'Y-m-d', $before - $difference ), |
|
| 113 | - 'after' => date( 'Y-m-d', $after - $difference ), |
|
| 114 | - ); |
|
| 115 | - |
|
| 116 | - // Generate the report. |
|
| 117 | - return array( |
|
| 118 | - 'before' => date( 'Y-m-d', $before ), |
|
| 119 | - 'after' => date( 'Y-m-d', $after ), |
|
| 120 | - ); |
|
| 121 | - |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Retrieves todays date range. |
|
| 126 | - * |
|
| 127 | - * @return array The appropriate date range. |
|
| 128 | - */ |
|
| 129 | - public function get_today_date_range() { |
|
| 130 | - |
|
| 131 | - // Set the previous date range. |
|
| 132 | - $this->previous_range = array( |
|
| 133 | - 'period' => 'yesterday', |
|
| 134 | - ); |
|
| 135 | - |
|
| 136 | - // Generate the report. |
|
| 137 | - return array( |
|
| 138 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
| 139 | - 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 140 | - ); |
|
| 141 | - |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Retrieves yesterdays date range. |
|
| 146 | - * |
|
| 147 | - * @return array The appropriate date range. |
|
| 148 | - */ |
|
| 149 | - public function get_yesterday_date_range() { |
|
| 150 | - |
|
| 151 | - // Set the previous date range. |
|
| 152 | - $this->previous_range = array( |
|
| 153 | - 'period' => 'custom', |
|
| 154 | - 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 155 | - 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
| 156 | - ); |
|
| 157 | - |
|
| 158 | - // Generate the report. |
|
| 159 | - return array( |
|
| 160 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 161 | - 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
| 162 | - ); |
|
| 163 | - |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Retrieves this week's date range. |
|
| 168 | - * |
|
| 169 | - * @return array The appropriate date range. |
|
| 170 | - */ |
|
| 171 | - public function get_week_date_range() { |
|
| 172 | - |
|
| 173 | - // Set the previous date range. |
|
| 174 | - $this->previous_range = array( |
|
| 175 | - 'period' => 'last_week', |
|
| 176 | - ); |
|
| 177 | - |
|
| 178 | - // Generate the report. |
|
| 179 | - return array( |
|
| 180 | - 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
| 181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
| 182 | - ); |
|
| 183 | - |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * Retrieves last week's date range. |
|
| 188 | - * |
|
| 189 | - * @return array The appropriate date range. |
|
| 190 | - */ |
|
| 191 | - public function get_last_week_date_range() { |
|
| 192 | - |
|
| 193 | - // Set the previous date range. |
|
| 194 | - $this->previous_range = array( |
|
| 195 | - 'period' => 'custom', |
|
| 196 | - 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
| 197 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
| 198 | - ); |
|
| 199 | - |
|
| 200 | - // Generate the report. |
|
| 201 | - return array( |
|
| 202 | - 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
| 203 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
| 204 | - ); |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * Retrieves last 7 days date range. |
|
| 210 | - * |
|
| 211 | - * @return array The appropriate date range. |
|
| 212 | - */ |
|
| 213 | - public function get_7_days_date_range() { |
|
| 214 | - |
|
| 215 | - // Set the previous date range. |
|
| 216 | - $this->previous_range = array( |
|
| 217 | - 'period' => 'custom', |
|
| 218 | - 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
| 219 | - 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
| 220 | - ); |
|
| 221 | - |
|
| 222 | - // Generate the report. |
|
| 223 | - return array( |
|
| 224 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 225 | - 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 226 | - ); |
|
| 227 | - |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - /** |
|
| 231 | - * Retrieves last 30 days date range. |
|
| 232 | - * |
|
| 233 | - * @return array The appropriate date range. |
|
| 234 | - */ |
|
| 235 | - public function get_30_days_date_range() { |
|
| 236 | - |
|
| 237 | - // Set the previous date range. |
|
| 238 | - $this->previous_range = array( |
|
| 239 | - 'period' => 'custom', |
|
| 240 | - 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
| 241 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 242 | - ); |
|
| 243 | - |
|
| 244 | - // Generate the report. |
|
| 245 | - return array( |
|
| 246 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 247 | - 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
| 248 | - ); |
|
| 249 | - |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Retrieves last 90 days date range. |
|
| 254 | - * |
|
| 255 | - * @return array The appropriate date range. |
|
| 256 | - */ |
|
| 257 | - public function get_90_days_date_range() { |
|
| 258 | - |
|
| 259 | - $this->groupby = 'month'; |
|
| 260 | - |
|
| 261 | - // Set the previous date range. |
|
| 262 | - $this->previous_range = array( |
|
| 263 | - 'period' => 'custom', |
|
| 264 | - 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
| 265 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 266 | - ); |
|
| 267 | - |
|
| 268 | - // Generate the report. |
|
| 269 | - return array( |
|
| 270 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 271 | - 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
| 272 | - ); |
|
| 273 | - |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * Retrieves last 180 days date range. |
|
| 278 | - * |
|
| 279 | - * @return array The appropriate date range. |
|
| 280 | - */ |
|
| 281 | - public function get_180_days_date_range() { |
|
| 282 | - |
|
| 283 | - $this->groupby = 'month'; |
|
| 284 | - |
|
| 285 | - // Set the previous date range. |
|
| 286 | - $this->previous_range = array( |
|
| 287 | - 'period' => 'custom', |
|
| 288 | - 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
| 289 | - 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
| 290 | - ); |
|
| 291 | - |
|
| 292 | - // Generate the report. |
|
| 293 | - return array( |
|
| 294 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 295 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 296 | - ); |
|
| 297 | - |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Retrieves last 60 days date range. |
|
| 302 | - * |
|
| 303 | - * @return array The appropriate date range. |
|
| 304 | - */ |
|
| 305 | - public function get_60_days_date_range() { |
|
| 306 | - |
|
| 307 | - // Set the previous date range. |
|
| 308 | - $this->previous_range = array( |
|
| 309 | - 'period' => 'custom', |
|
| 310 | - 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
| 311 | - 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
| 312 | - ); |
|
| 313 | - |
|
| 314 | - // Generate the report. |
|
| 315 | - return array( |
|
| 316 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 317 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 318 | - ); |
|
| 319 | - |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Retrieves this month date range. |
|
| 324 | - * |
|
| 325 | - * @return array The appropriate date range. |
|
| 326 | - */ |
|
| 327 | - public function get_month_date_range() { |
|
| 328 | - |
|
| 329 | - // Set the previous date range. |
|
| 330 | - $this->previous_range = array( |
|
| 331 | - 'period' => 'last_month', |
|
| 332 | - ); |
|
| 333 | - |
|
| 334 | - // Generate the report. |
|
| 335 | - return array( |
|
| 336 | - 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
| 337 | - 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 338 | - ); |
|
| 339 | - |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * Retrieves last month's date range. |
|
| 344 | - * |
|
| 345 | - * @return array The appropriate date range. |
|
| 346 | - */ |
|
| 347 | - public function get_last_month_date_range() { |
|
| 348 | - |
|
| 349 | - // Set the previous date range. |
|
| 350 | - $this->previous_range = array( |
|
| 351 | - 'period' => 'custom', |
|
| 352 | - 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 353 | - 'after' => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ), |
|
| 354 | - ); |
|
| 355 | - |
|
| 356 | - // Generate the report. |
|
| 357 | - return array( |
|
| 358 | - 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
| 359 | - 'after' => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ), |
|
| 360 | - ); |
|
| 361 | - |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Retrieves this quarter date range. |
|
| 366 | - * |
|
| 367 | - * @return array The available quarters. |
|
| 368 | - */ |
|
| 369 | - public function get_quarters() { |
|
| 370 | - |
|
| 371 | - $last_year = (int) date('Y') - 1; |
|
| 372 | - $next_year = (int) date('Y') + 1; |
|
| 373 | - $year = (int) date('Y'); |
|
| 374 | - return array( |
|
| 375 | - |
|
| 376 | - array( |
|
| 377 | - 'after' => "$last_year-06-30", |
|
| 378 | - 'before' => "$last_year-10-01", |
|
| 379 | - ), |
|
| 380 | - |
|
| 381 | - array( |
|
| 382 | - 'before' => "$year-01-01", |
|
| 383 | - 'after' => "$last_year-09-30", |
|
| 384 | - ), |
|
| 385 | - |
|
| 386 | - array( |
|
| 387 | - 'before' => "$year-04-01", |
|
| 388 | - 'after' => "$last_year-12-31", |
|
| 389 | - ), |
|
| 390 | - |
|
| 391 | - array( |
|
| 392 | - 'before' => "$year-07-01", |
|
| 393 | - 'after' => "$year-03-31", |
|
| 394 | - ), |
|
| 395 | - |
|
| 396 | - array( |
|
| 397 | - 'after' => "$year-06-30", |
|
| 398 | - 'before' => "$year-10-01", |
|
| 399 | - ), |
|
| 400 | - |
|
| 401 | - array( |
|
| 402 | - 'before' => "$next_year-01-01", |
|
| 403 | - 'after' => "$year-09-30", |
|
| 404 | - ) |
|
| 405 | - |
|
| 406 | - ); |
|
| 407 | - |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Retrieves the current quater. |
|
| 412 | - * |
|
| 413 | - * @return int The current quarter. |
|
| 414 | - */ |
|
| 415 | - public function get_quarter() { |
|
| 416 | - |
|
| 417 | - $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
| 418 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
| 419 | - return $quarters[ $month - 1 ]; |
|
| 420 | - |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * Retrieves this quarter date range. |
|
| 425 | - * |
|
| 426 | - * @return array The appropriate date range. |
|
| 427 | - */ |
|
| 428 | - public function get_quarter_date_range() { |
|
| 429 | - |
|
| 430 | - // Set the previous date range. |
|
| 431 | - $this->previous_range = array( |
|
| 432 | - 'period' => 'last_quarter', |
|
| 433 | - ); |
|
| 434 | - |
|
| 435 | - // Generate the report. |
|
| 436 | - $quarters = $this->get_quarters(); |
|
| 437 | - return $quarters[ $this->get_quarter() + 1 ]; |
|
| 438 | - |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - /** |
|
| 442 | - * Retrieves last quarter's date range. |
|
| 443 | - * |
|
| 444 | - * @return array The appropriate date range. |
|
| 445 | - */ |
|
| 446 | - public function get_last_quarter_date_range() { |
|
| 447 | - |
|
| 448 | - $quarters = $this->get_quarters(); |
|
| 449 | - $quarter = $this->get_quarter(); |
|
| 450 | - |
|
| 451 | - // Set the previous date range. |
|
| 452 | - $this->previous_range = array_merge( |
|
| 453 | - $quarters[ $quarter - 1 ], |
|
| 454 | - array( 'period' => 'custom' ) |
|
| 455 | - ); |
|
| 456 | - |
|
| 457 | - // Generate the report. |
|
| 458 | - return $quarters[ $quarter ]; |
|
| 459 | - |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - /** |
|
| 463 | - * Retrieves this year date range. |
|
| 464 | - * |
|
| 465 | - * @return array The appropriate date range. |
|
| 466 | - */ |
|
| 467 | - public function get_year_date_range() { |
|
| 468 | - |
|
| 469 | - $this->groupby = 'month'; |
|
| 470 | - |
|
| 471 | - // Set the previous date range. |
|
| 472 | - $this->previous_range = array( |
|
| 473 | - 'period' => 'last_year', |
|
| 474 | - ); |
|
| 475 | - |
|
| 476 | - // Generate the report. |
|
| 477 | - return array( |
|
| 478 | - 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
| 479 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
| 480 | - ); |
|
| 481 | - |
|
| 482 | - } |
|
| 483 | - |
|
| 484 | - /** |
|
| 485 | - * Retrieves last year date range. |
|
| 486 | - * |
|
| 487 | - * @return array The appropriate date range. |
|
| 488 | - */ |
|
| 489 | - public function get_last_year_date_range() { |
|
| 490 | - |
|
| 491 | - $this->groupby = 'month'; |
|
| 492 | - |
|
| 493 | - // Set the previous date range. |
|
| 494 | - $year = (int) date('Y') - 3; |
|
| 495 | - $this->previous_range = array( |
|
| 496 | - 'period' => 'custom', |
|
| 497 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
| 498 | - 'after' => "$year-12-31", |
|
| 499 | - ); |
|
| 500 | - |
|
| 501 | - // Generate the report. |
|
| 502 | - $year = (int) date('Y') - 2; |
|
| 503 | - return array( |
|
| 504 | - 'after' => "$year-12-31", |
|
| 505 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
| 506 | - ); |
|
| 507 | - |
|
| 508 | - } |
|
| 509 | - |
|
| 510 | - /** |
|
| 511 | - * Prepare a the request date for SQL usage. |
|
| 512 | - * |
|
| 513 | - * @param WP_REST_Request $request Request object. |
|
| 514 | - * @param string $date_field The date field. |
|
| 515 | - * @return string The appropriate SQL. |
|
| 516 | - */ |
|
| 517 | - public function get_date_range_sql( $request, $date_field ) { |
|
| 518 | - global $wpdb; |
|
| 519 | - |
|
| 520 | - $sql = '1=1'; |
|
| 521 | - $range = $this->get_date_range( $request ); |
|
| 522 | - |
|
| 523 | - if ( ! empty( $range['after'] ) ) { |
|
| 524 | - $sql .= ' AND ' . $wpdb->prepare( |
|
| 525 | - "$date_field > %s", |
|
| 526 | - $range['after'] |
|
| 527 | - ); |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - if ( ! empty( $range['before'] ) ) { |
|
| 531 | - $sql .= ' AND ' . $wpdb->prepare( |
|
| 532 | - "$date_field < %s", |
|
| 533 | - $range['before'] |
|
| 534 | - ); |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - return $sql; |
|
| 538 | - |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * Prepares a group by query. |
|
| 543 | - * |
|
| 544 | - * @param string $date_field The date field. |
|
| 545 | - * @return string The appropriate SQL. |
|
| 546 | - */ |
|
| 547 | - public function get_group_by_sql( $date_field ) { |
|
| 548 | - |
|
| 549 | - if ( 'day' === $this->groupby ) { |
|
| 550 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - return "YEAR($date_field), MONTH($date_field)"; |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - /** |
|
| 557 | - * Get the query params for collections. |
|
| 558 | - * |
|
| 559 | - * @return array |
|
| 560 | - */ |
|
| 561 | - public function get_collection_params() { |
|
| 562 | - return array( |
|
| 563 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 564 | - 'period' => array( |
|
| 565 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
| 566 | - 'type' => 'string', |
|
| 567 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
| 568 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 570 | - 'default' => '7_days', |
|
| 571 | - ), |
|
| 572 | - 'after' => array( |
|
| 573 | - /* translators: %s: date format */ |
|
| 574 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 575 | - 'type' => 'string', |
|
| 576 | - 'format' => 'date', |
|
| 577 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 578 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 579 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 580 | - ), |
|
| 581 | - 'before' => array( |
|
| 582 | - /* translators: %s: date format */ |
|
| 583 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 584 | - 'type' => 'string', |
|
| 585 | - 'format' => 'date', |
|
| 586 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 587 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 588 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 589 | - ), |
|
| 590 | - ); |
|
| 591 | - } |
|
| 19 | + /** |
|
| 20 | + * Group response items by day or month. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + public $groupby = 'day'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Returns an array with arguments to request the previous report. |
|
| 28 | + * |
|
| 29 | + * @var array |
|
| 30 | + */ |
|
| 31 | + public $previous_range = array(); |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * The period interval. |
|
| 35 | + * |
|
| 36 | + * @var int |
|
| 37 | + */ |
|
| 38 | + public $interval; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Retrieves the before and after dates. |
|
| 42 | + * |
|
| 43 | + * @param WP_REST_Request $request Request object. |
|
| 44 | + * @return array The appropriate date range. |
|
| 45 | + */ |
|
| 46 | + public function get_date_range( $request ) { |
|
| 47 | + |
|
| 48 | + // If not supported, assume all time. |
|
| 49 | + if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
| 50 | + $request['period'] = '7_days'; |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
| 54 | + $this->prepare_interval( $date_range ); |
|
| 55 | + |
|
| 56 | + return $date_range; |
|
| 57 | + |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Groups by month or days. |
|
| 62 | + * |
|
| 63 | + * @param array $range Date range. |
|
| 64 | + * @return array The appropriate date range. |
|
| 65 | + */ |
|
| 66 | + public function prepare_interval( $range ) { |
|
| 67 | + |
|
| 68 | + $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
| 69 | + $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
| 70 | + if ( 'day' === $this->groupby ) { |
|
| 71 | + $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
| 72 | + $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
| 73 | + return; |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + $this->interval = 0; |
|
| 77 | + $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
| 78 | + |
|
| 79 | + while ( $min_date <= $before ) { |
|
| 80 | + $this->interval ++; |
|
| 81 | + $min_date = strtotime( '+1 MONTH', $min_date ); |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + $this->interval = max( 1, $this->interval ); |
|
| 85 | + |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Retrieves a custom date range. |
|
| 90 | + * |
|
| 91 | + * @param WP_REST_Request $request Request object. |
|
| 92 | + * @return array The appropriate date range. |
|
| 93 | + */ |
|
| 94 | + public function get_custom_date_range( $request ) { |
|
| 95 | + |
|
| 96 | + $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
| 97 | + $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
| 98 | + |
|
| 99 | + if ( ! empty( $request['before'] ) ) { |
|
| 100 | + $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + // 3 months max for day view |
|
| 104 | + if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
| 105 | + $this->groupby = 'month'; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + // Set the previous date range. |
|
| 109 | + $difference = $before - $after; |
|
| 110 | + $this->previous_range = array( |
|
| 111 | + 'period' => 'custom', |
|
| 112 | + 'before' => date( 'Y-m-d', $before - $difference ), |
|
| 113 | + 'after' => date( 'Y-m-d', $after - $difference ), |
|
| 114 | + ); |
|
| 115 | + |
|
| 116 | + // Generate the report. |
|
| 117 | + return array( |
|
| 118 | + 'before' => date( 'Y-m-d', $before ), |
|
| 119 | + 'after' => date( 'Y-m-d', $after ), |
|
| 120 | + ); |
|
| 121 | + |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Retrieves todays date range. |
|
| 126 | + * |
|
| 127 | + * @return array The appropriate date range. |
|
| 128 | + */ |
|
| 129 | + public function get_today_date_range() { |
|
| 130 | + |
|
| 131 | + // Set the previous date range. |
|
| 132 | + $this->previous_range = array( |
|
| 133 | + 'period' => 'yesterday', |
|
| 134 | + ); |
|
| 135 | + |
|
| 136 | + // Generate the report. |
|
| 137 | + return array( |
|
| 138 | + 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
| 139 | + 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 140 | + ); |
|
| 141 | + |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Retrieves yesterdays date range. |
|
| 146 | + * |
|
| 147 | + * @return array The appropriate date range. |
|
| 148 | + */ |
|
| 149 | + public function get_yesterday_date_range() { |
|
| 150 | + |
|
| 151 | + // Set the previous date range. |
|
| 152 | + $this->previous_range = array( |
|
| 153 | + 'period' => 'custom', |
|
| 154 | + 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 155 | + 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
| 156 | + ); |
|
| 157 | + |
|
| 158 | + // Generate the report. |
|
| 159 | + return array( |
|
| 160 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 161 | + 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
| 162 | + ); |
|
| 163 | + |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Retrieves this week's date range. |
|
| 168 | + * |
|
| 169 | + * @return array The appropriate date range. |
|
| 170 | + */ |
|
| 171 | + public function get_week_date_range() { |
|
| 172 | + |
|
| 173 | + // Set the previous date range. |
|
| 174 | + $this->previous_range = array( |
|
| 175 | + 'period' => 'last_week', |
|
| 176 | + ); |
|
| 177 | + |
|
| 178 | + // Generate the report. |
|
| 179 | + return array( |
|
| 180 | + 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
| 181 | + 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
| 182 | + ); |
|
| 183 | + |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * Retrieves last week's date range. |
|
| 188 | + * |
|
| 189 | + * @return array The appropriate date range. |
|
| 190 | + */ |
|
| 191 | + public function get_last_week_date_range() { |
|
| 192 | + |
|
| 193 | + // Set the previous date range. |
|
| 194 | + $this->previous_range = array( |
|
| 195 | + 'period' => 'custom', |
|
| 196 | + 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
| 197 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
| 198 | + ); |
|
| 199 | + |
|
| 200 | + // Generate the report. |
|
| 201 | + return array( |
|
| 202 | + 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
| 203 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
| 204 | + ); |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * Retrieves last 7 days date range. |
|
| 210 | + * |
|
| 211 | + * @return array The appropriate date range. |
|
| 212 | + */ |
|
| 213 | + public function get_7_days_date_range() { |
|
| 214 | + |
|
| 215 | + // Set the previous date range. |
|
| 216 | + $this->previous_range = array( |
|
| 217 | + 'period' => 'custom', |
|
| 218 | + 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
| 219 | + 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
| 220 | + ); |
|
| 221 | + |
|
| 222 | + // Generate the report. |
|
| 223 | + return array( |
|
| 224 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 225 | + 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 226 | + ); |
|
| 227 | + |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * Retrieves last 30 days date range. |
|
| 232 | + * |
|
| 233 | + * @return array The appropriate date range. |
|
| 234 | + */ |
|
| 235 | + public function get_30_days_date_range() { |
|
| 236 | + |
|
| 237 | + // Set the previous date range. |
|
| 238 | + $this->previous_range = array( |
|
| 239 | + 'period' => 'custom', |
|
| 240 | + 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
| 241 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 242 | + ); |
|
| 243 | + |
|
| 244 | + // Generate the report. |
|
| 245 | + return array( |
|
| 246 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 247 | + 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
| 248 | + ); |
|
| 249 | + |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Retrieves last 90 days date range. |
|
| 254 | + * |
|
| 255 | + * @return array The appropriate date range. |
|
| 256 | + */ |
|
| 257 | + public function get_90_days_date_range() { |
|
| 258 | + |
|
| 259 | + $this->groupby = 'month'; |
|
| 260 | + |
|
| 261 | + // Set the previous date range. |
|
| 262 | + $this->previous_range = array( |
|
| 263 | + 'period' => 'custom', |
|
| 264 | + 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
| 265 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 266 | + ); |
|
| 267 | + |
|
| 268 | + // Generate the report. |
|
| 269 | + return array( |
|
| 270 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 271 | + 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
| 272 | + ); |
|
| 273 | + |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * Retrieves last 180 days date range. |
|
| 278 | + * |
|
| 279 | + * @return array The appropriate date range. |
|
| 280 | + */ |
|
| 281 | + public function get_180_days_date_range() { |
|
| 282 | + |
|
| 283 | + $this->groupby = 'month'; |
|
| 284 | + |
|
| 285 | + // Set the previous date range. |
|
| 286 | + $this->previous_range = array( |
|
| 287 | + 'period' => 'custom', |
|
| 288 | + 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
| 289 | + 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
| 290 | + ); |
|
| 291 | + |
|
| 292 | + // Generate the report. |
|
| 293 | + return array( |
|
| 294 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 295 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 296 | + ); |
|
| 297 | + |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Retrieves last 60 days date range. |
|
| 302 | + * |
|
| 303 | + * @return array The appropriate date range. |
|
| 304 | + */ |
|
| 305 | + public function get_60_days_date_range() { |
|
| 306 | + |
|
| 307 | + // Set the previous date range. |
|
| 308 | + $this->previous_range = array( |
|
| 309 | + 'period' => 'custom', |
|
| 310 | + 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
| 311 | + 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
| 312 | + ); |
|
| 313 | + |
|
| 314 | + // Generate the report. |
|
| 315 | + return array( |
|
| 316 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 317 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 318 | + ); |
|
| 319 | + |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Retrieves this month date range. |
|
| 324 | + * |
|
| 325 | + * @return array The appropriate date range. |
|
| 326 | + */ |
|
| 327 | + public function get_month_date_range() { |
|
| 328 | + |
|
| 329 | + // Set the previous date range. |
|
| 330 | + $this->previous_range = array( |
|
| 331 | + 'period' => 'last_month', |
|
| 332 | + ); |
|
| 333 | + |
|
| 334 | + // Generate the report. |
|
| 335 | + return array( |
|
| 336 | + 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
| 337 | + 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 338 | + ); |
|
| 339 | + |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * Retrieves last month's date range. |
|
| 344 | + * |
|
| 345 | + * @return array The appropriate date range. |
|
| 346 | + */ |
|
| 347 | + public function get_last_month_date_range() { |
|
| 348 | + |
|
| 349 | + // Set the previous date range. |
|
| 350 | + $this->previous_range = array( |
|
| 351 | + 'period' => 'custom', |
|
| 352 | + 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 353 | + 'after' => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ), |
|
| 354 | + ); |
|
| 355 | + |
|
| 356 | + // Generate the report. |
|
| 357 | + return array( |
|
| 358 | + 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
| 359 | + 'after' => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ), |
|
| 360 | + ); |
|
| 361 | + |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Retrieves this quarter date range. |
|
| 366 | + * |
|
| 367 | + * @return array The available quarters. |
|
| 368 | + */ |
|
| 369 | + public function get_quarters() { |
|
| 370 | + |
|
| 371 | + $last_year = (int) date('Y') - 1; |
|
| 372 | + $next_year = (int) date('Y') + 1; |
|
| 373 | + $year = (int) date('Y'); |
|
| 374 | + return array( |
|
| 375 | + |
|
| 376 | + array( |
|
| 377 | + 'after' => "$last_year-06-30", |
|
| 378 | + 'before' => "$last_year-10-01", |
|
| 379 | + ), |
|
| 380 | + |
|
| 381 | + array( |
|
| 382 | + 'before' => "$year-01-01", |
|
| 383 | + 'after' => "$last_year-09-30", |
|
| 384 | + ), |
|
| 385 | + |
|
| 386 | + array( |
|
| 387 | + 'before' => "$year-04-01", |
|
| 388 | + 'after' => "$last_year-12-31", |
|
| 389 | + ), |
|
| 390 | + |
|
| 391 | + array( |
|
| 392 | + 'before' => "$year-07-01", |
|
| 393 | + 'after' => "$year-03-31", |
|
| 394 | + ), |
|
| 395 | + |
|
| 396 | + array( |
|
| 397 | + 'after' => "$year-06-30", |
|
| 398 | + 'before' => "$year-10-01", |
|
| 399 | + ), |
|
| 400 | + |
|
| 401 | + array( |
|
| 402 | + 'before' => "$next_year-01-01", |
|
| 403 | + 'after' => "$year-09-30", |
|
| 404 | + ) |
|
| 405 | + |
|
| 406 | + ); |
|
| 407 | + |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Retrieves the current quater. |
|
| 412 | + * |
|
| 413 | + * @return int The current quarter. |
|
| 414 | + */ |
|
| 415 | + public function get_quarter() { |
|
| 416 | + |
|
| 417 | + $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
| 418 | + $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
| 419 | + return $quarters[ $month - 1 ]; |
|
| 420 | + |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * Retrieves this quarter date range. |
|
| 425 | + * |
|
| 426 | + * @return array The appropriate date range. |
|
| 427 | + */ |
|
| 428 | + public function get_quarter_date_range() { |
|
| 429 | + |
|
| 430 | + // Set the previous date range. |
|
| 431 | + $this->previous_range = array( |
|
| 432 | + 'period' => 'last_quarter', |
|
| 433 | + ); |
|
| 434 | + |
|
| 435 | + // Generate the report. |
|
| 436 | + $quarters = $this->get_quarters(); |
|
| 437 | + return $quarters[ $this->get_quarter() + 1 ]; |
|
| 438 | + |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + /** |
|
| 442 | + * Retrieves last quarter's date range. |
|
| 443 | + * |
|
| 444 | + * @return array The appropriate date range. |
|
| 445 | + */ |
|
| 446 | + public function get_last_quarter_date_range() { |
|
| 447 | + |
|
| 448 | + $quarters = $this->get_quarters(); |
|
| 449 | + $quarter = $this->get_quarter(); |
|
| 450 | + |
|
| 451 | + // Set the previous date range. |
|
| 452 | + $this->previous_range = array_merge( |
|
| 453 | + $quarters[ $quarter - 1 ], |
|
| 454 | + array( 'period' => 'custom' ) |
|
| 455 | + ); |
|
| 456 | + |
|
| 457 | + // Generate the report. |
|
| 458 | + return $quarters[ $quarter ]; |
|
| 459 | + |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + /** |
|
| 463 | + * Retrieves this year date range. |
|
| 464 | + * |
|
| 465 | + * @return array The appropriate date range. |
|
| 466 | + */ |
|
| 467 | + public function get_year_date_range() { |
|
| 468 | + |
|
| 469 | + $this->groupby = 'month'; |
|
| 470 | + |
|
| 471 | + // Set the previous date range. |
|
| 472 | + $this->previous_range = array( |
|
| 473 | + 'period' => 'last_year', |
|
| 474 | + ); |
|
| 475 | + |
|
| 476 | + // Generate the report. |
|
| 477 | + return array( |
|
| 478 | + 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
| 479 | + 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
| 480 | + ); |
|
| 481 | + |
|
| 482 | + } |
|
| 483 | + |
|
| 484 | + /** |
|
| 485 | + * Retrieves last year date range. |
|
| 486 | + * |
|
| 487 | + * @return array The appropriate date range. |
|
| 488 | + */ |
|
| 489 | + public function get_last_year_date_range() { |
|
| 490 | + |
|
| 491 | + $this->groupby = 'month'; |
|
| 492 | + |
|
| 493 | + // Set the previous date range. |
|
| 494 | + $year = (int) date('Y') - 3; |
|
| 495 | + $this->previous_range = array( |
|
| 496 | + 'period' => 'custom', |
|
| 497 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
| 498 | + 'after' => "$year-12-31", |
|
| 499 | + ); |
|
| 500 | + |
|
| 501 | + // Generate the report. |
|
| 502 | + $year = (int) date('Y') - 2; |
|
| 503 | + return array( |
|
| 504 | + 'after' => "$year-12-31", |
|
| 505 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
| 506 | + ); |
|
| 507 | + |
|
| 508 | + } |
|
| 509 | + |
|
| 510 | + /** |
|
| 511 | + * Prepare a the request date for SQL usage. |
|
| 512 | + * |
|
| 513 | + * @param WP_REST_Request $request Request object. |
|
| 514 | + * @param string $date_field The date field. |
|
| 515 | + * @return string The appropriate SQL. |
|
| 516 | + */ |
|
| 517 | + public function get_date_range_sql( $request, $date_field ) { |
|
| 518 | + global $wpdb; |
|
| 519 | + |
|
| 520 | + $sql = '1=1'; |
|
| 521 | + $range = $this->get_date_range( $request ); |
|
| 522 | + |
|
| 523 | + if ( ! empty( $range['after'] ) ) { |
|
| 524 | + $sql .= ' AND ' . $wpdb->prepare( |
|
| 525 | + "$date_field > %s", |
|
| 526 | + $range['after'] |
|
| 527 | + ); |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + if ( ! empty( $range['before'] ) ) { |
|
| 531 | + $sql .= ' AND ' . $wpdb->prepare( |
|
| 532 | + "$date_field < %s", |
|
| 533 | + $range['before'] |
|
| 534 | + ); |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + return $sql; |
|
| 538 | + |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * Prepares a group by query. |
|
| 543 | + * |
|
| 544 | + * @param string $date_field The date field. |
|
| 545 | + * @return string The appropriate SQL. |
|
| 546 | + */ |
|
| 547 | + public function get_group_by_sql( $date_field ) { |
|
| 548 | + |
|
| 549 | + if ( 'day' === $this->groupby ) { |
|
| 550 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + return "YEAR($date_field), MONTH($date_field)"; |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + /** |
|
| 557 | + * Get the query params for collections. |
|
| 558 | + * |
|
| 559 | + * @return array |
|
| 560 | + */ |
|
| 561 | + public function get_collection_params() { |
|
| 562 | + return array( |
|
| 563 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 564 | + 'period' => array( |
|
| 565 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
| 566 | + 'type' => 'string', |
|
| 567 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
| 568 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 570 | + 'default' => '7_days', |
|
| 571 | + ), |
|
| 572 | + 'after' => array( |
|
| 573 | + /* translators: %s: date format */ |
|
| 574 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 575 | + 'type' => 'string', |
|
| 576 | + 'format' => 'date', |
|
| 577 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 578 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 579 | + 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 580 | + ), |
|
| 581 | + 'before' => array( |
|
| 582 | + /* translators: %s: date format */ |
|
| 583 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 584 | + 'type' => 'string', |
|
| 585 | + 'format' => 'date', |
|
| 586 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 587 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 588 | + 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 589 | + ), |
|
| 590 | + ); |
|
| 591 | + } |
|
| 592 | 592 | } |
@@ -12,88 +12,88 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var array |
|
| 17 | - */ |
|
| 18 | - public $views; |
|
| 15 | + /** |
|
| 16 | + * @var array |
|
| 17 | + */ |
|
| 18 | + public $views; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Class constructor. |
|
| 22 | - * |
|
| 23 | - */ |
|
| 24 | - public function __construct() { |
|
| 20 | + /** |
|
| 21 | + * Class constructor. |
|
| 22 | + * |
|
| 23 | + */ |
|
| 24 | + public function __construct() { |
|
| 25 | 25 | |
| 26 | - $this->views = array( |
|
| 26 | + $this->views = array( |
|
| 27 | 27 | |
| 28 | 28 | 'items' => array( |
| 29 | - 'label' => __( 'Items', 'invoicing' ), |
|
| 30 | - 'class' => 'GetPaid_Reports_Report_Items', |
|
| 31 | - ), |
|
| 29 | + 'label' => __( 'Items', 'invoicing' ), |
|
| 30 | + 'class' => 'GetPaid_Reports_Report_Items', |
|
| 31 | + ), |
|
| 32 | 32 | |
| 33 | - 'gateways' => array( |
|
| 34 | - 'label' => __( 'Payment Methods', 'invoicing' ), |
|
| 35 | - 'class' => 'GetPaid_Reports_Report_Gateways', |
|
| 36 | - ), |
|
| 33 | + 'gateways' => array( |
|
| 34 | + 'label' => __( 'Payment Methods', 'invoicing' ), |
|
| 35 | + 'class' => 'GetPaid_Reports_Report_Gateways', |
|
| 36 | + ), |
|
| 37 | 37 | |
| 38 | - 'discounts' => array( |
|
| 39 | - 'label' => __( 'Discount Codes', 'invoicing' ), |
|
| 40 | - 'class' => 'GetPaid_Reports_Report_Discounts', |
|
| 41 | - ), |
|
| 38 | + 'discounts' => array( |
|
| 39 | + 'label' => __( 'Discount Codes', 'invoicing' ), |
|
| 40 | + 'class' => 'GetPaid_Reports_Report_Discounts', |
|
| 41 | + ), |
|
| 42 | 42 | |
| 43 | 43 | ); |
| 44 | 44 | |
| 45 | - $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
| 46 | - |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Retrieves the current range. |
|
| 51 | - * |
|
| 52 | - */ |
|
| 53 | - public function get_range() { |
|
| 54 | - $valid_ranges = $this->get_periods(); |
|
| 55 | - |
|
| 56 | - if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 57 | - return sanitize_key( $_GET['date_range'] ); |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - return '7_days'; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Returns an array of date ranges. |
|
| 65 | - * |
|
| 66 | - * @return array |
|
| 67 | - */ |
|
| 68 | - public function get_periods() { |
|
| 69 | - |
|
| 70 | - $periods = array( |
|
| 71 | - 'today' => __( 'Today', 'invoicing' ), |
|
| 72 | - 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
| 73 | - 'week' => __( 'This week', 'invoicing' ), |
|
| 74 | - 'last_week' => __( 'Last week', 'invoicing' ), |
|
| 75 | - '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
| 76 | - 'month' => __( 'This month', 'invoicing' ), |
|
| 77 | - 'last_month' => __( 'Last month', 'invoicing' ), |
|
| 78 | - '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 79 | - 'quarter' => __( 'This Quarter', 'invoicing' ), |
|
| 80 | - 'last_quarter' => __( 'Last Quarter', 'invoicing' ), |
|
| 81 | - 'year' => __( 'This year', 'invoicing' ), |
|
| 82 | - 'last_year' => __( 'Last Year', 'invoicing' ), |
|
| 83 | - 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
| 84 | - ); |
|
| 85 | - |
|
| 86 | - return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * Displays the range selector. |
|
| 91 | - * |
|
| 92 | - */ |
|
| 93 | - public function display_range_selector() { |
|
| 94 | - |
|
| 95 | - $range = $this->get_range(); |
|
| 96 | - ?> |
|
| 45 | + $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
| 46 | + |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Retrieves the current range. |
|
| 51 | + * |
|
| 52 | + */ |
|
| 53 | + public function get_range() { |
|
| 54 | + $valid_ranges = $this->get_periods(); |
|
| 55 | + |
|
| 56 | + if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 57 | + return sanitize_key( $_GET['date_range'] ); |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + return '7_days'; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Returns an array of date ranges. |
|
| 65 | + * |
|
| 66 | + * @return array |
|
| 67 | + */ |
|
| 68 | + public function get_periods() { |
|
| 69 | + |
|
| 70 | + $periods = array( |
|
| 71 | + 'today' => __( 'Today', 'invoicing' ), |
|
| 72 | + 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
| 73 | + 'week' => __( 'This week', 'invoicing' ), |
|
| 74 | + 'last_week' => __( 'Last week', 'invoicing' ), |
|
| 75 | + '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
| 76 | + 'month' => __( 'This month', 'invoicing' ), |
|
| 77 | + 'last_month' => __( 'Last month', 'invoicing' ), |
|
| 78 | + '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 79 | + 'quarter' => __( 'This Quarter', 'invoicing' ), |
|
| 80 | + 'last_quarter' => __( 'Last Quarter', 'invoicing' ), |
|
| 81 | + 'year' => __( 'This year', 'invoicing' ), |
|
| 82 | + 'last_year' => __( 'Last Year', 'invoicing' ), |
|
| 83 | + 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
| 84 | + ); |
|
| 85 | + |
|
| 86 | + return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * Displays the range selector. |
|
| 91 | + * |
|
| 92 | + */ |
|
| 93 | + public function display_range_selector() { |
|
| 94 | + |
|
| 95 | + $range = $this->get_range(); |
|
| 96 | + ?> |
|
| 97 | 97 | |
| 98 | 98 | <form method="get" class="getpaid-filter-earnings float-right"> |
| 99 | 99 | <?php getpaid_hidden_field( 'page', 'wpinv-reports' ); ?> |
@@ -115,14 +115,14 @@ discard block |
||
| 115 | 115 | </form> |
| 116 | 116 | |
| 117 | 117 | <?php |
| 118 | - } |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Displays the reports tab. |
|
| 122 | - * |
|
| 123 | - */ |
|
| 124 | - public function display() { |
|
| 125 | - ?> |
|
| 120 | + /** |
|
| 121 | + * Displays the reports tab. |
|
| 122 | + * |
|
| 123 | + */ |
|
| 124 | + public function display() { |
|
| 125 | + ?> |
|
| 126 | 126 | |
| 127 | 127 | <div class="mt-4" style="max-width: 1200px;"> |
| 128 | 128 | |
@@ -202,24 +202,24 @@ discard block |
||
| 202 | 202 | |
| 203 | 203 | <?php |
| 204 | 204 | |
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * Displays the left side. |
|
| 209 | - * |
|
| 210 | - */ |
|
| 211 | - public function display_left() { |
|
| 212 | - $graphs = array( |
|
| 213 | - 'sales' => __( 'Earnings', 'invoicing' ), |
|
| 214 | - 'refunds' => __( 'Refunds', 'invoicing' ), |
|
| 215 | - 'tax' => __( 'Taxes', 'invoicing' ), |
|
| 216 | - 'fees' => __( 'Fees', 'invoicing' ), |
|
| 217 | - 'discount' => __( 'Discounts', 'invoicing' ), |
|
| 218 | - 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 219 | - 'items' => __( 'Purchased Items', 'invoicing' ), |
|
| 220 | - ); |
|
| 221 | - |
|
| 222 | - ?> |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * Displays the left side. |
|
| 209 | + * |
|
| 210 | + */ |
|
| 211 | + public function display_left() { |
|
| 212 | + $graphs = array( |
|
| 213 | + 'sales' => __( 'Earnings', 'invoicing' ), |
|
| 214 | + 'refunds' => __( 'Refunds', 'invoicing' ), |
|
| 215 | + 'tax' => __( 'Taxes', 'invoicing' ), |
|
| 216 | + 'fees' => __( 'Fees', 'invoicing' ), |
|
| 217 | + 'discount' => __( 'Discounts', 'invoicing' ), |
|
| 218 | + 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 219 | + 'items' => __( 'Purchased Items', 'invoicing' ), |
|
| 220 | + ); |
|
| 221 | + |
|
| 222 | + ?> |
|
| 223 | 223 | |
| 224 | 224 | <?php foreach ( $graphs as $key => $graph ) : ?> |
| 225 | 225 | <div class="row mb-4"> |
@@ -238,35 +238,35 @@ discard block |
||
| 238 | 238 | |
| 239 | 239 | <?php |
| 240 | 240 | |
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Retrieves the download url. |
|
| 245 | - * |
|
| 246 | - */ |
|
| 247 | - public function get_download_url( $graph, $file_type ) { |
|
| 248 | - |
|
| 249 | - return wp_nonce_url( |
|
| 250 | - add_query_arg( |
|
| 251 | - array( |
|
| 252 | - 'getpaid-admin-action' => 'download_graph', |
|
| 253 | - 'file_type' => urlencode( $file_type ), |
|
| 254 | - 'graph' => urlencode( $graph ), |
|
| 255 | - ) |
|
| 256 | - ), |
|
| 257 | - 'getpaid-nonce', |
|
| 258 | - 'getpaid-nonce' |
|
| 259 | - ); |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Retrieves the download url. |
|
| 245 | + * |
|
| 246 | + */ |
|
| 247 | + public function get_download_url( $graph, $file_type ) { |
|
| 248 | + |
|
| 249 | + return wp_nonce_url( |
|
| 250 | + add_query_arg( |
|
| 251 | + array( |
|
| 252 | + 'getpaid-admin-action' => 'download_graph', |
|
| 253 | + 'file_type' => urlencode( $file_type ), |
|
| 254 | + 'graph' => urlencode( $graph ), |
|
| 255 | + ) |
|
| 256 | + ), |
|
| 257 | + 'getpaid-nonce', |
|
| 258 | + 'getpaid-nonce' |
|
| 259 | + ); |
|
| 260 | 260 | |
| 261 | - } |
|
| 261 | + } |
|
| 262 | 262 | |
| 263 | - /** |
|
| 264 | - * Displays the right side. |
|
| 265 | - * |
|
| 266 | - */ |
|
| 267 | - public function display_right() { |
|
| 263 | + /** |
|
| 264 | + * Displays the right side. |
|
| 265 | + * |
|
| 266 | + */ |
|
| 267 | + public function display_right() { |
|
| 268 | 268 | |
| 269 | - ?> |
|
| 269 | + ?> |
|
| 270 | 270 | |
| 271 | 271 | <?php foreach ( $this->views as $key => $view ) : ?> |
| 272 | 272 | <div class="row mb-4"> |
@@ -295,10 +295,10 @@ discard block |
||
| 295 | 295 | </div> |
| 296 | 296 | <div class="card-body"> |
| 297 | 297 | <?php |
| 298 | - $class = $view['class']; |
|
| 299 | - $class = new $class(); |
|
| 300 | - $class->display_stats(); |
|
| 301 | - ?> |
|
| 298 | + $class = $view['class']; |
|
| 299 | + $class = new $class(); |
|
| 300 | + $class->display_stats(); |
|
| 301 | + ?> |
|
| 302 | 302 | </div> |
| 303 | 303 | </div> |
| 304 | 304 | </div> |
@@ -307,67 +307,67 @@ discard block |
||
| 307 | 307 | |
| 308 | 308 | <?php |
| 309 | 309 | |
| 310 | - } |
|
| 311 | - |
|
| 312 | - /** |
|
| 313 | - * Returns a list of report cards. |
|
| 314 | - * |
|
| 315 | - */ |
|
| 316 | - public function get_cards() { |
|
| 317 | - |
|
| 318 | - $cards = array( |
|
| 319 | - 'total_sales' => array( |
|
| 320 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 321 | - 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
| 322 | - ), |
|
| 323 | - 'net_sales' => array( |
|
| 324 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 325 | - 'label' => __( 'Net Revenue', 'invoicing' ), |
|
| 326 | - ), |
|
| 327 | - 'average_sales' => array( |
|
| 328 | - 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
| 329 | - 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
| 330 | - ), |
|
| 331 | - 'average_total_sales' => array( |
|
| 332 | - 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
| 333 | - 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
| 334 | - ), |
|
| 335 | - 'total_invoices' => array( |
|
| 336 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 337 | - 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
| 338 | - ), |
|
| 339 | - 'total_items' => array( |
|
| 340 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 341 | - 'label' => __( 'Purchased Items', 'invoicing' ), |
|
| 342 | - ), |
|
| 343 | - 'refunded_items' => array( |
|
| 344 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 345 | - 'label' => __( 'Refunded Items', 'invoicing' ), |
|
| 346 | - ), |
|
| 347 | - 'total_tax' => array( |
|
| 348 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 349 | - 'label' => __( 'Tax', 'invoicing' ), |
|
| 350 | - ), |
|
| 351 | - 'total_refunded_tax' => array( |
|
| 352 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 353 | - 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
| 354 | - ), |
|
| 355 | - 'total_fees' => array( |
|
| 356 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 357 | - 'label' => __( 'Fees', 'invoicing' ), |
|
| 358 | - ), |
|
| 359 | - 'total_refunds' => array( |
|
| 360 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 361 | - 'label' => __( 'Refunded', 'invoicing' ), |
|
| 362 | - ), |
|
| 363 | - 'total_discount' => array( |
|
| 364 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 365 | - 'label' => __( 'Discounted', 'invoicing' ), |
|
| 366 | - ), |
|
| 367 | - ); |
|
| 368 | - |
|
| 369 | - return apply_filters( 'wpinv_report_cards', $cards ); |
|
| 370 | - } |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + /** |
|
| 313 | + * Returns a list of report cards. |
|
| 314 | + * |
|
| 315 | + */ |
|
| 316 | + public function get_cards() { |
|
| 317 | + |
|
| 318 | + $cards = array( |
|
| 319 | + 'total_sales' => array( |
|
| 320 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 321 | + 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
| 322 | + ), |
|
| 323 | + 'net_sales' => array( |
|
| 324 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 325 | + 'label' => __( 'Net Revenue', 'invoicing' ), |
|
| 326 | + ), |
|
| 327 | + 'average_sales' => array( |
|
| 328 | + 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
| 329 | + 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
| 330 | + ), |
|
| 331 | + 'average_total_sales' => array( |
|
| 332 | + 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
| 333 | + 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
| 334 | + ), |
|
| 335 | + 'total_invoices' => array( |
|
| 336 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 337 | + 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
| 338 | + ), |
|
| 339 | + 'total_items' => array( |
|
| 340 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 341 | + 'label' => __( 'Purchased Items', 'invoicing' ), |
|
| 342 | + ), |
|
| 343 | + 'refunded_items' => array( |
|
| 344 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 345 | + 'label' => __( 'Refunded Items', 'invoicing' ), |
|
| 346 | + ), |
|
| 347 | + 'total_tax' => array( |
|
| 348 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 349 | + 'label' => __( 'Tax', 'invoicing' ), |
|
| 350 | + ), |
|
| 351 | + 'total_refunded_tax' => array( |
|
| 352 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 353 | + 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
| 354 | + ), |
|
| 355 | + 'total_fees' => array( |
|
| 356 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 357 | + 'label' => __( 'Fees', 'invoicing' ), |
|
| 358 | + ), |
|
| 359 | + 'total_refunds' => array( |
|
| 360 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 361 | + 'label' => __( 'Refunded', 'invoicing' ), |
|
| 362 | + ), |
|
| 363 | + 'total_discount' => array( |
|
| 364 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 365 | + 'label' => __( 'Discounted', 'invoicing' ), |
|
| 366 | + ), |
|
| 367 | + ); |
|
| 368 | + |
|
| 369 | + return apply_filters( 'wpinv_report_cards', $cards ); |
|
| 370 | + } |
|
| 371 | 371 | |
| 372 | 372 | |
| 373 | 373 | |
@@ -15,30 +15,30 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class WPInv_Discount extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | 23 | protected $data_store_name = 'discount'; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'discount'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Discount Data array. This is the core item data exposed in APIs. |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array( |
|
| 39 | - 'status' => 'draft', |
|
| 40 | - 'version' => '', |
|
| 41 | - 'date_created' => null, |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'discount'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Discount Data array. This is the core item data exposed in APIs. |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array( |
|
| 39 | + 'status' => 'draft', |
|
| 40 | + 'version' => '', |
|
| 41 | + 'date_created' => null, |
|
| 42 | 42 | 'date_modified' => null, |
| 43 | 43 | 'name' => 'no-name', |
| 44 | 44 | 'description' => '', |
@@ -58,144 +58,144 @@ discard block |
||
| 58 | 58 | 'amount' => null, |
| 59 | 59 | ); |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Stores meta in cache for future reads. |
|
| 63 | - * |
|
| 64 | - * A group must be set to to enable caching. |
|
| 65 | - * |
|
| 66 | - * @var string |
|
| 67 | - */ |
|
| 68 | - protected $cache_group = 'getpaid_discounts'; |
|
| 61 | + /** |
|
| 62 | + * Stores meta in cache for future reads. |
|
| 63 | + * |
|
| 64 | + * A group must be set to to enable caching. |
|
| 65 | + * |
|
| 66 | + * @var string |
|
| 67 | + */ |
|
| 68 | + protected $cache_group = 'getpaid_discounts'; |
|
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | 71 | * Stores a reference to the original WP_Post object |
| 72 | 72 | * |
| 73 | 73 | * @var WP_Post |
| 74 | 74 | */ |
| 75 | - protected $post = null; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | - * |
|
| 80 | - * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | - */ |
|
| 82 | - public function __construct( $discount = 0 ) { |
|
| 83 | - parent::__construct( $discount ); |
|
| 84 | - |
|
| 85 | - if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | - $this->set_id( $discount ); |
|
| 87 | - } elseif ( $discount instanceof self ) { |
|
| 88 | - $this->set_id( $discount->get_id() ); |
|
| 89 | - } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | - $this->set_id( $discount->ID ); |
|
| 91 | - } elseif ( is_array( $discount ) ) { |
|
| 92 | - $this->set_props( $discount ); |
|
| 93 | - |
|
| 94 | - if ( isset( $discount['ID'] ) ) { |
|
| 95 | - $this->set_id( $discount['ID'] ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | - $this->set_id( $discount ); |
|
| 100 | - } else { |
|
| 101 | - $this->set_object_read( true ); |
|
| 102 | - } |
|
| 75 | + protected $post = null; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | + * |
|
| 80 | + * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | + */ |
|
| 82 | + public function __construct( $discount = 0 ) { |
|
| 83 | + parent::__construct( $discount ); |
|
| 84 | + |
|
| 85 | + if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | + $this->set_id( $discount ); |
|
| 87 | + } elseif ( $discount instanceof self ) { |
|
| 88 | + $this->set_id( $discount->get_id() ); |
|
| 89 | + } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | + $this->set_id( $discount->ID ); |
|
| 91 | + } elseif ( is_array( $discount ) ) { |
|
| 92 | + $this->set_props( $discount ); |
|
| 93 | + |
|
| 94 | + if ( isset( $discount['ID'] ) ) { |
|
| 95 | + $this->set_id( $discount['ID'] ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | + $this->set_id( $discount ); |
|
| 100 | + } else { |
|
| 101 | + $this->set_object_read( true ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | // Load the datastore. |
| 105 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 105 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 106 | 106 | |
| 107 | - if ( $this->get_id() > 0 ) { |
|
| 107 | + if ( $this->get_id() > 0 ) { |
|
| 108 | 108 | $this->post = get_post( $this->get_id() ); |
| 109 | 109 | $this->ID = $this->get_id(); |
| 110 | - $this->data_store->read( $this ); |
|
| 110 | + $this->data_store->read( $this ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Fetch a discount from the db/cache |
|
| 117 | + * |
|
| 118 | + * |
|
| 119 | + * @static |
|
| 120 | + * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | + * @param string|int $value The field value |
|
| 122 | + * @deprecated |
|
| 123 | + * @since 1.0.15 |
|
| 124 | + * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | + */ |
|
| 126 | + public static function get_data_by( $field, $value ) { |
|
| 127 | + |
|
| 128 | + if ( 'id' == strtolower( $field ) ) { |
|
| 129 | + // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | + // to int 1. |
|
| 131 | + if ( ! is_numeric( $value ) ) |
|
| 132 | + return false; |
|
| 133 | + $value = intval( $value ); |
|
| 134 | + if ( $value < 1 ) |
|
| 135 | + return false; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | + return false; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + $field = trim( $field ); |
|
| 143 | + |
|
| 144 | + // prepare query args |
|
| 145 | + switch ( strtolower( $field ) ) { |
|
| 146 | + case 'id': |
|
| 147 | + $discount_id = $value; |
|
| 148 | + $args = array( 'include' => array( $value ) ); |
|
| 149 | + break; |
|
| 150 | + case 'discount_code': |
|
| 151 | + case 'code': |
|
| 152 | + $value = trim( $value ); |
|
| 153 | + $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | + $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | + break; |
|
| 156 | + case 'name': |
|
| 157 | + $discount_id = 0; |
|
| 158 | + $args = array( 'name' => trim( $value ) ); |
|
| 159 | + break; |
|
| 160 | + default: |
|
| 161 | + $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | + if ( ! is_array( $args ) ) { |
|
| 163 | + return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + // Check if there is a cached value. |
|
| 169 | + if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | + return $discount; |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + $args = array_merge( |
|
| 174 | + $args, |
|
| 175 | + array( |
|
| 176 | + 'post_type' => 'wpi_discount', |
|
| 177 | + 'posts_per_page' => 1, |
|
| 178 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | + ) |
|
| 180 | + ); |
|
| 181 | + |
|
| 182 | + $discount = get_posts( $args ); |
|
| 183 | + |
|
| 184 | + if( empty( $discount ) ) { |
|
| 185 | + return false; |
|
| 111 | 186 | } |
| 112 | 187 | |
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Fetch a discount from the db/cache |
|
| 117 | - * |
|
| 118 | - * |
|
| 119 | - * @static |
|
| 120 | - * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | - * @param string|int $value The field value |
|
| 122 | - * @deprecated |
|
| 123 | - * @since 1.0.15 |
|
| 124 | - * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | - */ |
|
| 126 | - public static function get_data_by( $field, $value ) { |
|
| 127 | - |
|
| 128 | - if ( 'id' == strtolower( $field ) ) { |
|
| 129 | - // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | - // to int 1. |
|
| 131 | - if ( ! is_numeric( $value ) ) |
|
| 132 | - return false; |
|
| 133 | - $value = intval( $value ); |
|
| 134 | - if ( $value < 1 ) |
|
| 135 | - return false; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | - return false; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - $field = trim( $field ); |
|
| 143 | - |
|
| 144 | - // prepare query args |
|
| 145 | - switch ( strtolower( $field ) ) { |
|
| 146 | - case 'id': |
|
| 147 | - $discount_id = $value; |
|
| 148 | - $args = array( 'include' => array( $value ) ); |
|
| 149 | - break; |
|
| 150 | - case 'discount_code': |
|
| 151 | - case 'code': |
|
| 152 | - $value = trim( $value ); |
|
| 153 | - $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | - $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | - break; |
|
| 156 | - case 'name': |
|
| 157 | - $discount_id = 0; |
|
| 158 | - $args = array( 'name' => trim( $value ) ); |
|
| 159 | - break; |
|
| 160 | - default: |
|
| 161 | - $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | - if ( ! is_array( $args ) ) { |
|
| 163 | - return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - // Check if there is a cached value. |
|
| 169 | - if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | - return $discount; |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - $args = array_merge( |
|
| 174 | - $args, |
|
| 175 | - array( |
|
| 176 | - 'post_type' => 'wpi_discount', |
|
| 177 | - 'posts_per_page' => 1, |
|
| 178 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | - ) |
|
| 180 | - ); |
|
| 181 | - |
|
| 182 | - $discount = get_posts( $args ); |
|
| 183 | - |
|
| 184 | - if( empty( $discount ) ) { |
|
| 185 | - return false; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - $discount = $discount[0]; |
|
| 189 | - |
|
| 190 | - // Prepare the return data. |
|
| 191 | - $return = array( |
|
| 188 | + $discount = $discount[0]; |
|
| 189 | + |
|
| 190 | + // Prepare the return data. |
|
| 191 | + $return = array( |
|
| 192 | 192 | 'ID' => $discount->ID, |
| 193 | 193 | 'code' => get_post_meta( $discount->ID, '_wpi_discount_code', true ), |
| 194 | 194 | 'amount' => get_post_meta( $discount->ID, '_wpi_discount_amount', true ), |
| 195 | 195 | 'date_created' => $discount->post_date, |
| 196 | - 'date_modified' => $discount->post_modified, |
|
| 197 | - 'status' => $discount->post_status, |
|
| 198 | - 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 196 | + 'date_modified' => $discount->post_modified, |
|
| 197 | + 'status' => $discount->post_status, |
|
| 198 | + 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 199 | 199 | 'expiration' => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ), |
| 200 | 200 | 'type' => get_post_meta( $discount->ID, '_wpi_discount_type', true ), |
| 201 | 201 | 'description' => $discount->post_excerpt, |
@@ -209,77 +209,77 @@ discard block |
||
| 209 | 209 | 'max_total' => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ), |
| 210 | 210 | ); |
| 211 | 211 | |
| 212 | - $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | - |
|
| 214 | - // Update the cache with our data |
|
| 215 | - wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | - wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | - |
|
| 218 | - return $return; |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Given a discount code, it returns a discount id. |
|
| 223 | - * |
|
| 224 | - * |
|
| 225 | - * @static |
|
| 226 | - * @param string $discount_code |
|
| 227 | - * @since 1.0.15 |
|
| 228 | - * @return int |
|
| 229 | - */ |
|
| 230 | - public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | - |
|
| 232 | - // Trim the code. |
|
| 233 | - $discount_code = trim( $discount_code ); |
|
| 234 | - |
|
| 235 | - // Ensure a value has been passed. |
|
| 236 | - if ( empty( $discount_code ) ) { |
|
| 237 | - return 0; |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - // Maybe retrieve from the cache. |
|
| 241 | - $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | - if ( ! empty( $discount_id ) ) { |
|
| 243 | - return $discount_id; |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - // Fetch the first discount codes. |
|
| 247 | - $discounts = get_posts( |
|
| 248 | - array( |
|
| 249 | - 'meta_key' => '_wpi_discount_code', |
|
| 250 | - 'meta_value' => $discount_code, |
|
| 251 | - 'post_type' => 'wpi_discount', |
|
| 252 | - 'posts_per_page' => 1, |
|
| 253 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | - 'fields' => 'ids', |
|
| 255 | - ) |
|
| 256 | - ); |
|
| 257 | - |
|
| 258 | - if ( empty( $discounts ) ) { |
|
| 259 | - return 0; |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - $discount_id = $discounts[0]; |
|
| 263 | - |
|
| 264 | - // Update the cache with our data |
|
| 265 | - wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | - |
|
| 267 | - return $discount_id; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Magic method for checking the existence of a certain custom field. |
|
| 272 | - * |
|
| 273 | - * @since 1.0.15 |
|
| 274 | - * @access public |
|
| 275 | - * |
|
| 276 | - * @return bool Whether the given discount field is set. |
|
| 277 | - */ |
|
| 278 | - public function __isset( $key ){ |
|
| 279 | - return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /* |
|
| 212 | + $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | + |
|
| 214 | + // Update the cache with our data |
|
| 215 | + wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | + wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | + |
|
| 218 | + return $return; |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Given a discount code, it returns a discount id. |
|
| 223 | + * |
|
| 224 | + * |
|
| 225 | + * @static |
|
| 226 | + * @param string $discount_code |
|
| 227 | + * @since 1.0.15 |
|
| 228 | + * @return int |
|
| 229 | + */ |
|
| 230 | + public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | + |
|
| 232 | + // Trim the code. |
|
| 233 | + $discount_code = trim( $discount_code ); |
|
| 234 | + |
|
| 235 | + // Ensure a value has been passed. |
|
| 236 | + if ( empty( $discount_code ) ) { |
|
| 237 | + return 0; |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + // Maybe retrieve from the cache. |
|
| 241 | + $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | + if ( ! empty( $discount_id ) ) { |
|
| 243 | + return $discount_id; |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + // Fetch the first discount codes. |
|
| 247 | + $discounts = get_posts( |
|
| 248 | + array( |
|
| 249 | + 'meta_key' => '_wpi_discount_code', |
|
| 250 | + 'meta_value' => $discount_code, |
|
| 251 | + 'post_type' => 'wpi_discount', |
|
| 252 | + 'posts_per_page' => 1, |
|
| 253 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | + 'fields' => 'ids', |
|
| 255 | + ) |
|
| 256 | + ); |
|
| 257 | + |
|
| 258 | + if ( empty( $discounts ) ) { |
|
| 259 | + return 0; |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + $discount_id = $discounts[0]; |
|
| 263 | + |
|
| 264 | + // Update the cache with our data |
|
| 265 | + wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | + |
|
| 267 | + return $discount_id; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Magic method for checking the existence of a certain custom field. |
|
| 272 | + * |
|
| 273 | + * @since 1.0.15 |
|
| 274 | + * @access public |
|
| 275 | + * |
|
| 276 | + * @return bool Whether the given discount field is set. |
|
| 277 | + */ |
|
| 278 | + public function __isset( $key ){ |
|
| 279 | + return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /* |
|
| 283 | 283 | |-------------------------------------------------------------------------- |
| 284 | 284 | | CRUD methods |
| 285 | 285 | |-------------------------------------------------------------------------- |
@@ -294,430 +294,430 @@ discard block |
||
| 294 | 294 | |-------------------------------------------------------------------------- |
| 295 | 295 | */ |
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * Get discount status. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @param string $context View or edit context. |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function get_status( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'status', $context ); |
|
| 297 | + /** |
|
| 298 | + * Get discount status. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @param string $context View or edit context. |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function get_status( $context = 'view' ) { |
|
| 305 | + return $this->get_prop( 'status', $context ); |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | 308 | /** |
| 309 | - * Get plugin version when the discount was created. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.19 |
|
| 312 | - * @param string $context View or edit context. |
|
| 313 | - * @return string |
|
| 314 | - */ |
|
| 315 | - public function get_version( $context = 'view' ) { |
|
| 316 | - return $this->get_prop( 'version', $context ); |
|
| 309 | + * Get plugin version when the discount was created. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.19 |
|
| 312 | + * @param string $context View or edit context. |
|
| 313 | + * @return string |
|
| 314 | + */ |
|
| 315 | + public function get_version( $context = 'view' ) { |
|
| 316 | + return $this->get_prop( 'version', $context ); |
|
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | /** |
| 320 | - * Get date when the discount was created. |
|
| 321 | - * |
|
| 322 | - * @since 1.0.19 |
|
| 323 | - * @param string $context View or edit context. |
|
| 324 | - * @return string |
|
| 325 | - */ |
|
| 326 | - public function get_date_created( $context = 'view' ) { |
|
| 327 | - return $this->get_prop( 'date_created', $context ); |
|
| 320 | + * Get date when the discount was created. |
|
| 321 | + * |
|
| 322 | + * @since 1.0.19 |
|
| 323 | + * @param string $context View or edit context. |
|
| 324 | + * @return string |
|
| 325 | + */ |
|
| 326 | + public function get_date_created( $context = 'view' ) { |
|
| 327 | + return $this->get_prop( 'date_created', $context ); |
|
| 328 | 328 | } |
| 329 | 329 | |
| 330 | 330 | /** |
| 331 | - * Get GMT date when the discount was created. |
|
| 332 | - * |
|
| 333 | - * @since 1.0.19 |
|
| 334 | - * @param string $context View or edit context. |
|
| 335 | - * @return string |
|
| 336 | - */ |
|
| 337 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 331 | + * Get GMT date when the discount was created. |
|
| 332 | + * |
|
| 333 | + * @since 1.0.19 |
|
| 334 | + * @param string $context View or edit context. |
|
| 335 | + * @return string |
|
| 336 | + */ |
|
| 337 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 338 | 338 | $date = $this->get_date_created( $context ); |
| 339 | 339 | |
| 340 | 340 | if ( $date ) { |
| 341 | 341 | $date = get_gmt_from_date( $date ); |
| 342 | 342 | } |
| 343 | - return $date; |
|
| 343 | + return $date; |
|
| 344 | 344 | } |
| 345 | 345 | |
| 346 | 346 | /** |
| 347 | - * Get date when the discount was last modified. |
|
| 348 | - * |
|
| 349 | - * @since 1.0.19 |
|
| 350 | - * @param string $context View or edit context. |
|
| 351 | - * @return string |
|
| 352 | - */ |
|
| 353 | - public function get_date_modified( $context = 'view' ) { |
|
| 354 | - return $this->get_prop( 'date_modified', $context ); |
|
| 347 | + * Get date when the discount was last modified. |
|
| 348 | + * |
|
| 349 | + * @since 1.0.19 |
|
| 350 | + * @param string $context View or edit context. |
|
| 351 | + * @return string |
|
| 352 | + */ |
|
| 353 | + public function get_date_modified( $context = 'view' ) { |
|
| 354 | + return $this->get_prop( 'date_modified', $context ); |
|
| 355 | 355 | } |
| 356 | 356 | |
| 357 | 357 | /** |
| 358 | - * Get GMT date when the discount was last modified. |
|
| 359 | - * |
|
| 360 | - * @since 1.0.19 |
|
| 361 | - * @param string $context View or edit context. |
|
| 362 | - * @return string |
|
| 363 | - */ |
|
| 364 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 358 | + * Get GMT date when the discount was last modified. |
|
| 359 | + * |
|
| 360 | + * @since 1.0.19 |
|
| 361 | + * @param string $context View or edit context. |
|
| 362 | + * @return string |
|
| 363 | + */ |
|
| 364 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 365 | 365 | $date = $this->get_date_modified( $context ); |
| 366 | 366 | |
| 367 | 367 | if ( $date ) { |
| 368 | 368 | $date = get_gmt_from_date( $date ); |
| 369 | 369 | } |
| 370 | - return $date; |
|
| 370 | + return $date; |
|
| 371 | 371 | } |
| 372 | 372 | |
| 373 | 373 | /** |
| 374 | - * Get the discount name. |
|
| 375 | - * |
|
| 376 | - * @since 1.0.19 |
|
| 377 | - * @param string $context View or edit context. |
|
| 378 | - * @return string |
|
| 379 | - */ |
|
| 380 | - public function get_name( $context = 'view' ) { |
|
| 381 | - return $this->get_prop( 'name', $context ); |
|
| 374 | + * Get the discount name. |
|
| 375 | + * |
|
| 376 | + * @since 1.0.19 |
|
| 377 | + * @param string $context View or edit context. |
|
| 378 | + * @return string |
|
| 379 | + */ |
|
| 380 | + public function get_name( $context = 'view' ) { |
|
| 381 | + return $this->get_prop( 'name', $context ); |
|
| 382 | 382 | } |
| 383 | 383 | |
| 384 | 384 | /** |
| 385 | - * Alias of self::get_name(). |
|
| 386 | - * |
|
| 387 | - * @since 1.0.19 |
|
| 388 | - * @param string $context View or edit context. |
|
| 389 | - * @return string |
|
| 390 | - */ |
|
| 391 | - public function get_title( $context = 'view' ) { |
|
| 392 | - return $this->get_name( $context ); |
|
| 385 | + * Alias of self::get_name(). |
|
| 386 | + * |
|
| 387 | + * @since 1.0.19 |
|
| 388 | + * @param string $context View or edit context. |
|
| 389 | + * @return string |
|
| 390 | + */ |
|
| 391 | + public function get_title( $context = 'view' ) { |
|
| 392 | + return $this->get_name( $context ); |
|
| 393 | 393 | } |
| 394 | 394 | |
| 395 | 395 | /** |
| 396 | - * Get the discount description. |
|
| 397 | - * |
|
| 398 | - * @since 1.0.19 |
|
| 399 | - * @param string $context View or edit context. |
|
| 400 | - * @return string |
|
| 401 | - */ |
|
| 402 | - public function get_description( $context = 'view' ) { |
|
| 403 | - return $this->get_prop( 'description', $context ); |
|
| 396 | + * Get the discount description. |
|
| 397 | + * |
|
| 398 | + * @since 1.0.19 |
|
| 399 | + * @param string $context View or edit context. |
|
| 400 | + * @return string |
|
| 401 | + */ |
|
| 402 | + public function get_description( $context = 'view' ) { |
|
| 403 | + return $this->get_prop( 'description', $context ); |
|
| 404 | 404 | } |
| 405 | 405 | |
| 406 | 406 | /** |
| 407 | - * Alias of self::get_description(). |
|
| 408 | - * |
|
| 409 | - * @since 1.0.19 |
|
| 410 | - * @param string $context View or edit context. |
|
| 411 | - * @return string |
|
| 412 | - */ |
|
| 413 | - public function get_excerpt( $context = 'view' ) { |
|
| 414 | - return $this->get_description( $context ); |
|
| 407 | + * Alias of self::get_description(). |
|
| 408 | + * |
|
| 409 | + * @since 1.0.19 |
|
| 410 | + * @param string $context View or edit context. |
|
| 411 | + * @return string |
|
| 412 | + */ |
|
| 413 | + public function get_excerpt( $context = 'view' ) { |
|
| 414 | + return $this->get_description( $context ); |
|
| 415 | 415 | } |
| 416 | 416 | |
| 417 | 417 | /** |
| 418 | - * Alias of self::get_description(). |
|
| 419 | - * |
|
| 420 | - * @since 1.0.19 |
|
| 421 | - * @param string $context View or edit context. |
|
| 422 | - * @return string |
|
| 423 | - */ |
|
| 424 | - public function get_summary( $context = 'view' ) { |
|
| 425 | - return $this->get_description( $context ); |
|
| 418 | + * Alias of self::get_description(). |
|
| 419 | + * |
|
| 420 | + * @since 1.0.19 |
|
| 421 | + * @param string $context View or edit context. |
|
| 422 | + * @return string |
|
| 423 | + */ |
|
| 424 | + public function get_summary( $context = 'view' ) { |
|
| 425 | + return $this->get_description( $context ); |
|
| 426 | 426 | } |
| 427 | 427 | |
| 428 | 428 | /** |
| 429 | - * Get the owner of the discount. |
|
| 430 | - * |
|
| 431 | - * @since 1.0.19 |
|
| 432 | - * @param string $context View or edit context. |
|
| 433 | - * @return string |
|
| 434 | - */ |
|
| 435 | - public function get_author( $context = 'view' ) { |
|
| 436 | - return (int) $this->get_prop( 'author', $context ); |
|
| 437 | - } |
|
| 429 | + * Get the owner of the discount. |
|
| 430 | + * |
|
| 431 | + * @since 1.0.19 |
|
| 432 | + * @param string $context View or edit context. |
|
| 433 | + * @return string |
|
| 434 | + */ |
|
| 435 | + public function get_author( $context = 'view' ) { |
|
| 436 | + return (int) $this->get_prop( 'author', $context ); |
|
| 437 | + } |
|
| 438 | 438 | |
| 439 | - /** |
|
| 440 | - * Get the discount code. |
|
| 441 | - * |
|
| 442 | - * @since 1.0.19 |
|
| 443 | - * @param string $context View or edit context. |
|
| 444 | - * @return string |
|
| 445 | - */ |
|
| 446 | - public function get_code( $context = 'view' ) { |
|
| 447 | - return $this->get_prop( 'code', $context ); |
|
| 448 | - } |
|
| 439 | + /** |
|
| 440 | + * Get the discount code. |
|
| 441 | + * |
|
| 442 | + * @since 1.0.19 |
|
| 443 | + * @param string $context View or edit context. |
|
| 444 | + * @return string |
|
| 445 | + */ |
|
| 446 | + public function get_code( $context = 'view' ) { |
|
| 447 | + return $this->get_prop( 'code', $context ); |
|
| 448 | + } |
|
| 449 | 449 | |
| 450 | - /** |
|
| 451 | - * Alias for self::get_code(). |
|
| 452 | - * |
|
| 453 | - * @since 1.0.19 |
|
| 454 | - * @param string $context View or edit context. |
|
| 455 | - * @return string |
|
| 456 | - */ |
|
| 457 | - public function get_coupon_code( $context = 'view' ) { |
|
| 458 | - return $this->get_code( $context ); |
|
| 459 | - } |
|
| 450 | + /** |
|
| 451 | + * Alias for self::get_code(). |
|
| 452 | + * |
|
| 453 | + * @since 1.0.19 |
|
| 454 | + * @param string $context View or edit context. |
|
| 455 | + * @return string |
|
| 456 | + */ |
|
| 457 | + public function get_coupon_code( $context = 'view' ) { |
|
| 458 | + return $this->get_code( $context ); |
|
| 459 | + } |
|
| 460 | 460 | |
| 461 | - /** |
|
| 462 | - * Alias for self::get_code(). |
|
| 463 | - * |
|
| 464 | - * @since 1.0.19 |
|
| 465 | - * @param string $context View or edit context. |
|
| 466 | - * @return string |
|
| 467 | - */ |
|
| 468 | - public function get_discount_code( $context = 'view' ) { |
|
| 469 | - return $this->get_code( $context ); |
|
| 470 | - } |
|
| 461 | + /** |
|
| 462 | + * Alias for self::get_code(). |
|
| 463 | + * |
|
| 464 | + * @since 1.0.19 |
|
| 465 | + * @param string $context View or edit context. |
|
| 466 | + * @return string |
|
| 467 | + */ |
|
| 468 | + public function get_discount_code( $context = 'view' ) { |
|
| 469 | + return $this->get_code( $context ); |
|
| 470 | + } |
|
| 471 | 471 | |
| 472 | - /** |
|
| 473 | - * Get the discount's amount. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return float |
|
| 478 | - */ |
|
| 479 | - public function get_amount( $context = 'view' ) { |
|
| 480 | - return $this->get_prop( 'amount', $context ); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the discount's formated amount/rate. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return string |
|
| 488 | - */ |
|
| 489 | - public function get_formatted_amount() { |
|
| 490 | - |
|
| 491 | - if ( $this->is_type( 'flat' ) ) { |
|
| 492 | - $rate = wpinv_price( $this->get_amount() ); |
|
| 493 | - } else { |
|
| 494 | - $rate = $this->get_amount() . '%'; |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | - } |
|
| 472 | + /** |
|
| 473 | + * Get the discount's amount. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return float |
|
| 478 | + */ |
|
| 479 | + public function get_amount( $context = 'view' ) { |
|
| 480 | + return $this->get_prop( 'amount', $context ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the discount's formated amount/rate. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return string |
|
| 488 | + */ |
|
| 489 | + public function get_formatted_amount() { |
|
| 490 | + |
|
| 491 | + if ( $this->is_type( 'flat' ) ) { |
|
| 492 | + $rate = wpinv_price( $this->get_amount() ); |
|
| 493 | + } else { |
|
| 494 | + $rate = $this->get_amount() . '%'; |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | + } |
|
| 499 | 499 | |
| 500 | - /** |
|
| 501 | - * Get the discount's start date. |
|
| 502 | - * |
|
| 503 | - * @since 1.0.19 |
|
| 504 | - * @param string $context View or edit context. |
|
| 505 | - * @return string |
|
| 506 | - */ |
|
| 507 | - public function get_start( $context = 'view' ) { |
|
| 508 | - return $this->get_prop( 'start', $context ); |
|
| 509 | - } |
|
| 500 | + /** |
|
| 501 | + * Get the discount's start date. |
|
| 502 | + * |
|
| 503 | + * @since 1.0.19 |
|
| 504 | + * @param string $context View or edit context. |
|
| 505 | + * @return string |
|
| 506 | + */ |
|
| 507 | + public function get_start( $context = 'view' ) { |
|
| 508 | + return $this->get_prop( 'start', $context ); |
|
| 509 | + } |
|
| 510 | 510 | |
| 511 | - /** |
|
| 512 | - * Alias for self::get_start(). |
|
| 513 | - * |
|
| 514 | - * @since 1.0.19 |
|
| 515 | - * @param string $context View or edit context. |
|
| 516 | - * @return string |
|
| 517 | - */ |
|
| 518 | - public function get_start_date( $context = 'view' ) { |
|
| 519 | - return $this->get_start( $context ); |
|
| 520 | - } |
|
| 511 | + /** |
|
| 512 | + * Alias for self::get_start(). |
|
| 513 | + * |
|
| 514 | + * @since 1.0.19 |
|
| 515 | + * @param string $context View or edit context. |
|
| 516 | + * @return string |
|
| 517 | + */ |
|
| 518 | + public function get_start_date( $context = 'view' ) { |
|
| 519 | + return $this->get_start( $context ); |
|
| 520 | + } |
|
| 521 | 521 | |
| 522 | - /** |
|
| 523 | - * Get the discount's expiration date. |
|
| 524 | - * |
|
| 525 | - * @since 1.0.19 |
|
| 526 | - * @param string $context View or edit context. |
|
| 527 | - * @return string |
|
| 528 | - */ |
|
| 529 | - public function get_expiration( $context = 'view' ) { |
|
| 530 | - return $this->get_prop( 'expiration', $context ); |
|
| 531 | - } |
|
| 522 | + /** |
|
| 523 | + * Get the discount's expiration date. |
|
| 524 | + * |
|
| 525 | + * @since 1.0.19 |
|
| 526 | + * @param string $context View or edit context. |
|
| 527 | + * @return string |
|
| 528 | + */ |
|
| 529 | + public function get_expiration( $context = 'view' ) { |
|
| 530 | + return $this->get_prop( 'expiration', $context ); |
|
| 531 | + } |
|
| 532 | 532 | |
| 533 | - /** |
|
| 534 | - * Alias for self::get_expiration(). |
|
| 535 | - * |
|
| 536 | - * @since 1.0.19 |
|
| 537 | - * @param string $context View or edit context. |
|
| 538 | - * @return string |
|
| 539 | - */ |
|
| 540 | - public function get_expiration_date( $context = 'view' ) { |
|
| 541 | - return $this->get_expiration( $context ); |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * Alias for self::get_expiration(). |
|
| 546 | - * |
|
| 547 | - * @since 1.0.19 |
|
| 548 | - * @param string $context View or edit context. |
|
| 549 | - * @return string |
|
| 550 | - */ |
|
| 551 | - public function get_end_date( $context = 'view' ) { |
|
| 552 | - return $this->get_expiration( $context ); |
|
| 553 | - } |
|
| 533 | + /** |
|
| 534 | + * Alias for self::get_expiration(). |
|
| 535 | + * |
|
| 536 | + * @since 1.0.19 |
|
| 537 | + * @param string $context View or edit context. |
|
| 538 | + * @return string |
|
| 539 | + */ |
|
| 540 | + public function get_expiration_date( $context = 'view' ) { |
|
| 541 | + return $this->get_expiration( $context ); |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * Alias for self::get_expiration(). |
|
| 546 | + * |
|
| 547 | + * @since 1.0.19 |
|
| 548 | + * @param string $context View or edit context. |
|
| 549 | + * @return string |
|
| 550 | + */ |
|
| 551 | + public function get_end_date( $context = 'view' ) { |
|
| 552 | + return $this->get_expiration( $context ); |
|
| 553 | + } |
|
| 554 | 554 | |
| 555 | - /** |
|
| 556 | - * Get the discount's type. |
|
| 557 | - * |
|
| 558 | - * @since 1.0.19 |
|
| 559 | - * @param string $context View or edit context. |
|
| 560 | - * @return string |
|
| 561 | - */ |
|
| 562 | - public function get_type( $context = 'view' ) { |
|
| 563 | - return $this->get_prop( 'type', $context ); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Get the number of times a discount has been used. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - * @param string $context View or edit context. |
|
| 571 | - * @return int |
|
| 572 | - */ |
|
| 573 | - public function get_uses( $context = 'view' ) { |
|
| 574 | - return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Get the discount's usage, i.e uses / max uses. |
|
| 579 | - * |
|
| 580 | - * @since 1.0.19 |
|
| 581 | - * @return string |
|
| 582 | - */ |
|
| 583 | - public function get_usage() { |
|
| 584 | - |
|
| 585 | - if ( ! $this->has_limit() ) { |
|
| 586 | - return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | - |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * Get the maximum number of time a discount can be used. |
|
| 595 | - * |
|
| 596 | - * @since 1.0.19 |
|
| 597 | - * @param string $context View or edit context. |
|
| 598 | - * @return int |
|
| 599 | - */ |
|
| 600 | - public function get_max_uses( $context = 'view' ) { |
|
| 601 | - $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | - return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * Checks if this is a single use discount or not. |
|
| 607 | - * |
|
| 608 | - * @since 1.0.19 |
|
| 609 | - * @param string $context View or edit context. |
|
| 610 | - * @return bool |
|
| 611 | - */ |
|
| 612 | - public function get_is_single_use( $context = 'view' ) { |
|
| 613 | - return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | - } |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * Get the items that can be used with this discount. |
|
| 618 | - * |
|
| 619 | - * @since 1.0.19 |
|
| 620 | - * @param string $context View or edit context. |
|
| 621 | - * @return array |
|
| 622 | - */ |
|
| 623 | - public function get_items( $context = 'view' ) { |
|
| 624 | - return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - /** |
|
| 628 | - * Alias for self::get_items(). |
|
| 629 | - * |
|
| 630 | - * @since 1.0.19 |
|
| 631 | - * @param string $context View or edit context. |
|
| 632 | - * @return array |
|
| 633 | - */ |
|
| 634 | - public function get_allowed_items( $context = 'view' ) { |
|
| 635 | - return $this->get_items( $context ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Get the items that are not allowed to use this discount. |
|
| 640 | - * |
|
| 641 | - * @since 1.0.19 |
|
| 642 | - * @param string $context View or edit context. |
|
| 643 | - * @return array |
|
| 644 | - */ |
|
| 645 | - public function get_excluded_items( $context = 'view' ) { |
|
| 646 | - return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - /** |
|
| 650 | - * Checks if this is a recurring discount or not. |
|
| 651 | - * |
|
| 652 | - * @since 1.0.19 |
|
| 653 | - * @param string $context View or edit context. |
|
| 654 | - * @return int|string|bool |
|
| 655 | - */ |
|
| 656 | - public function get_is_recurring( $context = 'view' ) { |
|
| 657 | - return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | - } |
|
| 659 | - |
|
| 660 | - /** |
|
| 661 | - * Get's the minimum total amount allowed for this discount. |
|
| 662 | - * |
|
| 663 | - * @since 1.0.19 |
|
| 664 | - * @param string $context View or edit context. |
|
| 665 | - * @return float |
|
| 666 | - */ |
|
| 667 | - public function get_min_total( $context = 'view' ) { |
|
| 668 | - $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | - return empty( $minimum ) ? null : $minimum; |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - /** |
|
| 673 | - * Alias for self::get_min_total(). |
|
| 674 | - * |
|
| 675 | - * @since 1.0.19 |
|
| 676 | - * @param string $context View or edit context. |
|
| 677 | - * @return float |
|
| 678 | - */ |
|
| 679 | - public function get_minimum_total( $context = 'view' ) { |
|
| 680 | - return $this->get_min_total( $context ); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Get's the maximum total amount allowed for this discount. |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $context View or edit context. |
|
| 688 | - * @return float |
|
| 689 | - */ |
|
| 690 | - public function get_max_total( $context = 'view' ) { |
|
| 691 | - $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | - return empty( $maximum ) ? null : $maximum; |
|
| 693 | - } |
|
| 694 | - |
|
| 695 | - /** |
|
| 696 | - * Alias for self::get_max_total(). |
|
| 697 | - * |
|
| 698 | - * @since 1.0.19 |
|
| 699 | - * @param string $context View or edit context. |
|
| 700 | - * @return float |
|
| 701 | - */ |
|
| 702 | - public function get_maximum_total( $context = 'view' ) { |
|
| 703 | - return $this->get_max_total( $context ); |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - /** |
|
| 707 | - * Magic method for accessing discount properties. |
|
| 708 | - * |
|
| 709 | - * @since 1.0.15 |
|
| 710 | - * @access public |
|
| 711 | - * |
|
| 712 | - * @param string $key Discount data to retrieve |
|
| 713 | - * @param string $context View or edit context. |
|
| 714 | - * @return mixed Value of the given discount property (if set). |
|
| 715 | - */ |
|
| 716 | - public function get( $key, $context = 'view' ) { |
|
| 555 | + /** |
|
| 556 | + * Get the discount's type. |
|
| 557 | + * |
|
| 558 | + * @since 1.0.19 |
|
| 559 | + * @param string $context View or edit context. |
|
| 560 | + * @return string |
|
| 561 | + */ |
|
| 562 | + public function get_type( $context = 'view' ) { |
|
| 563 | + return $this->get_prop( 'type', $context ); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Get the number of times a discount has been used. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + * @param string $context View or edit context. |
|
| 571 | + * @return int |
|
| 572 | + */ |
|
| 573 | + public function get_uses( $context = 'view' ) { |
|
| 574 | + return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Get the discount's usage, i.e uses / max uses. |
|
| 579 | + * |
|
| 580 | + * @since 1.0.19 |
|
| 581 | + * @return string |
|
| 582 | + */ |
|
| 583 | + public function get_usage() { |
|
| 584 | + |
|
| 585 | + if ( ! $this->has_limit() ) { |
|
| 586 | + return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | + |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * Get the maximum number of time a discount can be used. |
|
| 595 | + * |
|
| 596 | + * @since 1.0.19 |
|
| 597 | + * @param string $context View or edit context. |
|
| 598 | + * @return int |
|
| 599 | + */ |
|
| 600 | + public function get_max_uses( $context = 'view' ) { |
|
| 601 | + $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | + return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * Checks if this is a single use discount or not. |
|
| 607 | + * |
|
| 608 | + * @since 1.0.19 |
|
| 609 | + * @param string $context View or edit context. |
|
| 610 | + * @return bool |
|
| 611 | + */ |
|
| 612 | + public function get_is_single_use( $context = 'view' ) { |
|
| 613 | + return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | + } |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * Get the items that can be used with this discount. |
|
| 618 | + * |
|
| 619 | + * @since 1.0.19 |
|
| 620 | + * @param string $context View or edit context. |
|
| 621 | + * @return array |
|
| 622 | + */ |
|
| 623 | + public function get_items( $context = 'view' ) { |
|
| 624 | + return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + /** |
|
| 628 | + * Alias for self::get_items(). |
|
| 629 | + * |
|
| 630 | + * @since 1.0.19 |
|
| 631 | + * @param string $context View or edit context. |
|
| 632 | + * @return array |
|
| 633 | + */ |
|
| 634 | + public function get_allowed_items( $context = 'view' ) { |
|
| 635 | + return $this->get_items( $context ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Get the items that are not allowed to use this discount. |
|
| 640 | + * |
|
| 641 | + * @since 1.0.19 |
|
| 642 | + * @param string $context View or edit context. |
|
| 643 | + * @return array |
|
| 644 | + */ |
|
| 645 | + public function get_excluded_items( $context = 'view' ) { |
|
| 646 | + return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + /** |
|
| 650 | + * Checks if this is a recurring discount or not. |
|
| 651 | + * |
|
| 652 | + * @since 1.0.19 |
|
| 653 | + * @param string $context View or edit context. |
|
| 654 | + * @return int|string|bool |
|
| 655 | + */ |
|
| 656 | + public function get_is_recurring( $context = 'view' ) { |
|
| 657 | + return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | + } |
|
| 659 | + |
|
| 660 | + /** |
|
| 661 | + * Get's the minimum total amount allowed for this discount. |
|
| 662 | + * |
|
| 663 | + * @since 1.0.19 |
|
| 664 | + * @param string $context View or edit context. |
|
| 665 | + * @return float |
|
| 666 | + */ |
|
| 667 | + public function get_min_total( $context = 'view' ) { |
|
| 668 | + $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | + return empty( $minimum ) ? null : $minimum; |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + /** |
|
| 673 | + * Alias for self::get_min_total(). |
|
| 674 | + * |
|
| 675 | + * @since 1.0.19 |
|
| 676 | + * @param string $context View or edit context. |
|
| 677 | + * @return float |
|
| 678 | + */ |
|
| 679 | + public function get_minimum_total( $context = 'view' ) { |
|
| 680 | + return $this->get_min_total( $context ); |
|
| 681 | + } |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Get's the maximum total amount allowed for this discount. |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $context View or edit context. |
|
| 688 | + * @return float |
|
| 689 | + */ |
|
| 690 | + public function get_max_total( $context = 'view' ) { |
|
| 691 | + $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | + return empty( $maximum ) ? null : $maximum; |
|
| 693 | + } |
|
| 694 | + |
|
| 695 | + /** |
|
| 696 | + * Alias for self::get_max_total(). |
|
| 697 | + * |
|
| 698 | + * @since 1.0.19 |
|
| 699 | + * @param string $context View or edit context. |
|
| 700 | + * @return float |
|
| 701 | + */ |
|
| 702 | + public function get_maximum_total( $context = 'view' ) { |
|
| 703 | + return $this->get_max_total( $context ); |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + /** |
|
| 707 | + * Magic method for accessing discount properties. |
|
| 708 | + * |
|
| 709 | + * @since 1.0.15 |
|
| 710 | + * @access public |
|
| 711 | + * |
|
| 712 | + * @param string $key Discount data to retrieve |
|
| 713 | + * @param string $context View or edit context. |
|
| 714 | + * @return mixed Value of the given discount property (if set). |
|
| 715 | + */ |
|
| 716 | + public function get( $key, $context = 'view' ) { |
|
| 717 | 717 | return $this->get_prop( $key, $context ); |
| 718 | - } |
|
| 718 | + } |
|
| 719 | 719 | |
| 720 | - /* |
|
| 720 | + /* |
|
| 721 | 721 | |-------------------------------------------------------------------------- |
| 722 | 722 | | Setters |
| 723 | 723 | |-------------------------------------------------------------------------- |
@@ -727,41 +727,41 @@ discard block |
||
| 727 | 727 | | object. |
| 728 | 728 | */ |
| 729 | 729 | |
| 730 | - /** |
|
| 731 | - * Sets discount status. |
|
| 732 | - * |
|
| 733 | - * @since 1.0.19 |
|
| 734 | - * @param string $status New status. |
|
| 735 | - * @return array details of change. |
|
| 736 | - */ |
|
| 737 | - public function set_status( $status ) { |
|
| 730 | + /** |
|
| 731 | + * Sets discount status. |
|
| 732 | + * |
|
| 733 | + * @since 1.0.19 |
|
| 734 | + * @param string $status New status. |
|
| 735 | + * @return array details of change. |
|
| 736 | + */ |
|
| 737 | + public function set_status( $status ) { |
|
| 738 | 738 | $old_status = $this->get_status(); |
| 739 | 739 | |
| 740 | 740 | $this->set_prop( 'status', $status ); |
| 741 | 741 | |
| 742 | - return array( |
|
| 743 | - 'from' => $old_status, |
|
| 744 | - 'to' => $status, |
|
| 745 | - ); |
|
| 742 | + return array( |
|
| 743 | + 'from' => $old_status, |
|
| 744 | + 'to' => $status, |
|
| 745 | + ); |
|
| 746 | 746 | } |
| 747 | 747 | |
| 748 | 748 | /** |
| 749 | - * Set plugin version when the discount was created. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - */ |
|
| 753 | - public function set_version( $value ) { |
|
| 754 | - $this->set_prop( 'version', $value ); |
|
| 749 | + * Set plugin version when the discount was created. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + */ |
|
| 753 | + public function set_version( $value ) { |
|
| 754 | + $this->set_prop( 'version', $value ); |
|
| 755 | 755 | } |
| 756 | 756 | |
| 757 | 757 | /** |
| 758 | - * Set date when the discount was created. |
|
| 759 | - * |
|
| 760 | - * @since 1.0.19 |
|
| 761 | - * @param string $value Value to set. |
|
| 758 | + * Set date when the discount was created. |
|
| 759 | + * |
|
| 760 | + * @since 1.0.19 |
|
| 761 | + * @param string $value Value to set. |
|
| 762 | 762 | * @return bool Whether or not the date was set. |
| 763 | - */ |
|
| 764 | - public function set_date_created( $value ) { |
|
| 763 | + */ |
|
| 764 | + public function set_date_created( $value ) { |
|
| 765 | 765 | $date = strtotime( $value ); |
| 766 | 766 | |
| 767 | 767 | if ( $date ) { |
@@ -774,13 +774,13 @@ discard block |
||
| 774 | 774 | } |
| 775 | 775 | |
| 776 | 776 | /** |
| 777 | - * Set date when the discount was last modified. |
|
| 778 | - * |
|
| 779 | - * @since 1.0.19 |
|
| 780 | - * @param string $value Value to set. |
|
| 777 | + * Set date when the discount was last modified. |
|
| 778 | + * |
|
| 779 | + * @since 1.0.19 |
|
| 780 | + * @param string $value Value to set. |
|
| 781 | 781 | * @return bool Whether or not the date was set. |
| 782 | - */ |
|
| 783 | - public function set_date_modified( $value ) { |
|
| 782 | + */ |
|
| 783 | + public function set_date_modified( $value ) { |
|
| 784 | 784 | $date = strtotime( $value ); |
| 785 | 785 | |
| 786 | 786 | if ( $date ) { |
@@ -793,324 +793,324 @@ discard block |
||
| 793 | 793 | } |
| 794 | 794 | |
| 795 | 795 | /** |
| 796 | - * Set the discount name. |
|
| 797 | - * |
|
| 798 | - * @since 1.0.19 |
|
| 799 | - * @param string $value New name. |
|
| 800 | - */ |
|
| 801 | - public function set_name( $value ) { |
|
| 796 | + * Set the discount name. |
|
| 797 | + * |
|
| 798 | + * @since 1.0.19 |
|
| 799 | + * @param string $value New name. |
|
| 800 | + */ |
|
| 801 | + public function set_name( $value ) { |
|
| 802 | 802 | $name = sanitize_text_field( $value ); |
| 803 | - $this->set_prop( 'name', $name ); |
|
| 803 | + $this->set_prop( 'name', $name ); |
|
| 804 | 804 | } |
| 805 | 805 | |
| 806 | 806 | /** |
| 807 | - * Alias of self::set_name(). |
|
| 808 | - * |
|
| 809 | - * @since 1.0.19 |
|
| 810 | - * @param string $value New name. |
|
| 811 | - */ |
|
| 812 | - public function set_title( $value ) { |
|
| 813 | - $this->set_name( $value ); |
|
| 807 | + * Alias of self::set_name(). |
|
| 808 | + * |
|
| 809 | + * @since 1.0.19 |
|
| 810 | + * @param string $value New name. |
|
| 811 | + */ |
|
| 812 | + public function set_title( $value ) { |
|
| 813 | + $this->set_name( $value ); |
|
| 814 | 814 | } |
| 815 | 815 | |
| 816 | 816 | /** |
| 817 | - * Set the discount description. |
|
| 818 | - * |
|
| 819 | - * @since 1.0.19 |
|
| 820 | - * @param string $value New description. |
|
| 821 | - */ |
|
| 822 | - public function set_description( $value ) { |
|
| 817 | + * Set the discount description. |
|
| 818 | + * |
|
| 819 | + * @since 1.0.19 |
|
| 820 | + * @param string $value New description. |
|
| 821 | + */ |
|
| 822 | + public function set_description( $value ) { |
|
| 823 | 823 | $description = wp_kses_post( $value ); |
| 824 | - return $this->set_prop( 'description', $description ); |
|
| 824 | + return $this->set_prop( 'description', $description ); |
|
| 825 | 825 | } |
| 826 | 826 | |
| 827 | 827 | /** |
| 828 | - * Alias of self::set_description(). |
|
| 829 | - * |
|
| 830 | - * @since 1.0.19 |
|
| 831 | - * @param string $value New description. |
|
| 832 | - */ |
|
| 833 | - public function set_excerpt( $value ) { |
|
| 834 | - $this->set_description( $value ); |
|
| 828 | + * Alias of self::set_description(). |
|
| 829 | + * |
|
| 830 | + * @since 1.0.19 |
|
| 831 | + * @param string $value New description. |
|
| 832 | + */ |
|
| 833 | + public function set_excerpt( $value ) { |
|
| 834 | + $this->set_description( $value ); |
|
| 835 | 835 | } |
| 836 | 836 | |
| 837 | 837 | /** |
| 838 | - * Alias of self::set_description(). |
|
| 839 | - * |
|
| 840 | - * @since 1.0.19 |
|
| 841 | - * @param string $value New description. |
|
| 842 | - */ |
|
| 843 | - public function set_summary( $value ) { |
|
| 844 | - $this->set_description( $value ); |
|
| 838 | + * Alias of self::set_description(). |
|
| 839 | + * |
|
| 840 | + * @since 1.0.19 |
|
| 841 | + * @param string $value New description. |
|
| 842 | + */ |
|
| 843 | + public function set_summary( $value ) { |
|
| 844 | + $this->set_description( $value ); |
|
| 845 | 845 | } |
| 846 | 846 | |
| 847 | 847 | /** |
| 848 | - * Set the owner of the discount. |
|
| 849 | - * |
|
| 850 | - * @since 1.0.19 |
|
| 851 | - * @param int $value New author. |
|
| 852 | - */ |
|
| 853 | - public function set_author( $value ) { |
|
| 854 | - $this->set_prop( 'author', (int) $value ); |
|
| 855 | - } |
|
| 848 | + * Set the owner of the discount. |
|
| 849 | + * |
|
| 850 | + * @since 1.0.19 |
|
| 851 | + * @param int $value New author. |
|
| 852 | + */ |
|
| 853 | + public function set_author( $value ) { |
|
| 854 | + $this->set_prop( 'author', (int) $value ); |
|
| 855 | + } |
|
| 856 | 856 | |
| 857 | - /** |
|
| 858 | - * Sets the discount code. |
|
| 859 | - * |
|
| 860 | - * @since 1.0.19 |
|
| 861 | - * @param string $value New discount code. |
|
| 862 | - */ |
|
| 863 | - public function set_code( $value ) { |
|
| 864 | - $code = sanitize_text_field( $value ); |
|
| 865 | - $this->set_prop( 'code', $code ); |
|
| 866 | - } |
|
| 857 | + /** |
|
| 858 | + * Sets the discount code. |
|
| 859 | + * |
|
| 860 | + * @since 1.0.19 |
|
| 861 | + * @param string $value New discount code. |
|
| 862 | + */ |
|
| 863 | + public function set_code( $value ) { |
|
| 864 | + $code = sanitize_text_field( $value ); |
|
| 865 | + $this->set_prop( 'code', $code ); |
|
| 866 | + } |
|
| 867 | 867 | |
| 868 | - /** |
|
| 869 | - * Alias of self::set_code(). |
|
| 870 | - * |
|
| 871 | - * @since 1.0.19 |
|
| 872 | - * @param string $value New discount code. |
|
| 873 | - */ |
|
| 874 | - public function set_coupon_code( $value ) { |
|
| 875 | - $this->set_code( $value ); |
|
| 876 | - } |
|
| 868 | + /** |
|
| 869 | + * Alias of self::set_code(). |
|
| 870 | + * |
|
| 871 | + * @since 1.0.19 |
|
| 872 | + * @param string $value New discount code. |
|
| 873 | + */ |
|
| 874 | + public function set_coupon_code( $value ) { |
|
| 875 | + $this->set_code( $value ); |
|
| 876 | + } |
|
| 877 | 877 | |
| 878 | - /** |
|
| 879 | - * Alias of self::set_code(). |
|
| 880 | - * |
|
| 881 | - * @since 1.0.19 |
|
| 882 | - * @param string $value New discount code. |
|
| 883 | - */ |
|
| 884 | - public function set_discount_code( $value ) { |
|
| 885 | - $this->set_code( $value ); |
|
| 886 | - } |
|
| 878 | + /** |
|
| 879 | + * Alias of self::set_code(). |
|
| 880 | + * |
|
| 881 | + * @since 1.0.19 |
|
| 882 | + * @param string $value New discount code. |
|
| 883 | + */ |
|
| 884 | + public function set_discount_code( $value ) { |
|
| 885 | + $this->set_code( $value ); |
|
| 886 | + } |
|
| 887 | 887 | |
| 888 | - /** |
|
| 889 | - * Sets the discount amount. |
|
| 890 | - * |
|
| 891 | - * @since 1.0.19 |
|
| 892 | - * @param float $value New discount code. |
|
| 893 | - */ |
|
| 894 | - public function set_amount( $value ) { |
|
| 895 | - $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | - $this->set_prop( 'amount', $amount ); |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - /** |
|
| 900 | - * Sets the discount's start date. |
|
| 901 | - * |
|
| 902 | - * @since 1.0.19 |
|
| 903 | - * @param float $value New start date. |
|
| 904 | - */ |
|
| 905 | - public function set_start( $value ) { |
|
| 906 | - $date = strtotime( $value ); |
|
| 888 | + /** |
|
| 889 | + * Sets the discount amount. |
|
| 890 | + * |
|
| 891 | + * @since 1.0.19 |
|
| 892 | + * @param float $value New discount code. |
|
| 893 | + */ |
|
| 894 | + public function set_amount( $value ) { |
|
| 895 | + $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | + $this->set_prop( 'amount', $amount ); |
|
| 897 | + } |
|
| 907 | 898 | |
| 908 | - if ( $date ) { |
|
| 909 | - $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
| 910 | - return true; |
|
| 911 | - } |
|
| 899 | + /** |
|
| 900 | + * Sets the discount's start date. |
|
| 901 | + * |
|
| 902 | + * @since 1.0.19 |
|
| 903 | + * @param float $value New start date. |
|
| 904 | + */ |
|
| 905 | + public function set_start( $value ) { |
|
| 906 | + $date = strtotime( $value ); |
|
| 907 | + |
|
| 908 | + if ( $date ) { |
|
| 909 | + $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
| 910 | + return true; |
|
| 911 | + } |
|
| 912 | 912 | |
| 913 | - $this->set_prop( 'start', '' ); |
|
| 913 | + $this->set_prop( 'start', '' ); |
|
| 914 | 914 | |
| 915 | 915 | return false; |
| 916 | - } |
|
| 917 | - |
|
| 918 | - /** |
|
| 919 | - * Alias of self::set_start(). |
|
| 920 | - * |
|
| 921 | - * @since 1.0.19 |
|
| 922 | - * @param string $value New start date. |
|
| 923 | - */ |
|
| 924 | - public function set_start_date( $value ) { |
|
| 925 | - $this->set_start( $value ); |
|
| 926 | - } |
|
| 927 | - |
|
| 928 | - /** |
|
| 929 | - * Sets the discount's expiration date. |
|
| 930 | - * |
|
| 931 | - * @since 1.0.19 |
|
| 932 | - * @param float $value New expiration date. |
|
| 933 | - */ |
|
| 934 | - public function set_expiration( $value ) { |
|
| 935 | - $date = strtotime( $value ); |
|
| 916 | + } |
|
| 917 | + |
|
| 918 | + /** |
|
| 919 | + * Alias of self::set_start(). |
|
| 920 | + * |
|
| 921 | + * @since 1.0.19 |
|
| 922 | + * @param string $value New start date. |
|
| 923 | + */ |
|
| 924 | + public function set_start_date( $value ) { |
|
| 925 | + $this->set_start( $value ); |
|
| 926 | + } |
|
| 927 | + |
|
| 928 | + /** |
|
| 929 | + * Sets the discount's expiration date. |
|
| 930 | + * |
|
| 931 | + * @since 1.0.19 |
|
| 932 | + * @param float $value New expiration date. |
|
| 933 | + */ |
|
| 934 | + public function set_expiration( $value ) { |
|
| 935 | + $date = strtotime( $value ); |
|
| 936 | 936 | |
| 937 | 937 | if ( $date ) { |
| 938 | 938 | $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) ); |
| 939 | 939 | return true; |
| 940 | 940 | } |
| 941 | 941 | |
| 942 | - $this->set_prop( 'expiration', '' ); |
|
| 942 | + $this->set_prop( 'expiration', '' ); |
|
| 943 | 943 | return false; |
| 944 | - } |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Alias of self::set_expiration(). |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param string $value New expiration date. |
|
| 951 | - */ |
|
| 952 | - public function set_expiration_date( $value ) { |
|
| 953 | - $this->set_expiration( $value ); |
|
| 954 | - } |
|
| 955 | - |
|
| 956 | - /** |
|
| 957 | - * Alias of self::set_expiration(). |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param string $value New expiration date. |
|
| 961 | - */ |
|
| 962 | - public function set_end_date( $value ) { |
|
| 963 | - $this->set_expiration( $value ); |
|
| 964 | - } |
|
| 965 | - |
|
| 966 | - /** |
|
| 967 | - * Sets the discount type. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param string $value New discount type. |
|
| 971 | - */ |
|
| 972 | - public function set_type( $value ) { |
|
| 973 | - if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | - $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | - } |
|
| 976 | - } |
|
| 977 | - |
|
| 978 | - /** |
|
| 979 | - * Sets the number of times a discount has been used. |
|
| 980 | - * |
|
| 981 | - * @since 1.0.19 |
|
| 982 | - * @param int $value usage count. |
|
| 983 | - */ |
|
| 984 | - public function set_uses( $value ) { |
|
| 985 | - |
|
| 986 | - $value = (int) $value; |
|
| 987 | - |
|
| 988 | - if ( $value < 0 ) { |
|
| 989 | - $value = 0; |
|
| 990 | - } |
|
| 991 | - |
|
| 992 | - $this->set_prop( 'uses', (int) $value ); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - /** |
|
| 996 | - * Sets the maximum number of times a discount can be used. |
|
| 997 | - * |
|
| 998 | - * @since 1.0.19 |
|
| 999 | - * @param int $value maximum usage count. |
|
| 1000 | - */ |
|
| 1001 | - public function set_max_uses( $value ) { |
|
| 1002 | - $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | - } |
|
| 1004 | - |
|
| 1005 | - /** |
|
| 1006 | - * Sets if this is a single use discount or not. |
|
| 1007 | - * |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int|bool $value is single use. |
|
| 1010 | - */ |
|
| 1011 | - public function set_is_single_use( $value ) { |
|
| 1012 | - $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | - } |
|
| 1014 | - |
|
| 1015 | - /** |
|
| 1016 | - * Sets the items that can be used with this discount. |
|
| 1017 | - * |
|
| 1018 | - * @since 1.0.19 |
|
| 1019 | - * @param array $value items. |
|
| 1020 | - */ |
|
| 1021 | - public function set_items( $value ) { |
|
| 1022 | - $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | - } |
|
| 1024 | - |
|
| 1025 | - /** |
|
| 1026 | - * Alias for self::set_items(). |
|
| 1027 | - * |
|
| 1028 | - * @since 1.0.19 |
|
| 1029 | - * @param array $value items. |
|
| 1030 | - */ |
|
| 1031 | - public function set_allowed_items( $value ) { |
|
| 1032 | - $this->set_items( $value ); |
|
| 1033 | - } |
|
| 1034 | - |
|
| 1035 | - /** |
|
| 1036 | - * Sets the items that can not be used with this discount. |
|
| 1037 | - * |
|
| 1038 | - * @since 1.0.19 |
|
| 1039 | - * @param array $value items. |
|
| 1040 | - */ |
|
| 1041 | - public function set_excluded_items( $value ) { |
|
| 1042 | - $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | - } |
|
| 1044 | - |
|
| 1045 | - /** |
|
| 1046 | - * Sets if this is a recurring discounts or not. |
|
| 1047 | - * |
|
| 1048 | - * @since 1.0.19 |
|
| 1049 | - * @param int|bool $value is recurring. |
|
| 1050 | - */ |
|
| 1051 | - public function set_is_recurring( $value ) { |
|
| 1052 | - $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | - } |
|
| 1054 | - |
|
| 1055 | - /** |
|
| 1056 | - * Sets the minimum total that can not be used with this discount. |
|
| 1057 | - * |
|
| 1058 | - * @since 1.0.19 |
|
| 1059 | - * @param float $value minimum total. |
|
| 1060 | - */ |
|
| 1061 | - public function set_min_total( $value ) { |
|
| 1062 | - $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | - } |
|
| 1064 | - |
|
| 1065 | - /** |
|
| 1066 | - * Alias for self::set_min_total(). |
|
| 1067 | - * |
|
| 1068 | - * @since 1.0.19 |
|
| 1069 | - * @param float $value minimum total. |
|
| 1070 | - */ |
|
| 1071 | - public function set_minimum_total( $value ) { |
|
| 1072 | - $this->set_min_total( $value ); |
|
| 1073 | - } |
|
| 1074 | - |
|
| 1075 | - /** |
|
| 1076 | - * Sets the maximum total that can not be used with this discount. |
|
| 1077 | - * |
|
| 1078 | - * @since 1.0.19 |
|
| 1079 | - * @param float $value maximum total. |
|
| 1080 | - */ |
|
| 1081 | - public function set_max_total( $value ) { |
|
| 1082 | - $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | - } |
|
| 1084 | - |
|
| 1085 | - /** |
|
| 1086 | - * Alias for self::set_max_total(). |
|
| 1087 | - * |
|
| 1088 | - * @since 1.0.19 |
|
| 1089 | - * @param float $value maximum total. |
|
| 1090 | - */ |
|
| 1091 | - public function set_maximum_total( $value ) { |
|
| 1092 | - $this->set_max_total( $value ); |
|
| 1093 | - } |
|
| 1094 | - |
|
| 1095 | - /** |
|
| 1096 | - * @deprecated |
|
| 1097 | - */ |
|
| 1098 | - public function refresh(){} |
|
| 1099 | - |
|
| 1100 | - /** |
|
| 1101 | - * @deprecated |
|
| 1102 | - * |
|
| 1103 | - */ |
|
| 1104 | - public function update_status( $status = 'publish' ){ |
|
| 1105 | - |
|
| 1106 | - if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | - $this->set_status( $status ); |
|
| 1108 | - $this->save(); |
|
| 1109 | - } |
|
| 1110 | - |
|
| 1111 | - } |
|
| 1112 | - |
|
| 1113 | - /* |
|
| 944 | + } |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Alias of self::set_expiration(). |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param string $value New expiration date. |
|
| 951 | + */ |
|
| 952 | + public function set_expiration_date( $value ) { |
|
| 953 | + $this->set_expiration( $value ); |
|
| 954 | + } |
|
| 955 | + |
|
| 956 | + /** |
|
| 957 | + * Alias of self::set_expiration(). |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param string $value New expiration date. |
|
| 961 | + */ |
|
| 962 | + public function set_end_date( $value ) { |
|
| 963 | + $this->set_expiration( $value ); |
|
| 964 | + } |
|
| 965 | + |
|
| 966 | + /** |
|
| 967 | + * Sets the discount type. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param string $value New discount type. |
|
| 971 | + */ |
|
| 972 | + public function set_type( $value ) { |
|
| 973 | + if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | + $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | + } |
|
| 976 | + } |
|
| 977 | + |
|
| 978 | + /** |
|
| 979 | + * Sets the number of times a discount has been used. |
|
| 980 | + * |
|
| 981 | + * @since 1.0.19 |
|
| 982 | + * @param int $value usage count. |
|
| 983 | + */ |
|
| 984 | + public function set_uses( $value ) { |
|
| 985 | + |
|
| 986 | + $value = (int) $value; |
|
| 987 | + |
|
| 988 | + if ( $value < 0 ) { |
|
| 989 | + $value = 0; |
|
| 990 | + } |
|
| 991 | + |
|
| 992 | + $this->set_prop( 'uses', (int) $value ); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + /** |
|
| 996 | + * Sets the maximum number of times a discount can be used. |
|
| 997 | + * |
|
| 998 | + * @since 1.0.19 |
|
| 999 | + * @param int $value maximum usage count. |
|
| 1000 | + */ |
|
| 1001 | + public function set_max_uses( $value ) { |
|
| 1002 | + $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | + } |
|
| 1004 | + |
|
| 1005 | + /** |
|
| 1006 | + * Sets if this is a single use discount or not. |
|
| 1007 | + * |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int|bool $value is single use. |
|
| 1010 | + */ |
|
| 1011 | + public function set_is_single_use( $value ) { |
|
| 1012 | + $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | + } |
|
| 1014 | + |
|
| 1015 | + /** |
|
| 1016 | + * Sets the items that can be used with this discount. |
|
| 1017 | + * |
|
| 1018 | + * @since 1.0.19 |
|
| 1019 | + * @param array $value items. |
|
| 1020 | + */ |
|
| 1021 | + public function set_items( $value ) { |
|
| 1022 | + $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | + } |
|
| 1024 | + |
|
| 1025 | + /** |
|
| 1026 | + * Alias for self::set_items(). |
|
| 1027 | + * |
|
| 1028 | + * @since 1.0.19 |
|
| 1029 | + * @param array $value items. |
|
| 1030 | + */ |
|
| 1031 | + public function set_allowed_items( $value ) { |
|
| 1032 | + $this->set_items( $value ); |
|
| 1033 | + } |
|
| 1034 | + |
|
| 1035 | + /** |
|
| 1036 | + * Sets the items that can not be used with this discount. |
|
| 1037 | + * |
|
| 1038 | + * @since 1.0.19 |
|
| 1039 | + * @param array $value items. |
|
| 1040 | + */ |
|
| 1041 | + public function set_excluded_items( $value ) { |
|
| 1042 | + $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | + } |
|
| 1044 | + |
|
| 1045 | + /** |
|
| 1046 | + * Sets if this is a recurring discounts or not. |
|
| 1047 | + * |
|
| 1048 | + * @since 1.0.19 |
|
| 1049 | + * @param int|bool $value is recurring. |
|
| 1050 | + */ |
|
| 1051 | + public function set_is_recurring( $value ) { |
|
| 1052 | + $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | + } |
|
| 1054 | + |
|
| 1055 | + /** |
|
| 1056 | + * Sets the minimum total that can not be used with this discount. |
|
| 1057 | + * |
|
| 1058 | + * @since 1.0.19 |
|
| 1059 | + * @param float $value minimum total. |
|
| 1060 | + */ |
|
| 1061 | + public function set_min_total( $value ) { |
|
| 1062 | + $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | + } |
|
| 1064 | + |
|
| 1065 | + /** |
|
| 1066 | + * Alias for self::set_min_total(). |
|
| 1067 | + * |
|
| 1068 | + * @since 1.0.19 |
|
| 1069 | + * @param float $value minimum total. |
|
| 1070 | + */ |
|
| 1071 | + public function set_minimum_total( $value ) { |
|
| 1072 | + $this->set_min_total( $value ); |
|
| 1073 | + } |
|
| 1074 | + |
|
| 1075 | + /** |
|
| 1076 | + * Sets the maximum total that can not be used with this discount. |
|
| 1077 | + * |
|
| 1078 | + * @since 1.0.19 |
|
| 1079 | + * @param float $value maximum total. |
|
| 1080 | + */ |
|
| 1081 | + public function set_max_total( $value ) { |
|
| 1082 | + $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | + } |
|
| 1084 | + |
|
| 1085 | + /** |
|
| 1086 | + * Alias for self::set_max_total(). |
|
| 1087 | + * |
|
| 1088 | + * @since 1.0.19 |
|
| 1089 | + * @param float $value maximum total. |
|
| 1090 | + */ |
|
| 1091 | + public function set_maximum_total( $value ) { |
|
| 1092 | + $this->set_max_total( $value ); |
|
| 1093 | + } |
|
| 1094 | + |
|
| 1095 | + /** |
|
| 1096 | + * @deprecated |
|
| 1097 | + */ |
|
| 1098 | + public function refresh(){} |
|
| 1099 | + |
|
| 1100 | + /** |
|
| 1101 | + * @deprecated |
|
| 1102 | + * |
|
| 1103 | + */ |
|
| 1104 | + public function update_status( $status = 'publish' ){ |
|
| 1105 | + |
|
| 1106 | + if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | + $this->set_status( $status ); |
|
| 1108 | + $this->save(); |
|
| 1109 | + } |
|
| 1110 | + |
|
| 1111 | + } |
|
| 1112 | + |
|
| 1113 | + /* |
|
| 1114 | 1114 | |-------------------------------------------------------------------------- |
| 1115 | 1115 | | Conditionals |
| 1116 | 1116 | |-------------------------------------------------------------------------- |
@@ -1119,263 +1119,263 @@ discard block |
||
| 1119 | 1119 | | |
| 1120 | 1120 | */ |
| 1121 | 1121 | |
| 1122 | - /** |
|
| 1123 | - * Checks whether a discount exists in the database or not |
|
| 1124 | - * |
|
| 1125 | - * @since 1.0.15 |
|
| 1126 | - */ |
|
| 1127 | - public function exists(){ |
|
| 1128 | - $id = $this->get_id(); |
|
| 1129 | - return ! empty( $id ); |
|
| 1130 | - } |
|
| 1131 | - |
|
| 1132 | - /** |
|
| 1133 | - * Checks the discount type. |
|
| 1134 | - * |
|
| 1135 | - * |
|
| 1136 | - * @param string $type the discount type to check against |
|
| 1137 | - * @since 1.0.15 |
|
| 1138 | - * @return bool |
|
| 1139 | - */ |
|
| 1140 | - public function is_type( $type ) { |
|
| 1141 | - return $this->get_type() == $type; |
|
| 1142 | - } |
|
| 1143 | - |
|
| 1144 | - /** |
|
| 1145 | - * Checks whether the discount is published or not |
|
| 1146 | - * |
|
| 1147 | - * @since 1.0.15 |
|
| 1148 | - * @return bool |
|
| 1149 | - */ |
|
| 1150 | - public function is_active() { |
|
| 1151 | - return $this->get_status() == 'publish'; |
|
| 1152 | - } |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * Checks whether the discount has max uses |
|
| 1156 | - * |
|
| 1157 | - * @since 1.0.15 |
|
| 1158 | - * @return bool |
|
| 1159 | - */ |
|
| 1160 | - public function has_limit() { |
|
| 1161 | - $limit = $this->get_max_uses(); |
|
| 1162 | - return ! empty( $limit ); |
|
| 1163 | - } |
|
| 1164 | - |
|
| 1165 | - /** |
|
| 1166 | - * Checks whether the discount has ever been used. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.15 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1171 | - public function has_uses() { |
|
| 1172 | - return $this->get_uses() > 0; |
|
| 1173 | - } |
|
| 1174 | - |
|
| 1175 | - /** |
|
| 1176 | - * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | - * |
|
| 1178 | - * @since 1.0.15 |
|
| 1179 | - * @return bool |
|
| 1180 | - */ |
|
| 1181 | - public function has_exceeded_limit() { |
|
| 1182 | - |
|
| 1183 | - if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | - $exceeded = false ; |
|
| 1185 | - } else { |
|
| 1186 | - $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
| 1187 | - } |
|
| 1188 | - |
|
| 1189 | - return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
| 1190 | - } |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Checks whether the discount has an expiration date. |
|
| 1194 | - * |
|
| 1195 | - * @since 1.0.15 |
|
| 1196 | - * @return bool |
|
| 1197 | - */ |
|
| 1198 | - public function has_expiration_date() { |
|
| 1199 | - $date = $this->get_expiration_date(); |
|
| 1200 | - return ! empty( $date ); |
|
| 1201 | - } |
|
| 1202 | - |
|
| 1203 | - /** |
|
| 1204 | - * Checks if the discount is expired |
|
| 1205 | - * |
|
| 1206 | - * @since 1.0.15 |
|
| 1207 | - * @return bool |
|
| 1208 | - */ |
|
| 1209 | - public function is_expired() { |
|
| 1210 | - $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | - return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
| 1212 | - } |
|
| 1213 | - |
|
| 1214 | - /** |
|
| 1215 | - * Checks whether the discount has a start date. |
|
| 1216 | - * |
|
| 1217 | - * @since 1.0.15 |
|
| 1218 | - * @return bool |
|
| 1219 | - */ |
|
| 1220 | - public function has_start_date() { |
|
| 1221 | - $date = $this->get_start_date(); |
|
| 1222 | - return ! empty( $date ); |
|
| 1223 | - } |
|
| 1224 | - |
|
| 1225 | - /** |
|
| 1226 | - * Checks the discount start date. |
|
| 1227 | - * |
|
| 1228 | - * @since 1.0.15 |
|
| 1229 | - * @return bool |
|
| 1230 | - */ |
|
| 1231 | - public function has_started() { |
|
| 1232 | - $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | - return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
| 1234 | - } |
|
| 1235 | - |
|
| 1236 | - /** |
|
| 1237 | - * Checks the discount has allowed items or not. |
|
| 1238 | - * |
|
| 1239 | - * @since 1.0.15 |
|
| 1240 | - * @return bool |
|
| 1241 | - */ |
|
| 1242 | - public function has_allowed_items() { |
|
| 1243 | - $allowed_items = $this->get_allowed_items(); |
|
| 1244 | - return ! empty( $allowed_items ); |
|
| 1245 | - } |
|
| 1246 | - |
|
| 1247 | - /** |
|
| 1248 | - * Checks the discount has excluded items or not. |
|
| 1249 | - * |
|
| 1250 | - * @since 1.0.15 |
|
| 1251 | - * @return bool |
|
| 1252 | - */ |
|
| 1253 | - public function has_excluded_items() { |
|
| 1254 | - $excluded_items = $this->get_excluded_items(); |
|
| 1255 | - return ! empty( $excluded_items ); |
|
| 1256 | - } |
|
| 1257 | - |
|
| 1258 | - /** |
|
| 1259 | - * Check if a discount is valid for a given item id. |
|
| 1260 | - * |
|
| 1261 | - * @param int|int[] $item_ids |
|
| 1262 | - * @since 1.0.15 |
|
| 1263 | - * @return boolean |
|
| 1264 | - */ |
|
| 1265 | - public function is_valid_for_items( $item_ids ) { |
|
| 1266 | - |
|
| 1267 | - $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | - $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | - $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | - |
|
| 1271 | - if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | - return false; |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | - return false; |
|
| 1277 | - } |
|
| 1278 | - |
|
| 1279 | - return true; |
|
| 1280 | - } |
|
| 1281 | - |
|
| 1282 | - /** |
|
| 1283 | - * Check if a discount is valid for the given amount |
|
| 1284 | - * |
|
| 1285 | - * @param float $amount The amount to check against |
|
| 1286 | - * @since 1.0.15 |
|
| 1287 | - * @return boolean |
|
| 1288 | - */ |
|
| 1289 | - public function is_valid_for_amount( $amount ) { |
|
| 1290 | - return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | - } |
|
| 1292 | - |
|
| 1293 | - /** |
|
| 1294 | - * Checks if the minimum amount is set |
|
| 1295 | - * |
|
| 1296 | - * @since 1.0.15 |
|
| 1297 | - * @return boolean |
|
| 1298 | - */ |
|
| 1299 | - public function has_minimum_amount() { |
|
| 1300 | - $minimum = $this->get_minimum_total(); |
|
| 1301 | - return ! empty( $minimum ); |
|
| 1302 | - } |
|
| 1303 | - |
|
| 1304 | - /** |
|
| 1305 | - * Checks if the minimum amount is met |
|
| 1306 | - * |
|
| 1307 | - * @param float $amount The amount to check against |
|
| 1308 | - * @since 1.0.15 |
|
| 1309 | - * @return boolean |
|
| 1310 | - */ |
|
| 1311 | - public function is_minimum_amount_met( $amount ) { |
|
| 1312 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | - $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | - return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1315 | - } |
|
| 1316 | - |
|
| 1317 | - /** |
|
| 1318 | - * Checks if the maximum amount is set |
|
| 1319 | - * |
|
| 1320 | - * @since 1.0.15 |
|
| 1321 | - * @return boolean |
|
| 1322 | - */ |
|
| 1323 | - public function has_maximum_amount() { |
|
| 1324 | - $maximum = $this->get_maximum_total(); |
|
| 1325 | - return ! empty( $maximum ); |
|
| 1326 | - } |
|
| 1327 | - |
|
| 1328 | - /** |
|
| 1329 | - * Checks if the maximum amount is met |
|
| 1330 | - * |
|
| 1331 | - * @param float $amount The amount to check against |
|
| 1332 | - * @since 1.0.15 |
|
| 1333 | - * @return boolean |
|
| 1334 | - */ |
|
| 1335 | - public function is_maximum_amount_met( $amount ) { |
|
| 1336 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | - $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | - return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1339 | - } |
|
| 1340 | - |
|
| 1341 | - /** |
|
| 1342 | - * Checks if the discount is recurring. |
|
| 1343 | - * |
|
| 1344 | - * @since 1.0.15 |
|
| 1345 | - * @return boolean |
|
| 1346 | - */ |
|
| 1347 | - public function is_recurring() { |
|
| 1348 | - $recurring = $this->get_is_recurring(); |
|
| 1349 | - return ! empty( $recurring ); |
|
| 1350 | - } |
|
| 1351 | - |
|
| 1352 | - /** |
|
| 1353 | - * Checks if the discount is single use. |
|
| 1354 | - * |
|
| 1355 | - * @since 1.0.15 |
|
| 1356 | - * @return boolean |
|
| 1357 | - */ |
|
| 1358 | - public function is_single_use() { |
|
| 1359 | - $usage = $this->get_is_single_use(); |
|
| 1360 | - return ! empty( $usage ); |
|
| 1361 | - } |
|
| 1362 | - |
|
| 1363 | - /** |
|
| 1364 | - * Check if a discount is valid for the given user |
|
| 1365 | - * |
|
| 1366 | - * @param int|string $user |
|
| 1367 | - * @since 1.0.15 |
|
| 1368 | - * @return boolean |
|
| 1369 | - */ |
|
| 1370 | - public function is_valid_for_user( $user ) { |
|
| 1371 | - |
|
| 1372 | - // Ensure that the discount is single use. |
|
| 1373 | - if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | - return true; |
|
| 1375 | - } |
|
| 1376 | - |
|
| 1377 | - // Prepare the user id. |
|
| 1378 | - $user_id = 0; |
|
| 1122 | + /** |
|
| 1123 | + * Checks whether a discount exists in the database or not |
|
| 1124 | + * |
|
| 1125 | + * @since 1.0.15 |
|
| 1126 | + */ |
|
| 1127 | + public function exists(){ |
|
| 1128 | + $id = $this->get_id(); |
|
| 1129 | + return ! empty( $id ); |
|
| 1130 | + } |
|
| 1131 | + |
|
| 1132 | + /** |
|
| 1133 | + * Checks the discount type. |
|
| 1134 | + * |
|
| 1135 | + * |
|
| 1136 | + * @param string $type the discount type to check against |
|
| 1137 | + * @since 1.0.15 |
|
| 1138 | + * @return bool |
|
| 1139 | + */ |
|
| 1140 | + public function is_type( $type ) { |
|
| 1141 | + return $this->get_type() == $type; |
|
| 1142 | + } |
|
| 1143 | + |
|
| 1144 | + /** |
|
| 1145 | + * Checks whether the discount is published or not |
|
| 1146 | + * |
|
| 1147 | + * @since 1.0.15 |
|
| 1148 | + * @return bool |
|
| 1149 | + */ |
|
| 1150 | + public function is_active() { |
|
| 1151 | + return $this->get_status() == 'publish'; |
|
| 1152 | + } |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * Checks whether the discount has max uses |
|
| 1156 | + * |
|
| 1157 | + * @since 1.0.15 |
|
| 1158 | + * @return bool |
|
| 1159 | + */ |
|
| 1160 | + public function has_limit() { |
|
| 1161 | + $limit = $this->get_max_uses(); |
|
| 1162 | + return ! empty( $limit ); |
|
| 1163 | + } |
|
| 1164 | + |
|
| 1165 | + /** |
|
| 1166 | + * Checks whether the discount has ever been used. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.15 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | + public function has_uses() { |
|
| 1172 | + return $this->get_uses() > 0; |
|
| 1173 | + } |
|
| 1174 | + |
|
| 1175 | + /** |
|
| 1176 | + * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | + * |
|
| 1178 | + * @since 1.0.15 |
|
| 1179 | + * @return bool |
|
| 1180 | + */ |
|
| 1181 | + public function has_exceeded_limit() { |
|
| 1182 | + |
|
| 1183 | + if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | + $exceeded = false ; |
|
| 1185 | + } else { |
|
| 1186 | + $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
| 1187 | + } |
|
| 1188 | + |
|
| 1189 | + return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
| 1190 | + } |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Checks whether the discount has an expiration date. |
|
| 1194 | + * |
|
| 1195 | + * @since 1.0.15 |
|
| 1196 | + * @return bool |
|
| 1197 | + */ |
|
| 1198 | + public function has_expiration_date() { |
|
| 1199 | + $date = $this->get_expiration_date(); |
|
| 1200 | + return ! empty( $date ); |
|
| 1201 | + } |
|
| 1202 | + |
|
| 1203 | + /** |
|
| 1204 | + * Checks if the discount is expired |
|
| 1205 | + * |
|
| 1206 | + * @since 1.0.15 |
|
| 1207 | + * @return bool |
|
| 1208 | + */ |
|
| 1209 | + public function is_expired() { |
|
| 1210 | + $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | + return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
| 1212 | + } |
|
| 1213 | + |
|
| 1214 | + /** |
|
| 1215 | + * Checks whether the discount has a start date. |
|
| 1216 | + * |
|
| 1217 | + * @since 1.0.15 |
|
| 1218 | + * @return bool |
|
| 1219 | + */ |
|
| 1220 | + public function has_start_date() { |
|
| 1221 | + $date = $this->get_start_date(); |
|
| 1222 | + return ! empty( $date ); |
|
| 1223 | + } |
|
| 1224 | + |
|
| 1225 | + /** |
|
| 1226 | + * Checks the discount start date. |
|
| 1227 | + * |
|
| 1228 | + * @since 1.0.15 |
|
| 1229 | + * @return bool |
|
| 1230 | + */ |
|
| 1231 | + public function has_started() { |
|
| 1232 | + $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | + return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
| 1234 | + } |
|
| 1235 | + |
|
| 1236 | + /** |
|
| 1237 | + * Checks the discount has allowed items or not. |
|
| 1238 | + * |
|
| 1239 | + * @since 1.0.15 |
|
| 1240 | + * @return bool |
|
| 1241 | + */ |
|
| 1242 | + public function has_allowed_items() { |
|
| 1243 | + $allowed_items = $this->get_allowed_items(); |
|
| 1244 | + return ! empty( $allowed_items ); |
|
| 1245 | + } |
|
| 1246 | + |
|
| 1247 | + /** |
|
| 1248 | + * Checks the discount has excluded items or not. |
|
| 1249 | + * |
|
| 1250 | + * @since 1.0.15 |
|
| 1251 | + * @return bool |
|
| 1252 | + */ |
|
| 1253 | + public function has_excluded_items() { |
|
| 1254 | + $excluded_items = $this->get_excluded_items(); |
|
| 1255 | + return ! empty( $excluded_items ); |
|
| 1256 | + } |
|
| 1257 | + |
|
| 1258 | + /** |
|
| 1259 | + * Check if a discount is valid for a given item id. |
|
| 1260 | + * |
|
| 1261 | + * @param int|int[] $item_ids |
|
| 1262 | + * @since 1.0.15 |
|
| 1263 | + * @return boolean |
|
| 1264 | + */ |
|
| 1265 | + public function is_valid_for_items( $item_ids ) { |
|
| 1266 | + |
|
| 1267 | + $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | + $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | + $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | + |
|
| 1271 | + if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | + return false; |
|
| 1273 | + } |
|
| 1274 | + |
|
| 1275 | + if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | + return false; |
|
| 1277 | + } |
|
| 1278 | + |
|
| 1279 | + return true; |
|
| 1280 | + } |
|
| 1281 | + |
|
| 1282 | + /** |
|
| 1283 | + * Check if a discount is valid for the given amount |
|
| 1284 | + * |
|
| 1285 | + * @param float $amount The amount to check against |
|
| 1286 | + * @since 1.0.15 |
|
| 1287 | + * @return boolean |
|
| 1288 | + */ |
|
| 1289 | + public function is_valid_for_amount( $amount ) { |
|
| 1290 | + return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | + } |
|
| 1292 | + |
|
| 1293 | + /** |
|
| 1294 | + * Checks if the minimum amount is set |
|
| 1295 | + * |
|
| 1296 | + * @since 1.0.15 |
|
| 1297 | + * @return boolean |
|
| 1298 | + */ |
|
| 1299 | + public function has_minimum_amount() { |
|
| 1300 | + $minimum = $this->get_minimum_total(); |
|
| 1301 | + return ! empty( $minimum ); |
|
| 1302 | + } |
|
| 1303 | + |
|
| 1304 | + /** |
|
| 1305 | + * Checks if the minimum amount is met |
|
| 1306 | + * |
|
| 1307 | + * @param float $amount The amount to check against |
|
| 1308 | + * @since 1.0.15 |
|
| 1309 | + * @return boolean |
|
| 1310 | + */ |
|
| 1311 | + public function is_minimum_amount_met( $amount ) { |
|
| 1312 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | + $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | + return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1315 | + } |
|
| 1316 | + |
|
| 1317 | + /** |
|
| 1318 | + * Checks if the maximum amount is set |
|
| 1319 | + * |
|
| 1320 | + * @since 1.0.15 |
|
| 1321 | + * @return boolean |
|
| 1322 | + */ |
|
| 1323 | + public function has_maximum_amount() { |
|
| 1324 | + $maximum = $this->get_maximum_total(); |
|
| 1325 | + return ! empty( $maximum ); |
|
| 1326 | + } |
|
| 1327 | + |
|
| 1328 | + /** |
|
| 1329 | + * Checks if the maximum amount is met |
|
| 1330 | + * |
|
| 1331 | + * @param float $amount The amount to check against |
|
| 1332 | + * @since 1.0.15 |
|
| 1333 | + * @return boolean |
|
| 1334 | + */ |
|
| 1335 | + public function is_maximum_amount_met( $amount ) { |
|
| 1336 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | + $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | + return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1339 | + } |
|
| 1340 | + |
|
| 1341 | + /** |
|
| 1342 | + * Checks if the discount is recurring. |
|
| 1343 | + * |
|
| 1344 | + * @since 1.0.15 |
|
| 1345 | + * @return boolean |
|
| 1346 | + */ |
|
| 1347 | + public function is_recurring() { |
|
| 1348 | + $recurring = $this->get_is_recurring(); |
|
| 1349 | + return ! empty( $recurring ); |
|
| 1350 | + } |
|
| 1351 | + |
|
| 1352 | + /** |
|
| 1353 | + * Checks if the discount is single use. |
|
| 1354 | + * |
|
| 1355 | + * @since 1.0.15 |
|
| 1356 | + * @return boolean |
|
| 1357 | + */ |
|
| 1358 | + public function is_single_use() { |
|
| 1359 | + $usage = $this->get_is_single_use(); |
|
| 1360 | + return ! empty( $usage ); |
|
| 1361 | + } |
|
| 1362 | + |
|
| 1363 | + /** |
|
| 1364 | + * Check if a discount is valid for the given user |
|
| 1365 | + * |
|
| 1366 | + * @param int|string $user |
|
| 1367 | + * @since 1.0.15 |
|
| 1368 | + * @return boolean |
|
| 1369 | + */ |
|
| 1370 | + public function is_valid_for_user( $user ) { |
|
| 1371 | + |
|
| 1372 | + // Ensure that the discount is single use. |
|
| 1373 | + if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | + return true; |
|
| 1375 | + } |
|
| 1376 | + |
|
| 1377 | + // Prepare the user id. |
|
| 1378 | + $user_id = 0; |
|
| 1379 | 1379 | if ( is_numeric( $user ) ) { |
| 1380 | 1380 | $user_id = absint( $user ); |
| 1381 | 1381 | } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) { |
@@ -1384,117 +1384,117 @@ discard block |
||
| 1384 | 1384 | $user_id = $user_data->ID; |
| 1385 | 1385 | } |
| 1386 | 1386 | |
| 1387 | - // Ensure that we have a user. |
|
| 1388 | - if ( empty( $user_id ) ) { |
|
| 1389 | - return true; |
|
| 1390 | - } |
|
| 1387 | + // Ensure that we have a user. |
|
| 1388 | + if ( empty( $user_id ) ) { |
|
| 1389 | + return true; |
|
| 1390 | + } |
|
| 1391 | 1391 | |
| 1392 | - // Get all payments with matching user id. |
|
| 1392 | + // Get all payments with matching user id. |
|
| 1393 | 1393 | $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false, 'paginate' => false ) ); |
| 1394 | - $code = strtolower( $this->get_code() ); |
|
| 1395 | - |
|
| 1396 | - // For each payment... |
|
| 1397 | - foreach ( $payments as $payment ) { |
|
| 1398 | - |
|
| 1399 | - // Only check for paid invoices. |
|
| 1400 | - if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | - return false; |
|
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - } |
|
| 1405 | - |
|
| 1406 | - return true; |
|
| 1407 | - } |
|
| 1408 | - |
|
| 1409 | - /** |
|
| 1410 | - * Deletes the discount from the database |
|
| 1411 | - * |
|
| 1412 | - * @since 1.0.15 |
|
| 1413 | - * @return boolean |
|
| 1414 | - */ |
|
| 1415 | - public function remove() { |
|
| 1416 | - return $this->delete(); |
|
| 1417 | - } |
|
| 1418 | - |
|
| 1419 | - /** |
|
| 1420 | - * Increases a discount's usage. |
|
| 1421 | - * |
|
| 1422 | - * @since 1.0.15 |
|
| 1423 | - * @param int $by The number of usages to increas by. |
|
| 1424 | - * @return int |
|
| 1425 | - */ |
|
| 1426 | - public function increase_usage( $by = 1 ) { |
|
| 1427 | - |
|
| 1428 | - // Abort if zero. |
|
| 1429 | - if ( empty( $by ) ) { |
|
| 1430 | - return; |
|
| 1431 | - } |
|
| 1432 | - |
|
| 1433 | - // Increase the usage. |
|
| 1434 | - $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | - |
|
| 1436 | - // Save the discount. |
|
| 1437 | - $this->save(); |
|
| 1438 | - |
|
| 1439 | - // Fire relevant hooks. |
|
| 1440 | - if( (int) $by > 0 ) { |
|
| 1441 | - do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1442 | - } else { |
|
| 1443 | - do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1444 | - } |
|
| 1445 | - |
|
| 1446 | - // Return the number of times the discount has been used. |
|
| 1447 | - return $this->get_uses(); |
|
| 1448 | - } |
|
| 1449 | - |
|
| 1450 | - /** |
|
| 1451 | - * Alias of self::__toString() |
|
| 1452 | - * |
|
| 1453 | - * @since 1.0.15 |
|
| 1454 | - * @return string|false |
|
| 1455 | - */ |
|
| 1456 | - public function get_data_as_json() { |
|
| 1457 | - return $this->__toString(); |
|
| 1458 | - } |
|
| 1459 | - |
|
| 1460 | - /** |
|
| 1461 | - * Returns a discount's discounted amount. |
|
| 1462 | - * |
|
| 1463 | - * @since 1.0.15 |
|
| 1464 | - * @param float $amount |
|
| 1465 | - * @return float |
|
| 1466 | - */ |
|
| 1467 | - public function get_discounted_amount( $amount ) { |
|
| 1468 | - |
|
| 1469 | - // Convert amount to float. |
|
| 1470 | - $amount = (float) $amount; |
|
| 1471 | - |
|
| 1472 | - // Get discount amount. |
|
| 1473 | - $discount_amount = $this->get_amount(); |
|
| 1474 | - |
|
| 1475 | - if ( empty( $discount_amount ) ) { |
|
| 1476 | - return 0; |
|
| 1477 | - } |
|
| 1478 | - |
|
| 1479 | - // Format the amount. |
|
| 1480 | - $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1394 | + $code = strtolower( $this->get_code() ); |
|
| 1395 | + |
|
| 1396 | + // For each payment... |
|
| 1397 | + foreach ( $payments as $payment ) { |
|
| 1398 | + |
|
| 1399 | + // Only check for paid invoices. |
|
| 1400 | + if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | + return false; |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + } |
|
| 1405 | + |
|
| 1406 | + return true; |
|
| 1407 | + } |
|
| 1408 | + |
|
| 1409 | + /** |
|
| 1410 | + * Deletes the discount from the database |
|
| 1411 | + * |
|
| 1412 | + * @since 1.0.15 |
|
| 1413 | + * @return boolean |
|
| 1414 | + */ |
|
| 1415 | + public function remove() { |
|
| 1416 | + return $this->delete(); |
|
| 1417 | + } |
|
| 1418 | + |
|
| 1419 | + /** |
|
| 1420 | + * Increases a discount's usage. |
|
| 1421 | + * |
|
| 1422 | + * @since 1.0.15 |
|
| 1423 | + * @param int $by The number of usages to increas by. |
|
| 1424 | + * @return int |
|
| 1425 | + */ |
|
| 1426 | + public function increase_usage( $by = 1 ) { |
|
| 1427 | + |
|
| 1428 | + // Abort if zero. |
|
| 1429 | + if ( empty( $by ) ) { |
|
| 1430 | + return; |
|
| 1431 | + } |
|
| 1432 | + |
|
| 1433 | + // Increase the usage. |
|
| 1434 | + $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | + |
|
| 1436 | + // Save the discount. |
|
| 1437 | + $this->save(); |
|
| 1438 | + |
|
| 1439 | + // Fire relevant hooks. |
|
| 1440 | + if( (int) $by > 0 ) { |
|
| 1441 | + do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1442 | + } else { |
|
| 1443 | + do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1444 | + } |
|
| 1445 | + |
|
| 1446 | + // Return the number of times the discount has been used. |
|
| 1447 | + return $this->get_uses(); |
|
| 1448 | + } |
|
| 1449 | + |
|
| 1450 | + /** |
|
| 1451 | + * Alias of self::__toString() |
|
| 1452 | + * |
|
| 1453 | + * @since 1.0.15 |
|
| 1454 | + * @return string|false |
|
| 1455 | + */ |
|
| 1456 | + public function get_data_as_json() { |
|
| 1457 | + return $this->__toString(); |
|
| 1458 | + } |
|
| 1459 | + |
|
| 1460 | + /** |
|
| 1461 | + * Returns a discount's discounted amount. |
|
| 1462 | + * |
|
| 1463 | + * @since 1.0.15 |
|
| 1464 | + * @param float $amount |
|
| 1465 | + * @return float |
|
| 1466 | + */ |
|
| 1467 | + public function get_discounted_amount( $amount ) { |
|
| 1468 | + |
|
| 1469 | + // Convert amount to float. |
|
| 1470 | + $amount = (float) $amount; |
|
| 1471 | + |
|
| 1472 | + // Get discount amount. |
|
| 1473 | + $discount_amount = $this->get_amount(); |
|
| 1474 | + |
|
| 1475 | + if ( empty( $discount_amount ) ) { |
|
| 1476 | + return 0; |
|
| 1477 | + } |
|
| 1478 | + |
|
| 1479 | + // Format the amount. |
|
| 1480 | + $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1481 | 1481 | |
| 1482 | - // If this is a percentage discount. |
|
| 1483 | - if ( $this->is_type( 'percent' ) ) { |
|
| 1482 | + // If this is a percentage discount. |
|
| 1483 | + if ( $this->is_type( 'percent' ) ) { |
|
| 1484 | 1484 | $discount_amount = $amount * ( $discount_amount / 100 ); |
| 1485 | - } |
|
| 1485 | + } |
|
| 1486 | 1486 | |
| 1487 | - // Discount can not be less than zero... |
|
| 1488 | - if ( $discount_amount < 0 ) { |
|
| 1489 | - $discount_amount = 0; |
|
| 1490 | - } |
|
| 1487 | + // Discount can not be less than zero... |
|
| 1488 | + if ( $discount_amount < 0 ) { |
|
| 1489 | + $discount_amount = 0; |
|
| 1490 | + } |
|
| 1491 | 1491 | |
| 1492 | - // ... or more than the amount. |
|
| 1493 | - if ( $discount_amount > $amount ) { |
|
| 1494 | - $discount_amount = $amount; |
|
| 1495 | - } |
|
| 1492 | + // ... or more than the amount. |
|
| 1493 | + if ( $discount_amount > $amount ) { |
|
| 1494 | + $discount_amount = $amount; |
|
| 1495 | + } |
|
| 1496 | 1496 | |
| 1497 | - return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | - } |
|
| 1497 | + return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | + } |
|
| 1499 | 1499 | |
| 1500 | 1500 | } |
