AyeCode /
invoicing
@@ -1,7 +1,7 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if ( ! defined( 'ABSPATH' ) ) { |
| 4 | - exit; // Exit if accessed directly |
|
| 4 | + exit; // Exit if accessed directly |
|
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | /** |
@@ -11,1012 +11,1012 @@ discard block |
||
| 11 | 11 | */ |
| 12 | 12 | class AUI_Component_Input { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * Build the component. |
|
| 16 | - * |
|
| 17 | - * @param array $args |
|
| 18 | - * |
|
| 19 | - * @return string The rendered component. |
|
| 20 | - */ |
|
| 21 | - public static function input($args = array()){ |
|
| 22 | - $defaults = array( |
|
| 23 | - 'type' => 'text', |
|
| 24 | - 'name' => '', |
|
| 25 | - 'class' => '', |
|
| 26 | - 'wrap_class' => '', |
|
| 27 | - 'id' => '', |
|
| 28 | - 'placeholder'=> '', |
|
| 29 | - 'title' => '', |
|
| 30 | - 'value' => '', |
|
| 31 | - 'required' => false, |
|
| 32 | - 'label' => '', |
|
| 33 | - 'label_after'=> false, |
|
| 34 | - 'label_class'=> '', |
|
| 35 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 36 | - 'help_text' => '', |
|
| 37 | - 'validation_text' => '', |
|
| 38 | - 'validation_pattern' => '', |
|
| 39 | - 'no_wrap' => false, |
|
| 40 | - 'input_group_right' => '', |
|
| 41 | - 'input_group_left' => '', |
|
| 42 | - 'input_group_right_inside' => false, // forces the input group inside the input |
|
| 43 | - 'input_group_left_inside' => false, // forces the input group inside the input |
|
| 44 | - 'step' => '', |
|
| 45 | - 'switch' => false, // to show checkbox as a switch |
|
| 46 | - 'checked' => false, // set a checkbox or radio as selected |
|
| 47 | - 'password_toggle' => true, // toggle view/hide password |
|
| 48 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 49 | - 'extra_attributes' => array() // an array of extra attributes |
|
| 50 | - ); |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 54 | - */ |
|
| 55 | - $args = wp_parse_args( $args, $defaults ); |
|
| 56 | - $output = ''; |
|
| 57 | - if ( ! empty( $args['type'] ) ) { |
|
| 58 | - // hidden label option needs to be empty |
|
| 59 | - $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 60 | - |
|
| 61 | - $type = sanitize_html_class( $args['type'] ); |
|
| 62 | - |
|
| 63 | - $help_text = ''; |
|
| 64 | - $label = ''; |
|
| 65 | - $label_after = $args['label_after']; |
|
| 66 | - $label_args = array( |
|
| 67 | - 'title'=> $args['label'], |
|
| 68 | - 'for'=> $args['id'], |
|
| 69 | - 'class' => $args['label_class']." ", |
|
| 70 | - 'label_type' => $args['label_type'] |
|
| 71 | - ); |
|
| 72 | - |
|
| 73 | - // floating labels need label after |
|
| 74 | - if( $args['label_type'] == 'floating' && $type != 'checkbox' ){ |
|
| 75 | - $label_after = true; |
|
| 76 | - $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - // Some special sauce for files |
|
| 80 | - if($type=='file' ){ |
|
| 81 | - $label_after = true; // if type file we need the label after |
|
| 82 | - $args['class'] .= ' custom-file-input '; |
|
| 83 | - }elseif($type=='checkbox'){ |
|
| 84 | - $label_after = true; // if type file we need the label after |
|
| 85 | - $args['class'] .= ' custom-control-input '; |
|
| 86 | - }elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 87 | - $type = 'text'; |
|
| 88 | - //$args['class'] .= ' aui-flatpickr bg-initial '; |
|
| 89 | - $args['class'] .= ' bg-initial '; |
|
| 90 | - |
|
| 91 | - $args['extra_attributes']['data-aui-init'] = 'flatpickr'; |
|
| 92 | - // enqueue the script |
|
| 93 | - $aui_settings = AyeCode_UI_Settings::instance(); |
|
| 94 | - $aui_settings->enqueue_flatpickr(); |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - |
|
| 98 | - // open/type |
|
| 99 | - $output .= '<input type="' . $type . '" '; |
|
| 100 | - |
|
| 101 | - // name |
|
| 102 | - if(!empty($args['name'])){ |
|
| 103 | - $output .= ' name="'.esc_attr($args['name']).'" '; |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - // id |
|
| 107 | - if(!empty($args['id'])){ |
|
| 108 | - $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - // placeholder |
|
| 112 | - if(isset($args['placeholder']) && '' != $args['placeholder'] ){ |
|
| 113 | - $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - // title |
|
| 117 | - if(!empty($args['title'])){ |
|
| 118 | - $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - // value |
|
| 122 | - if(!empty($args['value'])){ |
|
| 123 | - $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - // checked, for radio and checkboxes |
|
| 127 | - if( ( $type == 'checkbox' || $type == 'radio' ) && $args['checked'] ){ |
|
| 128 | - $output .= ' checked '; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - // validation text |
|
| 132 | - if(!empty($args['validation_text'])){ |
|
| 133 | - $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 134 | - $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - // validation_pattern |
|
| 138 | - if(!empty($args['validation_pattern'])){ |
|
| 139 | - $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - // step (for numbers) |
|
| 143 | - if(!empty($args['step'])){ |
|
| 144 | - $output .= ' step="'.$args['step'].'" '; |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - // required |
|
| 148 | - if(!empty($args['required'])){ |
|
| 149 | - $output .= ' required '; |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - // class |
|
| 153 | - $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 154 | - $output .= ' class="form-control '.$class.'" '; |
|
| 155 | - |
|
| 156 | - // data-attributes |
|
| 157 | - $output .= AUI_Component_Helper::data_attributes($args); |
|
| 158 | - |
|
| 159 | - // extra attributes |
|
| 160 | - if(!empty($args['extra_attributes'])){ |
|
| 161 | - $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - // close |
|
| 165 | - $output .= ' >'; |
|
| 166 | - |
|
| 167 | - |
|
| 168 | - // label |
|
| 169 | - if(!empty($args['label'])){ |
|
| 170 | - if($type == 'file'){$label_args['class'] .= 'custom-file-label';} |
|
| 171 | - elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 172 | - $label = self::label( $label_args, $type ); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - // help text |
|
| 176 | - if(!empty($args['help_text'])){ |
|
| 177 | - $help_text = AUI_Component_Helper::help_text($args['help_text']); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - |
|
| 181 | - // set help text in the correct possition |
|
| 182 | - if($label_after){ |
|
| 183 | - $output .= $label . $help_text; |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - // some input types need a separate wrap |
|
| 187 | - if($type == 'file') { |
|
| 188 | - $output = self::wrap( array( |
|
| 189 | - 'content' => $output, |
|
| 190 | - 'class' => 'form-group custom-file' |
|
| 191 | - ) ); |
|
| 192 | - }elseif($type == 'checkbox'){ |
|
| 193 | - $wrap_class = $args['switch'] ? 'custom-switch' : 'custom-checkbox'; |
|
| 194 | - $output = self::wrap( array( |
|
| 195 | - 'content' => $output, |
|
| 196 | - 'class' => 'custom-control '.$wrap_class |
|
| 197 | - ) ); |
|
| 198 | - |
|
| 199 | - if($args['label_type']=='horizontal'){ |
|
| 200 | - $output = '<div class="col-sm-2 col-form-label"></div><div class="col-sm-10">' . $output . '</div>'; |
|
| 201 | - } |
|
| 202 | - }elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 203 | - |
|
| 204 | - |
|
| 205 | - // allow password field to toggle view |
|
| 206 | - $args['input_group_right'] = '<span class="input-group-text c-pointer px-3" |
|
| 14 | + /** |
|
| 15 | + * Build the component. |
|
| 16 | + * |
|
| 17 | + * @param array $args |
|
| 18 | + * |
|
| 19 | + * @return string The rendered component. |
|
| 20 | + */ |
|
| 21 | + public static function input($args = array()){ |
|
| 22 | + $defaults = array( |
|
| 23 | + 'type' => 'text', |
|
| 24 | + 'name' => '', |
|
| 25 | + 'class' => '', |
|
| 26 | + 'wrap_class' => '', |
|
| 27 | + 'id' => '', |
|
| 28 | + 'placeholder'=> '', |
|
| 29 | + 'title' => '', |
|
| 30 | + 'value' => '', |
|
| 31 | + 'required' => false, |
|
| 32 | + 'label' => '', |
|
| 33 | + 'label_after'=> false, |
|
| 34 | + 'label_class'=> '', |
|
| 35 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 36 | + 'help_text' => '', |
|
| 37 | + 'validation_text' => '', |
|
| 38 | + 'validation_pattern' => '', |
|
| 39 | + 'no_wrap' => false, |
|
| 40 | + 'input_group_right' => '', |
|
| 41 | + 'input_group_left' => '', |
|
| 42 | + 'input_group_right_inside' => false, // forces the input group inside the input |
|
| 43 | + 'input_group_left_inside' => false, // forces the input group inside the input |
|
| 44 | + 'step' => '', |
|
| 45 | + 'switch' => false, // to show checkbox as a switch |
|
| 46 | + 'checked' => false, // set a checkbox or radio as selected |
|
| 47 | + 'password_toggle' => true, // toggle view/hide password |
|
| 48 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 49 | + 'extra_attributes' => array() // an array of extra attributes |
|
| 50 | + ); |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 54 | + */ |
|
| 55 | + $args = wp_parse_args( $args, $defaults ); |
|
| 56 | + $output = ''; |
|
| 57 | + if ( ! empty( $args['type'] ) ) { |
|
| 58 | + // hidden label option needs to be empty |
|
| 59 | + $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 60 | + |
|
| 61 | + $type = sanitize_html_class( $args['type'] ); |
|
| 62 | + |
|
| 63 | + $help_text = ''; |
|
| 64 | + $label = ''; |
|
| 65 | + $label_after = $args['label_after']; |
|
| 66 | + $label_args = array( |
|
| 67 | + 'title'=> $args['label'], |
|
| 68 | + 'for'=> $args['id'], |
|
| 69 | + 'class' => $args['label_class']." ", |
|
| 70 | + 'label_type' => $args['label_type'] |
|
| 71 | + ); |
|
| 72 | + |
|
| 73 | + // floating labels need label after |
|
| 74 | + if( $args['label_type'] == 'floating' && $type != 'checkbox' ){ |
|
| 75 | + $label_after = true; |
|
| 76 | + $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + // Some special sauce for files |
|
| 80 | + if($type=='file' ){ |
|
| 81 | + $label_after = true; // if type file we need the label after |
|
| 82 | + $args['class'] .= ' custom-file-input '; |
|
| 83 | + }elseif($type=='checkbox'){ |
|
| 84 | + $label_after = true; // if type file we need the label after |
|
| 85 | + $args['class'] .= ' custom-control-input '; |
|
| 86 | + }elseif($type=='datepicker' || $type=='timepicker'){ |
|
| 87 | + $type = 'text'; |
|
| 88 | + //$args['class'] .= ' aui-flatpickr bg-initial '; |
|
| 89 | + $args['class'] .= ' bg-initial '; |
|
| 90 | + |
|
| 91 | + $args['extra_attributes']['data-aui-init'] = 'flatpickr'; |
|
| 92 | + // enqueue the script |
|
| 93 | + $aui_settings = AyeCode_UI_Settings::instance(); |
|
| 94 | + $aui_settings->enqueue_flatpickr(); |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + |
|
| 98 | + // open/type |
|
| 99 | + $output .= '<input type="' . $type . '" '; |
|
| 100 | + |
|
| 101 | + // name |
|
| 102 | + if(!empty($args['name'])){ |
|
| 103 | + $output .= ' name="'.esc_attr($args['name']).'" '; |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + // id |
|
| 107 | + if(!empty($args['id'])){ |
|
| 108 | + $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + // placeholder |
|
| 112 | + if(isset($args['placeholder']) && '' != $args['placeholder'] ){ |
|
| 113 | + $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + // title |
|
| 117 | + if(!empty($args['title'])){ |
|
| 118 | + $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + // value |
|
| 122 | + if(!empty($args['value'])){ |
|
| 123 | + $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + // checked, for radio and checkboxes |
|
| 127 | + if( ( $type == 'checkbox' || $type == 'radio' ) && $args['checked'] ){ |
|
| 128 | + $output .= ' checked '; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + // validation text |
|
| 132 | + if(!empty($args['validation_text'])){ |
|
| 133 | + $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 134 | + $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + // validation_pattern |
|
| 138 | + if(!empty($args['validation_pattern'])){ |
|
| 139 | + $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + // step (for numbers) |
|
| 143 | + if(!empty($args['step'])){ |
|
| 144 | + $output .= ' step="'.$args['step'].'" '; |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + // required |
|
| 148 | + if(!empty($args['required'])){ |
|
| 149 | + $output .= ' required '; |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + // class |
|
| 153 | + $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 154 | + $output .= ' class="form-control '.$class.'" '; |
|
| 155 | + |
|
| 156 | + // data-attributes |
|
| 157 | + $output .= AUI_Component_Helper::data_attributes($args); |
|
| 158 | + |
|
| 159 | + // extra attributes |
|
| 160 | + if(!empty($args['extra_attributes'])){ |
|
| 161 | + $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + // close |
|
| 165 | + $output .= ' >'; |
|
| 166 | + |
|
| 167 | + |
|
| 168 | + // label |
|
| 169 | + if(!empty($args['label'])){ |
|
| 170 | + if($type == 'file'){$label_args['class'] .= 'custom-file-label';} |
|
| 171 | + elseif($type == 'checkbox'){$label_args['class'] .= 'custom-control-label';} |
|
| 172 | + $label = self::label( $label_args, $type ); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + // help text |
|
| 176 | + if(!empty($args['help_text'])){ |
|
| 177 | + $help_text = AUI_Component_Helper::help_text($args['help_text']); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + |
|
| 181 | + // set help text in the correct possition |
|
| 182 | + if($label_after){ |
|
| 183 | + $output .= $label . $help_text; |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + // some input types need a separate wrap |
|
| 187 | + if($type == 'file') { |
|
| 188 | + $output = self::wrap( array( |
|
| 189 | + 'content' => $output, |
|
| 190 | + 'class' => 'form-group custom-file' |
|
| 191 | + ) ); |
|
| 192 | + }elseif($type == 'checkbox'){ |
|
| 193 | + $wrap_class = $args['switch'] ? 'custom-switch' : 'custom-checkbox'; |
|
| 194 | + $output = self::wrap( array( |
|
| 195 | + 'content' => $output, |
|
| 196 | + 'class' => 'custom-control '.$wrap_class |
|
| 197 | + ) ); |
|
| 198 | + |
|
| 199 | + if($args['label_type']=='horizontal'){ |
|
| 200 | + $output = '<div class="col-sm-2 col-form-label"></div><div class="col-sm-10">' . $output . '</div>'; |
|
| 201 | + } |
|
| 202 | + }elseif($type == 'password' && $args['password_toggle'] && !$args['input_group_right']){ |
|
| 203 | + |
|
| 204 | + |
|
| 205 | + // allow password field to toggle view |
|
| 206 | + $args['input_group_right'] = '<span class="input-group-text c-pointer px-3" |
|
| 207 | 207 | onclick="var $el = jQuery(this).find(\'i\');$el.toggleClass(\'fa-eye fa-eye-slash\'); |
| 208 | 208 | var $eli = jQuery(this).parent().parent().find(\'input\'); |
| 209 | 209 | if($el.hasClass(\'fa-eye\')) |
| 210 | 210 | {$eli.attr(\'type\',\'text\');} |
| 211 | 211 | else{$eli.attr(\'type\',\'password\');}" |
| 212 | 212 | ><i class="far fa-fw fa-eye-slash"></i></span>'; |
| 213 | - } |
|
| 214 | - |
|
| 215 | - // input group wraps |
|
| 216 | - if($args['input_group_left'] || $args['input_group_right']){ |
|
| 217 | - $w100 = strpos($args['class'], 'w-100') !== false ? ' w-100' : ''; |
|
| 218 | - if($args['input_group_left']){ |
|
| 219 | - $output = self::wrap( array( |
|
| 220 | - 'content' => $output, |
|
| 221 | - 'class' => $args['input_group_left_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 222 | - 'input_group_left' => $args['input_group_left'], |
|
| 223 | - 'input_group_left_inside' => $args['input_group_left_inside'] |
|
| 224 | - ) ); |
|
| 225 | - } |
|
| 226 | - if($args['input_group_right']){ |
|
| 227 | - $output = self::wrap( array( |
|
| 228 | - 'content' => $output, |
|
| 229 | - 'class' => $args['input_group_right_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 230 | - 'input_group_right' => $args['input_group_right'], |
|
| 231 | - 'input_group_right_inside' => $args['input_group_right_inside'] |
|
| 232 | - ) ); |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - if(!$label_after){ |
|
| 238 | - $output .= $help_text; |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - |
|
| 242 | - if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 243 | - $output = self::wrap( array( |
|
| 244 | - 'content' => $output, |
|
| 245 | - 'class' => 'col-sm-10', |
|
| 246 | - ) ); |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - if(!$label_after){ |
|
| 250 | - $output = $label . $output; |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - // wrap |
|
| 254 | - if(!$args['no_wrap']){ |
|
| 255 | - |
|
| 256 | - $form_group_class = $args['label_type']=='floating' && $type != 'checkbox' ? 'form-label-group' : 'form-group'; |
|
| 257 | - $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 258 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 259 | - $output = self::wrap(array( |
|
| 260 | - 'content' => $output, |
|
| 261 | - 'class' => $wrap_class, |
|
| 262 | - 'element_require' => $args['element_require'], |
|
| 263 | - 'argument_id' => $args['id'] |
|
| 264 | - )); |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - |
|
| 268 | - |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - return $output; |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * Build the component. |
|
| 276 | - * |
|
| 277 | - * @param array $args |
|
| 278 | - * |
|
| 279 | - * @return string The rendered component. |
|
| 280 | - */ |
|
| 281 | - public static function textarea($args = array()){ |
|
| 282 | - $defaults = array( |
|
| 283 | - 'name' => '', |
|
| 284 | - 'class' => '', |
|
| 285 | - 'wrap_class' => '', |
|
| 286 | - 'id' => '', |
|
| 287 | - 'placeholder'=> '', |
|
| 288 | - 'title' => '', |
|
| 289 | - 'value' => '', |
|
| 290 | - 'required' => false, |
|
| 291 | - 'label' => '', |
|
| 292 | - 'label_after'=> false, |
|
| 293 | - 'label_class' => '', |
|
| 294 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 295 | - 'help_text' => '', |
|
| 296 | - 'validation_text' => '', |
|
| 297 | - 'validation_pattern' => '', |
|
| 298 | - 'no_wrap' => false, |
|
| 299 | - 'rows' => '', |
|
| 300 | - 'wysiwyg' => false, |
|
| 301 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 302 | - ); |
|
| 303 | - |
|
| 304 | - /** |
|
| 305 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 306 | - */ |
|
| 307 | - $args = wp_parse_args( $args, $defaults ); |
|
| 308 | - $output = ''; |
|
| 309 | - |
|
| 310 | - // hidden label option needs to be empty |
|
| 311 | - $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 312 | - |
|
| 313 | - // floating labels don't work with wysiwyg so set it as top |
|
| 314 | - if($args['label_type'] == 'floating' && !empty($args['wysiwyg'])){ |
|
| 315 | - $args['label_type'] = 'top'; |
|
| 316 | - } |
|
| 317 | - |
|
| 318 | - $label_after = $args['label_after']; |
|
| 319 | - |
|
| 320 | - // floating labels need label after |
|
| 321 | - if( $args['label_type'] == 'floating' && empty($args['wysiwyg']) ){ |
|
| 322 | - $label_after = true; |
|
| 323 | - $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - // label |
|
| 327 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 328 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 329 | - $label_args = array( |
|
| 330 | - 'title'=> $args['label'], |
|
| 331 | - 'for'=> $args['id'], |
|
| 332 | - 'class' => $args['label_class']." ", |
|
| 333 | - 'label_type' => $args['label_type'] |
|
| 334 | - ); |
|
| 335 | - $output .= self::label( $label_args ); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - // maybe horizontal label |
|
| 339 | - if($args['label_type']=='horizontal'){ |
|
| 340 | - $output .= '<div class="col-sm-10">'; |
|
| 341 | - } |
|
| 342 | - |
|
| 343 | - if(!empty($args['wysiwyg'])){ |
|
| 344 | - ob_start(); |
|
| 345 | - $content = $args['value']; |
|
| 346 | - $editor_id = !empty($args['id']) ? sanitize_html_class($args['id']) : 'wp_editor'; |
|
| 347 | - $settings = array( |
|
| 348 | - 'textarea_rows' => !empty(absint($args['rows'])) ? absint($args['rows']) : 4, |
|
| 349 | - 'quicktags' => false, |
|
| 350 | - 'media_buttons' => false, |
|
| 351 | - 'editor_class' => 'form-control', |
|
| 352 | - 'textarea_name' => !empty($args['name']) ? sanitize_html_class($args['name']) : sanitize_html_class($args['id']), |
|
| 353 | - 'teeny' => true, |
|
| 354 | - ); |
|
| 355 | - |
|
| 356 | - // maybe set settings if array |
|
| 357 | - if(is_array($args['wysiwyg'])){ |
|
| 358 | - $settings = wp_parse_args( $args['wysiwyg'], $settings ); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - wp_editor( $content, $editor_id, $settings ); |
|
| 362 | - $output .= ob_get_clean(); |
|
| 363 | - }else{ |
|
| 364 | - |
|
| 365 | - // open |
|
| 366 | - $output .= '<textarea '; |
|
| 367 | - |
|
| 368 | - // name |
|
| 369 | - if(!empty($args['name'])){ |
|
| 370 | - $output .= ' name="'.sanitize_html_class($args['name']).'" '; |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - // id |
|
| 374 | - if(!empty($args['id'])){ |
|
| 375 | - $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - // placeholder |
|
| 379 | - if(isset($args['placeholder']) && '' != $args['placeholder']){ |
|
| 380 | - $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 381 | - } |
|
| 382 | - |
|
| 383 | - // title |
|
| 384 | - if(!empty($args['title'])){ |
|
| 385 | - $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 386 | - } |
|
| 387 | - |
|
| 388 | - // validation text |
|
| 389 | - if(!empty($args['validation_text'])){ |
|
| 390 | - $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 391 | - $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 392 | - } |
|
| 393 | - |
|
| 394 | - // validation_pattern |
|
| 395 | - if(!empty($args['validation_pattern'])){ |
|
| 396 | - $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - // required |
|
| 400 | - if(!empty($args['required'])){ |
|
| 401 | - $output .= ' required '; |
|
| 402 | - } |
|
| 403 | - |
|
| 404 | - // rows |
|
| 405 | - if(!empty($args['rows'])){ |
|
| 406 | - $output .= ' rows="'.absint($args['rows']).'" '; |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - |
|
| 410 | - // class |
|
| 411 | - $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 412 | - $output .= ' class="form-control '.$class.'" '; |
|
| 413 | - |
|
| 414 | - |
|
| 415 | - // close tag |
|
| 416 | - $output .= ' >'; |
|
| 417 | - |
|
| 418 | - // value |
|
| 419 | - if(!empty($args['value'])){ |
|
| 420 | - $output .= sanitize_textarea_field($args['value']); |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - // closing tag |
|
| 424 | - $output .= '</textarea>'; |
|
| 425 | - |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - if(!empty($args['label']) && $label_after){ |
|
| 429 | - $label_args = array( |
|
| 430 | - 'title'=> $args['label'], |
|
| 431 | - 'for'=> $args['id'], |
|
| 432 | - 'class' => $args['label_class']." ", |
|
| 433 | - 'label_type' => $args['label_type'] |
|
| 434 | - ); |
|
| 435 | - $output .= self::label( $label_args ); |
|
| 436 | - } |
|
| 437 | - |
|
| 438 | - // help text |
|
| 439 | - if(!empty($args['help_text'])){ |
|
| 440 | - $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 441 | - } |
|
| 442 | - |
|
| 443 | - // maybe horizontal label |
|
| 444 | - if($args['label_type']=='horizontal'){ |
|
| 445 | - $output .= '</div>'; |
|
| 446 | - } |
|
| 447 | - |
|
| 448 | - |
|
| 449 | - // wrap |
|
| 450 | - if(!$args['no_wrap']){ |
|
| 451 | - $form_group_class = $args['label_type']=='floating' ? 'form-label-group' : 'form-group'; |
|
| 452 | - $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 453 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 454 | - $output = self::wrap(array( |
|
| 455 | - 'content' => $output, |
|
| 456 | - 'class' => $wrap_class, |
|
| 457 | - 'element_require' => $args['element_require'], |
|
| 458 | - 'argument_id' => $args['id'] |
|
| 459 | - )); |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - |
|
| 463 | - return $output; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - public static function label($args = array(), $type = ''){ |
|
| 467 | - //<label for="exampleInputEmail1">Email address</label> |
|
| 468 | - $defaults = array( |
|
| 469 | - 'title' => 'div', |
|
| 470 | - 'for' => '', |
|
| 471 | - 'class' => '', |
|
| 472 | - 'label_type' => '', // empty = hidden, top, horizontal |
|
| 473 | - ); |
|
| 474 | - |
|
| 475 | - /** |
|
| 476 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 477 | - */ |
|
| 478 | - $args = wp_parse_args( $args, $defaults ); |
|
| 479 | - $output = ''; |
|
| 480 | - |
|
| 481 | - if($args['title']){ |
|
| 482 | - |
|
| 483 | - // maybe hide labels //@todo set a global option for visibility class |
|
| 484 | - if($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type']) ){ |
|
| 485 | - $class = $args['class']; |
|
| 486 | - }else{ |
|
| 487 | - $class = 'sr-only '.$args['class']; |
|
| 488 | - } |
|
| 489 | - |
|
| 490 | - // maybe horizontal |
|
| 491 | - if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 492 | - $class .= ' col-sm-2 col-form-label'; |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - // open |
|
| 496 | - $output .= '<label '; |
|
| 497 | - |
|
| 498 | - // for |
|
| 499 | - if(!empty($args['for'])){ |
|
| 500 | - $output .= ' for="'.sanitize_text_field($args['for']).'" '; |
|
| 501 | - } |
|
| 502 | - |
|
| 503 | - // class |
|
| 504 | - $class = $class ? AUI_Component_Helper::esc_classes( $class ) : ''; |
|
| 505 | - $output .= ' class="'.$class.'" '; |
|
| 506 | - |
|
| 507 | - // close |
|
| 508 | - $output .= '>'; |
|
| 509 | - |
|
| 510 | - |
|
| 511 | - // title, don't escape fully as can contain html |
|
| 512 | - if(!empty($args['title'])){ |
|
| 513 | - $output .= wp_kses_post($args['title']); |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - // close wrap |
|
| 517 | - $output .= '</label>'; |
|
| 518 | - |
|
| 519 | - |
|
| 520 | - } |
|
| 521 | - |
|
| 522 | - |
|
| 523 | - return $output; |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - /** |
|
| 527 | - * Wrap some content in a HTML wrapper. |
|
| 528 | - * |
|
| 529 | - * @param array $args |
|
| 530 | - * |
|
| 531 | - * @return string |
|
| 532 | - */ |
|
| 533 | - public static function wrap($args = array()){ |
|
| 534 | - $defaults = array( |
|
| 535 | - 'type' => 'div', |
|
| 536 | - 'class' => 'form-group', |
|
| 537 | - 'content' => '', |
|
| 538 | - 'input_group_left' => '', |
|
| 539 | - 'input_group_right' => '', |
|
| 540 | - 'input_group_left_inside' => false, |
|
| 541 | - 'input_group_right_inside' => false, |
|
| 542 | - 'element_require' => '', |
|
| 543 | - 'argument_id' => '', |
|
| 544 | - ); |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 548 | - */ |
|
| 549 | - $args = wp_parse_args( $args, $defaults ); |
|
| 550 | - $output = ''; |
|
| 551 | - if($args['type']){ |
|
| 552 | - |
|
| 553 | - // open |
|
| 554 | - $output .= '<'.sanitize_html_class($args['type']); |
|
| 555 | - |
|
| 556 | - // element require |
|
| 557 | - if(!empty($args['element_require'])){ |
|
| 558 | - $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 559 | - $args['class'] .= " aui-conditional-field"; |
|
| 560 | - } |
|
| 561 | - |
|
| 562 | - // argument_id |
|
| 563 | - if( !empty($args['argument_id']) ){ |
|
| 564 | - $output .= ' data-argument="'.esc_attr($args['argument_id']).'"'; |
|
| 565 | - } |
|
| 566 | - |
|
| 567 | - // class |
|
| 568 | - $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 569 | - $output .= ' class="'.$class.'" '; |
|
| 570 | - |
|
| 571 | - // close wrap |
|
| 572 | - $output .= ' >'; |
|
| 573 | - |
|
| 574 | - |
|
| 575 | - // Input group left |
|
| 576 | - if(!empty($args['input_group_left'])){ |
|
| 577 | - $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 578 | - $input_group_left = strpos($args['input_group_left'], '<') !== false ? $args['input_group_left'] : '<span class="input-group-text">'.$args['input_group_left'].'</span>'; |
|
| 579 | - $output .= '<div class="input-group-prepend '.$position_class.'">'.$input_group_left.'</div>'; |
|
| 580 | - } |
|
| 581 | - |
|
| 582 | - // content |
|
| 583 | - $output .= $args['content']; |
|
| 584 | - |
|
| 585 | - // Input group right |
|
| 586 | - if(!empty($args['input_group_right'])){ |
|
| 587 | - $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 588 | - $input_group_right = strpos($args['input_group_right'], '<') !== false ? $args['input_group_right'] : '<span class="input-group-text">'.$args['input_group_right'].'</span>'; |
|
| 589 | - $output .= '<div class="input-group-append '.$position_class.'">'.$input_group_right.'</div>'; |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - |
|
| 593 | - // close wrap |
|
| 594 | - $output .= '</'.sanitize_html_class($args['type']).'>'; |
|
| 595 | - |
|
| 596 | - |
|
| 597 | - }else{ |
|
| 598 | - $output = $args['content']; |
|
| 599 | - } |
|
| 600 | - |
|
| 601 | - return $output; |
|
| 602 | - } |
|
| 603 | - |
|
| 604 | - /** |
|
| 605 | - * Build the component. |
|
| 606 | - * |
|
| 607 | - * @param array $args |
|
| 608 | - * |
|
| 609 | - * @return string The rendered component. |
|
| 610 | - */ |
|
| 611 | - public static function select($args = array()){ |
|
| 612 | - $defaults = array( |
|
| 613 | - 'class' => '', |
|
| 614 | - 'wrap_class' => '', |
|
| 615 | - 'id' => '', |
|
| 616 | - 'title' => '', |
|
| 617 | - 'value' => '', // can be an array or a string |
|
| 618 | - 'required' => false, |
|
| 619 | - 'label' => '', |
|
| 620 | - 'label_after'=> false, |
|
| 621 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 622 | - 'label_class' => '', |
|
| 623 | - 'help_text' => '', |
|
| 624 | - 'placeholder'=> '', |
|
| 625 | - 'options' => array(), // array or string |
|
| 626 | - 'icon' => '', |
|
| 627 | - 'multiple' => false, |
|
| 628 | - 'select2' => false, |
|
| 629 | - 'no_wrap' => false, |
|
| 630 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 631 | - 'extra_attributes' => array(), // an array of extra attributes |
|
| 632 | - ); |
|
| 633 | - |
|
| 634 | - /** |
|
| 635 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 636 | - */ |
|
| 637 | - $args = wp_parse_args( $args, $defaults ); |
|
| 638 | - $output = ''; |
|
| 639 | - |
|
| 640 | - // for now lets hide floating labels |
|
| 641 | - if( $args['label_type'] == 'floating' ){$args['label_type'] = 'hidden';} |
|
| 642 | - |
|
| 643 | - // hidden label option needs to be empty |
|
| 644 | - $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 645 | - |
|
| 646 | - |
|
| 647 | - $label_after = $args['label_after']; |
|
| 648 | - |
|
| 649 | - // floating labels need label after |
|
| 650 | - if( $args['label_type'] == 'floating' ){ |
|
| 651 | - $label_after = true; |
|
| 652 | - $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - // Maybe setup select2 |
|
| 656 | - $is_select2 = false; |
|
| 657 | - if(!empty($args['select2'])){ |
|
| 658 | - $args['class'] .= ' aui-select2'; |
|
| 659 | - $is_select2 = true; |
|
| 660 | - }elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 661 | - $is_select2 = true; |
|
| 662 | - } |
|
| 663 | - |
|
| 664 | - // select2 tags |
|
| 665 | - if( !empty($args['select2']) && $args['select2'] === 'tags'){ // triple equals needed here for some reason |
|
| 666 | - $args['data-tags'] = 'true'; |
|
| 667 | - $args['data-token-separators'] = "[',']"; |
|
| 668 | - $args['multiple'] = true; |
|
| 669 | - } |
|
| 670 | - |
|
| 671 | - // select2 placeholder |
|
| 672 | - if($is_select2 && isset($args['placeholder']) && '' != $args['placeholder'] && empty($args['data-placeholder'])){ |
|
| 673 | - $args['data-placeholder'] = esc_attr($args['placeholder']); |
|
| 674 | - $args['data-allow-clear'] = isset($args['data-allow-clear']) ? (bool) $args['data-allow-clear'] : true; |
|
| 675 | - } |
|
| 676 | - |
|
| 677 | - // label |
|
| 678 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 679 | - }elseif(!empty($args['label']) && !$label_after){ |
|
| 680 | - $label_args = array( |
|
| 681 | - 'title'=> $args['label'], |
|
| 682 | - 'for'=> $args['id'], |
|
| 683 | - 'class' => $args['label_class']." ", |
|
| 684 | - 'label_type' => $args['label_type'] |
|
| 685 | - ); |
|
| 686 | - $output .= self::label($label_args); |
|
| 687 | - } |
|
| 688 | - |
|
| 689 | - // maybe horizontal label |
|
| 690 | - if($args['label_type']=='horizontal'){ |
|
| 691 | - $output .= '<div class="col-sm-10">'; |
|
| 692 | - } |
|
| 693 | - |
|
| 694 | - // open/type |
|
| 695 | - $output .= '<select '; |
|
| 696 | - |
|
| 697 | - // style |
|
| 698 | - if($is_select2){ |
|
| 699 | - $output .= " style='width:100%;' "; |
|
| 700 | - } |
|
| 701 | - |
|
| 702 | - // element require |
|
| 703 | - if(!empty($args['element_require'])){ |
|
| 704 | - $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 705 | - $args['class'] .= " aui-conditional-field"; |
|
| 706 | - } |
|
| 707 | - |
|
| 708 | - // class |
|
| 709 | - $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 710 | - $output .= AUI_Component_Helper::class_attr('custom-select '.$class); |
|
| 711 | - |
|
| 712 | - // name |
|
| 713 | - if(!empty($args['name'])){ |
|
| 714 | - $output .= AUI_Component_Helper::name($args['name'],$args['multiple']); |
|
| 715 | - } |
|
| 716 | - |
|
| 717 | - // id |
|
| 718 | - if(!empty($args['id'])){ |
|
| 719 | - $output .= AUI_Component_Helper::id($args['id']); |
|
| 720 | - } |
|
| 721 | - |
|
| 722 | - // title |
|
| 723 | - if(!empty($args['title'])){ |
|
| 724 | - $output .= AUI_Component_Helper::title($args['title']); |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - // data-attributes |
|
| 728 | - $output .= AUI_Component_Helper::data_attributes($args); |
|
| 729 | - |
|
| 730 | - // aria-attributes |
|
| 731 | - $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 732 | - |
|
| 733 | - // extra attributes |
|
| 734 | - if(!empty($args['extra_attributes'])){ |
|
| 735 | - $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 736 | - } |
|
| 737 | - |
|
| 738 | - // required |
|
| 739 | - if(!empty($args['required'])){ |
|
| 740 | - $output .= ' required '; |
|
| 741 | - } |
|
| 742 | - |
|
| 743 | - // multiple |
|
| 744 | - if(!empty($args['multiple'])){ |
|
| 745 | - $output .= ' multiple '; |
|
| 746 | - } |
|
| 747 | - |
|
| 748 | - // close opening tag |
|
| 749 | - $output .= ' >'; |
|
| 750 | - |
|
| 751 | - // placeholder |
|
| 752 | - if(isset($args['placeholder']) && '' != $args['placeholder'] && !$is_select2){ |
|
| 753 | - $output .= '<option value="" disabled selected hidden>'.esc_attr($args['placeholder']).'</option>'; |
|
| 754 | - }elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 755 | - $output .= "<option></option>"; // select2 needs an empty select to fill the placeholder |
|
| 756 | - } |
|
| 757 | - |
|
| 758 | - // Options |
|
| 759 | - if(!empty($args['options'])){ |
|
| 760 | - |
|
| 761 | - if(!is_array($args['options'])){ |
|
| 762 | - $output .= $args['options']; // not the preferred way but an option |
|
| 763 | - }else{ |
|
| 764 | - foreach($args['options'] as $val => $name){ |
|
| 765 | - $selected = ''; |
|
| 766 | - if(is_array($name)){ |
|
| 767 | - if (isset($name['optgroup']) && ($name['optgroup'] == 'start' || $name['optgroup'] == 'end')) { |
|
| 768 | - $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 769 | - |
|
| 770 | - $output .= $name['optgroup'] == 'start' ? '<optgroup label="' . esc_attr($option_label) . '">' : '</optgroup>'; |
|
| 771 | - } else { |
|
| 772 | - $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 773 | - $option_value = isset($name['value']) ? $name['value'] : ''; |
|
| 774 | - if(!empty($args['multiple']) && !empty($args['value']) && is_array($args['value']) ){ |
|
| 775 | - $selected = in_array($option_value, stripslashes_deep($args['value'])) ? "selected" : ""; |
|
| 776 | - } elseif(!empty($args['value'])) { |
|
| 777 | - $selected = selected($option_value,stripslashes_deep($args['value']), false); |
|
| 778 | - } |
|
| 779 | - |
|
| 780 | - $output .= '<option value="' . esc_attr($option_value) . '" ' . $selected . '>' . $option_label . '</option>'; |
|
| 781 | - } |
|
| 782 | - }else{ |
|
| 783 | - if(!empty($args['value'])){ |
|
| 784 | - if(is_array($args['value'])){ |
|
| 785 | - $selected = in_array($val,$args['value']) ? 'selected="selected"' : ''; |
|
| 786 | - } elseif(!empty($args['value'])) { |
|
| 787 | - $selected = selected( $args['value'], $val, false); |
|
| 788 | - } |
|
| 789 | - } |
|
| 790 | - $output .= '<option value="'.esc_attr($val).'" '.$selected.'>'.esc_attr($name).'</option>'; |
|
| 791 | - } |
|
| 792 | - } |
|
| 793 | - } |
|
| 794 | - |
|
| 795 | - } |
|
| 796 | - |
|
| 797 | - // closing tag |
|
| 798 | - $output .= '</select>'; |
|
| 799 | - |
|
| 800 | - if(!empty($args['label']) && $label_after){ |
|
| 801 | - $label_args = array( |
|
| 802 | - 'title'=> $args['label'], |
|
| 803 | - 'for'=> $args['id'], |
|
| 804 | - 'class' => $args['label_class']." ", |
|
| 805 | - 'label_type' => $args['label_type'] |
|
| 806 | - ); |
|
| 807 | - $output .= self::label($label_args); |
|
| 808 | - } |
|
| 809 | - |
|
| 810 | - // help text |
|
| 811 | - if(!empty($args['help_text'])){ |
|
| 812 | - $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 813 | - } |
|
| 814 | - |
|
| 815 | - // maybe horizontal label |
|
| 816 | - if($args['label_type']=='horizontal'){ |
|
| 817 | - $output .= '</div>'; |
|
| 818 | - } |
|
| 819 | - |
|
| 820 | - |
|
| 821 | - // wrap |
|
| 822 | - if(!$args['no_wrap']){ |
|
| 823 | - $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 824 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 825 | - $output = self::wrap(array( |
|
| 826 | - 'content' => $output, |
|
| 827 | - 'class' => $wrap_class, |
|
| 828 | - 'element_require' => $args['element_require'], |
|
| 829 | - 'argument_id' => $args['id'] |
|
| 830 | - )); |
|
| 831 | - } |
|
| 832 | - |
|
| 833 | - |
|
| 834 | - return $output; |
|
| 835 | - } |
|
| 836 | - |
|
| 837 | - /** |
|
| 838 | - * Build the component. |
|
| 839 | - * |
|
| 840 | - * @param array $args |
|
| 841 | - * |
|
| 842 | - * @return string The rendered component. |
|
| 843 | - */ |
|
| 844 | - public static function radio($args = array()){ |
|
| 845 | - $defaults = array( |
|
| 846 | - 'class' => '', |
|
| 847 | - 'wrap_class' => '', |
|
| 848 | - 'id' => '', |
|
| 849 | - 'title' => '', |
|
| 850 | - 'horizontal' => false, // sets the lable horizontal |
|
| 851 | - 'value' => '', |
|
| 852 | - 'label' => '', |
|
| 853 | - 'label_class'=> '', |
|
| 854 | - 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 855 | - 'inline' => true, |
|
| 856 | - 'required' => false, |
|
| 857 | - 'options' => array(), |
|
| 858 | - 'icon' => '', |
|
| 859 | - 'no_wrap' => false, |
|
| 860 | - 'element_require' => '', // [%element_id%] == "1" |
|
| 861 | - 'extra_attributes' => array() // an array of extra attributes |
|
| 862 | - ); |
|
| 863 | - |
|
| 864 | - /** |
|
| 865 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 866 | - */ |
|
| 867 | - $args = wp_parse_args( $args, $defaults ); |
|
| 868 | - |
|
| 869 | - // for now lets use horizontal for floating |
|
| 870 | - if( $args['label_type'] == 'floating' ){$args['label_type'] = 'horizontal';} |
|
| 871 | - |
|
| 872 | - $label_args = array( |
|
| 873 | - 'title'=> $args['label'], |
|
| 874 | - 'class' => $args['label_class']." pt-0 ", |
|
| 875 | - 'label_type' => $args['label_type'] |
|
| 876 | - ); |
|
| 877 | - |
|
| 878 | - $output = ''; |
|
| 879 | - |
|
| 880 | - |
|
| 881 | - |
|
| 882 | - // label before |
|
| 883 | - if(!empty($args['label'])){ |
|
| 884 | - $output .= self::label( $label_args, 'radio' ); |
|
| 885 | - } |
|
| 886 | - |
|
| 887 | - // maybe horizontal label |
|
| 888 | - if($args['label_type']=='horizontal'){ |
|
| 889 | - $output .= '<div class="col-sm-10">'; |
|
| 890 | - } |
|
| 891 | - |
|
| 892 | - if(!empty($args['options'])){ |
|
| 893 | - $count = 0; |
|
| 894 | - foreach($args['options'] as $value => $label){ |
|
| 895 | - $option_args = $args; |
|
| 896 | - $option_args['value'] = $value; |
|
| 897 | - $option_args['label'] = $label; |
|
| 898 | - $option_args['checked'] = $value == $args['value'] ? true : false; |
|
| 899 | - $output .= self::radio_option($option_args,$count); |
|
| 900 | - $count++; |
|
| 901 | - } |
|
| 902 | - } |
|
| 903 | - |
|
| 904 | - // maybe horizontal label |
|
| 905 | - if($args['label_type']=='horizontal'){ |
|
| 906 | - $output .= '</div>'; |
|
| 907 | - } |
|
| 908 | - |
|
| 909 | - |
|
| 910 | - // wrap |
|
| 911 | - $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 912 | - $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 913 | - $output = self::wrap(array( |
|
| 914 | - 'content' => $output, |
|
| 915 | - 'class' => $wrap_class, |
|
| 916 | - 'element_require' => $args['element_require'], |
|
| 917 | - 'argument_id' => $args['id'] |
|
| 918 | - )); |
|
| 919 | - |
|
| 920 | - |
|
| 921 | - return $output; |
|
| 922 | - } |
|
| 923 | - |
|
| 924 | - /** |
|
| 925 | - * Build the component. |
|
| 926 | - * |
|
| 927 | - * @param array $args |
|
| 928 | - * |
|
| 929 | - * @return string The rendered component. |
|
| 930 | - */ |
|
| 931 | - public static function radio_option($args = array(),$count = ''){ |
|
| 932 | - $defaults = array( |
|
| 933 | - 'class' => '', |
|
| 934 | - 'id' => '', |
|
| 935 | - 'title' => '', |
|
| 936 | - 'value' => '', |
|
| 937 | - 'required' => false, |
|
| 938 | - 'inline' => true, |
|
| 939 | - 'label' => '', |
|
| 940 | - 'options' => array(), |
|
| 941 | - 'icon' => '', |
|
| 942 | - 'no_wrap' => false, |
|
| 943 | - 'extra_attributes' => array() // an array of extra attributes |
|
| 944 | - ); |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 948 | - */ |
|
| 949 | - $args = wp_parse_args( $args, $defaults ); |
|
| 950 | - |
|
| 951 | - $output = ''; |
|
| 952 | - |
|
| 953 | - // open/type |
|
| 954 | - $output .= '<input type="radio"'; |
|
| 955 | - |
|
| 956 | - // class |
|
| 957 | - $output .= ' class="form-check-input" '; |
|
| 958 | - |
|
| 959 | - // name |
|
| 960 | - if(!empty($args['name'])){ |
|
| 961 | - $output .= AUI_Component_Helper::name($args['name']); |
|
| 962 | - } |
|
| 963 | - |
|
| 964 | - // id |
|
| 965 | - if(!empty($args['id'])){ |
|
| 966 | - $output .= AUI_Component_Helper::id($args['id'].$count); |
|
| 967 | - } |
|
| 968 | - |
|
| 969 | - // title |
|
| 970 | - if(!empty($args['title'])){ |
|
| 971 | - $output .= AUI_Component_Helper::title($args['title']); |
|
| 972 | - } |
|
| 973 | - |
|
| 974 | - // value |
|
| 975 | - if(isset($args['value'])){ |
|
| 976 | - $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 977 | - } |
|
| 978 | - |
|
| 979 | - // checked, for radio and checkboxes |
|
| 980 | - if( $args['checked'] ){ |
|
| 981 | - $output .= ' checked '; |
|
| 982 | - } |
|
| 983 | - |
|
| 984 | - // data-attributes |
|
| 985 | - $output .= AUI_Component_Helper::data_attributes($args); |
|
| 986 | - |
|
| 987 | - // aria-attributes |
|
| 988 | - $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 989 | - |
|
| 990 | - // extra attributes |
|
| 991 | - if(!empty($args['extra_attributes'])){ |
|
| 992 | - $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - // required |
|
| 996 | - if(!empty($args['required'])){ |
|
| 997 | - $output .= ' required '; |
|
| 998 | - } |
|
| 999 | - |
|
| 1000 | - // close opening tag |
|
| 1001 | - $output .= ' >'; |
|
| 1002 | - |
|
| 1003 | - // label |
|
| 1004 | - if(!empty($args['label']) && is_array($args['label'])){ |
|
| 1005 | - }elseif(!empty($args['label'])){ |
|
| 1006 | - $output .= self::label(array('title'=>$args['label'],'for'=>$args['id'].$count,'class'=>'form-check-label'),'radio'); |
|
| 1007 | - } |
|
| 1008 | - |
|
| 1009 | - // wrap |
|
| 1010 | - if(!$args['no_wrap']){ |
|
| 1011 | - $wrap_class = $args['inline'] ? 'form-check form-check-inline' : 'form-check'; |
|
| 1012 | - $output = self::wrap(array( |
|
| 1013 | - 'content' => $output, |
|
| 1014 | - 'class' => $wrap_class |
|
| 1015 | - )); |
|
| 1016 | - } |
|
| 1017 | - |
|
| 1018 | - |
|
| 1019 | - return $output; |
|
| 1020 | - } |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + // input group wraps |
|
| 216 | + if($args['input_group_left'] || $args['input_group_right']){ |
|
| 217 | + $w100 = strpos($args['class'], 'w-100') !== false ? ' w-100' : ''; |
|
| 218 | + if($args['input_group_left']){ |
|
| 219 | + $output = self::wrap( array( |
|
| 220 | + 'content' => $output, |
|
| 221 | + 'class' => $args['input_group_left_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 222 | + 'input_group_left' => $args['input_group_left'], |
|
| 223 | + 'input_group_left_inside' => $args['input_group_left_inside'] |
|
| 224 | + ) ); |
|
| 225 | + } |
|
| 226 | + if($args['input_group_right']){ |
|
| 227 | + $output = self::wrap( array( |
|
| 228 | + 'content' => $output, |
|
| 229 | + 'class' => $args['input_group_right_inside'] ? 'input-group-inside position-relative'.$w100 : 'input-group', |
|
| 230 | + 'input_group_right' => $args['input_group_right'], |
|
| 231 | + 'input_group_right_inside' => $args['input_group_right_inside'] |
|
| 232 | + ) ); |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + if(!$label_after){ |
|
| 238 | + $output .= $help_text; |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + |
|
| 242 | + if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 243 | + $output = self::wrap( array( |
|
| 244 | + 'content' => $output, |
|
| 245 | + 'class' => 'col-sm-10', |
|
| 246 | + ) ); |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + if(!$label_after){ |
|
| 250 | + $output = $label . $output; |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + // wrap |
|
| 254 | + if(!$args['no_wrap']){ |
|
| 255 | + |
|
| 256 | + $form_group_class = $args['label_type']=='floating' && $type != 'checkbox' ? 'form-label-group' : 'form-group'; |
|
| 257 | + $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 258 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 259 | + $output = self::wrap(array( |
|
| 260 | + 'content' => $output, |
|
| 261 | + 'class' => $wrap_class, |
|
| 262 | + 'element_require' => $args['element_require'], |
|
| 263 | + 'argument_id' => $args['id'] |
|
| 264 | + )); |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + |
|
| 268 | + |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + return $output; |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * Build the component. |
|
| 276 | + * |
|
| 277 | + * @param array $args |
|
| 278 | + * |
|
| 279 | + * @return string The rendered component. |
|
| 280 | + */ |
|
| 281 | + public static function textarea($args = array()){ |
|
| 282 | + $defaults = array( |
|
| 283 | + 'name' => '', |
|
| 284 | + 'class' => '', |
|
| 285 | + 'wrap_class' => '', |
|
| 286 | + 'id' => '', |
|
| 287 | + 'placeholder'=> '', |
|
| 288 | + 'title' => '', |
|
| 289 | + 'value' => '', |
|
| 290 | + 'required' => false, |
|
| 291 | + 'label' => '', |
|
| 292 | + 'label_after'=> false, |
|
| 293 | + 'label_class' => '', |
|
| 294 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 295 | + 'help_text' => '', |
|
| 296 | + 'validation_text' => '', |
|
| 297 | + 'validation_pattern' => '', |
|
| 298 | + 'no_wrap' => false, |
|
| 299 | + 'rows' => '', |
|
| 300 | + 'wysiwyg' => false, |
|
| 301 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 302 | + ); |
|
| 303 | + |
|
| 304 | + /** |
|
| 305 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 306 | + */ |
|
| 307 | + $args = wp_parse_args( $args, $defaults ); |
|
| 308 | + $output = ''; |
|
| 309 | + |
|
| 310 | + // hidden label option needs to be empty |
|
| 311 | + $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 312 | + |
|
| 313 | + // floating labels don't work with wysiwyg so set it as top |
|
| 314 | + if($args['label_type'] == 'floating' && !empty($args['wysiwyg'])){ |
|
| 315 | + $args['label_type'] = 'top'; |
|
| 316 | + } |
|
| 317 | + |
|
| 318 | + $label_after = $args['label_after']; |
|
| 319 | + |
|
| 320 | + // floating labels need label after |
|
| 321 | + if( $args['label_type'] == 'floating' && empty($args['wysiwyg']) ){ |
|
| 322 | + $label_after = true; |
|
| 323 | + $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + // label |
|
| 327 | + if(!empty($args['label']) && is_array($args['label'])){ |
|
| 328 | + }elseif(!empty($args['label']) && !$label_after){ |
|
| 329 | + $label_args = array( |
|
| 330 | + 'title'=> $args['label'], |
|
| 331 | + 'for'=> $args['id'], |
|
| 332 | + 'class' => $args['label_class']." ", |
|
| 333 | + 'label_type' => $args['label_type'] |
|
| 334 | + ); |
|
| 335 | + $output .= self::label( $label_args ); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + // maybe horizontal label |
|
| 339 | + if($args['label_type']=='horizontal'){ |
|
| 340 | + $output .= '<div class="col-sm-10">'; |
|
| 341 | + } |
|
| 342 | + |
|
| 343 | + if(!empty($args['wysiwyg'])){ |
|
| 344 | + ob_start(); |
|
| 345 | + $content = $args['value']; |
|
| 346 | + $editor_id = !empty($args['id']) ? sanitize_html_class($args['id']) : 'wp_editor'; |
|
| 347 | + $settings = array( |
|
| 348 | + 'textarea_rows' => !empty(absint($args['rows'])) ? absint($args['rows']) : 4, |
|
| 349 | + 'quicktags' => false, |
|
| 350 | + 'media_buttons' => false, |
|
| 351 | + 'editor_class' => 'form-control', |
|
| 352 | + 'textarea_name' => !empty($args['name']) ? sanitize_html_class($args['name']) : sanitize_html_class($args['id']), |
|
| 353 | + 'teeny' => true, |
|
| 354 | + ); |
|
| 355 | + |
|
| 356 | + // maybe set settings if array |
|
| 357 | + if(is_array($args['wysiwyg'])){ |
|
| 358 | + $settings = wp_parse_args( $args['wysiwyg'], $settings ); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + wp_editor( $content, $editor_id, $settings ); |
|
| 362 | + $output .= ob_get_clean(); |
|
| 363 | + }else{ |
|
| 364 | + |
|
| 365 | + // open |
|
| 366 | + $output .= '<textarea '; |
|
| 367 | + |
|
| 368 | + // name |
|
| 369 | + if(!empty($args['name'])){ |
|
| 370 | + $output .= ' name="'.sanitize_html_class($args['name']).'" '; |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + // id |
|
| 374 | + if(!empty($args['id'])){ |
|
| 375 | + $output .= ' id="'.sanitize_html_class($args['id']).'" '; |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + // placeholder |
|
| 379 | + if(isset($args['placeholder']) && '' != $args['placeholder']){ |
|
| 380 | + $output .= ' placeholder="'.esc_attr($args['placeholder']).'" '; |
|
| 381 | + } |
|
| 382 | + |
|
| 383 | + // title |
|
| 384 | + if(!empty($args['title'])){ |
|
| 385 | + $output .= ' title="'.esc_attr($args['title']).'" '; |
|
| 386 | + } |
|
| 387 | + |
|
| 388 | + // validation text |
|
| 389 | + if(!empty($args['validation_text'])){ |
|
| 390 | + $output .= ' oninvalid="setCustomValidity(\''.esc_attr($args['validation_text']).'\')" '; |
|
| 391 | + $output .= ' onchange="try{setCustomValidity(\'\')}catch(e){}" '; |
|
| 392 | + } |
|
| 393 | + |
|
| 394 | + // validation_pattern |
|
| 395 | + if(!empty($args['validation_pattern'])){ |
|
| 396 | + $output .= ' pattern="'.$args['validation_pattern'].'" '; |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + // required |
|
| 400 | + if(!empty($args['required'])){ |
|
| 401 | + $output .= ' required '; |
|
| 402 | + } |
|
| 403 | + |
|
| 404 | + // rows |
|
| 405 | + if(!empty($args['rows'])){ |
|
| 406 | + $output .= ' rows="'.absint($args['rows']).'" '; |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + |
|
| 410 | + // class |
|
| 411 | + $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 412 | + $output .= ' class="form-control '.$class.'" '; |
|
| 413 | + |
|
| 414 | + |
|
| 415 | + // close tag |
|
| 416 | + $output .= ' >'; |
|
| 417 | + |
|
| 418 | + // value |
|
| 419 | + if(!empty($args['value'])){ |
|
| 420 | + $output .= sanitize_textarea_field($args['value']); |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + // closing tag |
|
| 424 | + $output .= '</textarea>'; |
|
| 425 | + |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + if(!empty($args['label']) && $label_after){ |
|
| 429 | + $label_args = array( |
|
| 430 | + 'title'=> $args['label'], |
|
| 431 | + 'for'=> $args['id'], |
|
| 432 | + 'class' => $args['label_class']." ", |
|
| 433 | + 'label_type' => $args['label_type'] |
|
| 434 | + ); |
|
| 435 | + $output .= self::label( $label_args ); |
|
| 436 | + } |
|
| 437 | + |
|
| 438 | + // help text |
|
| 439 | + if(!empty($args['help_text'])){ |
|
| 440 | + $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 441 | + } |
|
| 442 | + |
|
| 443 | + // maybe horizontal label |
|
| 444 | + if($args['label_type']=='horizontal'){ |
|
| 445 | + $output .= '</div>'; |
|
| 446 | + } |
|
| 447 | + |
|
| 448 | + |
|
| 449 | + // wrap |
|
| 450 | + if(!$args['no_wrap']){ |
|
| 451 | + $form_group_class = $args['label_type']=='floating' ? 'form-label-group' : 'form-group'; |
|
| 452 | + $wrap_class = $args['label_type']=='horizontal' ? $form_group_class . ' row' : $form_group_class; |
|
| 453 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 454 | + $output = self::wrap(array( |
|
| 455 | + 'content' => $output, |
|
| 456 | + 'class' => $wrap_class, |
|
| 457 | + 'element_require' => $args['element_require'], |
|
| 458 | + 'argument_id' => $args['id'] |
|
| 459 | + )); |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + |
|
| 463 | + return $output; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + public static function label($args = array(), $type = ''){ |
|
| 467 | + //<label for="exampleInputEmail1">Email address</label> |
|
| 468 | + $defaults = array( |
|
| 469 | + 'title' => 'div', |
|
| 470 | + 'for' => '', |
|
| 471 | + 'class' => '', |
|
| 472 | + 'label_type' => '', // empty = hidden, top, horizontal |
|
| 473 | + ); |
|
| 474 | + |
|
| 475 | + /** |
|
| 476 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 477 | + */ |
|
| 478 | + $args = wp_parse_args( $args, $defaults ); |
|
| 479 | + $output = ''; |
|
| 480 | + |
|
| 481 | + if($args['title']){ |
|
| 482 | + |
|
| 483 | + // maybe hide labels //@todo set a global option for visibility class |
|
| 484 | + if($type == 'file' || $type == 'checkbox' || $type == 'radio' || !empty($args['label_type']) ){ |
|
| 485 | + $class = $args['class']; |
|
| 486 | + }else{ |
|
| 487 | + $class = 'sr-only '.$args['class']; |
|
| 488 | + } |
|
| 489 | + |
|
| 490 | + // maybe horizontal |
|
| 491 | + if($args['label_type']=='horizontal' && $type != 'checkbox'){ |
|
| 492 | + $class .= ' col-sm-2 col-form-label'; |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + // open |
|
| 496 | + $output .= '<label '; |
|
| 497 | + |
|
| 498 | + // for |
|
| 499 | + if(!empty($args['for'])){ |
|
| 500 | + $output .= ' for="'.sanitize_text_field($args['for']).'" '; |
|
| 501 | + } |
|
| 502 | + |
|
| 503 | + // class |
|
| 504 | + $class = $class ? AUI_Component_Helper::esc_classes( $class ) : ''; |
|
| 505 | + $output .= ' class="'.$class.'" '; |
|
| 506 | + |
|
| 507 | + // close |
|
| 508 | + $output .= '>'; |
|
| 509 | + |
|
| 510 | + |
|
| 511 | + // title, don't escape fully as can contain html |
|
| 512 | + if(!empty($args['title'])){ |
|
| 513 | + $output .= wp_kses_post($args['title']); |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + // close wrap |
|
| 517 | + $output .= '</label>'; |
|
| 518 | + |
|
| 519 | + |
|
| 520 | + } |
|
| 521 | + |
|
| 522 | + |
|
| 523 | + return $output; |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + /** |
|
| 527 | + * Wrap some content in a HTML wrapper. |
|
| 528 | + * |
|
| 529 | + * @param array $args |
|
| 530 | + * |
|
| 531 | + * @return string |
|
| 532 | + */ |
|
| 533 | + public static function wrap($args = array()){ |
|
| 534 | + $defaults = array( |
|
| 535 | + 'type' => 'div', |
|
| 536 | + 'class' => 'form-group', |
|
| 537 | + 'content' => '', |
|
| 538 | + 'input_group_left' => '', |
|
| 539 | + 'input_group_right' => '', |
|
| 540 | + 'input_group_left_inside' => false, |
|
| 541 | + 'input_group_right_inside' => false, |
|
| 542 | + 'element_require' => '', |
|
| 543 | + 'argument_id' => '', |
|
| 544 | + ); |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 548 | + */ |
|
| 549 | + $args = wp_parse_args( $args, $defaults ); |
|
| 550 | + $output = ''; |
|
| 551 | + if($args['type']){ |
|
| 552 | + |
|
| 553 | + // open |
|
| 554 | + $output .= '<'.sanitize_html_class($args['type']); |
|
| 555 | + |
|
| 556 | + // element require |
|
| 557 | + if(!empty($args['element_require'])){ |
|
| 558 | + $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 559 | + $args['class'] .= " aui-conditional-field"; |
|
| 560 | + } |
|
| 561 | + |
|
| 562 | + // argument_id |
|
| 563 | + if( !empty($args['argument_id']) ){ |
|
| 564 | + $output .= ' data-argument="'.esc_attr($args['argument_id']).'"'; |
|
| 565 | + } |
|
| 566 | + |
|
| 567 | + // class |
|
| 568 | + $class = !empty($args['class']) ? AUI_Component_Helper::esc_classes( $args['class'] ) : ''; |
|
| 569 | + $output .= ' class="'.$class.'" '; |
|
| 570 | + |
|
| 571 | + // close wrap |
|
| 572 | + $output .= ' >'; |
|
| 573 | + |
|
| 574 | + |
|
| 575 | + // Input group left |
|
| 576 | + if(!empty($args['input_group_left'])){ |
|
| 577 | + $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 578 | + $input_group_left = strpos($args['input_group_left'], '<') !== false ? $args['input_group_left'] : '<span class="input-group-text">'.$args['input_group_left'].'</span>'; |
|
| 579 | + $output .= '<div class="input-group-prepend '.$position_class.'">'.$input_group_left.'</div>'; |
|
| 580 | + } |
|
| 581 | + |
|
| 582 | + // content |
|
| 583 | + $output .= $args['content']; |
|
| 584 | + |
|
| 585 | + // Input group right |
|
| 586 | + if(!empty($args['input_group_right'])){ |
|
| 587 | + $position_class = !empty($args['input_group_left_inside']) ? 'position-absolute h-100' : ''; |
|
| 588 | + $input_group_right = strpos($args['input_group_right'], '<') !== false ? $args['input_group_right'] : '<span class="input-group-text">'.$args['input_group_right'].'</span>'; |
|
| 589 | + $output .= '<div class="input-group-append '.$position_class.'">'.$input_group_right.'</div>'; |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + |
|
| 593 | + // close wrap |
|
| 594 | + $output .= '</'.sanitize_html_class($args['type']).'>'; |
|
| 595 | + |
|
| 596 | + |
|
| 597 | + }else{ |
|
| 598 | + $output = $args['content']; |
|
| 599 | + } |
|
| 600 | + |
|
| 601 | + return $output; |
|
| 602 | + } |
|
| 603 | + |
|
| 604 | + /** |
|
| 605 | + * Build the component. |
|
| 606 | + * |
|
| 607 | + * @param array $args |
|
| 608 | + * |
|
| 609 | + * @return string The rendered component. |
|
| 610 | + */ |
|
| 611 | + public static function select($args = array()){ |
|
| 612 | + $defaults = array( |
|
| 613 | + 'class' => '', |
|
| 614 | + 'wrap_class' => '', |
|
| 615 | + 'id' => '', |
|
| 616 | + 'title' => '', |
|
| 617 | + 'value' => '', // can be an array or a string |
|
| 618 | + 'required' => false, |
|
| 619 | + 'label' => '', |
|
| 620 | + 'label_after'=> false, |
|
| 621 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 622 | + 'label_class' => '', |
|
| 623 | + 'help_text' => '', |
|
| 624 | + 'placeholder'=> '', |
|
| 625 | + 'options' => array(), // array or string |
|
| 626 | + 'icon' => '', |
|
| 627 | + 'multiple' => false, |
|
| 628 | + 'select2' => false, |
|
| 629 | + 'no_wrap' => false, |
|
| 630 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 631 | + 'extra_attributes' => array(), // an array of extra attributes |
|
| 632 | + ); |
|
| 633 | + |
|
| 634 | + /** |
|
| 635 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 636 | + */ |
|
| 637 | + $args = wp_parse_args( $args, $defaults ); |
|
| 638 | + $output = ''; |
|
| 639 | + |
|
| 640 | + // for now lets hide floating labels |
|
| 641 | + if( $args['label_type'] == 'floating' ){$args['label_type'] = 'hidden';} |
|
| 642 | + |
|
| 643 | + // hidden label option needs to be empty |
|
| 644 | + $args['label_type'] = $args['label_type'] == 'hidden' ? '' : $args['label_type']; |
|
| 645 | + |
|
| 646 | + |
|
| 647 | + $label_after = $args['label_after']; |
|
| 648 | + |
|
| 649 | + // floating labels need label after |
|
| 650 | + if( $args['label_type'] == 'floating' ){ |
|
| 651 | + $label_after = true; |
|
| 652 | + $args['placeholder'] = ' '; // set the placeholder not empty so the floating label works. |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + // Maybe setup select2 |
|
| 656 | + $is_select2 = false; |
|
| 657 | + if(!empty($args['select2'])){ |
|
| 658 | + $args['class'] .= ' aui-select2'; |
|
| 659 | + $is_select2 = true; |
|
| 660 | + }elseif( strpos($args['class'], 'aui-select2') !== false){ |
|
| 661 | + $is_select2 = true; |
|
| 662 | + } |
|
| 663 | + |
|
| 664 | + // select2 tags |
|
| 665 | + if( !empty($args['select2']) && $args['select2'] === 'tags'){ // triple equals needed here for some reason |
|
| 666 | + $args['data-tags'] = 'true'; |
|
| 667 | + $args['data-token-separators'] = "[',']"; |
|
| 668 | + $args['multiple'] = true; |
|
| 669 | + } |
|
| 670 | + |
|
| 671 | + // select2 placeholder |
|
| 672 | + if($is_select2 && isset($args['placeholder']) && '' != $args['placeholder'] && empty($args['data-placeholder'])){ |
|
| 673 | + $args['data-placeholder'] = esc_attr($args['placeholder']); |
|
| 674 | + $args['data-allow-clear'] = isset($args['data-allow-clear']) ? (bool) $args['data-allow-clear'] : true; |
|
| 675 | + } |
|
| 676 | + |
|
| 677 | + // label |
|
| 678 | + if(!empty($args['label']) && is_array($args['label'])){ |
|
| 679 | + }elseif(!empty($args['label']) && !$label_after){ |
|
| 680 | + $label_args = array( |
|
| 681 | + 'title'=> $args['label'], |
|
| 682 | + 'for'=> $args['id'], |
|
| 683 | + 'class' => $args['label_class']." ", |
|
| 684 | + 'label_type' => $args['label_type'] |
|
| 685 | + ); |
|
| 686 | + $output .= self::label($label_args); |
|
| 687 | + } |
|
| 688 | + |
|
| 689 | + // maybe horizontal label |
|
| 690 | + if($args['label_type']=='horizontal'){ |
|
| 691 | + $output .= '<div class="col-sm-10">'; |
|
| 692 | + } |
|
| 693 | + |
|
| 694 | + // open/type |
|
| 695 | + $output .= '<select '; |
|
| 696 | + |
|
| 697 | + // style |
|
| 698 | + if($is_select2){ |
|
| 699 | + $output .= " style='width:100%;' "; |
|
| 700 | + } |
|
| 701 | + |
|
| 702 | + // element require |
|
| 703 | + if(!empty($args['element_require'])){ |
|
| 704 | + $output .= AUI_Component_Helper::element_require($args['element_require']); |
|
| 705 | + $args['class'] .= " aui-conditional-field"; |
|
| 706 | + } |
|
| 707 | + |
|
| 708 | + // class |
|
| 709 | + $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 710 | + $output .= AUI_Component_Helper::class_attr('custom-select '.$class); |
|
| 711 | + |
|
| 712 | + // name |
|
| 713 | + if(!empty($args['name'])){ |
|
| 714 | + $output .= AUI_Component_Helper::name($args['name'],$args['multiple']); |
|
| 715 | + } |
|
| 716 | + |
|
| 717 | + // id |
|
| 718 | + if(!empty($args['id'])){ |
|
| 719 | + $output .= AUI_Component_Helper::id($args['id']); |
|
| 720 | + } |
|
| 721 | + |
|
| 722 | + // title |
|
| 723 | + if(!empty($args['title'])){ |
|
| 724 | + $output .= AUI_Component_Helper::title($args['title']); |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + // data-attributes |
|
| 728 | + $output .= AUI_Component_Helper::data_attributes($args); |
|
| 729 | + |
|
| 730 | + // aria-attributes |
|
| 731 | + $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 732 | + |
|
| 733 | + // extra attributes |
|
| 734 | + if(!empty($args['extra_attributes'])){ |
|
| 735 | + $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 736 | + } |
|
| 737 | + |
|
| 738 | + // required |
|
| 739 | + if(!empty($args['required'])){ |
|
| 740 | + $output .= ' required '; |
|
| 741 | + } |
|
| 742 | + |
|
| 743 | + // multiple |
|
| 744 | + if(!empty($args['multiple'])){ |
|
| 745 | + $output .= ' multiple '; |
|
| 746 | + } |
|
| 747 | + |
|
| 748 | + // close opening tag |
|
| 749 | + $output .= ' >'; |
|
| 750 | + |
|
| 751 | + // placeholder |
|
| 752 | + if(isset($args['placeholder']) && '' != $args['placeholder'] && !$is_select2){ |
|
| 753 | + $output .= '<option value="" disabled selected hidden>'.esc_attr($args['placeholder']).'</option>'; |
|
| 754 | + }elseif($is_select2 && !empty($args['placeholder'])){ |
|
| 755 | + $output .= "<option></option>"; // select2 needs an empty select to fill the placeholder |
|
| 756 | + } |
|
| 757 | + |
|
| 758 | + // Options |
|
| 759 | + if(!empty($args['options'])){ |
|
| 760 | + |
|
| 761 | + if(!is_array($args['options'])){ |
|
| 762 | + $output .= $args['options']; // not the preferred way but an option |
|
| 763 | + }else{ |
|
| 764 | + foreach($args['options'] as $val => $name){ |
|
| 765 | + $selected = ''; |
|
| 766 | + if(is_array($name)){ |
|
| 767 | + if (isset($name['optgroup']) && ($name['optgroup'] == 'start' || $name['optgroup'] == 'end')) { |
|
| 768 | + $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 769 | + |
|
| 770 | + $output .= $name['optgroup'] == 'start' ? '<optgroup label="' . esc_attr($option_label) . '">' : '</optgroup>'; |
|
| 771 | + } else { |
|
| 772 | + $option_label = isset($name['label']) ? $name['label'] : ''; |
|
| 773 | + $option_value = isset($name['value']) ? $name['value'] : ''; |
|
| 774 | + if(!empty($args['multiple']) && !empty($args['value']) && is_array($args['value']) ){ |
|
| 775 | + $selected = in_array($option_value, stripslashes_deep($args['value'])) ? "selected" : ""; |
|
| 776 | + } elseif(!empty($args['value'])) { |
|
| 777 | + $selected = selected($option_value,stripslashes_deep($args['value']), false); |
|
| 778 | + } |
|
| 779 | + |
|
| 780 | + $output .= '<option value="' . esc_attr($option_value) . '" ' . $selected . '>' . $option_label . '</option>'; |
|
| 781 | + } |
|
| 782 | + }else{ |
|
| 783 | + if(!empty($args['value'])){ |
|
| 784 | + if(is_array($args['value'])){ |
|
| 785 | + $selected = in_array($val,$args['value']) ? 'selected="selected"' : ''; |
|
| 786 | + } elseif(!empty($args['value'])) { |
|
| 787 | + $selected = selected( $args['value'], $val, false); |
|
| 788 | + } |
|
| 789 | + } |
|
| 790 | + $output .= '<option value="'.esc_attr($val).'" '.$selected.'>'.esc_attr($name).'</option>'; |
|
| 791 | + } |
|
| 792 | + } |
|
| 793 | + } |
|
| 794 | + |
|
| 795 | + } |
|
| 796 | + |
|
| 797 | + // closing tag |
|
| 798 | + $output .= '</select>'; |
|
| 799 | + |
|
| 800 | + if(!empty($args['label']) && $label_after){ |
|
| 801 | + $label_args = array( |
|
| 802 | + 'title'=> $args['label'], |
|
| 803 | + 'for'=> $args['id'], |
|
| 804 | + 'class' => $args['label_class']." ", |
|
| 805 | + 'label_type' => $args['label_type'] |
|
| 806 | + ); |
|
| 807 | + $output .= self::label($label_args); |
|
| 808 | + } |
|
| 809 | + |
|
| 810 | + // help text |
|
| 811 | + if(!empty($args['help_text'])){ |
|
| 812 | + $output .= AUI_Component_Helper::help_text($args['help_text']); |
|
| 813 | + } |
|
| 814 | + |
|
| 815 | + // maybe horizontal label |
|
| 816 | + if($args['label_type']=='horizontal'){ |
|
| 817 | + $output .= '</div>'; |
|
| 818 | + } |
|
| 819 | + |
|
| 820 | + |
|
| 821 | + // wrap |
|
| 822 | + if(!$args['no_wrap']){ |
|
| 823 | + $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 824 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 825 | + $output = self::wrap(array( |
|
| 826 | + 'content' => $output, |
|
| 827 | + 'class' => $wrap_class, |
|
| 828 | + 'element_require' => $args['element_require'], |
|
| 829 | + 'argument_id' => $args['id'] |
|
| 830 | + )); |
|
| 831 | + } |
|
| 832 | + |
|
| 833 | + |
|
| 834 | + return $output; |
|
| 835 | + } |
|
| 836 | + |
|
| 837 | + /** |
|
| 838 | + * Build the component. |
|
| 839 | + * |
|
| 840 | + * @param array $args |
|
| 841 | + * |
|
| 842 | + * @return string The rendered component. |
|
| 843 | + */ |
|
| 844 | + public static function radio($args = array()){ |
|
| 845 | + $defaults = array( |
|
| 846 | + 'class' => '', |
|
| 847 | + 'wrap_class' => '', |
|
| 848 | + 'id' => '', |
|
| 849 | + 'title' => '', |
|
| 850 | + 'horizontal' => false, // sets the lable horizontal |
|
| 851 | + 'value' => '', |
|
| 852 | + 'label' => '', |
|
| 853 | + 'label_class'=> '', |
|
| 854 | + 'label_type' => '', // sets the label type, default: hidden. Options: hidden, top, horizontal, floating |
|
| 855 | + 'inline' => true, |
|
| 856 | + 'required' => false, |
|
| 857 | + 'options' => array(), |
|
| 858 | + 'icon' => '', |
|
| 859 | + 'no_wrap' => false, |
|
| 860 | + 'element_require' => '', // [%element_id%] == "1" |
|
| 861 | + 'extra_attributes' => array() // an array of extra attributes |
|
| 862 | + ); |
|
| 863 | + |
|
| 864 | + /** |
|
| 865 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 866 | + */ |
|
| 867 | + $args = wp_parse_args( $args, $defaults ); |
|
| 868 | + |
|
| 869 | + // for now lets use horizontal for floating |
|
| 870 | + if( $args['label_type'] == 'floating' ){$args['label_type'] = 'horizontal';} |
|
| 871 | + |
|
| 872 | + $label_args = array( |
|
| 873 | + 'title'=> $args['label'], |
|
| 874 | + 'class' => $args['label_class']." pt-0 ", |
|
| 875 | + 'label_type' => $args['label_type'] |
|
| 876 | + ); |
|
| 877 | + |
|
| 878 | + $output = ''; |
|
| 879 | + |
|
| 880 | + |
|
| 881 | + |
|
| 882 | + // label before |
|
| 883 | + if(!empty($args['label'])){ |
|
| 884 | + $output .= self::label( $label_args, 'radio' ); |
|
| 885 | + } |
|
| 886 | + |
|
| 887 | + // maybe horizontal label |
|
| 888 | + if($args['label_type']=='horizontal'){ |
|
| 889 | + $output .= '<div class="col-sm-10">'; |
|
| 890 | + } |
|
| 891 | + |
|
| 892 | + if(!empty($args['options'])){ |
|
| 893 | + $count = 0; |
|
| 894 | + foreach($args['options'] as $value => $label){ |
|
| 895 | + $option_args = $args; |
|
| 896 | + $option_args['value'] = $value; |
|
| 897 | + $option_args['label'] = $label; |
|
| 898 | + $option_args['checked'] = $value == $args['value'] ? true : false; |
|
| 899 | + $output .= self::radio_option($option_args,$count); |
|
| 900 | + $count++; |
|
| 901 | + } |
|
| 902 | + } |
|
| 903 | + |
|
| 904 | + // maybe horizontal label |
|
| 905 | + if($args['label_type']=='horizontal'){ |
|
| 906 | + $output .= '</div>'; |
|
| 907 | + } |
|
| 908 | + |
|
| 909 | + |
|
| 910 | + // wrap |
|
| 911 | + $wrap_class = $args['label_type']=='horizontal' ? 'form-group row' : 'form-group'; |
|
| 912 | + $wrap_class = !empty($args['wrap_class']) ? $wrap_class." ".$args['wrap_class'] : $wrap_class; |
|
| 913 | + $output = self::wrap(array( |
|
| 914 | + 'content' => $output, |
|
| 915 | + 'class' => $wrap_class, |
|
| 916 | + 'element_require' => $args['element_require'], |
|
| 917 | + 'argument_id' => $args['id'] |
|
| 918 | + )); |
|
| 919 | + |
|
| 920 | + |
|
| 921 | + return $output; |
|
| 922 | + } |
|
| 923 | + |
|
| 924 | + /** |
|
| 925 | + * Build the component. |
|
| 926 | + * |
|
| 927 | + * @param array $args |
|
| 928 | + * |
|
| 929 | + * @return string The rendered component. |
|
| 930 | + */ |
|
| 931 | + public static function radio_option($args = array(),$count = ''){ |
|
| 932 | + $defaults = array( |
|
| 933 | + 'class' => '', |
|
| 934 | + 'id' => '', |
|
| 935 | + 'title' => '', |
|
| 936 | + 'value' => '', |
|
| 937 | + 'required' => false, |
|
| 938 | + 'inline' => true, |
|
| 939 | + 'label' => '', |
|
| 940 | + 'options' => array(), |
|
| 941 | + 'icon' => '', |
|
| 942 | + 'no_wrap' => false, |
|
| 943 | + 'extra_attributes' => array() // an array of extra attributes |
|
| 944 | + ); |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 948 | + */ |
|
| 949 | + $args = wp_parse_args( $args, $defaults ); |
|
| 950 | + |
|
| 951 | + $output = ''; |
|
| 952 | + |
|
| 953 | + // open/type |
|
| 954 | + $output .= '<input type="radio"'; |
|
| 955 | + |
|
| 956 | + // class |
|
| 957 | + $output .= ' class="form-check-input" '; |
|
| 958 | + |
|
| 959 | + // name |
|
| 960 | + if(!empty($args['name'])){ |
|
| 961 | + $output .= AUI_Component_Helper::name($args['name']); |
|
| 962 | + } |
|
| 963 | + |
|
| 964 | + // id |
|
| 965 | + if(!empty($args['id'])){ |
|
| 966 | + $output .= AUI_Component_Helper::id($args['id'].$count); |
|
| 967 | + } |
|
| 968 | + |
|
| 969 | + // title |
|
| 970 | + if(!empty($args['title'])){ |
|
| 971 | + $output .= AUI_Component_Helper::title($args['title']); |
|
| 972 | + } |
|
| 973 | + |
|
| 974 | + // value |
|
| 975 | + if(isset($args['value'])){ |
|
| 976 | + $output .= ' value="'.sanitize_text_field($args['value']).'" '; |
|
| 977 | + } |
|
| 978 | + |
|
| 979 | + // checked, for radio and checkboxes |
|
| 980 | + if( $args['checked'] ){ |
|
| 981 | + $output .= ' checked '; |
|
| 982 | + } |
|
| 983 | + |
|
| 984 | + // data-attributes |
|
| 985 | + $output .= AUI_Component_Helper::data_attributes($args); |
|
| 986 | + |
|
| 987 | + // aria-attributes |
|
| 988 | + $output .= AUI_Component_Helper::aria_attributes($args); |
|
| 989 | + |
|
| 990 | + // extra attributes |
|
| 991 | + if(!empty($args['extra_attributes'])){ |
|
| 992 | + $output .= AUI_Component_Helper::extra_attributes($args['extra_attributes']); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + // required |
|
| 996 | + if(!empty($args['required'])){ |
|
| 997 | + $output .= ' required '; |
|
| 998 | + } |
|
| 999 | + |
|
| 1000 | + // close opening tag |
|
| 1001 | + $output .= ' >'; |
|
| 1002 | + |
|
| 1003 | + // label |
|
| 1004 | + if(!empty($args['label']) && is_array($args['label'])){ |
|
| 1005 | + }elseif(!empty($args['label'])){ |
|
| 1006 | + $output .= self::label(array('title'=>$args['label'],'for'=>$args['id'].$count,'class'=>'form-check-label'),'radio'); |
|
| 1007 | + } |
|
| 1008 | + |
|
| 1009 | + // wrap |
|
| 1010 | + if(!$args['no_wrap']){ |
|
| 1011 | + $wrap_class = $args['inline'] ? 'form-check form-check-inline' : 'form-check'; |
|
| 1012 | + $output = self::wrap(array( |
|
| 1013 | + 'content' => $output, |
|
| 1014 | + 'class' => $wrap_class |
|
| 1015 | + )); |
|
| 1016 | + } |
|
| 1017 | + |
|
| 1018 | + |
|
| 1019 | + return $output; |
|
| 1020 | + } |
|
| 1021 | 1021 | |
| 1022 | 1022 | } |
| 1023 | 1023 | \ No newline at end of file |
@@ -1,7 +1,7 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if ( ! defined( 'ABSPATH' ) ) { |
| 4 | - exit; // Exit if accessed directly |
|
| 4 | + exit; // Exit if accessed directly |
|
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | /** |
@@ -11,250 +11,250 @@ discard block |
||
| 11 | 11 | */ |
| 12 | 12 | class AUI_Component_Helper { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * A component helper for generating a input name. |
|
| 16 | - * |
|
| 17 | - * @param $text |
|
| 18 | - * @param $multiple bool If the name is set to be multiple but no brackets found then we add some. |
|
| 19 | - * |
|
| 20 | - * @return string |
|
| 21 | - */ |
|
| 22 | - public static function name($text,$multiple = false){ |
|
| 23 | - $output = ''; |
|
| 24 | - |
|
| 25 | - if($text){ |
|
| 26 | - $is_multiple = strpos($text, '[') === false && $multiple ? '[]' : ''; |
|
| 27 | - $output = ' name="'.esc_attr($text).$is_multiple.'" '; |
|
| 28 | - } |
|
| 29 | - |
|
| 30 | - return $output; |
|
| 31 | - } |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * A component helper for generating a item id. |
|
| 35 | - * |
|
| 36 | - * @param $text string The text to be used as the value. |
|
| 37 | - * |
|
| 38 | - * @return string The sanitized item. |
|
| 39 | - */ |
|
| 40 | - public static function id($text){ |
|
| 41 | - $output = ''; |
|
| 42 | - |
|
| 43 | - if($text){ |
|
| 44 | - $output = ' id="'.sanitize_html_class($text).'" '; |
|
| 45 | - } |
|
| 46 | - |
|
| 47 | - return $output; |
|
| 48 | - } |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * A component helper for generating a item title. |
|
| 52 | - * |
|
| 53 | - * @param $text string The text to be used as the value. |
|
| 54 | - * |
|
| 55 | - * @return string The sanitized item. |
|
| 56 | - */ |
|
| 57 | - public static function title($text){ |
|
| 58 | - $output = ''; |
|
| 59 | - |
|
| 60 | - if($text){ |
|
| 61 | - $output = ' title="'.esc_attr($text).'" '; |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - return $output; |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * A component helper for generating a item value. |
|
| 69 | - * |
|
| 70 | - * @param $text string The text to be used as the value. |
|
| 71 | - * |
|
| 72 | - * @return string The sanitized item. |
|
| 73 | - */ |
|
| 74 | - public static function value($text){ |
|
| 75 | - $output = ''; |
|
| 76 | - |
|
| 77 | - if($text){ |
|
| 78 | - $output = ' value="'.sanitize_text_field($text).'" '; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return $output; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * A component helper for generating a item class attribute. |
|
| 86 | - * |
|
| 87 | - * @param $text string The text to be used as the value. |
|
| 88 | - * |
|
| 89 | - * @return string The sanitized item. |
|
| 90 | - */ |
|
| 91 | - public static function class_attr($text){ |
|
| 92 | - $output = ''; |
|
| 93 | - |
|
| 94 | - if($text){ |
|
| 95 | - $classes = self::esc_classes($text); |
|
| 96 | - if(!empty($classes)){ |
|
| 97 | - $output = ' class="'.$classes.'" '; |
|
| 98 | - } |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - return $output; |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - /** |
|
| 105 | - * Escape a string of classes. |
|
| 106 | - * |
|
| 107 | - * @param $text |
|
| 108 | - * |
|
| 109 | - * @return string |
|
| 110 | - */ |
|
| 111 | - public static function esc_classes($text){ |
|
| 112 | - $output = ''; |
|
| 113 | - |
|
| 114 | - if($text){ |
|
| 115 | - $classes = explode(" ",$text); |
|
| 116 | - $classes = array_map("trim",$classes); |
|
| 117 | - $classes = array_map("sanitize_html_class",$classes); |
|
| 118 | - if(!empty($classes)){ |
|
| 119 | - $output = implode(" ",$classes); |
|
| 120 | - } |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - return $output; |
|
| 124 | - |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * @param $args |
|
| 129 | - * |
|
| 130 | - * @return string |
|
| 131 | - */ |
|
| 132 | - public static function data_attributes($args){ |
|
| 133 | - $output = ''; |
|
| 134 | - |
|
| 135 | - if(!empty($args)){ |
|
| 136 | - |
|
| 137 | - foreach($args as $key => $val){ |
|
| 138 | - if(substr( $key, 0, 5 ) === "data-"){ |
|
| 139 | - $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 140 | - } |
|
| 141 | - } |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - return $output; |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - /** |
|
| 148 | - * @param $args |
|
| 149 | - * |
|
| 150 | - * @return string |
|
| 151 | - */ |
|
| 152 | - public static function aria_attributes($args){ |
|
| 153 | - $output = ''; |
|
| 154 | - |
|
| 155 | - if(!empty($args)){ |
|
| 156 | - |
|
| 157 | - foreach($args as $key => $val){ |
|
| 158 | - if(substr( $key, 0, 5 ) === "aria-"){ |
|
| 159 | - $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 160 | - } |
|
| 161 | - } |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - return $output; |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * Build a font awesome icon from a class. |
|
| 169 | - * |
|
| 170 | - * @param $class |
|
| 171 | - * @param bool $space_after |
|
| 172 | - * @param array $extra_attributes An array of extra attributes. |
|
| 173 | - * |
|
| 174 | - * @return string |
|
| 175 | - */ |
|
| 176 | - public static function icon($class,$space_after = false, $extra_attributes = array()){ |
|
| 177 | - $output = ''; |
|
| 178 | - |
|
| 179 | - if($class){ |
|
| 180 | - $classes = self::esc_classes($class); |
|
| 181 | - if(!empty($classes)){ |
|
| 182 | - $output = '<i class="'.$classes.'" '; |
|
| 183 | - // extra attributes |
|
| 184 | - if(!empty($extra_attributes)){ |
|
| 185 | - $output .= AUI_Component_Helper::extra_attributes($extra_attributes); |
|
| 186 | - } |
|
| 187 | - $output .= '></i>'; |
|
| 188 | - if($space_after){ |
|
| 189 | - $output .= " "; |
|
| 190 | - } |
|
| 191 | - } |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - return $output; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * @param $args |
|
| 199 | - * |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public static function extra_attributes($args){ |
|
| 203 | - $output = ''; |
|
| 204 | - |
|
| 205 | - if(!empty($args)){ |
|
| 206 | - |
|
| 207 | - if( is_array($args) ){ |
|
| 208 | - foreach($args as $key => $val){ |
|
| 209 | - $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 210 | - } |
|
| 211 | - }else{ |
|
| 212 | - $output .= ' '.$args.' '; |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - return $output; |
|
| 218 | - } |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * @param $args |
|
| 222 | - * |
|
| 223 | - * @return string |
|
| 224 | - */ |
|
| 225 | - public static function help_text($text){ |
|
| 226 | - $output = ''; |
|
| 227 | - |
|
| 228 | - if($text){ |
|
| 229 | - $output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>'; |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - |
|
| 233 | - return $output; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - /** |
|
| 237 | - * Replace element require context with JS. |
|
| 238 | - * |
|
| 239 | - * @param $input |
|
| 240 | - * |
|
| 241 | - * @return string|void |
|
| 242 | - */ |
|
| 243 | - public static function element_require( $input ) { |
|
| 244 | - |
|
| 245 | - $input = str_replace( "'", '"', $input );// we only want double quotes |
|
| 246 | - |
|
| 247 | - $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array( |
|
| 248 | - "jQuery(form).find('[data-argument=\"", |
|
| 249 | - "\"]').find('input,select,textarea').val()", |
|
| 250 | - "\"]').find('input:checked').val()", |
|
| 251 | - ), $input ) ); |
|
| 252 | - |
|
| 253 | - if($output){ |
|
| 254 | - $output = ' data-element-require="'.$output.'" '; |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - return $output; |
|
| 258 | - } |
|
| 14 | + /** |
|
| 15 | + * A component helper for generating a input name. |
|
| 16 | + * |
|
| 17 | + * @param $text |
|
| 18 | + * @param $multiple bool If the name is set to be multiple but no brackets found then we add some. |
|
| 19 | + * |
|
| 20 | + * @return string |
|
| 21 | + */ |
|
| 22 | + public static function name($text,$multiple = false){ |
|
| 23 | + $output = ''; |
|
| 24 | + |
|
| 25 | + if($text){ |
|
| 26 | + $is_multiple = strpos($text, '[') === false && $multiple ? '[]' : ''; |
|
| 27 | + $output = ' name="'.esc_attr($text).$is_multiple.'" '; |
|
| 28 | + } |
|
| 29 | + |
|
| 30 | + return $output; |
|
| 31 | + } |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * A component helper for generating a item id. |
|
| 35 | + * |
|
| 36 | + * @param $text string The text to be used as the value. |
|
| 37 | + * |
|
| 38 | + * @return string The sanitized item. |
|
| 39 | + */ |
|
| 40 | + public static function id($text){ |
|
| 41 | + $output = ''; |
|
| 42 | + |
|
| 43 | + if($text){ |
|
| 44 | + $output = ' id="'.sanitize_html_class($text).'" '; |
|
| 45 | + } |
|
| 46 | + |
|
| 47 | + return $output; |
|
| 48 | + } |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * A component helper for generating a item title. |
|
| 52 | + * |
|
| 53 | + * @param $text string The text to be used as the value. |
|
| 54 | + * |
|
| 55 | + * @return string The sanitized item. |
|
| 56 | + */ |
|
| 57 | + public static function title($text){ |
|
| 58 | + $output = ''; |
|
| 59 | + |
|
| 60 | + if($text){ |
|
| 61 | + $output = ' title="'.esc_attr($text).'" '; |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + return $output; |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * A component helper for generating a item value. |
|
| 69 | + * |
|
| 70 | + * @param $text string The text to be used as the value. |
|
| 71 | + * |
|
| 72 | + * @return string The sanitized item. |
|
| 73 | + */ |
|
| 74 | + public static function value($text){ |
|
| 75 | + $output = ''; |
|
| 76 | + |
|
| 77 | + if($text){ |
|
| 78 | + $output = ' value="'.sanitize_text_field($text).'" '; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return $output; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * A component helper for generating a item class attribute. |
|
| 86 | + * |
|
| 87 | + * @param $text string The text to be used as the value. |
|
| 88 | + * |
|
| 89 | + * @return string The sanitized item. |
|
| 90 | + */ |
|
| 91 | + public static function class_attr($text){ |
|
| 92 | + $output = ''; |
|
| 93 | + |
|
| 94 | + if($text){ |
|
| 95 | + $classes = self::esc_classes($text); |
|
| 96 | + if(!empty($classes)){ |
|
| 97 | + $output = ' class="'.$classes.'" '; |
|
| 98 | + } |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + return $output; |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + /** |
|
| 105 | + * Escape a string of classes. |
|
| 106 | + * |
|
| 107 | + * @param $text |
|
| 108 | + * |
|
| 109 | + * @return string |
|
| 110 | + */ |
|
| 111 | + public static function esc_classes($text){ |
|
| 112 | + $output = ''; |
|
| 113 | + |
|
| 114 | + if($text){ |
|
| 115 | + $classes = explode(" ",$text); |
|
| 116 | + $classes = array_map("trim",$classes); |
|
| 117 | + $classes = array_map("sanitize_html_class",$classes); |
|
| 118 | + if(!empty($classes)){ |
|
| 119 | + $output = implode(" ",$classes); |
|
| 120 | + } |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + return $output; |
|
| 124 | + |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * @param $args |
|
| 129 | + * |
|
| 130 | + * @return string |
|
| 131 | + */ |
|
| 132 | + public static function data_attributes($args){ |
|
| 133 | + $output = ''; |
|
| 134 | + |
|
| 135 | + if(!empty($args)){ |
|
| 136 | + |
|
| 137 | + foreach($args as $key => $val){ |
|
| 138 | + if(substr( $key, 0, 5 ) === "data-"){ |
|
| 139 | + $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + return $output; |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + /** |
|
| 148 | + * @param $args |
|
| 149 | + * |
|
| 150 | + * @return string |
|
| 151 | + */ |
|
| 152 | + public static function aria_attributes($args){ |
|
| 153 | + $output = ''; |
|
| 154 | + |
|
| 155 | + if(!empty($args)){ |
|
| 156 | + |
|
| 157 | + foreach($args as $key => $val){ |
|
| 158 | + if(substr( $key, 0, 5 ) === "aria-"){ |
|
| 159 | + $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 160 | + } |
|
| 161 | + } |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + return $output; |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * Build a font awesome icon from a class. |
|
| 169 | + * |
|
| 170 | + * @param $class |
|
| 171 | + * @param bool $space_after |
|
| 172 | + * @param array $extra_attributes An array of extra attributes. |
|
| 173 | + * |
|
| 174 | + * @return string |
|
| 175 | + */ |
|
| 176 | + public static function icon($class,$space_after = false, $extra_attributes = array()){ |
|
| 177 | + $output = ''; |
|
| 178 | + |
|
| 179 | + if($class){ |
|
| 180 | + $classes = self::esc_classes($class); |
|
| 181 | + if(!empty($classes)){ |
|
| 182 | + $output = '<i class="'.$classes.'" '; |
|
| 183 | + // extra attributes |
|
| 184 | + if(!empty($extra_attributes)){ |
|
| 185 | + $output .= AUI_Component_Helper::extra_attributes($extra_attributes); |
|
| 186 | + } |
|
| 187 | + $output .= '></i>'; |
|
| 188 | + if($space_after){ |
|
| 189 | + $output .= " "; |
|
| 190 | + } |
|
| 191 | + } |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + return $output; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * @param $args |
|
| 199 | + * |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public static function extra_attributes($args){ |
|
| 203 | + $output = ''; |
|
| 204 | + |
|
| 205 | + if(!empty($args)){ |
|
| 206 | + |
|
| 207 | + if( is_array($args) ){ |
|
| 208 | + foreach($args as $key => $val){ |
|
| 209 | + $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 210 | + } |
|
| 211 | + }else{ |
|
| 212 | + $output .= ' '.$args.' '; |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + return $output; |
|
| 218 | + } |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * @param $args |
|
| 222 | + * |
|
| 223 | + * @return string |
|
| 224 | + */ |
|
| 225 | + public static function help_text($text){ |
|
| 226 | + $output = ''; |
|
| 227 | + |
|
| 228 | + if($text){ |
|
| 229 | + $output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>'; |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + |
|
| 233 | + return $output; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + /** |
|
| 237 | + * Replace element require context with JS. |
|
| 238 | + * |
|
| 239 | + * @param $input |
|
| 240 | + * |
|
| 241 | + * @return string|void |
|
| 242 | + */ |
|
| 243 | + public static function element_require( $input ) { |
|
| 244 | + |
|
| 245 | + $input = str_replace( "'", '"', $input );// we only want double quotes |
|
| 246 | + |
|
| 247 | + $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array( |
|
| 248 | + "jQuery(form).find('[data-argument=\"", |
|
| 249 | + "\"]').find('input,select,textarea').val()", |
|
| 250 | + "\"]').find('input:checked').val()", |
|
| 251 | + ), $input ) ); |
|
| 252 | + |
|
| 253 | + if($output){ |
|
| 254 | + $output = ' data-element-require="'.$output.'" '; |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + return $output; |
|
| 258 | + } |
|
| 259 | 259 | |
| 260 | 260 | } |
| 261 | 261 | \ No newline at end of file |
@@ -1,7 +1,7 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | |
| 3 | 3 | if ( ! defined( 'ABSPATH' ) ) { |
| 4 | - exit; // Exit if accessed directly |
|
| 4 | + exit; // Exit if accessed directly |
|
| 5 | 5 | } |
| 6 | 6 | |
| 7 | 7 | /** |
@@ -11,231 +11,231 @@ discard block |
||
| 11 | 11 | */ |
| 12 | 12 | class AUI { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * Holds the class instance. |
|
| 16 | - * |
|
| 17 | - * @since 1.0.0 |
|
| 18 | - * @var null |
|
| 19 | - */ |
|
| 20 | - private static $instance = null; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Holds the current AUI version number. |
|
| 24 | - * |
|
| 25 | - * @var string $ver The current version number. |
|
| 26 | - */ |
|
| 27 | - public static $ver = '0.1.35'; |
|
| 28 | - |
|
| 29 | - public static $options = null; |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * There can be only one. |
|
| 33 | - * |
|
| 34 | - * @since 1.0.0 |
|
| 35 | - * @return AUI|null |
|
| 36 | - */ |
|
| 37 | - public static function instance() { |
|
| 38 | - if ( self::$instance == null ) { |
|
| 39 | - self::$instance = new AUI(); |
|
| 40 | - } |
|
| 41 | - |
|
| 42 | - return self::$instance; |
|
| 43 | - } |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * AUI constructor. |
|
| 47 | - * |
|
| 48 | - * @since 1.0.0 |
|
| 49 | - */ |
|
| 50 | - private function __construct() { |
|
| 51 | - if ( function_exists( "__autoload" ) ) { |
|
| 52 | - spl_autoload_register( "__autoload" ); |
|
| 53 | - } |
|
| 54 | - spl_autoload_register( array( $this, 'autoload' ) ); |
|
| 55 | - |
|
| 56 | - // load options |
|
| 57 | - self::$options = get_option('aui_options'); |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Autoload any components on the fly. |
|
| 62 | - * |
|
| 63 | - * @since 1.0.0 |
|
| 64 | - * |
|
| 65 | - * @param $classname |
|
| 66 | - */ |
|
| 67 | - private function autoload( $classname ) { |
|
| 68 | - $class = str_replace( '_', '-', strtolower( $classname ) ); |
|
| 69 | - $file_path = trailingslashit( dirname( __FILE__ ) ) . "components/class-" . $class . '.php'; |
|
| 70 | - if ( $file_path && is_readable( $file_path ) ) { |
|
| 71 | - include_once( $file_path ); |
|
| 72 | - } |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * Get the AUI options. |
|
| 77 | - * |
|
| 78 | - * @param $option |
|
| 79 | - * |
|
| 80 | - * @return string|void |
|
| 81 | - */ |
|
| 82 | - public function get_option( $option ){ |
|
| 83 | - $result = isset(self::$options[$option]) ? esc_attr(self::$options[$option]) : ''; |
|
| 84 | - |
|
| 85 | - if ( ! $result && $option) { |
|
| 86 | - if( $option == 'color_primary' ){ |
|
| 87 | - $result = AUI_PRIMARY_COLOR; |
|
| 88 | - }elseif( $option == 'color_secondary' ){ |
|
| 89 | - $result = AUI_SECONDARY_COLOR; |
|
| 90 | - } |
|
| 91 | - } |
|
| 92 | - return $result; |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - public function render( $items = array() ) { |
|
| 96 | - $output = ''; |
|
| 97 | - |
|
| 98 | - if ( ! empty( $items ) ) { |
|
| 99 | - foreach ( $items as $args ) { |
|
| 100 | - $render = isset( $args['render'] ) ? $args['render'] : ''; |
|
| 101 | - if ( $render && method_exists( __CLASS__, $render ) ) { |
|
| 102 | - $output .= $this->$render( $args ); |
|
| 103 | - } |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - return $output; |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Render and return a bootstrap alert component. |
|
| 112 | - * |
|
| 113 | - * @since 1.0.0 |
|
| 114 | - * |
|
| 115 | - * @param array $args |
|
| 116 | - * |
|
| 117 | - * @return string The rendered component. |
|
| 118 | - */ |
|
| 119 | - public function alert( $args = array() ) { |
|
| 120 | - return AUI_Component_Alert::get( $args ); |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Render and return a bootstrap input component. |
|
| 125 | - * |
|
| 126 | - * @since 1.0.0 |
|
| 127 | - * |
|
| 128 | - * @param array $args |
|
| 129 | - * |
|
| 130 | - * @return string The rendered component. |
|
| 131 | - */ |
|
| 132 | - public function input( $args = array() ) { |
|
| 133 | - return AUI_Component_Input::input( $args ); |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Render and return a bootstrap textarea component. |
|
| 138 | - * |
|
| 139 | - * @since 1.0.0 |
|
| 140 | - * |
|
| 141 | - * @param array $args |
|
| 142 | - * |
|
| 143 | - * @return string The rendered component. |
|
| 144 | - */ |
|
| 145 | - public function textarea( $args = array() ) { |
|
| 146 | - return AUI_Component_Input::textarea( $args ); |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * Render and return a bootstrap button component. |
|
| 151 | - * |
|
| 152 | - * @since 1.0.0 |
|
| 153 | - * |
|
| 154 | - * @param array $args |
|
| 155 | - * |
|
| 156 | - * @return string The rendered component. |
|
| 157 | - */ |
|
| 158 | - public function button( $args = array() ) { |
|
| 159 | - return AUI_Component_Button::get( $args ); |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * Render and return a bootstrap button component. |
|
| 164 | - * |
|
| 165 | - * @since 1.0.0 |
|
| 166 | - * |
|
| 167 | - * @param array $args |
|
| 168 | - * |
|
| 169 | - * @return string The rendered component. |
|
| 170 | - */ |
|
| 171 | - public function badge( $args = array() ) { |
|
| 172 | - $defaults = array( |
|
| 173 | - 'class' => 'badge badge-primary align-middle', |
|
| 174 | - ); |
|
| 175 | - |
|
| 176 | - // maybe set type |
|
| 177 | - if ( empty( $args['href'] ) ) { |
|
| 178 | - $defaults['type'] = 'badge'; |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 183 | - */ |
|
| 184 | - $args = wp_parse_args( $args, $defaults ); |
|
| 185 | - |
|
| 186 | - return AUI_Component_Button::get( $args ); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * Render and return a bootstrap dropdown component. |
|
| 191 | - * |
|
| 192 | - * @since 1.0.0 |
|
| 193 | - * |
|
| 194 | - * @param array $args |
|
| 195 | - * |
|
| 196 | - * @return string The rendered component. |
|
| 197 | - */ |
|
| 198 | - public function dropdown( $args = array() ) { |
|
| 199 | - return AUI_Component_Dropdown::get( $args ); |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Render and return a bootstrap select component. |
|
| 204 | - * |
|
| 205 | - * @since 1.0.0 |
|
| 206 | - * |
|
| 207 | - * @param array $args |
|
| 208 | - * |
|
| 209 | - * @return string The rendered component. |
|
| 210 | - */ |
|
| 211 | - public function select( $args = array() ) { |
|
| 212 | - return AUI_Component_Input::select( $args ); |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - /** |
|
| 216 | - * Render and return a bootstrap radio component. |
|
| 217 | - * |
|
| 218 | - * @since 1.0.0 |
|
| 219 | - * |
|
| 220 | - * @param array $args |
|
| 221 | - * |
|
| 222 | - * @return string The rendered component. |
|
| 223 | - */ |
|
| 224 | - public function radio( $args = array() ) { |
|
| 225 | - return AUI_Component_Input::radio( $args ); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - /** |
|
| 229 | - * Render and return a bootstrap pagination component. |
|
| 230 | - * |
|
| 231 | - * @since 1.0.0 |
|
| 232 | - * |
|
| 233 | - * @param array $args |
|
| 234 | - * |
|
| 235 | - * @return string The rendered component. |
|
| 236 | - */ |
|
| 237 | - public function pagination( $args = array() ) { |
|
| 238 | - return AUI_Component_Pagination::get( $args ); |
|
| 239 | - } |
|
| 14 | + /** |
|
| 15 | + * Holds the class instance. |
|
| 16 | + * |
|
| 17 | + * @since 1.0.0 |
|
| 18 | + * @var null |
|
| 19 | + */ |
|
| 20 | + private static $instance = null; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Holds the current AUI version number. |
|
| 24 | + * |
|
| 25 | + * @var string $ver The current version number. |
|
| 26 | + */ |
|
| 27 | + public static $ver = '0.1.35'; |
|
| 28 | + |
|
| 29 | + public static $options = null; |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * There can be only one. |
|
| 33 | + * |
|
| 34 | + * @since 1.0.0 |
|
| 35 | + * @return AUI|null |
|
| 36 | + */ |
|
| 37 | + public static function instance() { |
|
| 38 | + if ( self::$instance == null ) { |
|
| 39 | + self::$instance = new AUI(); |
|
| 40 | + } |
|
| 41 | + |
|
| 42 | + return self::$instance; |
|
| 43 | + } |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * AUI constructor. |
|
| 47 | + * |
|
| 48 | + * @since 1.0.0 |
|
| 49 | + */ |
|
| 50 | + private function __construct() { |
|
| 51 | + if ( function_exists( "__autoload" ) ) { |
|
| 52 | + spl_autoload_register( "__autoload" ); |
|
| 53 | + } |
|
| 54 | + spl_autoload_register( array( $this, 'autoload' ) ); |
|
| 55 | + |
|
| 56 | + // load options |
|
| 57 | + self::$options = get_option('aui_options'); |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Autoload any components on the fly. |
|
| 62 | + * |
|
| 63 | + * @since 1.0.0 |
|
| 64 | + * |
|
| 65 | + * @param $classname |
|
| 66 | + */ |
|
| 67 | + private function autoload( $classname ) { |
|
| 68 | + $class = str_replace( '_', '-', strtolower( $classname ) ); |
|
| 69 | + $file_path = trailingslashit( dirname( __FILE__ ) ) . "components/class-" . $class . '.php'; |
|
| 70 | + if ( $file_path && is_readable( $file_path ) ) { |
|
| 71 | + include_once( $file_path ); |
|
| 72 | + } |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * Get the AUI options. |
|
| 77 | + * |
|
| 78 | + * @param $option |
|
| 79 | + * |
|
| 80 | + * @return string|void |
|
| 81 | + */ |
|
| 82 | + public function get_option( $option ){ |
|
| 83 | + $result = isset(self::$options[$option]) ? esc_attr(self::$options[$option]) : ''; |
|
| 84 | + |
|
| 85 | + if ( ! $result && $option) { |
|
| 86 | + if( $option == 'color_primary' ){ |
|
| 87 | + $result = AUI_PRIMARY_COLOR; |
|
| 88 | + }elseif( $option == 'color_secondary' ){ |
|
| 89 | + $result = AUI_SECONDARY_COLOR; |
|
| 90 | + } |
|
| 91 | + } |
|
| 92 | + return $result; |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + public function render( $items = array() ) { |
|
| 96 | + $output = ''; |
|
| 97 | + |
|
| 98 | + if ( ! empty( $items ) ) { |
|
| 99 | + foreach ( $items as $args ) { |
|
| 100 | + $render = isset( $args['render'] ) ? $args['render'] : ''; |
|
| 101 | + if ( $render && method_exists( __CLASS__, $render ) ) { |
|
| 102 | + $output .= $this->$render( $args ); |
|
| 103 | + } |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + return $output; |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Render and return a bootstrap alert component. |
|
| 112 | + * |
|
| 113 | + * @since 1.0.0 |
|
| 114 | + * |
|
| 115 | + * @param array $args |
|
| 116 | + * |
|
| 117 | + * @return string The rendered component. |
|
| 118 | + */ |
|
| 119 | + public function alert( $args = array() ) { |
|
| 120 | + return AUI_Component_Alert::get( $args ); |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Render and return a bootstrap input component. |
|
| 125 | + * |
|
| 126 | + * @since 1.0.0 |
|
| 127 | + * |
|
| 128 | + * @param array $args |
|
| 129 | + * |
|
| 130 | + * @return string The rendered component. |
|
| 131 | + */ |
|
| 132 | + public function input( $args = array() ) { |
|
| 133 | + return AUI_Component_Input::input( $args ); |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Render and return a bootstrap textarea component. |
|
| 138 | + * |
|
| 139 | + * @since 1.0.0 |
|
| 140 | + * |
|
| 141 | + * @param array $args |
|
| 142 | + * |
|
| 143 | + * @return string The rendered component. |
|
| 144 | + */ |
|
| 145 | + public function textarea( $args = array() ) { |
|
| 146 | + return AUI_Component_Input::textarea( $args ); |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * Render and return a bootstrap button component. |
|
| 151 | + * |
|
| 152 | + * @since 1.0.0 |
|
| 153 | + * |
|
| 154 | + * @param array $args |
|
| 155 | + * |
|
| 156 | + * @return string The rendered component. |
|
| 157 | + */ |
|
| 158 | + public function button( $args = array() ) { |
|
| 159 | + return AUI_Component_Button::get( $args ); |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * Render and return a bootstrap button component. |
|
| 164 | + * |
|
| 165 | + * @since 1.0.0 |
|
| 166 | + * |
|
| 167 | + * @param array $args |
|
| 168 | + * |
|
| 169 | + * @return string The rendered component. |
|
| 170 | + */ |
|
| 171 | + public function badge( $args = array() ) { |
|
| 172 | + $defaults = array( |
|
| 173 | + 'class' => 'badge badge-primary align-middle', |
|
| 174 | + ); |
|
| 175 | + |
|
| 176 | + // maybe set type |
|
| 177 | + if ( empty( $args['href'] ) ) { |
|
| 178 | + $defaults['type'] = 'badge'; |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 183 | + */ |
|
| 184 | + $args = wp_parse_args( $args, $defaults ); |
|
| 185 | + |
|
| 186 | + return AUI_Component_Button::get( $args ); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * Render and return a bootstrap dropdown component. |
|
| 191 | + * |
|
| 192 | + * @since 1.0.0 |
|
| 193 | + * |
|
| 194 | + * @param array $args |
|
| 195 | + * |
|
| 196 | + * @return string The rendered component. |
|
| 197 | + */ |
|
| 198 | + public function dropdown( $args = array() ) { |
|
| 199 | + return AUI_Component_Dropdown::get( $args ); |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Render and return a bootstrap select component. |
|
| 204 | + * |
|
| 205 | + * @since 1.0.0 |
|
| 206 | + * |
|
| 207 | + * @param array $args |
|
| 208 | + * |
|
| 209 | + * @return string The rendered component. |
|
| 210 | + */ |
|
| 211 | + public function select( $args = array() ) { |
|
| 212 | + return AUI_Component_Input::select( $args ); |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + /** |
|
| 216 | + * Render and return a bootstrap radio component. |
|
| 217 | + * |
|
| 218 | + * @since 1.0.0 |
|
| 219 | + * |
|
| 220 | + * @param array $args |
|
| 221 | + * |
|
| 222 | + * @return string The rendered component. |
|
| 223 | + */ |
|
| 224 | + public function radio( $args = array() ) { |
|
| 225 | + return AUI_Component_Input::radio( $args ); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + /** |
|
| 229 | + * Render and return a bootstrap pagination component. |
|
| 230 | + * |
|
| 231 | + * @since 1.0.0 |
|
| 232 | + * |
|
| 233 | + * @param array $args |
|
| 234 | + * |
|
| 235 | + * @return string The rendered component. |
|
| 236 | + */ |
|
| 237 | + public function pagination( $args = array() ) { |
|
| 238 | + return AUI_Component_Pagination::get( $args ); |
|
| 239 | + } |
|
| 240 | 240 | |
| 241 | 241 | } |
| 242 | 242 | \ No newline at end of file |
@@ -7,40 +7,40 @@ |
||
| 7 | 7 | * Bail if we are not in WP. |
| 8 | 8 | */ |
| 9 | 9 | if ( ! defined( 'ABSPATH' ) ) { |
| 10 | - exit; |
|
| 10 | + exit; |
|
| 11 | 11 | } |
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | 14 | * Set the version only if its the current newest while loading. |
| 15 | 15 | */ |
| 16 | 16 | add_action('after_setup_theme', function () { |
| 17 | - global $ayecode_ui_version,$ayecode_ui_file_key; |
|
| 18 | - $this_version = "0.1.35"; |
|
| 19 | - if(version_compare($this_version , $ayecode_ui_version, '>')){ |
|
| 20 | - $ayecode_ui_version = $this_version ; |
|
| 21 | - $ayecode_ui_file_key = wp_hash( __FILE__ ); |
|
| 22 | - } |
|
| 17 | + global $ayecode_ui_version,$ayecode_ui_file_key; |
|
| 18 | + $this_version = "0.1.35"; |
|
| 19 | + if(version_compare($this_version , $ayecode_ui_version, '>')){ |
|
| 20 | + $ayecode_ui_version = $this_version ; |
|
| 21 | + $ayecode_ui_file_key = wp_hash( __FILE__ ); |
|
| 22 | + } |
|
| 23 | 23 | },0); |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | 26 | * Load this version of WP Bootstrap Settings only if the file hash is the current one. |
| 27 | 27 | */ |
| 28 | 28 | add_action('after_setup_theme', function () { |
| 29 | - global $ayecode_ui_file_key; |
|
| 30 | - if($ayecode_ui_file_key && $ayecode_ui_file_key == wp_hash( __FILE__ )){ |
|
| 31 | - include_once( dirname( __FILE__ ) . '/includes/class-aui.php' ); |
|
| 32 | - include_once( dirname( __FILE__ ) . '/includes/ayecode-ui-settings.php' ); |
|
| 33 | - } |
|
| 29 | + global $ayecode_ui_file_key; |
|
| 30 | + if($ayecode_ui_file_key && $ayecode_ui_file_key == wp_hash( __FILE__ )){ |
|
| 31 | + include_once( dirname( __FILE__ ) . '/includes/class-aui.php' ); |
|
| 32 | + include_once( dirname( __FILE__ ) . '/includes/ayecode-ui-settings.php' ); |
|
| 33 | + } |
|
| 34 | 34 | },1); |
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | 37 | * Add the function that calls the class. |
| 38 | 38 | */ |
| 39 | 39 | if(!function_exists('aui')){ |
| 40 | - function aui(){ |
|
| 41 | - if(!class_exists("AUI",false)){ |
|
| 42 | - return false; |
|
| 43 | - } |
|
| 44 | - return AUI::instance(); |
|
| 45 | - } |
|
| 40 | + function aui(){ |
|
| 41 | + if(!class_exists("AUI",false)){ |
|
| 42 | + return false; |
|
| 43 | + } |
|
| 44 | + return AUI::instance(); |
|
| 45 | + } |
|
| 46 | 46 | } |
| 47 | 47 | \ No newline at end of file |
@@ -13,9 +13,9 @@ discard block |
||
| 13 | 13 | |
| 14 | 14 | |
| 15 | 15 | function wpinv_get_default_country() { |
| 16 | - $country = wpinv_get_option( 'default_country', 'UK' ); |
|
| 16 | + $country = wpinv_get_option( 'default_country', 'UK' ); |
|
| 17 | 17 | |
| 18 | - return apply_filters( 'wpinv_default_country', $country ); |
|
| 18 | + return apply_filters( 'wpinv_default_country', $country ); |
|
| 19 | 19 | } |
| 20 | 20 | |
| 21 | 21 | /** |
@@ -26,7 +26,7 @@ discard block |
||
| 26 | 26 | */ |
| 27 | 27 | function wpinv_sanitize_country( $country ) { |
| 28 | 28 | |
| 29 | - // Enure the country is specified |
|
| 29 | + // Enure the country is specified |
|
| 30 | 30 | if ( empty( $country ) ) { |
| 31 | 31 | $country = wpinv_get_default_country(); |
| 32 | 32 | } |
@@ -56,9 +56,9 @@ discard block |
||
| 56 | 56 | } |
| 57 | 57 | |
| 58 | 58 | function wpinv_get_default_state() { |
| 59 | - $state = wpinv_get_option( 'default_state', '' ); |
|
| 59 | + $state = wpinv_get_option( 'default_state', '' ); |
|
| 60 | 60 | |
| 61 | - return apply_filters( 'wpinv_default_state', $state ); |
|
| 61 | + return apply_filters( 'wpinv_default_state', $state ); |
|
| 62 | 62 | } |
| 63 | 63 | |
| 64 | 64 | function wpinv_state_name( $state_code = '', $country_code = '' ) { |
@@ -288,11 +288,11 @@ discard block |
||
| 288 | 288 | |
| 289 | 289 | $country = wpinv_sanitize_country( $country ); |
| 290 | 290 | |
| 291 | - foreach ( wpinv_get_continents( 'countries' ) as $continent_code => $countries ) { |
|
| 292 | - if ( false !== array_search( $country, $countries, true ) ) { |
|
| 293 | - return $continent_code; |
|
| 294 | - } |
|
| 295 | - } |
|
| 291 | + foreach ( wpinv_get_continents( 'countries' ) as $continent_code => $countries ) { |
|
| 292 | + if ( false !== array_search( $country, $countries, true ) ) { |
|
| 293 | + return $continent_code; |
|
| 294 | + } |
|
| 295 | + } |
|
| 296 | 296 | |
| 297 | 297 | return ''; |
| 298 | 298 | |
@@ -584,30 +584,30 @@ discard block |
||
| 584 | 584 | } |
| 585 | 585 | |
| 586 | 586 | function wpinv_get_states_field() { |
| 587 | - if( empty( $_POST['country'] ) ) { |
|
| 588 | - $_POST['country'] = wpinv_get_default_country(); |
|
| 589 | - } |
|
| 590 | - $states = wpinv_get_country_states( sanitize_text_field( $_POST['country'] ) ); |
|
| 587 | + if( empty( $_POST['country'] ) ) { |
|
| 588 | + $_POST['country'] = wpinv_get_default_country(); |
|
| 589 | + } |
|
| 590 | + $states = wpinv_get_country_states( sanitize_text_field( $_POST['country'] ) ); |
|
| 591 | 591 | |
| 592 | - if( !empty( $states ) ) { |
|
| 593 | - $sanitized_field_name = sanitize_text_field( $_POST['field_name'] ); |
|
| 592 | + if( !empty( $states ) ) { |
|
| 593 | + $sanitized_field_name = sanitize_text_field( $_POST['field_name'] ); |
|
| 594 | 594 | |
| 595 | 595 | $args = array( |
| 596 | - 'name' => $sanitized_field_name, |
|
| 597 | - 'id' => $sanitized_field_name, |
|
| 598 | - 'class' => $sanitized_field_name . 'custom-select wpinv-select wpi_select2', |
|
| 599 | - 'options' => array_merge( array( '' => '' ), $states ), |
|
| 600 | - 'show_option_all' => false, |
|
| 601 | - 'show_option_none' => false |
|
| 602 | - ); |
|
| 603 | - |
|
| 604 | - $response = wpinv_html_select( $args ); |
|
| 605 | - |
|
| 606 | - } else { |
|
| 607 | - $response = 'nostates'; |
|
| 608 | - } |
|
| 596 | + 'name' => $sanitized_field_name, |
|
| 597 | + 'id' => $sanitized_field_name, |
|
| 598 | + 'class' => $sanitized_field_name . 'custom-select wpinv-select wpi_select2', |
|
| 599 | + 'options' => array_merge( array( '' => '' ), $states ), |
|
| 600 | + 'show_option_all' => false, |
|
| 601 | + 'show_option_none' => false |
|
| 602 | + ); |
|
| 603 | + |
|
| 604 | + $response = wpinv_html_select( $args ); |
|
| 605 | + |
|
| 606 | + } else { |
|
| 607 | + $response = 'nostates'; |
|
| 608 | + } |
|
| 609 | 609 | |
| 610 | - return $response; |
|
| 610 | + return $response; |
|
| 611 | 611 | } |
| 612 | 612 | |
| 613 | 613 | function wpinv_default_billing_country( $country = '', $user_id = 0 ) { |
@@ -625,46 +625,46 @@ discard block |
||
| 625 | 625 | */ |
| 626 | 626 | function wpinv_get_address_formats() { |
| 627 | 627 | |
| 628 | - return apply_filters( 'wpinv_localisation_address_formats', |
|
| 629 | - array( |
|
| 630 | - 'default' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}\n{{zip}}\n{{country}}", |
|
| 631 | - 'AU' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}} {{zip}}\n{{country}}", |
|
| 632 | - 'AT' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 633 | - 'BE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 634 | - 'CA' => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{state_code}} {{zip}}\n{{country}}", |
|
| 635 | - 'CH' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 636 | - 'CL' => "{{company}}\n{{name}}\n{{address}}\n{{state}}\n{{zip}} {{city}}\n{{country}}", |
|
| 637 | - 'CN' => "{{country}} {{zip}}\n{{state}}, {{city}}, {{address}}\n{{company}}\n{{name}}", |
|
| 638 | - 'CZ' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 639 | - 'DE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 640 | - 'EE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 641 | - 'FI' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 642 | - 'DK' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 643 | - 'FR' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city_upper}}\n{{country}}", |
|
| 644 | - 'HK' => "{{company}}\n{{first_name}} {{last_name_upper}}\n{{address}}\n{{city_upper}}\n{{state_upper}}\n{{country}}", |
|
| 645 | - 'HU' => "{{name}}\n{{company}}\n{{city}}\n{{address}}\n{{zip}}\n{{country}}", |
|
| 646 | - 'IN' => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{zip}}\n{{state}}, {{country}}", |
|
| 647 | - 'IS' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 648 | - 'IT' => "{{company}}\n{{name}}\n{{address}}\n{{zip}}\n{{city}}\n{{state_upper}}\n{{country}}", |
|
| 649 | - 'JP' => "{{zip}}\n{{state}} {{city}} {{address}}\n{{company}}\n{{last_name}} {{first_name}}\n{{country}}", |
|
| 650 | - 'TW' => "{{company}}\n{{last_name}} {{first_name}}\n{{address}}\n{{state}}, {{city}} {{zip}}\n{{country}}", |
|
| 651 | - 'LI' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 652 | - 'NL' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 653 | - 'NZ' => "{{name}}\n{{company}}\n{{address}}\n{{city}} {{zip}}\n{{country}}", |
|
| 654 | - 'NO' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 655 | - 'PL' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 656 | - 'PT' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 657 | - 'SK' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 658 | - 'RS' => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 659 | - 'SI' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 660 | - 'ES' => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{state}}\n{{country}}", |
|
| 661 | - 'SE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 662 | - 'TR' => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}} {{state}}\n{{country}}", |
|
| 663 | - 'UG' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}, {{country}}", |
|
| 664 | - 'US' => "{{name}}\n{{company}}\n{{address}}\n{{city}}, {{state_code}} {{zip}}\n{{country}}", |
|
| 665 | - 'VN' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{country}}", |
|
| 666 | - ) |
|
| 667 | - ); |
|
| 628 | + return apply_filters( 'wpinv_localisation_address_formats', |
|
| 629 | + array( |
|
| 630 | + 'default' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}\n{{zip}}\n{{country}}", |
|
| 631 | + 'AU' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}} {{zip}}\n{{country}}", |
|
| 632 | + 'AT' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 633 | + 'BE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 634 | + 'CA' => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{state_code}} {{zip}}\n{{country}}", |
|
| 635 | + 'CH' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 636 | + 'CL' => "{{company}}\n{{name}}\n{{address}}\n{{state}}\n{{zip}} {{city}}\n{{country}}", |
|
| 637 | + 'CN' => "{{country}} {{zip}}\n{{state}}, {{city}}, {{address}}\n{{company}}\n{{name}}", |
|
| 638 | + 'CZ' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 639 | + 'DE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 640 | + 'EE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 641 | + 'FI' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 642 | + 'DK' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 643 | + 'FR' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city_upper}}\n{{country}}", |
|
| 644 | + 'HK' => "{{company}}\n{{first_name}} {{last_name_upper}}\n{{address}}\n{{city_upper}}\n{{state_upper}}\n{{country}}", |
|
| 645 | + 'HU' => "{{name}}\n{{company}}\n{{city}}\n{{address}}\n{{zip}}\n{{country}}", |
|
| 646 | + 'IN' => "{{company}}\n{{name}}\n{{address}}\n{{city}} {{zip}}\n{{state}}, {{country}}", |
|
| 647 | + 'IS' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 648 | + 'IT' => "{{company}}\n{{name}}\n{{address}}\n{{zip}}\n{{city}}\n{{state_upper}}\n{{country}}", |
|
| 649 | + 'JP' => "{{zip}}\n{{state}} {{city}} {{address}}\n{{company}}\n{{last_name}} {{first_name}}\n{{country}}", |
|
| 650 | + 'TW' => "{{company}}\n{{last_name}} {{first_name}}\n{{address}}\n{{state}}, {{city}} {{zip}}\n{{country}}", |
|
| 651 | + 'LI' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 652 | + 'NL' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 653 | + 'NZ' => "{{name}}\n{{company}}\n{{address}}\n{{city}} {{zip}}\n{{country}}", |
|
| 654 | + 'NO' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 655 | + 'PL' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 656 | + 'PT' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 657 | + 'SK' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 658 | + 'RS' => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 659 | + 'SI' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 660 | + 'ES' => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}}\n{{state}}\n{{country}}", |
|
| 661 | + 'SE' => "{{company}}\n{{name}}\n{{address}}\n{{zip}} {{city}}\n{{country}}", |
|
| 662 | + 'TR' => "{{name}}\n{{company}}\n{{address}}\n{{zip}} {{city}} {{state}}\n{{country}}", |
|
| 663 | + 'UG' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{state}}, {{country}}", |
|
| 664 | + 'US' => "{{name}}\n{{company}}\n{{address}}\n{{city}}, {{state_code}} {{zip}}\n{{country}}", |
|
| 665 | + 'VN' => "{{name}}\n{{company}}\n{{address}}\n{{city}}\n{{country}}", |
|
| 666 | + ) |
|
| 667 | + ); |
|
| 668 | 668 | } |
| 669 | 669 | |
| 670 | 670 | /** |
@@ -681,21 +681,21 @@ discard block |
||
| 681 | 681 | } |
| 682 | 682 | |
| 683 | 683 | // Get all formats. |
| 684 | - $formats = wpinv_get_address_formats(); |
|
| 684 | + $formats = wpinv_get_address_formats(); |
|
| 685 | 685 | |
| 686 | - // Get format for the specified country. |
|
| 687 | - $format = ( $country && isset( $formats[ $country ] ) ) ? $formats[ $country ] : $formats['default']; |
|
| 686 | + // Get format for the specified country. |
|
| 687 | + $format = ( $country && isset( $formats[ $country ] ) ) ? $formats[ $country ] : $formats['default']; |
|
| 688 | 688 | |
| 689 | 689 | /** |
| 690 | - * Filters the address format to use on Invoices. |
|
| 690 | + * Filters the address format to use on Invoices. |
|
| 691 | 691 | * |
| 692 | 692 | * New lines will be replaced by a `br` element. Double new lines will be replaced by a paragraph. HTML tags are allowed. |
| 693 | - * |
|
| 694 | - * @since 1.0.13 |
|
| 695 | - * |
|
| 696 | - * @param string $format The address format to use. |
|
| 693 | + * |
|
| 694 | + * @since 1.0.13 |
|
| 695 | + * |
|
| 696 | + * @param string $format The address format to use. |
|
| 697 | 697 | * @param string $country The country who's address format is being retrieved. |
| 698 | - */ |
|
| 698 | + */ |
|
| 699 | 699 | return apply_filters( 'wpinv_get_full_address_format', $format, $country ); |
| 700 | 700 | } |
| 701 | 701 | |
@@ -716,8 +716,8 @@ discard block |
||
| 716 | 716 | 'country' => '', |
| 717 | 717 | 'zip' => '', |
| 718 | 718 | 'first_name' => '', |
| 719 | - 'last_name' => '', |
|
| 720 | - 'company' => '', |
|
| 719 | + 'last_name' => '', |
|
| 720 | + 'company' => '', |
|
| 721 | 721 | ); |
| 722 | 722 | |
| 723 | 723 | $args = map_deep( wp_parse_args( $billing_details, $default_args ), 'trim' ); |
@@ -738,14 +738,14 @@ discard block |
||
| 738 | 738 | $args['country_code']= $country; |
| 739 | 739 | |
| 740 | 740 | /** |
| 741 | - * Filters the address format replacements to use on Invoices. |
|
| 741 | + * Filters the address format replacements to use on Invoices. |
|
| 742 | 742 | * |
| 743 | - * |
|
| 744 | - * @since 1.0.13 |
|
| 745 | - * |
|
| 746 | - * @param array $replacements The address replacements to use. |
|
| 743 | + * |
|
| 744 | + * @since 1.0.13 |
|
| 745 | + * |
|
| 746 | + * @param array $replacements The address replacements to use. |
|
| 747 | 747 | * @param array $billing_details The billing details to use. |
| 748 | - */ |
|
| 748 | + */ |
|
| 749 | 749 | $replacements = apply_filters( 'wpinv_get_invoice_address_replacements', $args, $billing_details ); |
| 750 | 750 | |
| 751 | 751 | $return = array(); |
@@ -768,5 +768,5 @@ discard block |
||
| 768 | 768 | * @return string |
| 769 | 769 | */ |
| 770 | 770 | function wpinv_trim_formatted_address_line( $line ) { |
| 771 | - return trim( $line, ', ' ); |
|
| 771 | + return trim( $line, ', ' ); |
|
| 772 | 772 | } |
| 773 | 773 | \ No newline at end of file |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | 11 | if ( ! defined( 'ABSPATH' ) ) { |
| 12 | - exit; |
|
| 12 | + exit; |
|
| 13 | 13 | } |
| 14 | 14 | |
| 15 | 15 | /** |
@@ -21,356 +21,356 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | abstract class GetPaid_Data { |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * ID for this object. |
|
| 26 | - * |
|
| 27 | - * @since 1.0.19 |
|
| 28 | - * @var int |
|
| 29 | - */ |
|
| 30 | - protected $id = 0; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Core data for this object. Name value pairs (name + default value). |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Core data changes for this object. |
|
| 42 | - * |
|
| 43 | - * @since 1.0.19 |
|
| 44 | - * @var array |
|
| 45 | - */ |
|
| 46 | - protected $changes = array(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * This is false until the object is read from the DB. |
|
| 50 | - * |
|
| 51 | - * @since 1.0.19 |
|
| 52 | - * @var bool |
|
| 53 | - */ |
|
| 54 | - protected $object_read = false; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * This is the name of this object type. |
|
| 58 | - * |
|
| 59 | - * @since 1.0.19 |
|
| 60 | - * @var string |
|
| 61 | - */ |
|
| 62 | - protected $object_type = 'data'; |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Extra data for this object. Name value pairs (name + default value). |
|
| 66 | - * Used as a standard way for sub classes (like item types) to add |
|
| 67 | - * additional information to an inherited class. |
|
| 68 | - * |
|
| 69 | - * @since 1.0.19 |
|
| 70 | - * @var array |
|
| 71 | - */ |
|
| 72 | - protected $extra_data = array(); |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Set to _data on construct so we can track and reset data if needed. |
|
| 76 | - * |
|
| 77 | - * @since 1.0.19 |
|
| 78 | - * @var array |
|
| 79 | - */ |
|
| 80 | - protected $default_data = array(); |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Contains a reference to the data store for this class. |
|
| 84 | - * |
|
| 85 | - * @since 1.0.19 |
|
| 86 | - * @var GetPaid_Data_Store |
|
| 87 | - */ |
|
| 88 | - protected $data_store; |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Stores meta in cache for future reads. |
|
| 92 | - * A group must be set to to enable caching. |
|
| 93 | - * |
|
| 94 | - * @since 1.0.19 |
|
| 95 | - * @var string |
|
| 96 | - */ |
|
| 97 | - protected $cache_group = ''; |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * Stores the last error. |
|
| 101 | - * |
|
| 102 | - * @since 1.0.19 |
|
| 103 | - * @var string |
|
| 104 | - */ |
|
| 105 | - public $last_error = ''; |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Stores additional meta data. |
|
| 109 | - * |
|
| 110 | - * @since 1.0.19 |
|
| 111 | - * @var array |
|
| 112 | - */ |
|
| 113 | - protected $meta_data = null; |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Default constructor. |
|
| 117 | - * |
|
| 118 | - * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
|
| 119 | - */ |
|
| 120 | - public function __construct( $read = 0 ) { |
|
| 121 | - $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 122 | - $this->default_data = $this->data; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Only store the object ID to avoid serializing the data object instance. |
|
| 127 | - * |
|
| 128 | - * @return array |
|
| 129 | - */ |
|
| 130 | - public function __sleep() { |
|
| 131 | - return array( 'id' ); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * Re-run the constructor with the object ID. |
|
| 136 | - * |
|
| 137 | - * If the object no longer exists, remove the ID. |
|
| 138 | - */ |
|
| 139 | - public function __wakeup() { |
|
| 140 | - $this->__construct( absint( $this->id ) ); |
|
| 141 | - |
|
| 142 | - if ( ! empty( $this->last_error ) ) { |
|
| 143 | - $this->set_id( 0 ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * When the object is cloned, make sure meta is duplicated correctly. |
|
| 150 | - * |
|
| 151 | - * @since 1.0.19 |
|
| 152 | - */ |
|
| 153 | - public function __clone() { |
|
| 154 | - $this->maybe_read_meta_data(); |
|
| 155 | - if ( ! empty( $this->meta_data ) ) { |
|
| 156 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | - $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | - if ( ! empty( $meta->id ) ) { |
|
| 159 | - $this->meta_data[ $array_key ]->id = null; |
|
| 160 | - } |
|
| 161 | - } |
|
| 162 | - } |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Get the data store. |
|
| 167 | - * |
|
| 168 | - * @since 1.0.19 |
|
| 169 | - * @return object |
|
| 170 | - */ |
|
| 171 | - public function get_data_store() { |
|
| 172 | - return $this->data_store; |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Get the object type. |
|
| 177 | - * |
|
| 178 | - * @since 1.0.19 |
|
| 179 | - * @return string |
|
| 180 | - */ |
|
| 181 | - public function get_object_type() { |
|
| 182 | - return $this->object_type; |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * Returns the unique ID for this object. |
|
| 187 | - * |
|
| 188 | - * @since 1.0.19 |
|
| 189 | - * @return int |
|
| 190 | - */ |
|
| 191 | - public function get_id() { |
|
| 192 | - return $this->id; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * Get form status. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_status( $context = 'view' ) { |
|
| 203 | - return $this->get_prop( 'status', $context ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * Delete an object, set the ID to 0, and return result. |
|
| 208 | - * |
|
| 209 | - * @since 1.0.19 |
|
| 210 | - * @param bool $force_delete Should the data be deleted permanently. |
|
| 211 | - * @return bool result |
|
| 212 | - */ |
|
| 213 | - public function delete( $force_delete = false ) { |
|
| 214 | - if ( $this->data_store && $this->get_id() ) { |
|
| 215 | - $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | - $this->set_id( 0 ); |
|
| 217 | - return true; |
|
| 218 | - } |
|
| 219 | - return false; |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Save should create or update based on object existence. |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @return int |
|
| 227 | - */ |
|
| 228 | - public function save() { |
|
| 229 | - if ( ! $this->data_store ) { |
|
| 230 | - return $this->get_id(); |
|
| 231 | - } |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
| 235 | - * |
|
| 236 | - * @param GetPaid_Data $this The object being saved. |
|
| 237 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 238 | - */ |
|
| 239 | - do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 240 | - |
|
| 241 | - if ( $this->get_id() ) { |
|
| 242 | - $this->data_store->update( $this ); |
|
| 243 | - } else { |
|
| 244 | - $this->data_store->create( $this ); |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * Trigger action after saving to the DB. |
|
| 249 | - * |
|
| 250 | - * @param GetPaid_Data $this The object being saved. |
|
| 251 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 252 | - */ |
|
| 253 | - do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 254 | - |
|
| 255 | - return $this->get_id(); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Change data to JSON format. |
|
| 260 | - * |
|
| 261 | - * @since 1.0.19 |
|
| 262 | - * @return string Data in JSON format. |
|
| 263 | - */ |
|
| 264 | - public function __toString() { |
|
| 265 | - return wp_json_encode( $this->get_data() ); |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Returns all data for this object. |
|
| 270 | - * |
|
| 271 | - * @since 1.0.19 |
|
| 272 | - * @return array |
|
| 273 | - */ |
|
| 274 | - public function get_data() { |
|
| 275 | - return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * Returns array of expected data keys for this object. |
|
| 280 | - * |
|
| 281 | - * @since 1.0.19 |
|
| 282 | - * @return array |
|
| 283 | - */ |
|
| 284 | - public function get_data_keys() { |
|
| 285 | - return array_keys( $this->data ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Returns all "extra" data keys for an object (for sub objects like item types). |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @return array |
|
| 293 | - */ |
|
| 294 | - public function get_extra_data_keys() { |
|
| 295 | - return array_keys( $this->extra_data ); |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * Filter null meta values from array. |
|
| 300 | - * |
|
| 301 | - * @since 1.0.19 |
|
| 302 | - * @param mixed $meta Meta value to check. |
|
| 303 | - * @return bool |
|
| 304 | - */ |
|
| 305 | - protected function filter_null_meta( $meta ) { |
|
| 306 | - return ! is_null( $meta->value ); |
|
| 307 | - } |
|
| 308 | - |
|
| 309 | - /** |
|
| 310 | - * Get All Meta Data. |
|
| 311 | - * |
|
| 312 | - * @since 1.0.19 |
|
| 313 | - * @return array of objects. |
|
| 314 | - */ |
|
| 315 | - public function get_meta_data() { |
|
| 316 | - $this->maybe_read_meta_data(); |
|
| 317 | - return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * Check if the key is an internal one. |
|
| 322 | - * |
|
| 323 | - * @since 1.0.19 |
|
| 324 | - * @param string $key Key to check. |
|
| 325 | - * @return bool true if it's an internal key, false otherwise |
|
| 326 | - */ |
|
| 327 | - protected function is_internal_meta_key( $key ) { |
|
| 328 | - $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 329 | - |
|
| 330 | - if ( ! $internal_meta_key ) { |
|
| 331 | - return false; |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 335 | - |
|
| 336 | - if ( ! $has_setter_or_getter ) { |
|
| 337 | - return false; |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /* translators: %s: $key Key to check */ |
|
| 341 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 342 | - |
|
| 343 | - return true; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * Magic method for setting data fields. |
|
| 348 | - * |
|
| 349 | - * This method does not update custom fields in the database. |
|
| 350 | - * |
|
| 351 | - * @since 1.0.19 |
|
| 352 | - * @access public |
|
| 353 | - * |
|
| 354 | - */ |
|
| 355 | - public function __set( $key, $value ) { |
|
| 356 | - |
|
| 357 | - if ( 'id' == strtolower( $key ) ) { |
|
| 358 | - return $this->set_id( $value ); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - if ( method_exists( $this, "set_$key") ) { |
|
| 362 | - |
|
| 363 | - /* translators: %s: $key Key to set */ |
|
| 364 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 365 | - |
|
| 366 | - call_user_func( array( $this, "set_$key" ), $value ); |
|
| 367 | - } else { |
|
| 368 | - $this->set_prop( $key, $value ); |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 24 | + /** |
|
| 25 | + * ID for this object. |
|
| 26 | + * |
|
| 27 | + * @since 1.0.19 |
|
| 28 | + * @var int |
|
| 29 | + */ |
|
| 30 | + protected $id = 0; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Core data for this object. Name value pairs (name + default value). |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Core data changes for this object. |
|
| 42 | + * |
|
| 43 | + * @since 1.0.19 |
|
| 44 | + * @var array |
|
| 45 | + */ |
|
| 46 | + protected $changes = array(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * This is false until the object is read from the DB. |
|
| 50 | + * |
|
| 51 | + * @since 1.0.19 |
|
| 52 | + * @var bool |
|
| 53 | + */ |
|
| 54 | + protected $object_read = false; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * This is the name of this object type. |
|
| 58 | + * |
|
| 59 | + * @since 1.0.19 |
|
| 60 | + * @var string |
|
| 61 | + */ |
|
| 62 | + protected $object_type = 'data'; |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Extra data for this object. Name value pairs (name + default value). |
|
| 66 | + * Used as a standard way for sub classes (like item types) to add |
|
| 67 | + * additional information to an inherited class. |
|
| 68 | + * |
|
| 69 | + * @since 1.0.19 |
|
| 70 | + * @var array |
|
| 71 | + */ |
|
| 72 | + protected $extra_data = array(); |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Set to _data on construct so we can track and reset data if needed. |
|
| 76 | + * |
|
| 77 | + * @since 1.0.19 |
|
| 78 | + * @var array |
|
| 79 | + */ |
|
| 80 | + protected $default_data = array(); |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Contains a reference to the data store for this class. |
|
| 84 | + * |
|
| 85 | + * @since 1.0.19 |
|
| 86 | + * @var GetPaid_Data_Store |
|
| 87 | + */ |
|
| 88 | + protected $data_store; |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Stores meta in cache for future reads. |
|
| 92 | + * A group must be set to to enable caching. |
|
| 93 | + * |
|
| 94 | + * @since 1.0.19 |
|
| 95 | + * @var string |
|
| 96 | + */ |
|
| 97 | + protected $cache_group = ''; |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * Stores the last error. |
|
| 101 | + * |
|
| 102 | + * @since 1.0.19 |
|
| 103 | + * @var string |
|
| 104 | + */ |
|
| 105 | + public $last_error = ''; |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Stores additional meta data. |
|
| 109 | + * |
|
| 110 | + * @since 1.0.19 |
|
| 111 | + * @var array |
|
| 112 | + */ |
|
| 113 | + protected $meta_data = null; |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Default constructor. |
|
| 117 | + * |
|
| 118 | + * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
|
| 119 | + */ |
|
| 120 | + public function __construct( $read = 0 ) { |
|
| 121 | + $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 122 | + $this->default_data = $this->data; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Only store the object ID to avoid serializing the data object instance. |
|
| 127 | + * |
|
| 128 | + * @return array |
|
| 129 | + */ |
|
| 130 | + public function __sleep() { |
|
| 131 | + return array( 'id' ); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * Re-run the constructor with the object ID. |
|
| 136 | + * |
|
| 137 | + * If the object no longer exists, remove the ID. |
|
| 138 | + */ |
|
| 139 | + public function __wakeup() { |
|
| 140 | + $this->__construct( absint( $this->id ) ); |
|
| 141 | + |
|
| 142 | + if ( ! empty( $this->last_error ) ) { |
|
| 143 | + $this->set_id( 0 ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * When the object is cloned, make sure meta is duplicated correctly. |
|
| 150 | + * |
|
| 151 | + * @since 1.0.19 |
|
| 152 | + */ |
|
| 153 | + public function __clone() { |
|
| 154 | + $this->maybe_read_meta_data(); |
|
| 155 | + if ( ! empty( $this->meta_data ) ) { |
|
| 156 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | + $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | + if ( ! empty( $meta->id ) ) { |
|
| 159 | + $this->meta_data[ $array_key ]->id = null; |
|
| 160 | + } |
|
| 161 | + } |
|
| 162 | + } |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Get the data store. |
|
| 167 | + * |
|
| 168 | + * @since 1.0.19 |
|
| 169 | + * @return object |
|
| 170 | + */ |
|
| 171 | + public function get_data_store() { |
|
| 172 | + return $this->data_store; |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Get the object type. |
|
| 177 | + * |
|
| 178 | + * @since 1.0.19 |
|
| 179 | + * @return string |
|
| 180 | + */ |
|
| 181 | + public function get_object_type() { |
|
| 182 | + return $this->object_type; |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * Returns the unique ID for this object. |
|
| 187 | + * |
|
| 188 | + * @since 1.0.19 |
|
| 189 | + * @return int |
|
| 190 | + */ |
|
| 191 | + public function get_id() { |
|
| 192 | + return $this->id; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * Get form status. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_status( $context = 'view' ) { |
|
| 203 | + return $this->get_prop( 'status', $context ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * Delete an object, set the ID to 0, and return result. |
|
| 208 | + * |
|
| 209 | + * @since 1.0.19 |
|
| 210 | + * @param bool $force_delete Should the data be deleted permanently. |
|
| 211 | + * @return bool result |
|
| 212 | + */ |
|
| 213 | + public function delete( $force_delete = false ) { |
|
| 214 | + if ( $this->data_store && $this->get_id() ) { |
|
| 215 | + $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | + $this->set_id( 0 ); |
|
| 217 | + return true; |
|
| 218 | + } |
|
| 219 | + return false; |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Save should create or update based on object existence. |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @return int |
|
| 227 | + */ |
|
| 228 | + public function save() { |
|
| 229 | + if ( ! $this->data_store ) { |
|
| 230 | + return $this->get_id(); |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
| 235 | + * |
|
| 236 | + * @param GetPaid_Data $this The object being saved. |
|
| 237 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 238 | + */ |
|
| 239 | + do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 240 | + |
|
| 241 | + if ( $this->get_id() ) { |
|
| 242 | + $this->data_store->update( $this ); |
|
| 243 | + } else { |
|
| 244 | + $this->data_store->create( $this ); |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * Trigger action after saving to the DB. |
|
| 249 | + * |
|
| 250 | + * @param GetPaid_Data $this The object being saved. |
|
| 251 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 252 | + */ |
|
| 253 | + do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 254 | + |
|
| 255 | + return $this->get_id(); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Change data to JSON format. |
|
| 260 | + * |
|
| 261 | + * @since 1.0.19 |
|
| 262 | + * @return string Data in JSON format. |
|
| 263 | + */ |
|
| 264 | + public function __toString() { |
|
| 265 | + return wp_json_encode( $this->get_data() ); |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Returns all data for this object. |
|
| 270 | + * |
|
| 271 | + * @since 1.0.19 |
|
| 272 | + * @return array |
|
| 273 | + */ |
|
| 274 | + public function get_data() { |
|
| 275 | + return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * Returns array of expected data keys for this object. |
|
| 280 | + * |
|
| 281 | + * @since 1.0.19 |
|
| 282 | + * @return array |
|
| 283 | + */ |
|
| 284 | + public function get_data_keys() { |
|
| 285 | + return array_keys( $this->data ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Returns all "extra" data keys for an object (for sub objects like item types). |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @return array |
|
| 293 | + */ |
|
| 294 | + public function get_extra_data_keys() { |
|
| 295 | + return array_keys( $this->extra_data ); |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * Filter null meta values from array. |
|
| 300 | + * |
|
| 301 | + * @since 1.0.19 |
|
| 302 | + * @param mixed $meta Meta value to check. |
|
| 303 | + * @return bool |
|
| 304 | + */ |
|
| 305 | + protected function filter_null_meta( $meta ) { |
|
| 306 | + return ! is_null( $meta->value ); |
|
| 307 | + } |
|
| 308 | + |
|
| 309 | + /** |
|
| 310 | + * Get All Meta Data. |
|
| 311 | + * |
|
| 312 | + * @since 1.0.19 |
|
| 313 | + * @return array of objects. |
|
| 314 | + */ |
|
| 315 | + public function get_meta_data() { |
|
| 316 | + $this->maybe_read_meta_data(); |
|
| 317 | + return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * Check if the key is an internal one. |
|
| 322 | + * |
|
| 323 | + * @since 1.0.19 |
|
| 324 | + * @param string $key Key to check. |
|
| 325 | + * @return bool true if it's an internal key, false otherwise |
|
| 326 | + */ |
|
| 327 | + protected function is_internal_meta_key( $key ) { |
|
| 328 | + $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 329 | + |
|
| 330 | + if ( ! $internal_meta_key ) { |
|
| 331 | + return false; |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 335 | + |
|
| 336 | + if ( ! $has_setter_or_getter ) { |
|
| 337 | + return false; |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /* translators: %s: $key Key to check */ |
|
| 341 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 342 | + |
|
| 343 | + return true; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * Magic method for setting data fields. |
|
| 348 | + * |
|
| 349 | + * This method does not update custom fields in the database. |
|
| 350 | + * |
|
| 351 | + * @since 1.0.19 |
|
| 352 | + * @access public |
|
| 353 | + * |
|
| 354 | + */ |
|
| 355 | + public function __set( $key, $value ) { |
|
| 356 | + |
|
| 357 | + if ( 'id' == strtolower( $key ) ) { |
|
| 358 | + return $this->set_id( $value ); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + if ( method_exists( $this, "set_$key") ) { |
|
| 362 | + |
|
| 363 | + /* translators: %s: $key Key to set */ |
|
| 364 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 365 | + |
|
| 366 | + call_user_func( array( $this, "set_$key" ), $value ); |
|
| 367 | + } else { |
|
| 368 | + $this->set_prop( $key, $value ); |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | 374 | * Margic method for retrieving a property. |
| 375 | 375 | */ |
| 376 | 376 | public function __get( $key ) { |
@@ -378,10 +378,10 @@ discard block |
||
| 378 | 378 | // Check if we have a helper method for that. |
| 379 | 379 | if ( method_exists( $this, 'get_' . $key ) ) { |
| 380 | 380 | |
| 381 | - if ( 'post_type' != $key ) { |
|
| 382 | - /* translators: %s: $key Key to set */ |
|
| 383 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 384 | - } |
|
| 381 | + if ( 'post_type' != $key ) { |
|
| 382 | + /* translators: %s: $key Key to set */ |
|
| 383 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'getpaid' ), $key ), '1.0.19' ); |
|
| 384 | + } |
|
| 385 | 385 | |
| 386 | 386 | return call_user_func( array( $this, 'get_' . $key ) ); |
| 387 | 387 | } |
@@ -391,512 +391,512 @@ discard block |
||
| 391 | 391 | return $this->post->$key; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | - return $this->get_prop( $key ); |
|
| 395 | - |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - /** |
|
| 399 | - * Get Meta Data by Key. |
|
| 400 | - * |
|
| 401 | - * @since 1.0.19 |
|
| 402 | - * @param string $key Meta Key. |
|
| 403 | - * @param bool $single return first found meta with key, or all with $key. |
|
| 404 | - * @param string $context What the value is for. Valid values are view and edit. |
|
| 405 | - * @return mixed |
|
| 406 | - */ |
|
| 407 | - public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 408 | - |
|
| 409 | - // Check if this is an internal meta key. |
|
| 410 | - $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | - $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | - if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 413 | - $function = 'get_' . $_key; |
|
| 414 | - |
|
| 415 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 416 | - return $this->{$function}(); |
|
| 417 | - } |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - // Read the meta data if not yet read. |
|
| 421 | - $this->maybe_read_meta_data(); |
|
| 422 | - $meta_data = $this->get_meta_data(); |
|
| 423 | - $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 424 | - $value = $single ? '' : array(); |
|
| 425 | - |
|
| 426 | - if ( ! empty( $array_keys ) ) { |
|
| 427 | - // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
| 428 | - if ( $single ) { |
|
| 429 | - $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 430 | - } else { |
|
| 431 | - $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 432 | - } |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - if ( 'view' === $context ) { |
|
| 436 | - $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - return $value; |
|
| 440 | - } |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * See if meta data exists, since get_meta always returns a '' or array(). |
|
| 444 | - * |
|
| 445 | - * @since 1.0.19 |
|
| 446 | - * @param string $key Meta Key. |
|
| 447 | - * @return boolean |
|
| 448 | - */ |
|
| 449 | - public function meta_exists( $key = '' ) { |
|
| 450 | - $this->maybe_read_meta_data(); |
|
| 451 | - $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | - return in_array( $key, $array_keys, true ); |
|
| 453 | - } |
|
| 454 | - |
|
| 455 | - /** |
|
| 456 | - * Set all meta data from array. |
|
| 457 | - * |
|
| 458 | - * @since 1.0.19 |
|
| 459 | - * @param array $data Key/Value pairs. |
|
| 460 | - */ |
|
| 461 | - public function set_meta_data( $data ) { |
|
| 462 | - if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 463 | - $this->maybe_read_meta_data(); |
|
| 464 | - foreach ( $data as $meta ) { |
|
| 465 | - $meta = (array) $meta; |
|
| 466 | - if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 467 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 468 | - array( |
|
| 469 | - 'id' => $meta['id'], |
|
| 470 | - 'key' => $meta['key'], |
|
| 471 | - 'value' => $meta['value'], |
|
| 472 | - ) |
|
| 473 | - ); |
|
| 474 | - } |
|
| 475 | - } |
|
| 476 | - } |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * Add meta data. |
|
| 481 | - * |
|
| 482 | - * @since 1.0.19 |
|
| 483 | - * |
|
| 484 | - * @param string $key Meta key. |
|
| 485 | - * @param string|array $value Meta value. |
|
| 486 | - * @param bool $unique Should this be a unique key?. |
|
| 487 | - */ |
|
| 488 | - public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 490 | - $function = 'set_' . $key; |
|
| 491 | - |
|
| 492 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | - return $this->{$function}( $value ); |
|
| 494 | - } |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - $this->maybe_read_meta_data(); |
|
| 498 | - if ( $unique ) { |
|
| 499 | - $this->delete_meta_data( $key ); |
|
| 500 | - } |
|
| 501 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 502 | - array( |
|
| 503 | - 'key' => $key, |
|
| 504 | - 'value' => $value, |
|
| 505 | - ) |
|
| 506 | - ); |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * Update meta data by key or ID, if provided. |
|
| 511 | - * |
|
| 512 | - * @since 1.0.19 |
|
| 513 | - * |
|
| 514 | - * @param string $key Meta key. |
|
| 515 | - * @param string|array $value Meta value. |
|
| 516 | - * @param int $meta_id Meta ID. |
|
| 517 | - */ |
|
| 518 | - public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 520 | - $function = 'set_' . $key; |
|
| 521 | - |
|
| 522 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | - return $this->{$function}( $value ); |
|
| 524 | - } |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - $this->maybe_read_meta_data(); |
|
| 528 | - |
|
| 529 | - $array_key = false; |
|
| 530 | - |
|
| 531 | - if ( $meta_id ) { |
|
| 532 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | - $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 534 | - } else { |
|
| 535 | - // Find matches by key. |
|
| 536 | - $matches = array(); |
|
| 537 | - foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | - if ( $meta->key === $key ) { |
|
| 539 | - $matches[] = $meta_data_array_key; |
|
| 540 | - } |
|
| 541 | - } |
|
| 542 | - |
|
| 543 | - if ( ! empty( $matches ) ) { |
|
| 544 | - // Set matches to null so only one key gets the new value. |
|
| 545 | - foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | - $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 547 | - } |
|
| 548 | - $array_key = current( $matches ); |
|
| 549 | - } |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - if ( false !== $array_key ) { |
|
| 553 | - $meta = $this->meta_data[ $array_key ]; |
|
| 554 | - $meta->key = $key; |
|
| 555 | - $meta->value = $value; |
|
| 556 | - } else { |
|
| 557 | - $this->add_meta_data( $key, $value, true ); |
|
| 558 | - } |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * Delete meta data. |
|
| 563 | - * |
|
| 564 | - * @since 1.0.19 |
|
| 565 | - * @param string $key Meta key. |
|
| 566 | - */ |
|
| 567 | - public function delete_meta_data( $key ) { |
|
| 568 | - $this->maybe_read_meta_data(); |
|
| 569 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 570 | - |
|
| 571 | - if ( $array_keys ) { |
|
| 572 | - foreach ( $array_keys as $array_key ) { |
|
| 573 | - $this->meta_data[ $array_key ]->value = null; |
|
| 574 | - } |
|
| 575 | - } |
|
| 576 | - } |
|
| 577 | - |
|
| 578 | - /** |
|
| 579 | - * Delete meta data. |
|
| 580 | - * |
|
| 581 | - * @since 1.0.19 |
|
| 582 | - * @param int $mid Meta ID. |
|
| 583 | - */ |
|
| 584 | - public function delete_meta_data_by_mid( $mid ) { |
|
| 585 | - $this->maybe_read_meta_data(); |
|
| 586 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 587 | - |
|
| 588 | - if ( $array_keys ) { |
|
| 589 | - foreach ( $array_keys as $array_key ) { |
|
| 590 | - $this->meta_data[ $array_key ]->value = null; |
|
| 591 | - } |
|
| 592 | - } |
|
| 593 | - } |
|
| 594 | - |
|
| 595 | - /** |
|
| 596 | - * Read meta data if null. |
|
| 597 | - * |
|
| 598 | - * @since 1.0.19 |
|
| 599 | - */ |
|
| 600 | - protected function maybe_read_meta_data() { |
|
| 601 | - if ( is_null( $this->meta_data ) ) { |
|
| 602 | - $this->read_meta_data(); |
|
| 603 | - } |
|
| 604 | - } |
|
| 605 | - |
|
| 606 | - /** |
|
| 607 | - * Read Meta Data from the database. Ignore any internal properties. |
|
| 608 | - * Uses it's own caches because get_metadata does not provide meta_ids. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @param bool $force_read True to force a new DB read (and update cache). |
|
| 612 | - */ |
|
| 613 | - public function read_meta_data( $force_read = false ) { |
|
| 614 | - |
|
| 615 | - // Reset meta data. |
|
| 616 | - $this->meta_data = array(); |
|
| 617 | - |
|
| 618 | - // Maybe abort early. |
|
| 619 | - if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 620 | - return; |
|
| 621 | - } |
|
| 622 | - |
|
| 623 | - // Only read from cache if the cache key is set. |
|
| 624 | - $cache_key = null; |
|
| 625 | - if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | - $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - // Should we force read? |
|
| 631 | - if ( empty( $raw_meta_data ) ) { |
|
| 632 | - $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 633 | - |
|
| 634 | - if ( ! empty( $cache_key ) ) { |
|
| 635 | - wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - } |
|
| 639 | - |
|
| 640 | - // Set meta data. |
|
| 641 | - if ( is_array( $raw_meta_data ) ) { |
|
| 642 | - |
|
| 643 | - foreach ( $raw_meta_data as $meta ) { |
|
| 644 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 645 | - array( |
|
| 646 | - 'id' => (int) $meta->meta_id, |
|
| 647 | - 'key' => $meta->meta_key, |
|
| 648 | - 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 649 | - ) |
|
| 650 | - ); |
|
| 651 | - } |
|
| 652 | - |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * Update Meta Data in the database. |
|
| 659 | - * |
|
| 660 | - * @since 1.0.19 |
|
| 661 | - */ |
|
| 662 | - public function save_meta_data() { |
|
| 663 | - if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 664 | - return; |
|
| 665 | - } |
|
| 666 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | - if ( is_null( $meta->value ) ) { |
|
| 668 | - if ( ! empty( $meta->id ) ) { |
|
| 669 | - $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | - unset( $this->meta_data[ $array_key ] ); |
|
| 671 | - } |
|
| 672 | - } elseif ( empty( $meta->id ) ) { |
|
| 673 | - $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 674 | - $meta->apply_changes(); |
|
| 675 | - } else { |
|
| 676 | - if ( $meta->get_changes() ) { |
|
| 677 | - $this->data_store->update_meta( $this, $meta ); |
|
| 678 | - $meta->apply_changes(); |
|
| 679 | - } |
|
| 680 | - } |
|
| 681 | - } |
|
| 682 | - if ( ! empty( $this->cache_group ) ) { |
|
| 683 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | - wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 685 | - } |
|
| 686 | - } |
|
| 687 | - |
|
| 688 | - /** |
|
| 689 | - * Set ID. |
|
| 690 | - * |
|
| 691 | - * @since 1.0.19 |
|
| 692 | - * @param int $id ID. |
|
| 693 | - */ |
|
| 694 | - public function set_id( $id ) { |
|
| 695 | - $this->id = absint( $id ); |
|
| 696 | - } |
|
| 697 | - |
|
| 698 | - /** |
|
| 699 | - * Sets item status. |
|
| 700 | - * |
|
| 701 | - * @since 1.0.19 |
|
| 702 | - * @param string $status New status. |
|
| 703 | - * @return array details of change. |
|
| 704 | - */ |
|
| 705 | - public function set_status( $status ) { |
|
| 394 | + return $this->get_prop( $key ); |
|
| 395 | + |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + /** |
|
| 399 | + * Get Meta Data by Key. |
|
| 400 | + * |
|
| 401 | + * @since 1.0.19 |
|
| 402 | + * @param string $key Meta Key. |
|
| 403 | + * @param bool $single return first found meta with key, or all with $key. |
|
| 404 | + * @param string $context What the value is for. Valid values are view and edit. |
|
| 405 | + * @return mixed |
|
| 406 | + */ |
|
| 407 | + public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 408 | + |
|
| 409 | + // Check if this is an internal meta key. |
|
| 410 | + $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | + $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | + if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 413 | + $function = 'get_' . $_key; |
|
| 414 | + |
|
| 415 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 416 | + return $this->{$function}(); |
|
| 417 | + } |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + // Read the meta data if not yet read. |
|
| 421 | + $this->maybe_read_meta_data(); |
|
| 422 | + $meta_data = $this->get_meta_data(); |
|
| 423 | + $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 424 | + $value = $single ? '' : array(); |
|
| 425 | + |
|
| 426 | + if ( ! empty( $array_keys ) ) { |
|
| 427 | + // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
| 428 | + if ( $single ) { |
|
| 429 | + $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 430 | + } else { |
|
| 431 | + $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 432 | + } |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + if ( 'view' === $context ) { |
|
| 436 | + $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + return $value; |
|
| 440 | + } |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * See if meta data exists, since get_meta always returns a '' or array(). |
|
| 444 | + * |
|
| 445 | + * @since 1.0.19 |
|
| 446 | + * @param string $key Meta Key. |
|
| 447 | + * @return boolean |
|
| 448 | + */ |
|
| 449 | + public function meta_exists( $key = '' ) { |
|
| 450 | + $this->maybe_read_meta_data(); |
|
| 451 | + $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | + return in_array( $key, $array_keys, true ); |
|
| 453 | + } |
|
| 454 | + |
|
| 455 | + /** |
|
| 456 | + * Set all meta data from array. |
|
| 457 | + * |
|
| 458 | + * @since 1.0.19 |
|
| 459 | + * @param array $data Key/Value pairs. |
|
| 460 | + */ |
|
| 461 | + public function set_meta_data( $data ) { |
|
| 462 | + if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 463 | + $this->maybe_read_meta_data(); |
|
| 464 | + foreach ( $data as $meta ) { |
|
| 465 | + $meta = (array) $meta; |
|
| 466 | + if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 467 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 468 | + array( |
|
| 469 | + 'id' => $meta['id'], |
|
| 470 | + 'key' => $meta['key'], |
|
| 471 | + 'value' => $meta['value'], |
|
| 472 | + ) |
|
| 473 | + ); |
|
| 474 | + } |
|
| 475 | + } |
|
| 476 | + } |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * Add meta data. |
|
| 481 | + * |
|
| 482 | + * @since 1.0.19 |
|
| 483 | + * |
|
| 484 | + * @param string $key Meta key. |
|
| 485 | + * @param string|array $value Meta value. |
|
| 486 | + * @param bool $unique Should this be a unique key?. |
|
| 487 | + */ |
|
| 488 | + public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
| 490 | + $function = 'set_' . $key; |
|
| 491 | + |
|
| 492 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | + return $this->{$function}( $value ); |
|
| 494 | + } |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + $this->maybe_read_meta_data(); |
|
| 498 | + if ( $unique ) { |
|
| 499 | + $this->delete_meta_data( $key ); |
|
| 500 | + } |
|
| 501 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 502 | + array( |
|
| 503 | + 'key' => $key, |
|
| 504 | + 'value' => $value, |
|
| 505 | + ) |
|
| 506 | + ); |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * Update meta data by key or ID, if provided. |
|
| 511 | + * |
|
| 512 | + * @since 1.0.19 |
|
| 513 | + * |
|
| 514 | + * @param string $key Meta key. |
|
| 515 | + * @param string|array $value Meta value. |
|
| 516 | + * @param int $meta_id Meta ID. |
|
| 517 | + */ |
|
| 518 | + public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
| 520 | + $function = 'set_' . $key; |
|
| 521 | + |
|
| 522 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | + return $this->{$function}( $value ); |
|
| 524 | + } |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + $this->maybe_read_meta_data(); |
|
| 528 | + |
|
| 529 | + $array_key = false; |
|
| 530 | + |
|
| 531 | + if ( $meta_id ) { |
|
| 532 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | + $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 534 | + } else { |
|
| 535 | + // Find matches by key. |
|
| 536 | + $matches = array(); |
|
| 537 | + foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | + if ( $meta->key === $key ) { |
|
| 539 | + $matches[] = $meta_data_array_key; |
|
| 540 | + } |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + if ( ! empty( $matches ) ) { |
|
| 544 | + // Set matches to null so only one key gets the new value. |
|
| 545 | + foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | + $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 547 | + } |
|
| 548 | + $array_key = current( $matches ); |
|
| 549 | + } |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + if ( false !== $array_key ) { |
|
| 553 | + $meta = $this->meta_data[ $array_key ]; |
|
| 554 | + $meta->key = $key; |
|
| 555 | + $meta->value = $value; |
|
| 556 | + } else { |
|
| 557 | + $this->add_meta_data( $key, $value, true ); |
|
| 558 | + } |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * Delete meta data. |
|
| 563 | + * |
|
| 564 | + * @since 1.0.19 |
|
| 565 | + * @param string $key Meta key. |
|
| 566 | + */ |
|
| 567 | + public function delete_meta_data( $key ) { |
|
| 568 | + $this->maybe_read_meta_data(); |
|
| 569 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 570 | + |
|
| 571 | + if ( $array_keys ) { |
|
| 572 | + foreach ( $array_keys as $array_key ) { |
|
| 573 | + $this->meta_data[ $array_key ]->value = null; |
|
| 574 | + } |
|
| 575 | + } |
|
| 576 | + } |
|
| 577 | + |
|
| 578 | + /** |
|
| 579 | + * Delete meta data. |
|
| 580 | + * |
|
| 581 | + * @since 1.0.19 |
|
| 582 | + * @param int $mid Meta ID. |
|
| 583 | + */ |
|
| 584 | + public function delete_meta_data_by_mid( $mid ) { |
|
| 585 | + $this->maybe_read_meta_data(); |
|
| 586 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 587 | + |
|
| 588 | + if ( $array_keys ) { |
|
| 589 | + foreach ( $array_keys as $array_key ) { |
|
| 590 | + $this->meta_data[ $array_key ]->value = null; |
|
| 591 | + } |
|
| 592 | + } |
|
| 593 | + } |
|
| 594 | + |
|
| 595 | + /** |
|
| 596 | + * Read meta data if null. |
|
| 597 | + * |
|
| 598 | + * @since 1.0.19 |
|
| 599 | + */ |
|
| 600 | + protected function maybe_read_meta_data() { |
|
| 601 | + if ( is_null( $this->meta_data ) ) { |
|
| 602 | + $this->read_meta_data(); |
|
| 603 | + } |
|
| 604 | + } |
|
| 605 | + |
|
| 606 | + /** |
|
| 607 | + * Read Meta Data from the database. Ignore any internal properties. |
|
| 608 | + * Uses it's own caches because get_metadata does not provide meta_ids. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @param bool $force_read True to force a new DB read (and update cache). |
|
| 612 | + */ |
|
| 613 | + public function read_meta_data( $force_read = false ) { |
|
| 614 | + |
|
| 615 | + // Reset meta data. |
|
| 616 | + $this->meta_data = array(); |
|
| 617 | + |
|
| 618 | + // Maybe abort early. |
|
| 619 | + if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 620 | + return; |
|
| 621 | + } |
|
| 622 | + |
|
| 623 | + // Only read from cache if the cache key is set. |
|
| 624 | + $cache_key = null; |
|
| 625 | + if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | + $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + // Should we force read? |
|
| 631 | + if ( empty( $raw_meta_data ) ) { |
|
| 632 | + $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 633 | + |
|
| 634 | + if ( ! empty( $cache_key ) ) { |
|
| 635 | + wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + } |
|
| 639 | + |
|
| 640 | + // Set meta data. |
|
| 641 | + if ( is_array( $raw_meta_data ) ) { |
|
| 642 | + |
|
| 643 | + foreach ( $raw_meta_data as $meta ) { |
|
| 644 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 645 | + array( |
|
| 646 | + 'id' => (int) $meta->meta_id, |
|
| 647 | + 'key' => $meta->meta_key, |
|
| 648 | + 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 649 | + ) |
|
| 650 | + ); |
|
| 651 | + } |
|
| 652 | + |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * Update Meta Data in the database. |
|
| 659 | + * |
|
| 660 | + * @since 1.0.19 |
|
| 661 | + */ |
|
| 662 | + public function save_meta_data() { |
|
| 663 | + if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 664 | + return; |
|
| 665 | + } |
|
| 666 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | + if ( is_null( $meta->value ) ) { |
|
| 668 | + if ( ! empty( $meta->id ) ) { |
|
| 669 | + $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | + unset( $this->meta_data[ $array_key ] ); |
|
| 671 | + } |
|
| 672 | + } elseif ( empty( $meta->id ) ) { |
|
| 673 | + $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 674 | + $meta->apply_changes(); |
|
| 675 | + } else { |
|
| 676 | + if ( $meta->get_changes() ) { |
|
| 677 | + $this->data_store->update_meta( $this, $meta ); |
|
| 678 | + $meta->apply_changes(); |
|
| 679 | + } |
|
| 680 | + } |
|
| 681 | + } |
|
| 682 | + if ( ! empty( $this->cache_group ) ) { |
|
| 683 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | + wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 685 | + } |
|
| 686 | + } |
|
| 687 | + |
|
| 688 | + /** |
|
| 689 | + * Set ID. |
|
| 690 | + * |
|
| 691 | + * @since 1.0.19 |
|
| 692 | + * @param int $id ID. |
|
| 693 | + */ |
|
| 694 | + public function set_id( $id ) { |
|
| 695 | + $this->id = absint( $id ); |
|
| 696 | + } |
|
| 697 | + |
|
| 698 | + /** |
|
| 699 | + * Sets item status. |
|
| 700 | + * |
|
| 701 | + * @since 1.0.19 |
|
| 702 | + * @param string $status New status. |
|
| 703 | + * @return array details of change. |
|
| 704 | + */ |
|
| 705 | + public function set_status( $status ) { |
|
| 706 | 706 | $old_status = $this->get_status(); |
| 707 | 707 | |
| 708 | - $this->set_prop( 'status', $status ); |
|
| 709 | - |
|
| 710 | - return array( |
|
| 711 | - 'from' => $old_status, |
|
| 712 | - 'to' => $status, |
|
| 713 | - ); |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - /** |
|
| 717 | - * Set all props to default values. |
|
| 718 | - * |
|
| 719 | - * @since 1.0.19 |
|
| 720 | - */ |
|
| 721 | - public function set_defaults() { |
|
| 722 | - $this->data = $this->default_data; |
|
| 723 | - $this->changes = array(); |
|
| 724 | - $this->set_object_read( false ); |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - /** |
|
| 728 | - * Set object read property. |
|
| 729 | - * |
|
| 730 | - * @since 1.0.19 |
|
| 731 | - * @param boolean $read Should read?. |
|
| 732 | - */ |
|
| 733 | - public function set_object_read( $read = true ) { |
|
| 734 | - $this->object_read = (bool) $read; |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - /** |
|
| 738 | - * Get object read property. |
|
| 739 | - * |
|
| 740 | - * @since 1.0.19 |
|
| 741 | - * @return boolean |
|
| 742 | - */ |
|
| 743 | - public function get_object_read() { |
|
| 744 | - return (bool) $this->object_read; |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - /** |
|
| 748 | - * Set a collection of props in one go, collect any errors, and return the result. |
|
| 749 | - * Only sets using public methods. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - * |
|
| 753 | - * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
| 754 | - * @param string $context In what context to run this. |
|
| 755 | - * |
|
| 756 | - * @return bool|WP_Error |
|
| 757 | - */ |
|
| 758 | - public function set_props( $props, $context = 'set' ) { |
|
| 759 | - $errors = false; |
|
| 760 | - |
|
| 761 | - foreach ( $props as $prop => $value ) { |
|
| 762 | - try { |
|
| 763 | - /** |
|
| 764 | - * Checks if the prop being set is allowed, and the value is not null. |
|
| 765 | - */ |
|
| 766 | - if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 767 | - continue; |
|
| 768 | - } |
|
| 769 | - $setter = "set_$prop"; |
|
| 770 | - |
|
| 771 | - if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | - $this->{$setter}( $value ); |
|
| 773 | - } |
|
| 774 | - } catch ( Exception $e ) { |
|
| 775 | - if ( ! $errors ) { |
|
| 776 | - $errors = new WP_Error(); |
|
| 777 | - } |
|
| 778 | - $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 779 | - $this->last_error = $e->getMessage(); |
|
| 780 | - } |
|
| 781 | - } |
|
| 782 | - |
|
| 783 | - return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - /** |
|
| 787 | - * Sets a prop for a setter method. |
|
| 788 | - * |
|
| 789 | - * This stores changes in a special array so we can track what needs saving |
|
| 790 | - * the the DB later. |
|
| 791 | - * |
|
| 792 | - * @since 1.0.19 |
|
| 793 | - * @param string $prop Name of prop to set. |
|
| 794 | - * @param mixed $value Value of the prop. |
|
| 795 | - */ |
|
| 796 | - protected function set_prop( $prop, $value ) { |
|
| 797 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | - if ( true === $this->object_read ) { |
|
| 799 | - if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | - $this->changes[ $prop ] = $value; |
|
| 801 | - } |
|
| 802 | - } else { |
|
| 803 | - $this->data[ $prop ] = $value; |
|
| 804 | - } |
|
| 805 | - } |
|
| 806 | - } |
|
| 807 | - |
|
| 808 | - /** |
|
| 809 | - * Return data changes only. |
|
| 810 | - * |
|
| 811 | - * @since 1.0.19 |
|
| 812 | - * @return array |
|
| 813 | - */ |
|
| 814 | - public function get_changes() { |
|
| 815 | - return $this->changes; |
|
| 816 | - } |
|
| 817 | - |
|
| 818 | - /** |
|
| 819 | - * Merge changes with data and clear. |
|
| 820 | - * |
|
| 821 | - * @since 1.0.19 |
|
| 822 | - */ |
|
| 823 | - public function apply_changes() { |
|
| 824 | - $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 825 | - $this->changes = array(); |
|
| 826 | - } |
|
| 827 | - |
|
| 828 | - /** |
|
| 829 | - * Prefix for action and filter hooks on data. |
|
| 830 | - * |
|
| 831 | - * @since 1.0.19 |
|
| 832 | - * @return string |
|
| 833 | - */ |
|
| 834 | - protected function get_hook_prefix() { |
|
| 835 | - return 'wpinv_get_' . $this->object_type . '_'; |
|
| 836 | - } |
|
| 837 | - |
|
| 838 | - /** |
|
| 839 | - * Gets a prop for a getter method. |
|
| 840 | - * |
|
| 841 | - * Gets the value from either current pending changes, or the data itself. |
|
| 842 | - * Context controls what happens to the value before it's returned. |
|
| 843 | - * |
|
| 844 | - * @since 1.0.19 |
|
| 845 | - * @param string $prop Name of prop to get. |
|
| 846 | - * @param string $context What the value is for. Valid values are view and edit. |
|
| 847 | - * @return mixed |
|
| 848 | - */ |
|
| 849 | - protected function get_prop( $prop, $context = 'view' ) { |
|
| 850 | - $value = null; |
|
| 851 | - |
|
| 852 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | - $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 854 | - |
|
| 855 | - if ( 'view' === $context ) { |
|
| 856 | - $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 857 | - } |
|
| 858 | - } |
|
| 859 | - |
|
| 860 | - return $value; |
|
| 861 | - } |
|
| 862 | - |
|
| 863 | - /** |
|
| 864 | - * Sets a date prop whilst handling formatting and datetime objects. |
|
| 865 | - * |
|
| 866 | - * @since 1.0.19 |
|
| 867 | - * @param string $prop Name of prop to set. |
|
| 868 | - * @param string|integer $value Value of the prop. |
|
| 869 | - */ |
|
| 870 | - protected function set_date_prop( $prop, $value ) { |
|
| 871 | - |
|
| 872 | - if ( empty( $value ) ) { |
|
| 873 | - $this->set_prop( $prop, null ); |
|
| 874 | - return; |
|
| 875 | - } |
|
| 876 | - $this->set_prop( $prop, $value ); |
|
| 877 | - |
|
| 878 | - } |
|
| 879 | - |
|
| 880 | - /** |
|
| 881 | - * When invalid data is found, throw an exception unless reading from the DB. |
|
| 882 | - * |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @param string $code Error code. |
|
| 885 | - * @param string $message Error message. |
|
| 886 | - */ |
|
| 887 | - protected function error( $code, $message ) { |
|
| 888 | - $this->last_error = $message; |
|
| 889 | - } |
|
| 890 | - |
|
| 891 | - /** |
|
| 892 | - * Checks if the object is saved in the database |
|
| 893 | - * |
|
| 894 | - * @since 1.0.19 |
|
| 895 | - * @return bool |
|
| 896 | - */ |
|
| 897 | - public function exists() { |
|
| 898 | - $id = $this->get_id(); |
|
| 899 | - return ! empty( $id ); |
|
| 900 | - } |
|
| 708 | + $this->set_prop( 'status', $status ); |
|
| 709 | + |
|
| 710 | + return array( |
|
| 711 | + 'from' => $old_status, |
|
| 712 | + 'to' => $status, |
|
| 713 | + ); |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + /** |
|
| 717 | + * Set all props to default values. |
|
| 718 | + * |
|
| 719 | + * @since 1.0.19 |
|
| 720 | + */ |
|
| 721 | + public function set_defaults() { |
|
| 722 | + $this->data = $this->default_data; |
|
| 723 | + $this->changes = array(); |
|
| 724 | + $this->set_object_read( false ); |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + /** |
|
| 728 | + * Set object read property. |
|
| 729 | + * |
|
| 730 | + * @since 1.0.19 |
|
| 731 | + * @param boolean $read Should read?. |
|
| 732 | + */ |
|
| 733 | + public function set_object_read( $read = true ) { |
|
| 734 | + $this->object_read = (bool) $read; |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + /** |
|
| 738 | + * Get object read property. |
|
| 739 | + * |
|
| 740 | + * @since 1.0.19 |
|
| 741 | + * @return boolean |
|
| 742 | + */ |
|
| 743 | + public function get_object_read() { |
|
| 744 | + return (bool) $this->object_read; |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + /** |
|
| 748 | + * Set a collection of props in one go, collect any errors, and return the result. |
|
| 749 | + * Only sets using public methods. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + * |
|
| 753 | + * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
| 754 | + * @param string $context In what context to run this. |
|
| 755 | + * |
|
| 756 | + * @return bool|WP_Error |
|
| 757 | + */ |
|
| 758 | + public function set_props( $props, $context = 'set' ) { |
|
| 759 | + $errors = false; |
|
| 760 | + |
|
| 761 | + foreach ( $props as $prop => $value ) { |
|
| 762 | + try { |
|
| 763 | + /** |
|
| 764 | + * Checks if the prop being set is allowed, and the value is not null. |
|
| 765 | + */ |
|
| 766 | + if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 767 | + continue; |
|
| 768 | + } |
|
| 769 | + $setter = "set_$prop"; |
|
| 770 | + |
|
| 771 | + if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | + $this->{$setter}( $value ); |
|
| 773 | + } |
|
| 774 | + } catch ( Exception $e ) { |
|
| 775 | + if ( ! $errors ) { |
|
| 776 | + $errors = new WP_Error(); |
|
| 777 | + } |
|
| 778 | + $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 779 | + $this->last_error = $e->getMessage(); |
|
| 780 | + } |
|
| 781 | + } |
|
| 782 | + |
|
| 783 | + return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + /** |
|
| 787 | + * Sets a prop for a setter method. |
|
| 788 | + * |
|
| 789 | + * This stores changes in a special array so we can track what needs saving |
|
| 790 | + * the the DB later. |
|
| 791 | + * |
|
| 792 | + * @since 1.0.19 |
|
| 793 | + * @param string $prop Name of prop to set. |
|
| 794 | + * @param mixed $value Value of the prop. |
|
| 795 | + */ |
|
| 796 | + protected function set_prop( $prop, $value ) { |
|
| 797 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | + if ( true === $this->object_read ) { |
|
| 799 | + if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | + $this->changes[ $prop ] = $value; |
|
| 801 | + } |
|
| 802 | + } else { |
|
| 803 | + $this->data[ $prop ] = $value; |
|
| 804 | + } |
|
| 805 | + } |
|
| 806 | + } |
|
| 807 | + |
|
| 808 | + /** |
|
| 809 | + * Return data changes only. |
|
| 810 | + * |
|
| 811 | + * @since 1.0.19 |
|
| 812 | + * @return array |
|
| 813 | + */ |
|
| 814 | + public function get_changes() { |
|
| 815 | + return $this->changes; |
|
| 816 | + } |
|
| 817 | + |
|
| 818 | + /** |
|
| 819 | + * Merge changes with data and clear. |
|
| 820 | + * |
|
| 821 | + * @since 1.0.19 |
|
| 822 | + */ |
|
| 823 | + public function apply_changes() { |
|
| 824 | + $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 825 | + $this->changes = array(); |
|
| 826 | + } |
|
| 827 | + |
|
| 828 | + /** |
|
| 829 | + * Prefix for action and filter hooks on data. |
|
| 830 | + * |
|
| 831 | + * @since 1.0.19 |
|
| 832 | + * @return string |
|
| 833 | + */ |
|
| 834 | + protected function get_hook_prefix() { |
|
| 835 | + return 'wpinv_get_' . $this->object_type . '_'; |
|
| 836 | + } |
|
| 837 | + |
|
| 838 | + /** |
|
| 839 | + * Gets a prop for a getter method. |
|
| 840 | + * |
|
| 841 | + * Gets the value from either current pending changes, or the data itself. |
|
| 842 | + * Context controls what happens to the value before it's returned. |
|
| 843 | + * |
|
| 844 | + * @since 1.0.19 |
|
| 845 | + * @param string $prop Name of prop to get. |
|
| 846 | + * @param string $context What the value is for. Valid values are view and edit. |
|
| 847 | + * @return mixed |
|
| 848 | + */ |
|
| 849 | + protected function get_prop( $prop, $context = 'view' ) { |
|
| 850 | + $value = null; |
|
| 851 | + |
|
| 852 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | + $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 854 | + |
|
| 855 | + if ( 'view' === $context ) { |
|
| 856 | + $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 857 | + } |
|
| 858 | + } |
|
| 859 | + |
|
| 860 | + return $value; |
|
| 861 | + } |
|
| 862 | + |
|
| 863 | + /** |
|
| 864 | + * Sets a date prop whilst handling formatting and datetime objects. |
|
| 865 | + * |
|
| 866 | + * @since 1.0.19 |
|
| 867 | + * @param string $prop Name of prop to set. |
|
| 868 | + * @param string|integer $value Value of the prop. |
|
| 869 | + */ |
|
| 870 | + protected function set_date_prop( $prop, $value ) { |
|
| 871 | + |
|
| 872 | + if ( empty( $value ) ) { |
|
| 873 | + $this->set_prop( $prop, null ); |
|
| 874 | + return; |
|
| 875 | + } |
|
| 876 | + $this->set_prop( $prop, $value ); |
|
| 877 | + |
|
| 878 | + } |
|
| 879 | + |
|
| 880 | + /** |
|
| 881 | + * When invalid data is found, throw an exception unless reading from the DB. |
|
| 882 | + * |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @param string $code Error code. |
|
| 885 | + * @param string $message Error message. |
|
| 886 | + */ |
|
| 887 | + protected function error( $code, $message ) { |
|
| 888 | + $this->last_error = $message; |
|
| 889 | + } |
|
| 890 | + |
|
| 891 | + /** |
|
| 892 | + * Checks if the object is saved in the database |
|
| 893 | + * |
|
| 894 | + * @since 1.0.19 |
|
| 895 | + * @return bool |
|
| 896 | + */ |
|
| 897 | + public function exists() { |
|
| 898 | + $id = $this->get_id(); |
|
| 899 | + return ! empty( $id ); |
|
| 900 | + } |
|
| 901 | 901 | |
| 902 | 902 | } |
@@ -63,8 +63,8 @@ discard block |
||
| 63 | 63 | 'getpaid-nonce' |
| 64 | 64 | ) |
| 65 | 65 | ); |
| 66 | - $anchor = __( 'Deactivate', 'invoicing' ); |
|
| 67 | - $title = esc_attr__( 'Are you sure you want to deactivate this discount?', 'invoicing' ); |
|
| 66 | + $anchor = __( 'Deactivate', 'invoicing' ); |
|
| 67 | + $title = esc_attr__( 'Are you sure you want to deactivate this discount?', 'invoicing' ); |
|
| 68 | 68 | $row_actions['deactivate'] = "<a href='$url' onclick='return confirm(\"$title\")'>$anchor</a>"; |
| 69 | 69 | |
| 70 | 70 | } else if( in_array( strtolower( $discount->post_status ), array( 'pending', 'draft' ) ) ) { |
@@ -81,8 +81,8 @@ discard block |
||
| 81 | 81 | 'getpaid-nonce' |
| 82 | 82 | ) |
| 83 | 83 | ); |
| 84 | - $anchor = __( 'Activate', 'invoicing' ); |
|
| 85 | - $title = esc_attr__( 'Are you sure you want to activate this discount?', 'invoicing' ); |
|
| 84 | + $anchor = __( 'Activate', 'invoicing' ); |
|
| 85 | + $title = esc_attr__( 'Are you sure you want to activate this discount?', 'invoicing' ); |
|
| 86 | 86 | $row_actions['activate'] = "<a href='$url' onclick='return confirm(\"$title\")'>$anchor</a>"; |
| 87 | 87 | |
| 88 | 88 | } |
@@ -99,8 +99,8 @@ discard block |
||
| 99 | 99 | 'getpaid-nonce' |
| 100 | 100 | ) |
| 101 | 101 | ); |
| 102 | - $anchor = __( 'Delete', 'invoicing' ); |
|
| 103 | - $title = esc_attr__( 'Are you sure you want to delete this discount?', 'invoicing' ); |
|
| 102 | + $anchor = __( 'Delete', 'invoicing' ); |
|
| 103 | + $title = esc_attr__( 'Are you sure you want to delete this discount?', 'invoicing' ); |
|
| 104 | 104 | $row_actions['delete'] = "<a href='$url' onclick='return confirm(\"$title\")'>$anchor</a>"; |
| 105 | 105 | |
| 106 | 106 | $row_actions = apply_filters( 'wpinv_discount_row_actions', $row_actions, $discount ); |
@@ -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( wpinv_format_amount( $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( wpinv_format_amount( $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 | } |
@@ -56,7 +56,7 @@ |
||
| 56 | 56 | } |
| 57 | 57 | |
| 58 | 58 | function wpinv_admin_messages() { |
| 59 | - settings_errors( 'wpinv-notices' ); |
|
| 59 | + settings_errors( 'wpinv-notices' ); |
|
| 60 | 60 | } |
| 61 | 61 | add_action( 'admin_notices', 'wpinv_admin_messages' ); |
| 62 | 62 | |
