@@ -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,77 +11,77 @@ discard block |
||
| 11 | 11 | */ |
| 12 | 12 | class AUI_Component_Pagination { |
| 13 | 13 | |
| 14 | - /** |
|
| 15 | - * Build the component. |
|
| 16 | - * |
|
| 17 | - * @param array $args |
|
| 18 | - * |
|
| 19 | - * @return string The rendered component. |
|
| 20 | - */ |
|
| 21 | - public static function get( $args = array() ) { |
|
| 22 | - global $wp_query; |
|
| 23 | - |
|
| 24 | - $defaults = array( |
|
| 25 | - 'class' => '', |
|
| 26 | - 'mid_size' => 2, |
|
| 27 | - 'prev_text' => '<i class="fas fa-chevron-left"></i>', |
|
| 28 | - 'next_text' => '<i class="fas fa-chevron-right"></i>', |
|
| 29 | - 'screen_reader_text' => __( 'Posts navigation','aui' ), |
|
| 30 | - 'before_paging' => '', |
|
| 31 | - 'after_paging' => '', |
|
| 32 | - 'type' => 'array', |
|
| 33 | - 'total' => isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1, |
|
| 34 | - 'links' => array() // an array of links if using custom links, this includes the a tag. |
|
| 35 | - ); |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Parse incoming $args into an array and merge it with $defaults |
|
| 39 | - */ |
|
| 40 | - $args = wp_parse_args( $args, $defaults ); |
|
| 41 | - |
|
| 42 | - $output = ''; |
|
| 43 | - |
|
| 44 | - // Don't print empty markup if there's only one page. |
|
| 45 | - if ( $args['total'] > 1 ) { |
|
| 46 | - |
|
| 47 | - // Set up paginated links. |
|
| 48 | - $links = !empty( $args['links'] ) ? $args['links'] : paginate_links( $args ); |
|
| 49 | - |
|
| 50 | - $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 51 | - |
|
| 52 | - // make the output bootstrap ready |
|
| 53 | - $links_html = "<ul class='pagination m-0 p-0 $class'>"; |
|
| 54 | - if ( ! empty( $links ) ) { |
|
| 55 | - foreach ( $links as $link ) { |
|
| 56 | - $active = strpos( $link, 'current' ) !== false ? 'active' : ''; |
|
| 57 | - $links_html .= "<li class='page-item $active'>"; |
|
| 58 | - $links_html .= str_replace( "page-numbers", "page-link", $link ); |
|
| 59 | - $links_html .= "</li>"; |
|
| 60 | - } |
|
| 61 | - } |
|
| 62 | - $links_html .= "</ul>"; |
|
| 63 | - |
|
| 64 | - if ( $links ) { |
|
| 65 | - $output .= '<section class="px-0 py-2 w-100">'; |
|
| 66 | - $output .= _navigation_markup( $links_html, 'aui-pagination', $args['screen_reader_text'] ); |
|
| 67 | - $output .= '</section>'; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - $output = str_replace( "screen-reader-text", "screen-reader-text sr-only", $output ); |
|
| 71 | - $output = str_replace( "nav-links", "aui-nav-links", $output ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - if ( $output ) { |
|
| 75 | - if ( ! empty( $args['before_paging'] ) ) { |
|
| 76 | - $output = $args['before_paging'] . $output; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - if ( ! empty( $args['after_paging'] ) ) { |
|
| 80 | - $output = $output . $args['after_paging']; |
|
| 81 | - } |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - return $output; |
|
| 85 | - } |
|
| 14 | + /** |
|
| 15 | + * Build the component. |
|
| 16 | + * |
|
| 17 | + * @param array $args |
|
| 18 | + * |
|
| 19 | + * @return string The rendered component. |
|
| 20 | + */ |
|
| 21 | + public static function get( $args = array() ) { |
|
| 22 | + global $wp_query; |
|
| 23 | + |
|
| 24 | + $defaults = array( |
|
| 25 | + 'class' => '', |
|
| 26 | + 'mid_size' => 2, |
|
| 27 | + 'prev_text' => '<i class="fas fa-chevron-left"></i>', |
|
| 28 | + 'next_text' => '<i class="fas fa-chevron-right"></i>', |
|
| 29 | + 'screen_reader_text' => __( 'Posts navigation','aui' ), |
|
| 30 | + 'before_paging' => '', |
|
| 31 | + 'after_paging' => '', |
|
| 32 | + 'type' => 'array', |
|
| 33 | + 'total' => isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1, |
|
| 34 | + 'links' => array() // an array of links if using custom links, this includes the a tag. |
|
| 35 | + ); |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Parse incoming $args into an array and merge it with $defaults |
|
| 39 | + */ |
|
| 40 | + $args = wp_parse_args( $args, $defaults ); |
|
| 41 | + |
|
| 42 | + $output = ''; |
|
| 43 | + |
|
| 44 | + // Don't print empty markup if there's only one page. |
|
| 45 | + if ( $args['total'] > 1 ) { |
|
| 46 | + |
|
| 47 | + // Set up paginated links. |
|
| 48 | + $links = !empty( $args['links'] ) ? $args['links'] : paginate_links( $args ); |
|
| 49 | + |
|
| 50 | + $class = !empty($args['class']) ? $args['class'] : ''; |
|
| 51 | + |
|
| 52 | + // make the output bootstrap ready |
|
| 53 | + $links_html = "<ul class='pagination m-0 p-0 $class'>"; |
|
| 54 | + if ( ! empty( $links ) ) { |
|
| 55 | + foreach ( $links as $link ) { |
|
| 56 | + $active = strpos( $link, 'current' ) !== false ? 'active' : ''; |
|
| 57 | + $links_html .= "<li class='page-item $active'>"; |
|
| 58 | + $links_html .= str_replace( "page-numbers", "page-link", $link ); |
|
| 59 | + $links_html .= "</li>"; |
|
| 60 | + } |
|
| 61 | + } |
|
| 62 | + $links_html .= "</ul>"; |
|
| 63 | + |
|
| 64 | + if ( $links ) { |
|
| 65 | + $output .= '<section class="px-0 py-2 w-100">'; |
|
| 66 | + $output .= _navigation_markup( $links_html, 'aui-pagination', $args['screen_reader_text'] ); |
|
| 67 | + $output .= '</section>'; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + $output = str_replace( "screen-reader-text", "screen-reader-text sr-only", $output ); |
|
| 71 | + $output = str_replace( "nav-links", "aui-nav-links", $output ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + if ( $output ) { |
|
| 75 | + if ( ! empty( $args['before_paging'] ) ) { |
|
| 76 | + $output = $args['before_paging'] . $output; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + if ( ! empty( $args['after_paging'] ) ) { |
|
| 80 | + $output = $output . $args['after_paging']; |
|
| 81 | + } |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + return $output; |
|
| 85 | + } |
|
| 86 | 86 | |
| 87 | 87 | } |
| 88 | 88 | \ 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,249 +11,249 @@ 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 | - * |
|
| 19 | - * @return string |
|
| 20 | - */ |
|
| 21 | - public static function name($text,$multiple = false){ |
|
| 22 | - $output = ''; |
|
| 23 | - |
|
| 24 | - if($text){ |
|
| 25 | - $is_multiple = strpos($text, '[]') !== false || (strpos($text, '[]') === false && $multiple ) ? '[]' : ''; |
|
| 26 | - $output = ' name="'.sanitize_html_class($text).$is_multiple.'" '; |
|
| 27 | - } |
|
| 28 | - |
|
| 29 | - return $output; |
|
| 30 | - } |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * A component helper for generating a item id. |
|
| 34 | - * |
|
| 35 | - * @param $text string The text to be used as the value. |
|
| 36 | - * |
|
| 37 | - * @return string The sanitized item. |
|
| 38 | - */ |
|
| 39 | - public static function id($text){ |
|
| 40 | - $output = ''; |
|
| 41 | - |
|
| 42 | - if($text){ |
|
| 43 | - $output = ' id="'.sanitize_html_class($text).'" '; |
|
| 44 | - } |
|
| 45 | - |
|
| 46 | - return $output; |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * A component helper for generating a item title. |
|
| 51 | - * |
|
| 52 | - * @param $text string The text to be used as the value. |
|
| 53 | - * |
|
| 54 | - * @return string The sanitized item. |
|
| 55 | - */ |
|
| 56 | - public static function title($text){ |
|
| 57 | - $output = ''; |
|
| 58 | - |
|
| 59 | - if($text){ |
|
| 60 | - $output = ' title="'.esc_attr($text).'" '; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - return $output; |
|
| 64 | - } |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * A component helper for generating a item value. |
|
| 68 | - * |
|
| 69 | - * @param $text string The text to be used as the value. |
|
| 70 | - * |
|
| 71 | - * @return string The sanitized item. |
|
| 72 | - */ |
|
| 73 | - public static function value($text){ |
|
| 74 | - $output = ''; |
|
| 75 | - |
|
| 76 | - if($text){ |
|
| 77 | - $output = ' value="'.sanitize_text_field($text).'" '; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - return $output; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * A component helper for generating a item class attribute. |
|
| 85 | - * |
|
| 86 | - * @param $text string The text to be used as the value. |
|
| 87 | - * |
|
| 88 | - * @return string The sanitized item. |
|
| 89 | - */ |
|
| 90 | - public static function class_attr($text){ |
|
| 91 | - $output = ''; |
|
| 92 | - |
|
| 93 | - if($text){ |
|
| 94 | - $classes = self::esc_classes($text); |
|
| 95 | - if(!empty($classes)){ |
|
| 96 | - $output = ' class="'.$classes.'" '; |
|
| 97 | - } |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - return $output; |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Escape a string of classes. |
|
| 105 | - * |
|
| 106 | - * @param $text |
|
| 107 | - * |
|
| 108 | - * @return string |
|
| 109 | - */ |
|
| 110 | - public static function esc_classes($text){ |
|
| 111 | - $output = ''; |
|
| 112 | - |
|
| 113 | - if($text){ |
|
| 114 | - $classes = explode(" ",$text); |
|
| 115 | - $classes = array_map("trim",$classes); |
|
| 116 | - $classes = array_map("sanitize_html_class",$classes); |
|
| 117 | - if(!empty($classes)){ |
|
| 118 | - $output = implode(" ",$classes); |
|
| 119 | - } |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - return $output; |
|
| 123 | - |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * @param $args |
|
| 128 | - * |
|
| 129 | - * @return string |
|
| 130 | - */ |
|
| 131 | - public static function data_attributes($args){ |
|
| 132 | - $output = ''; |
|
| 133 | - |
|
| 134 | - if(!empty($args)){ |
|
| 135 | - |
|
| 136 | - foreach($args as $key => $val){ |
|
| 137 | - if(substr( $key, 0, 5 ) === "data-"){ |
|
| 138 | - $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 139 | - } |
|
| 140 | - } |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - return $output; |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * @param $args |
|
| 148 | - * |
|
| 149 | - * @return string |
|
| 150 | - */ |
|
| 151 | - public static function aria_attributes($args){ |
|
| 152 | - $output = ''; |
|
| 153 | - |
|
| 154 | - if(!empty($args)){ |
|
| 155 | - |
|
| 156 | - foreach($args as $key => $val){ |
|
| 157 | - if(substr( $key, 0, 5 ) === "aria-"){ |
|
| 158 | - $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 159 | - } |
|
| 160 | - } |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - return $output; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Build a font awesome icon from a class. |
|
| 168 | - * |
|
| 169 | - * @param $class |
|
| 170 | - * @param bool $space_after |
|
| 171 | - * @param array $extra_attributes An array of extra attributes. |
|
| 172 | - * |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public static function icon($class,$space_after = false, $extra_attributes = array()){ |
|
| 176 | - $output = ''; |
|
| 177 | - |
|
| 178 | - if($class){ |
|
| 179 | - $classes = self::esc_classes($class); |
|
| 180 | - if(!empty($classes)){ |
|
| 181 | - $output = '<i class="'.$classes.'" '; |
|
| 182 | - // extra attributes |
|
| 183 | - if(!empty($extra_attributes)){ |
|
| 184 | - $output .= AUI_Component_Helper::extra_attributes($extra_attributes); |
|
| 185 | - } |
|
| 186 | - $output .= '></i>'; |
|
| 187 | - if($space_after){ |
|
| 188 | - $output .= " "; |
|
| 189 | - } |
|
| 190 | - } |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - return $output; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * @param $args |
|
| 198 | - * |
|
| 199 | - * @return string |
|
| 200 | - */ |
|
| 201 | - public static function extra_attributes($args){ |
|
| 202 | - $output = ''; |
|
| 203 | - |
|
| 204 | - if(!empty($args)){ |
|
| 205 | - |
|
| 206 | - if( is_array($args) ){ |
|
| 207 | - foreach($args as $key => $val){ |
|
| 208 | - $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 209 | - } |
|
| 210 | - }else{ |
|
| 211 | - $output .= ' '.$args.' '; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - return $output; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * @param $args |
|
| 221 | - * |
|
| 222 | - * @return string |
|
| 223 | - */ |
|
| 224 | - public static function help_text($text){ |
|
| 225 | - $output = ''; |
|
| 226 | - |
|
| 227 | - if($text){ |
|
| 228 | - $output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>'; |
|
| 229 | - } |
|
| 230 | - |
|
| 231 | - |
|
| 232 | - return $output; |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - /** |
|
| 236 | - * Replace element require context with JS. |
|
| 237 | - * |
|
| 238 | - * @param $input |
|
| 239 | - * |
|
| 240 | - * @return string|void |
|
| 241 | - */ |
|
| 242 | - public static function element_require( $input ) { |
|
| 243 | - |
|
| 244 | - $input = str_replace( "'", '"', $input );// we only want double quotes |
|
| 245 | - |
|
| 246 | - $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array( |
|
| 247 | - "jQuery(form).find('[data-argument=\"", |
|
| 248 | - "\"]').find('input,select,textarea').val()", |
|
| 249 | - "\"]').find('input:checked').val()", |
|
| 250 | - ), $input ) ); |
|
| 251 | - |
|
| 252 | - if($output){ |
|
| 253 | - $output = ' data-element-require="'.$output.'" '; |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - return $output; |
|
| 257 | - } |
|
| 14 | + /** |
|
| 15 | + * A component helper for generating a input name. |
|
| 16 | + * |
|
| 17 | + * @param $text |
|
| 18 | + * |
|
| 19 | + * @return string |
|
| 20 | + */ |
|
| 21 | + public static function name($text,$multiple = false){ |
|
| 22 | + $output = ''; |
|
| 23 | + |
|
| 24 | + if($text){ |
|
| 25 | + $is_multiple = strpos($text, '[]') !== false || (strpos($text, '[]') === false && $multiple ) ? '[]' : ''; |
|
| 26 | + $output = ' name="'.sanitize_html_class($text).$is_multiple.'" '; |
|
| 27 | + } |
|
| 28 | + |
|
| 29 | + return $output; |
|
| 30 | + } |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * A component helper for generating a item id. |
|
| 34 | + * |
|
| 35 | + * @param $text string The text to be used as the value. |
|
| 36 | + * |
|
| 37 | + * @return string The sanitized item. |
|
| 38 | + */ |
|
| 39 | + public static function id($text){ |
|
| 40 | + $output = ''; |
|
| 41 | + |
|
| 42 | + if($text){ |
|
| 43 | + $output = ' id="'.sanitize_html_class($text).'" '; |
|
| 44 | + } |
|
| 45 | + |
|
| 46 | + return $output; |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * A component helper for generating a item title. |
|
| 51 | + * |
|
| 52 | + * @param $text string The text to be used as the value. |
|
| 53 | + * |
|
| 54 | + * @return string The sanitized item. |
|
| 55 | + */ |
|
| 56 | + public static function title($text){ |
|
| 57 | + $output = ''; |
|
| 58 | + |
|
| 59 | + if($text){ |
|
| 60 | + $output = ' title="'.esc_attr($text).'" '; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + return $output; |
|
| 64 | + } |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * A component helper for generating a item value. |
|
| 68 | + * |
|
| 69 | + * @param $text string The text to be used as the value. |
|
| 70 | + * |
|
| 71 | + * @return string The sanitized item. |
|
| 72 | + */ |
|
| 73 | + public static function value($text){ |
|
| 74 | + $output = ''; |
|
| 75 | + |
|
| 76 | + if($text){ |
|
| 77 | + $output = ' value="'.sanitize_text_field($text).'" '; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + return $output; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * A component helper for generating a item class attribute. |
|
| 85 | + * |
|
| 86 | + * @param $text string The text to be used as the value. |
|
| 87 | + * |
|
| 88 | + * @return string The sanitized item. |
|
| 89 | + */ |
|
| 90 | + public static function class_attr($text){ |
|
| 91 | + $output = ''; |
|
| 92 | + |
|
| 93 | + if($text){ |
|
| 94 | + $classes = self::esc_classes($text); |
|
| 95 | + if(!empty($classes)){ |
|
| 96 | + $output = ' class="'.$classes.'" '; |
|
| 97 | + } |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + return $output; |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Escape a string of classes. |
|
| 105 | + * |
|
| 106 | + * @param $text |
|
| 107 | + * |
|
| 108 | + * @return string |
|
| 109 | + */ |
|
| 110 | + public static function esc_classes($text){ |
|
| 111 | + $output = ''; |
|
| 112 | + |
|
| 113 | + if($text){ |
|
| 114 | + $classes = explode(" ",$text); |
|
| 115 | + $classes = array_map("trim",$classes); |
|
| 116 | + $classes = array_map("sanitize_html_class",$classes); |
|
| 117 | + if(!empty($classes)){ |
|
| 118 | + $output = implode(" ",$classes); |
|
| 119 | + } |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + return $output; |
|
| 123 | + |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * @param $args |
|
| 128 | + * |
|
| 129 | + * @return string |
|
| 130 | + */ |
|
| 131 | + public static function data_attributes($args){ |
|
| 132 | + $output = ''; |
|
| 133 | + |
|
| 134 | + if(!empty($args)){ |
|
| 135 | + |
|
| 136 | + foreach($args as $key => $val){ |
|
| 137 | + if(substr( $key, 0, 5 ) === "data-"){ |
|
| 138 | + $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 139 | + } |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + return $output; |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * @param $args |
|
| 148 | + * |
|
| 149 | + * @return string |
|
| 150 | + */ |
|
| 151 | + public static function aria_attributes($args){ |
|
| 152 | + $output = ''; |
|
| 153 | + |
|
| 154 | + if(!empty($args)){ |
|
| 155 | + |
|
| 156 | + foreach($args as $key => $val){ |
|
| 157 | + if(substr( $key, 0, 5 ) === "aria-"){ |
|
| 158 | + $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 159 | + } |
|
| 160 | + } |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + return $output; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Build a font awesome icon from a class. |
|
| 168 | + * |
|
| 169 | + * @param $class |
|
| 170 | + * @param bool $space_after |
|
| 171 | + * @param array $extra_attributes An array of extra attributes. |
|
| 172 | + * |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public static function icon($class,$space_after = false, $extra_attributes = array()){ |
|
| 176 | + $output = ''; |
|
| 177 | + |
|
| 178 | + if($class){ |
|
| 179 | + $classes = self::esc_classes($class); |
|
| 180 | + if(!empty($classes)){ |
|
| 181 | + $output = '<i class="'.$classes.'" '; |
|
| 182 | + // extra attributes |
|
| 183 | + if(!empty($extra_attributes)){ |
|
| 184 | + $output .= AUI_Component_Helper::extra_attributes($extra_attributes); |
|
| 185 | + } |
|
| 186 | + $output .= '></i>'; |
|
| 187 | + if($space_after){ |
|
| 188 | + $output .= " "; |
|
| 189 | + } |
|
| 190 | + } |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + return $output; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * @param $args |
|
| 198 | + * |
|
| 199 | + * @return string |
|
| 200 | + */ |
|
| 201 | + public static function extra_attributes($args){ |
|
| 202 | + $output = ''; |
|
| 203 | + |
|
| 204 | + if(!empty($args)){ |
|
| 205 | + |
|
| 206 | + if( is_array($args) ){ |
|
| 207 | + foreach($args as $key => $val){ |
|
| 208 | + $output .= ' '.sanitize_html_class($key).'="'.esc_attr($val).'" '; |
|
| 209 | + } |
|
| 210 | + }else{ |
|
| 211 | + $output .= ' '.$args.' '; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + return $output; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * @param $args |
|
| 221 | + * |
|
| 222 | + * @return string |
|
| 223 | + */ |
|
| 224 | + public static function help_text($text){ |
|
| 225 | + $output = ''; |
|
| 226 | + |
|
| 227 | + if($text){ |
|
| 228 | + $output .= '<small class="form-text text-muted">'.wp_kses_post($text).'</small>'; |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + |
|
| 232 | + return $output; |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + /** |
|
| 236 | + * Replace element require context with JS. |
|
| 237 | + * |
|
| 238 | + * @param $input |
|
| 239 | + * |
|
| 240 | + * @return string|void |
|
| 241 | + */ |
|
| 242 | + public static function element_require( $input ) { |
|
| 243 | + |
|
| 244 | + $input = str_replace( "'", '"', $input );// we only want double quotes |
|
| 245 | + |
|
| 246 | + $output = esc_attr( str_replace( array( "[%", "%]", "%:checked]" ), array( |
|
| 247 | + "jQuery(form).find('[data-argument=\"", |
|
| 248 | + "\"]').find('input,select,textarea').val()", |
|
| 249 | + "\"]').find('input:checked').val()", |
|
| 250 | + ), $input ) ); |
|
| 251 | + |
|
| 252 | + if($output){ |
|
| 253 | + $output = ' data-element-require="'.$output.'" '; |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + return $output; |
|
| 257 | + } |
|
| 258 | 258 | |
| 259 | 259 | } |
| 260 | 260 | \ No newline at end of file |
@@ -14,7 +14,7 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | function wpinv_subscriptions_page() { |
| 16 | 16 | |
| 17 | - ?> |
|
| 17 | + ?> |
|
| 18 | 18 | |
| 19 | 19 | <div class="wrap"> |
| 20 | 20 | <h1><?php echo esc_html( get_admin_page_title() ); ?></h1> |
@@ -22,27 +22,27 @@ discard block |
||
| 22 | 22 | |
| 23 | 23 | <?php |
| 24 | 24 | |
| 25 | - // Verify user permissions. |
|
| 26 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 25 | + // Verify user permissions. |
|
| 26 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 27 | 27 | |
| 28 | - echo aui()->alert( |
|
| 29 | - array( |
|
| 30 | - 'type' => 'danger', |
|
| 31 | - 'content' => __( 'You are not permitted to view this page.', 'invoicing' ), |
|
| 32 | - ) |
|
| 33 | - ); |
|
| 28 | + echo aui()->alert( |
|
| 29 | + array( |
|
| 30 | + 'type' => 'danger', |
|
| 31 | + 'content' => __( 'You are not permitted to view this page.', 'invoicing' ), |
|
| 32 | + ) |
|
| 33 | + ); |
|
| 34 | 34 | |
| 35 | - } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) { |
|
| 35 | + } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) { |
|
| 36 | 36 | |
| 37 | - // Display a single subscription. |
|
| 38 | - wpinv_recurring_subscription_details(); |
|
| 39 | - } else { |
|
| 37 | + // Display a single subscription. |
|
| 38 | + wpinv_recurring_subscription_details(); |
|
| 39 | + } else { |
|
| 40 | 40 | |
| 41 | - // Display a list of available subscriptions. |
|
| 42 | - getpaid_print_subscriptions_list(); |
|
| 43 | - } |
|
| 41 | + // Display a list of available subscriptions. |
|
| 42 | + getpaid_print_subscriptions_list(); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - ?> |
|
| 45 | + ?> |
|
| 46 | 46 | |
| 47 | 47 | </div> |
| 48 | 48 | </div> |
@@ -59,10 +59,10 @@ discard block |
||
| 59 | 59 | */ |
| 60 | 60 | function getpaid_print_subscriptions_list() { |
| 61 | 61 | |
| 62 | - $subscribers_table = new WPInv_Subscriptions_List_Table(); |
|
| 63 | - $subscribers_table->prepare_items(); |
|
| 62 | + $subscribers_table = new WPInv_Subscriptions_List_Table(); |
|
| 63 | + $subscribers_table->prepare_items(); |
|
| 64 | 64 | |
| 65 | - ?> |
|
| 65 | + ?> |
|
| 66 | 66 | <form id="subscribers-filter" class="bsui" method="get"> |
| 67 | 67 | <input type="hidden" name="page" value="wpinv-subscriptions" /> |
| 68 | 68 | <?php $subscribers_table->views(); ?> |
@@ -80,27 +80,27 @@ discard block |
||
| 80 | 80 | */ |
| 81 | 81 | function wpinv_recurring_subscription_details() { |
| 82 | 82 | |
| 83 | - // Fetch the subscription. |
|
| 84 | - $sub = new WPInv_Subscription( (int) $_GET['id'] ); |
|
| 85 | - if ( ! $sub->get_id() ) { |
|
| 83 | + // Fetch the subscription. |
|
| 84 | + $sub = new WPInv_Subscription( (int) $_GET['id'] ); |
|
| 85 | + if ( ! $sub->get_id() ) { |
|
| 86 | 86 | |
| 87 | - echo aui()->alert( |
|
| 88 | - array( |
|
| 89 | - 'type' => 'danger', |
|
| 90 | - 'content' => __( 'Subscription not found.', 'invoicing' ), |
|
| 91 | - ) |
|
| 92 | - ); |
|
| 87 | + echo aui()->alert( |
|
| 88 | + array( |
|
| 89 | + 'type' => 'danger', |
|
| 90 | + 'content' => __( 'Subscription not found.', 'invoicing' ), |
|
| 91 | + ) |
|
| 92 | + ); |
|
| 93 | 93 | |
| 94 | - return; |
|
| 95 | - } |
|
| 94 | + return; |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | - // Use metaboxes to display the subscription details. |
|
| 98 | - add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' ); |
|
| 99 | - add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' ); |
|
| 100 | - add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' ); |
|
| 101 | - do_action( 'getpaid_admin_single_subscription_register_metabox', $sub ); |
|
| 97 | + // Use metaboxes to display the subscription details. |
|
| 98 | + add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' ); |
|
| 99 | + add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' ); |
|
| 100 | + add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' ); |
|
| 101 | + do_action( 'getpaid_admin_single_subscription_register_metabox', $sub ); |
|
| 102 | 102 | |
| 103 | - ?> |
|
| 103 | + ?> |
|
| 104 | 104 | |
| 105 | 105 | <form method="post" action="<?php echo admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $sub->get_id() ) ); ?>"> |
| 106 | 106 | |
@@ -140,41 +140,41 @@ discard block |
||
| 140 | 140 | */ |
| 141 | 141 | function getpaid_admin_subscription_details_metabox( $sub ) { |
| 142 | 142 | |
| 143 | - // Prepare subscription detail columns. |
|
| 144 | - $fields = apply_filters( |
|
| 145 | - 'getpaid_subscription_admin_page_fields', |
|
| 146 | - array( |
|
| 147 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 148 | - 'customer' => __( 'Customer', 'invoicing' ), |
|
| 149 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
| 150 | - 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 151 | - 'renews_on' => __( 'Next Payment', 'invoicing' ), |
|
| 152 | - 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 153 | - 'item' => __( 'Item', 'invoicing' ), |
|
| 154 | - 'gateway' => __( 'Payment Method', 'invoicing' ), |
|
| 155 | - 'profile_id' => __( 'Profile ID', 'invoicing' ), |
|
| 156 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 157 | - ) |
|
| 158 | - ); |
|
| 159 | - |
|
| 160 | - if ( ! $sub->is_active() ) { |
|
| 161 | - |
|
| 162 | - if ( isset( $fields['renews_on'] ) ) { |
|
| 163 | - unset( $fields['renews_on'] ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - if ( isset( $fields['gateway'] ) ) { |
|
| 167 | - unset( $fields['gateway'] ); |
|
| 168 | - } |
|
| 143 | + // Prepare subscription detail columns. |
|
| 144 | + $fields = apply_filters( |
|
| 145 | + 'getpaid_subscription_admin_page_fields', |
|
| 146 | + array( |
|
| 147 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 148 | + 'customer' => __( 'Customer', 'invoicing' ), |
|
| 149 | + 'amount' => __( 'Amount', 'invoicing' ), |
|
| 150 | + 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 151 | + 'renews_on' => __( 'Next Payment', 'invoicing' ), |
|
| 152 | + 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 153 | + 'item' => __( 'Item', 'invoicing' ), |
|
| 154 | + 'gateway' => __( 'Payment Method', 'invoicing' ), |
|
| 155 | + 'profile_id' => __( 'Profile ID', 'invoicing' ), |
|
| 156 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 157 | + ) |
|
| 158 | + ); |
|
| 159 | + |
|
| 160 | + if ( ! $sub->is_active() ) { |
|
| 161 | + |
|
| 162 | + if ( isset( $fields['renews_on'] ) ) { |
|
| 163 | + unset( $fields['renews_on'] ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + if ( isset( $fields['gateway'] ) ) { |
|
| 167 | + unset( $fields['gateway'] ); |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - } |
|
| 170 | + } |
|
| 171 | 171 | |
| 172 | - $profile_id = $sub->get_profile_id(); |
|
| 173 | - if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) { |
|
| 174 | - unset( $fields['profile_id'] ); |
|
| 175 | - } |
|
| 172 | + $profile_id = $sub->get_profile_id(); |
|
| 173 | + if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) { |
|
| 174 | + unset( $fields['profile_id'] ); |
|
| 175 | + } |
|
| 176 | 176 | |
| 177 | - ?> |
|
| 177 | + ?> |
|
| 178 | 178 | |
| 179 | 179 | <table class="table table-borderless" style="font-size: 14px;"> |
| 180 | 180 | <tbody> |
@@ -208,20 +208,20 @@ discard block |
||
| 208 | 208 | */ |
| 209 | 209 | function getpaid_admin_subscription_metabox_display_customer( $subscription ) { |
| 210 | 210 | |
| 211 | - $username = __( '(Missing User)', 'invoicing' ); |
|
| 211 | + $username = __( '(Missing User)', 'invoicing' ); |
|
| 212 | 212 | |
| 213 | - $user = get_userdata( $subscription->get_customer_id() ); |
|
| 214 | - if ( $user ) { |
|
| 213 | + $user = get_userdata( $subscription->get_customer_id() ); |
|
| 214 | + if ( $user ) { |
|
| 215 | 215 | |
| 216 | - $username = sprintf( |
|
| 217 | - '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 218 | - absint( $user->ID ), |
|
| 219 | - ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 220 | - ); |
|
| 216 | + $username = sprintf( |
|
| 217 | + '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 218 | + absint( $user->ID ), |
|
| 219 | + ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 220 | + ); |
|
| 221 | 221 | |
| 222 | - } |
|
| 222 | + } |
|
| 223 | 223 | |
| 224 | - echo $username; |
|
| 224 | + echo $username; |
|
| 225 | 225 | } |
| 226 | 226 | add_action( 'getpaid_subscription_admin_display_customer', 'getpaid_admin_subscription_metabox_display_customer' ); |
| 227 | 227 | |
@@ -231,8 +231,8 @@ discard block |
||
| 231 | 231 | * @param WPInv_Subscription $subscription |
| 232 | 232 | */ |
| 233 | 233 | function getpaid_admin_subscription_metabox_display_amount( $subscription ) { |
| 234 | - $amount = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) ); |
|
| 235 | - echo "<span>$amount</span>"; |
|
| 234 | + $amount = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) ); |
|
| 235 | + echo "<span>$amount</span>"; |
|
| 236 | 236 | } |
| 237 | 237 | add_action( 'getpaid_subscription_admin_display_amount', 'getpaid_admin_subscription_metabox_display_amount' ); |
| 238 | 238 | |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | * @param WPInv_Subscription $subscription |
| 243 | 243 | */ |
| 244 | 244 | function getpaid_admin_subscription_metabox_display_id( $subscription ) { |
| 245 | - echo '#' . absint( $subscription->get_id() ); |
|
| 245 | + echo '#' . absint( $subscription->get_id() ); |
|
| 246 | 246 | } |
| 247 | 247 | add_action( 'getpaid_subscription_admin_display_subscription', 'getpaid_admin_subscription_metabox_display_id' ); |
| 248 | 248 | |
@@ -252,7 +252,7 @@ discard block |
||
| 252 | 252 | * @param WPInv_Subscription $subscription |
| 253 | 253 | */ |
| 254 | 254 | function getpaid_admin_subscription_metabox_display_start_date( $subscription ) { |
| 255 | - echo getpaid_format_date_value( $subscription->get_date_created() ); |
|
| 255 | + echo getpaid_format_date_value( $subscription->get_date_created() ); |
|
| 256 | 256 | } |
| 257 | 257 | add_action( 'getpaid_subscription_admin_display_start_date', 'getpaid_admin_subscription_metabox_display_start_date' ); |
| 258 | 258 | |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | * @param WPInv_Subscription $subscription |
| 263 | 263 | */ |
| 264 | 264 | function getpaid_admin_subscription_metabox_display_renews_on( $subscription ) { |
| 265 | - echo getpaid_format_date_value( $subscription->get_expiration() ); |
|
| 265 | + echo getpaid_format_date_value( $subscription->get_expiration() ); |
|
| 266 | 266 | } |
| 267 | 267 | add_action( 'getpaid_subscription_admin_display_renews_on', 'getpaid_admin_subscription_metabox_display_renews_on' ); |
| 268 | 268 | |
@@ -272,8 +272,8 @@ discard block |
||
| 272 | 272 | * @param WPInv_Subscription $subscription |
| 273 | 273 | */ |
| 274 | 274 | function getpaid_admin_subscription_metabox_display_renewals( $subscription ) { |
| 275 | - $max_bills = $subscription->get_bill_times(); |
|
| 276 | - echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 275 | + $max_bills = $subscription->get_bill_times(); |
|
| 276 | + echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 277 | 277 | } |
| 278 | 278 | add_action( 'getpaid_subscription_admin_display_renewals', 'getpaid_admin_subscription_metabox_display_renewals' ); |
| 279 | 279 | /** |
@@ -283,16 +283,16 @@ discard block |
||
| 283 | 283 | */ |
| 284 | 284 | function getpaid_admin_subscription_metabox_display_item( $subscription ) { |
| 285 | 285 | |
| 286 | - $item = get_post( $subscription->get_product_id() ); |
|
| 286 | + $item = get_post( $subscription->get_product_id() ); |
|
| 287 | 287 | |
| 288 | - if ( ! empty( $item ) ) { |
|
| 289 | - $link = get_edit_post_link( $item ); |
|
| 290 | - $link = esc_url( $link ); |
|
| 291 | - $name = esc_html( get_the_title( $item ) ); |
|
| 292 | - echo "<a href='$link'>$name</a>"; |
|
| 293 | - } else { |
|
| 294 | - echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() ); |
|
| 295 | - } |
|
| 288 | + if ( ! empty( $item ) ) { |
|
| 289 | + $link = get_edit_post_link( $item ); |
|
| 290 | + $link = esc_url( $link ); |
|
| 291 | + $name = esc_html( get_the_title( $item ) ); |
|
| 292 | + echo "<a href='$link'>$name</a>"; |
|
| 293 | + } else { |
|
| 294 | + echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() ); |
|
| 295 | + } |
|
| 296 | 296 | |
| 297 | 297 | } |
| 298 | 298 | add_action( 'getpaid_subscription_admin_display_item', 'getpaid_admin_subscription_metabox_display_item' ); |
@@ -304,13 +304,13 @@ discard block |
||
| 304 | 304 | */ |
| 305 | 305 | function getpaid_admin_subscription_metabox_display_gateway( $subscription ) { |
| 306 | 306 | |
| 307 | - $gateway = $subscription->get_gateway(); |
|
| 307 | + $gateway = $subscription->get_gateway(); |
|
| 308 | 308 | |
| 309 | - if ( ! empty( $gateway ) ) { |
|
| 310 | - echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) ); |
|
| 311 | - } else { |
|
| 312 | - echo "—"; |
|
| 313 | - } |
|
| 309 | + if ( ! empty( $gateway ) ) { |
|
| 310 | + echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) ); |
|
| 311 | + } else { |
|
| 312 | + echo "—"; |
|
| 313 | + } |
|
| 314 | 314 | |
| 315 | 315 | } |
| 316 | 316 | add_action( 'getpaid_subscription_admin_display_gateway', 'getpaid_admin_subscription_metabox_display_gateway' ); |
@@ -321,7 +321,7 @@ discard block |
||
| 321 | 321 | * @param WPInv_Subscription $subscription |
| 322 | 322 | */ |
| 323 | 323 | function getpaid_admin_subscription_metabox_display_status( $subscription ) { |
| 324 | - echo $subscription->get_status_label_html(); |
|
| 324 | + echo $subscription->get_status_label_html(); |
|
| 325 | 325 | } |
| 326 | 326 | add_action( 'getpaid_subscription_admin_display_status', 'getpaid_admin_subscription_metabox_display_status' ); |
| 327 | 327 | |
@@ -332,14 +332,14 @@ discard block |
||
| 332 | 332 | */ |
| 333 | 333 | function getpaid_admin_subscription_metabox_display_profile_id( $subscription ) { |
| 334 | 334 | |
| 335 | - $profile_id = $subscription->get_profile_id(); |
|
| 335 | + $profile_id = $subscription->get_profile_id(); |
|
| 336 | 336 | |
| 337 | - if ( ! empty( $profile_id ) ) { |
|
| 338 | - $profile_id = sanitize_text_field( $profile_id ); |
|
| 339 | - echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription ); |
|
| 340 | - } else { |
|
| 341 | - echo "—"; |
|
| 342 | - } |
|
| 337 | + if ( ! empty( $profile_id ) ) { |
|
| 338 | + $profile_id = sanitize_text_field( $profile_id ); |
|
| 339 | + echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription ); |
|
| 340 | + } else { |
|
| 341 | + echo "—"; |
|
| 342 | + } |
|
| 343 | 343 | |
| 344 | 344 | } |
| 345 | 345 | add_action( 'getpaid_subscription_admin_display_profile_id', 'getpaid_admin_subscription_metabox_display_profile_id' ); |
@@ -351,39 +351,39 @@ discard block |
||
| 351 | 351 | */ |
| 352 | 352 | function getpaid_admin_subscription_update_metabox( $subscription ) { |
| 353 | 353 | |
| 354 | - ?> |
|
| 354 | + ?> |
|
| 355 | 355 | <div class="mt-3"> |
| 356 | 356 | |
| 357 | 357 | <?php |
| 358 | - echo aui()->select( |
|
| 359 | - array( |
|
| 360 | - 'options' => getpaid_get_subscription_statuses(), |
|
| 361 | - 'name' => 'subscription_status', |
|
| 362 | - 'id' => 'subscription_status_update_select', |
|
| 363 | - 'required' => true, |
|
| 364 | - 'no_wrap' => false, |
|
| 365 | - 'label' => __( 'Subscription Status', 'invoicing' ), |
|
| 366 | - 'help_text' => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ), |
|
| 367 | - 'select2' => true, |
|
| 368 | - 'value' => $subscription->get_status( 'edit' ), |
|
| 369 | - ) |
|
| 370 | - ); |
|
| 371 | - ?> |
|
| 358 | + echo aui()->select( |
|
| 359 | + array( |
|
| 360 | + 'options' => getpaid_get_subscription_statuses(), |
|
| 361 | + 'name' => 'subscription_status', |
|
| 362 | + 'id' => 'subscription_status_update_select', |
|
| 363 | + 'required' => true, |
|
| 364 | + 'no_wrap' => false, |
|
| 365 | + 'label' => __( 'Subscription Status', 'invoicing' ), |
|
| 366 | + 'help_text' => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ), |
|
| 367 | + 'select2' => true, |
|
| 368 | + 'value' => $subscription->get_status( 'edit' ), |
|
| 369 | + ) |
|
| 370 | + ); |
|
| 371 | + ?> |
|
| 372 | 372 | |
| 373 | 373 | <div class="mt-2 px-3 py-2 bg-light border-top" style="margin: -12px;"> |
| 374 | 374 | |
| 375 | 375 | <?php |
| 376 | - submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false ); |
|
| 376 | + submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false ); |
|
| 377 | 377 | |
| 378 | - $url = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) ); |
|
| 379 | - $anchor = __( 'Renew Subscription', 'invoicing' ); |
|
| 380 | - $title = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' ); |
|
| 378 | + $url = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) ); |
|
| 379 | + $anchor = __( 'Renew Subscription', 'invoicing' ); |
|
| 380 | + $title = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' ); |
|
| 381 | 381 | |
| 382 | - if ( $subscription->is_active() ) { |
|
| 383 | - echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>"; |
|
| 384 | - } |
|
| 382 | + if ( $subscription->is_active() ) { |
|
| 383 | + echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>"; |
|
| 384 | + } |
|
| 385 | 385 | |
| 386 | - echo '</div></div>'; |
|
| 386 | + echo '</div></div>'; |
|
| 387 | 387 | } |
| 388 | 388 | |
| 389 | 389 | /** |
@@ -393,33 +393,33 @@ discard block |
||
| 393 | 393 | */ |
| 394 | 394 | function getpaid_admin_subscription_invoice_details_metabox( $subscription ) { |
| 395 | 395 | |
| 396 | - $columns = apply_filters( |
|
| 397 | - 'getpaid_subscription_related_invoices_columns', |
|
| 398 | - array( |
|
| 399 | - 'invoice' => __( 'Invoice', 'invoicing' ), |
|
| 400 | - 'relationship' => __( 'Relationship', 'invoicing' ), |
|
| 401 | - 'date' => __( 'Date', 'invoicing' ), |
|
| 402 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 403 | - 'total' => __( 'Total', 'invoicing' ), |
|
| 404 | - ), |
|
| 405 | - $subscription |
|
| 406 | - ); |
|
| 407 | - |
|
| 408 | - // Prepare the invoices. |
|
| 409 | - $payments = $subscription->get_child_payments( ! is_admin() ); |
|
| 410 | - $parent = $subscription->get_parent_invoice(); |
|
| 411 | - |
|
| 412 | - if ( $parent->get_id() ) { |
|
| 413 | - $payments = array_merge( array( $parent ), $payments ); |
|
| 414 | - } |
|
| 396 | + $columns = apply_filters( |
|
| 397 | + 'getpaid_subscription_related_invoices_columns', |
|
| 398 | + array( |
|
| 399 | + 'invoice' => __( 'Invoice', 'invoicing' ), |
|
| 400 | + 'relationship' => __( 'Relationship', 'invoicing' ), |
|
| 401 | + 'date' => __( 'Date', 'invoicing' ), |
|
| 402 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 403 | + 'total' => __( 'Total', 'invoicing' ), |
|
| 404 | + ), |
|
| 405 | + $subscription |
|
| 406 | + ); |
|
| 407 | + |
|
| 408 | + // Prepare the invoices. |
|
| 409 | + $payments = $subscription->get_child_payments( ! is_admin() ); |
|
| 410 | + $parent = $subscription->get_parent_invoice(); |
|
| 411 | + |
|
| 412 | + if ( $parent->get_id() ) { |
|
| 413 | + $payments = array_merge( array( $parent ), $payments ); |
|
| 414 | + } |
|
| 415 | 415 | |
| 416 | - $table_class = 'w-100 bg-white'; |
|
| 416 | + $table_class = 'w-100 bg-white'; |
|
| 417 | 417 | |
| 418 | - if ( ! is_admin() ) { |
|
| 419 | - $table_class = 'table table-bordered table-striped'; |
|
| 420 | - } |
|
| 418 | + if ( ! is_admin() ) { |
|
| 419 | + $table_class = 'table table-bordered table-striped'; |
|
| 420 | + } |
|
| 421 | 421 | |
| 422 | - ?> |
|
| 422 | + ?> |
|
| 423 | 423 | <div class="m-0" style="overflow: auto;"> |
| 424 | 424 | |
| 425 | 425 | <table class="<?php echo $table_class; ?>"> |
@@ -427,13 +427,13 @@ discard block |
||
| 427 | 427 | <thead> |
| 428 | 428 | <tr> |
| 429 | 429 | <?php |
| 430 | - foreach ( $columns as $key => $label ) { |
|
| 431 | - $key = esc_attr( $key ); |
|
| 432 | - $label = sanitize_text_field( $label ); |
|
| 430 | + foreach ( $columns as $key => $label ) { |
|
| 431 | + $key = esc_attr( $key ); |
|
| 432 | + $label = sanitize_text_field( $label ); |
|
| 433 | 433 | |
| 434 | - echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark'>$label</th>"; |
|
| 435 | - } |
|
| 436 | - ?> |
|
| 434 | + echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark'>$label</th>"; |
|
| 435 | + } |
|
| 436 | + ?> |
|
| 437 | 437 | </tr> |
| 438 | 438 | </thead> |
| 439 | 439 | |
@@ -449,66 +449,66 @@ discard block |
||
| 449 | 449 | |
| 450 | 450 | <?php |
| 451 | 451 | |
| 452 | - foreach( $payments as $payment ) : |
|
| 452 | + foreach( $payments as $payment ) : |
|
| 453 | 453 | |
| 454 | - // Ensure that we have an invoice. |
|
| 455 | - $payment = new WPInv_Invoice( $payment ); |
|
| 454 | + // Ensure that we have an invoice. |
|
| 455 | + $payment = new WPInv_Invoice( $payment ); |
|
| 456 | 456 | |
| 457 | - // Abort if the invoice is invalid. |
|
| 458 | - if ( ! $payment->get_id() ) { |
|
| 459 | - continue; |
|
| 460 | - } |
|
| 457 | + // Abort if the invoice is invalid. |
|
| 458 | + if ( ! $payment->get_id() ) { |
|
| 459 | + continue; |
|
| 460 | + } |
|
| 461 | 461 | |
| 462 | - echo '<tr>'; |
|
| 462 | + echo '<tr>'; |
|
| 463 | 463 | |
| 464 | - foreach ( array_keys( $columns ) as $key ) { |
|
| 464 | + foreach ( array_keys( $columns ) as $key ) { |
|
| 465 | 465 | |
| 466 | - echo '<td class="p-2 text-left">'; |
|
| 466 | + echo '<td class="p-2 text-left">'; |
|
| 467 | 467 | |
| 468 | - switch( $key ) { |
|
| 468 | + switch( $key ) { |
|
| 469 | 469 | |
| 470 | - case 'total': |
|
| 471 | - echo '<strong>' . wpinv_price( wpinv_format_amount( wpinv_sanitize_amount( $payment->get_total() ) ), $payment->get_currency() ) . '</strong>'; |
|
| 472 | - break; |
|
| 470 | + case 'total': |
|
| 471 | + echo '<strong>' . wpinv_price( wpinv_format_amount( wpinv_sanitize_amount( $payment->get_total() ) ), $payment->get_currency() ) . '</strong>'; |
|
| 472 | + break; |
|
| 473 | 473 | |
| 474 | - case 'relationship': |
|
| 475 | - echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' ); |
|
| 476 | - break; |
|
| 474 | + case 'relationship': |
|
| 475 | + echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' ); |
|
| 476 | + break; |
|
| 477 | 477 | |
| 478 | - case 'date': |
|
| 479 | - echo getpaid_format_date_value( $payment->get_date_created() ); |
|
| 480 | - break; |
|
| 478 | + case 'date': |
|
| 479 | + echo getpaid_format_date_value( $payment->get_date_created() ); |
|
| 480 | + break; |
|
| 481 | 481 | |
| 482 | - case 'status': |
|
| 482 | + case 'status': |
|
| 483 | 483 | |
| 484 | - $status = $payment->get_status_nicename(); |
|
| 485 | - if ( is_admin() ) { |
|
| 486 | - $status = $payment->get_status_label_html(); |
|
| 487 | - } |
|
| 484 | + $status = $payment->get_status_nicename(); |
|
| 485 | + if ( is_admin() ) { |
|
| 486 | + $status = $payment->get_status_label_html(); |
|
| 487 | + } |
|
| 488 | 488 | |
| 489 | - echo $status; |
|
| 490 | - break; |
|
| 489 | + echo $status; |
|
| 490 | + break; |
|
| 491 | 491 | |
| 492 | - case 'invoice': |
|
| 493 | - $link = esc_url( get_edit_post_link( $payment->get_id() ) ); |
|
| 492 | + case 'invoice': |
|
| 493 | + $link = esc_url( get_edit_post_link( $payment->get_id() ) ); |
|
| 494 | 494 | |
| 495 | - if ( ! is_admin() ) { |
|
| 496 | - $link = esc_url( $payment->get_view_url() ); |
|
| 497 | - } |
|
| 495 | + if ( ! is_admin() ) { |
|
| 496 | + $link = esc_url( $payment->get_view_url() ); |
|
| 497 | + } |
|
| 498 | 498 | |
| 499 | - $invoice = sanitize_text_field( $payment->get_number() ); |
|
| 500 | - echo "<a href='$link'>$invoice</a>"; |
|
| 501 | - break; |
|
| 502 | - } |
|
| 499 | + $invoice = sanitize_text_field( $payment->get_number() ); |
|
| 500 | + echo "<a href='$link'>$invoice</a>"; |
|
| 501 | + break; |
|
| 502 | + } |
|
| 503 | 503 | |
| 504 | - echo '</td>'; |
|
| 504 | + echo '</td>'; |
|
| 505 | 505 | |
| 506 | - } |
|
| 506 | + } |
|
| 507 | 507 | |
| 508 | - echo '</tr>'; |
|
| 508 | + echo '</tr>'; |
|
| 509 | 509 | |
| 510 | - endforeach; |
|
| 511 | - ?> |
|
| 510 | + endforeach; |
|
| 511 | + ?> |
|
| 512 | 512 | |
| 513 | 513 | </tbody> |
| 514 | 514 | |
@@ -14,30 +14,30 @@ discard block |
||
| 14 | 14 | class WPInv_Invoice extends GetPaid_Data { |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | - * Which data store to load. |
|
| 18 | - * |
|
| 19 | - * @var string |
|
| 20 | - */ |
|
| 17 | + * Which data store to load. |
|
| 18 | + * |
|
| 19 | + * @var string |
|
| 20 | + */ |
|
| 21 | 21 | protected $data_store_name = 'invoice'; |
| 22 | 22 | |
| 23 | 23 | /** |
| 24 | - * This is the name of this object type. |
|
| 25 | - * |
|
| 26 | - * @var string |
|
| 27 | - */ |
|
| 24 | + * This is the name of this object type. |
|
| 25 | + * |
|
| 26 | + * @var string |
|
| 27 | + */ |
|
| 28 | 28 | protected $object_type = 'invoice'; |
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 32 | - * |
|
| 33 | - * @since 1.0.19 |
|
| 34 | - * @var array |
|
| 35 | - */ |
|
| 36 | - protected $data = array( |
|
| 37 | - 'parent_id' => 0, |
|
| 38 | - 'status' => 'wpi-pending', |
|
| 39 | - 'version' => '', |
|
| 40 | - 'date_created' => null, |
|
| 31 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 32 | + * |
|
| 33 | + * @since 1.0.19 |
|
| 34 | + * @var array |
|
| 35 | + */ |
|
| 36 | + protected $data = array( |
|
| 37 | + 'parent_id' => 0, |
|
| 38 | + 'status' => 'wpi-pending', |
|
| 39 | + 'version' => '', |
|
| 40 | + 'date_created' => null, |
|
| 41 | 41 | 'date_modified' => null, |
| 42 | 42 | 'due_date' => null, |
| 43 | 43 | 'completed_date' => null, |
@@ -79,22 +79,22 @@ discard block |
||
| 79 | 79 | 'transaction_id' => '', |
| 80 | 80 | 'currency' => '', |
| 81 | 81 | 'disable_taxes' => false, |
| 82 | - 'subscription_id' => null, |
|
| 83 | - 'remote_subscription_id' => null, |
|
| 84 | - 'is_viewed' => false, |
|
| 85 | - 'email_cc' => '', |
|
| 86 | - 'template' => 'quantity', // hours, amount only |
|
| 87 | - 'created_via' => null, |
|
| 82 | + 'subscription_id' => null, |
|
| 83 | + 'remote_subscription_id' => null, |
|
| 84 | + 'is_viewed' => false, |
|
| 85 | + 'email_cc' => '', |
|
| 86 | + 'template' => 'quantity', // hours, amount only |
|
| 87 | + 'created_via' => null, |
|
| 88 | 88 | ); |
| 89 | 89 | |
| 90 | 90 | /** |
| 91 | - * Stores meta in cache for future reads. |
|
| 92 | - * |
|
| 93 | - * A group must be set to to enable caching. |
|
| 94 | - * |
|
| 95 | - * @var string |
|
| 96 | - */ |
|
| 97 | - protected $cache_group = 'getpaid_invoices'; |
|
| 91 | + * Stores meta in cache for future reads. |
|
| 92 | + * |
|
| 93 | + * A group must be set to to enable caching. |
|
| 94 | + * |
|
| 95 | + * @var string |
|
| 96 | + */ |
|
| 97 | + protected $cache_group = 'getpaid_invoices'; |
|
| 98 | 98 | |
| 99 | 99 | /** |
| 100 | 100 | * Stores a reference to the original WP_Post object |
@@ -108,104 +108,104 @@ discard block |
||
| 108 | 108 | * |
| 109 | 109 | * @var int |
| 110 | 110 | */ |
| 111 | - protected $recurring_item = null; |
|
| 111 | + protected $recurring_item = null; |
|
| 112 | 112 | |
| 113 | - /** |
|
| 113 | + /** |
|
| 114 | 114 | * Stores an array of item totals. |
| 115 | - * |
|
| 116 | - * e.g $totals['discount'] = array( |
|
| 117 | - * 'initial' => 10, |
|
| 118 | - * 'recurring' => 10, |
|
| 119 | - * ) |
|
| 115 | + * |
|
| 116 | + * e.g $totals['discount'] = array( |
|
| 117 | + * 'initial' => 10, |
|
| 118 | + * 'recurring' => 10, |
|
| 119 | + * ) |
|
| 120 | 120 | * |
| 121 | 121 | * @var array |
| 122 | 122 | */ |
| 123 | - protected $totals = array(); |
|
| 123 | + protected $totals = array(); |
|
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Stores the status transition information. |
|
| 127 | - * |
|
| 128 | - * @since 1.0.19 |
|
| 129 | - * @var bool |
|
| 130 | - */ |
|
| 131 | - protected $status_transition = false; |
|
| 125 | + /** |
|
| 126 | + * Stores the status transition information. |
|
| 127 | + * |
|
| 128 | + * @since 1.0.19 |
|
| 129 | + * @var bool |
|
| 130 | + */ |
|
| 131 | + protected $status_transition = false; |
|
| 132 | 132 | |
| 133 | 133 | /** |
| 134 | - * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
| 135 | - * |
|
| 136 | - * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
| 137 | - */ |
|
| 134 | + * Get the invoice if ID is passed, otherwise the invoice is new and empty. |
|
| 135 | + * |
|
| 136 | + * @param int|string|object|WPInv_Invoice|WPInv_Legacy_Invoice|WP_Post $invoice Invoice id, key, transaction id, number or object to read. |
|
| 137 | + */ |
|
| 138 | 138 | public function __construct( $invoice = false ) { |
| 139 | 139 | |
| 140 | 140 | parent::__construct( $invoice ); |
| 141 | 141 | |
| 142 | - if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( $invoice ) ) ) { |
|
| 143 | - $this->set_id( $invoice ); |
|
| 144 | - } elseif ( $invoice instanceof self ) { |
|
| 145 | - $this->set_id( $invoice->get_id() ); |
|
| 146 | - } elseif ( ! empty( $invoice->ID ) ) { |
|
| 147 | - $this->set_id( $invoice->ID ); |
|
| 148 | - } elseif ( is_array( $invoice ) ) { |
|
| 149 | - $this->set_props( $invoice ); |
|
| 150 | - |
|
| 151 | - if ( isset( $invoice['ID'] ) ) { |
|
| 152 | - $this->set_id( $invoice['ID'] ); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
| 156 | - $this->set_id( $invoice_id ); |
|
| 157 | - } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
| 158 | - $this->set_id( $invoice_id ); |
|
| 159 | - } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
| 160 | - $this->set_id( $invoice_id ); |
|
| 161 | - }else { |
|
| 162 | - $this->set_object_read( true ); |
|
| 163 | - } |
|
| 142 | + if ( ! empty( $invoice ) && is_numeric( $invoice ) && getpaid_is_invoice_post_type( get_post_type( $invoice ) ) ) { |
|
| 143 | + $this->set_id( $invoice ); |
|
| 144 | + } elseif ( $invoice instanceof self ) { |
|
| 145 | + $this->set_id( $invoice->get_id() ); |
|
| 146 | + } elseif ( ! empty( $invoice->ID ) ) { |
|
| 147 | + $this->set_id( $invoice->ID ); |
|
| 148 | + } elseif ( is_array( $invoice ) ) { |
|
| 149 | + $this->set_props( $invoice ); |
|
| 150 | + |
|
| 151 | + if ( isset( $invoice['ID'] ) ) { |
|
| 152 | + $this->set_id( $invoice['ID'] ); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'key' ) ) { |
|
| 156 | + $this->set_id( $invoice_id ); |
|
| 157 | + } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'number' ) ) { |
|
| 158 | + $this->set_id( $invoice_id ); |
|
| 159 | + } elseif ( is_scalar( $invoice ) && $invoice_id = self::get_invoice_id_by_field( $invoice, 'transaction_id' ) ) { |
|
| 160 | + $this->set_id( $invoice_id ); |
|
| 161 | + }else { |
|
| 162 | + $this->set_object_read( true ); |
|
| 163 | + } |
|
| 164 | 164 | |
| 165 | 165 | // Load the datastore. |
| 166 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 166 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 167 | 167 | |
| 168 | - if ( $this->get_id() > 0 ) { |
|
| 168 | + if ( $this->get_id() > 0 ) { |
|
| 169 | 169 | $this->post = get_post( $this->get_id() ); |
| 170 | 170 | $this->ID = $this->get_id(); |
| 171 | - $this->data_store->read( $this ); |
|
| 171 | + $this->data_store->read( $this ); |
|
| 172 | 172 | } |
| 173 | 173 | |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | 176 | /** |
| 177 | - * Given an invoice key/number, it returns its id. |
|
| 178 | - * |
|
| 179 | - * |
|
| 180 | - * @static |
|
| 181 | - * @param string $value The invoice key or number |
|
| 182 | - * @param string $field Either key, transaction_id or number. |
|
| 183 | - * @since 1.0.15 |
|
| 184 | - * @return int |
|
| 185 | - */ |
|
| 186 | - public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
| 177 | + * Given an invoice key/number, it returns its id. |
|
| 178 | + * |
|
| 179 | + * |
|
| 180 | + * @static |
|
| 181 | + * @param string $value The invoice key or number |
|
| 182 | + * @param string $field Either key, transaction_id or number. |
|
| 183 | + * @since 1.0.15 |
|
| 184 | + * @return int |
|
| 185 | + */ |
|
| 186 | + public static function get_invoice_id_by_field( $value, $field = 'key' ) { |
|
| 187 | 187 | global $wpdb; |
| 188 | 188 | |
| 189 | - // Trim the value. |
|
| 190 | - $value = trim( $value ); |
|
| 189 | + // Trim the value. |
|
| 190 | + $value = trim( $value ); |
|
| 191 | 191 | |
| 192 | - if ( empty( $value ) ) { |
|
| 193 | - return 0; |
|
| 194 | - } |
|
| 192 | + if ( empty( $value ) ) { |
|
| 193 | + return 0; |
|
| 194 | + } |
|
| 195 | 195 | |
| 196 | 196 | // Valid fields. |
| 197 | 197 | $fields = array( 'key', 'number', 'transaction_id' ); |
| 198 | 198 | |
| 199 | - // Ensure a field has been passed. |
|
| 200 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 201 | - return 0; |
|
| 202 | - } |
|
| 199 | + // Ensure a field has been passed. |
|
| 200 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 201 | + return 0; |
|
| 202 | + } |
|
| 203 | 203 | |
| 204 | - // Maybe retrieve from the cache. |
|
| 205 | - $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 206 | - if ( false !== $invoice_id ) { |
|
| 207 | - return $invoice_id; |
|
| 208 | - } |
|
| 204 | + // Maybe retrieve from the cache. |
|
| 205 | + $invoice_id = wp_cache_get( $value, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 206 | + if ( false !== $invoice_id ) { |
|
| 207 | + return $invoice_id; |
|
| 208 | + } |
|
| 209 | 209 | |
| 210 | 210 | // Fetch from the db. |
| 211 | 211 | $table = $wpdb->prefix . 'getpaid_invoices'; |
@@ -213,10 +213,10 @@ discard block |
||
| 213 | 213 | $wpdb->prepare( "SELECT `post_id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
| 214 | 214 | ); |
| 215 | 215 | |
| 216 | - // Update the cache with our data |
|
| 217 | - wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 216 | + // Update the cache with our data |
|
| 217 | + wp_cache_set( $value, $invoice_id, "getpaid_invoice_{$field}s_to_invoice_ids" ); |
|
| 218 | 218 | |
| 219 | - return $invoice_id; |
|
| 219 | + return $invoice_id; |
|
| 220 | 220 | } |
| 221 | 221 | |
| 222 | 222 | /** |
@@ -242,80 +242,80 @@ discard block |
||
| 242 | 242 | */ |
| 243 | 243 | |
| 244 | 244 | /** |
| 245 | - * Get parent invoice ID. |
|
| 246 | - * |
|
| 247 | - * @since 1.0.19 |
|
| 248 | - * @param string $context View or edit context. |
|
| 249 | - * @return int |
|
| 250 | - */ |
|
| 251 | - public function get_parent_id( $context = 'view' ) { |
|
| 252 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 245 | + * Get parent invoice ID. |
|
| 246 | + * |
|
| 247 | + * @since 1.0.19 |
|
| 248 | + * @param string $context View or edit context. |
|
| 249 | + * @return int |
|
| 250 | + */ |
|
| 251 | + public function get_parent_id( $context = 'view' ) { |
|
| 252 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | /** |
| 256 | - * Get parent invoice. |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * @return WPInv_Invoice |
|
| 260 | - */ |
|
| 256 | + * Get parent invoice. |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * @return WPInv_Invoice |
|
| 260 | + */ |
|
| 261 | 261 | public function get_parent_payment() { |
| 262 | 262 | return new WPInv_Invoice( $this->get_parent_id() ); |
| 263 | 263 | } |
| 264 | 264 | |
| 265 | 265 | /** |
| 266 | - * Alias for self::get_parent_payment(). |
|
| 267 | - * |
|
| 268 | - * @since 1.0.19 |
|
| 269 | - * @return WPInv_Invoice |
|
| 270 | - */ |
|
| 266 | + * Alias for self::get_parent_payment(). |
|
| 267 | + * |
|
| 268 | + * @since 1.0.19 |
|
| 269 | + * @return WPInv_Invoice |
|
| 270 | + */ |
|
| 271 | 271 | public function get_parent() { |
| 272 | 272 | return $this->get_parent_payment(); |
| 273 | 273 | } |
| 274 | 274 | |
| 275 | 275 | /** |
| 276 | - * Get invoice status. |
|
| 277 | - * |
|
| 278 | - * @since 1.0.19 |
|
| 279 | - * @param string $context View or edit context. |
|
| 280 | - * @return string |
|
| 281 | - */ |
|
| 282 | - public function get_status( $context = 'view' ) { |
|
| 283 | - return $this->get_prop( 'status', $context ); |
|
| 284 | - } |
|
| 276 | + * Get invoice status. |
|
| 277 | + * |
|
| 278 | + * @since 1.0.19 |
|
| 279 | + * @param string $context View or edit context. |
|
| 280 | + * @return string |
|
| 281 | + */ |
|
| 282 | + public function get_status( $context = 'view' ) { |
|
| 283 | + return $this->get_prop( 'status', $context ); |
|
| 284 | + } |
|
| 285 | 285 | |
| 286 | - /** |
|
| 287 | - * Retrieves an array of possible invoice statuses. |
|
| 288 | - * |
|
| 289 | - * @since 1.0.19 |
|
| 290 | - * @return array |
|
| 291 | - */ |
|
| 292 | - public function get_all_statuses() { |
|
| 293 | - |
|
| 294 | - $statuses = wpinv_get_invoice_statuses( true, true, $this ); |
|
| 295 | - |
|
| 296 | - // For backwards compatibility. |
|
| 297 | - if ( $this->is_quote() && class_exists( 'Wpinv_Quotes_Shared' ) ) { |
|
| 286 | + /** |
|
| 287 | + * Retrieves an array of possible invoice statuses. |
|
| 288 | + * |
|
| 289 | + * @since 1.0.19 |
|
| 290 | + * @return array |
|
| 291 | + */ |
|
| 292 | + public function get_all_statuses() { |
|
| 293 | + |
|
| 294 | + $statuses = wpinv_get_invoice_statuses( true, true, $this ); |
|
| 295 | + |
|
| 296 | + // For backwards compatibility. |
|
| 297 | + if ( $this->is_quote() && class_exists( 'Wpinv_Quotes_Shared' ) ) { |
|
| 298 | 298 | $statuses = Wpinv_Quotes_Shared::wpinv_get_quote_statuses(); |
| 299 | - } |
|
| 299 | + } |
|
| 300 | 300 | |
| 301 | - return $statuses; |
|
| 301 | + return $statuses; |
|
| 302 | 302 | } |
| 303 | 303 | |
| 304 | 304 | /** |
| 305 | - * Get invoice status nice name. |
|
| 306 | - * |
|
| 307 | - * @since 1.0.19 |
|
| 308 | - * @return string |
|
| 309 | - */ |
|
| 305 | + * Get invoice status nice name. |
|
| 306 | + * |
|
| 307 | + * @since 1.0.19 |
|
| 308 | + * @return string |
|
| 309 | + */ |
|
| 310 | 310 | public function get_status_nicename() { |
| 311 | - $statuses = $this->get_all_statuses(); |
|
| 311 | + $statuses = $this->get_all_statuses(); |
|
| 312 | 312 | |
| 313 | 313 | $status = isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : $this->get_status(); |
| 314 | 314 | |
| 315 | 315 | return apply_filters( 'wpinv_get_invoice_status_nicename', $status, $this ); |
| 316 | 316 | } |
| 317 | 317 | |
| 318 | - /** |
|
| 318 | + /** |
|
| 319 | 319 | * Retrieves the invoice status label html |
| 320 | 320 | * |
| 321 | 321 | * @since 1.0.0 |
@@ -323,262 +323,262 @@ discard block |
||
| 323 | 323 | */ |
| 324 | 324 | public function get_status_label_html() { |
| 325 | 325 | |
| 326 | - $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
| 327 | - $status = sanitize_html_class( $this->get_status() ); |
|
| 326 | + $status_label = sanitize_text_field( $this->get_status_nicename() ); |
|
| 327 | + $status = sanitize_html_class( $this->get_status() ); |
|
| 328 | 328 | |
| 329 | - return "<span class='bsui'><span class='d-inline-block py-2 px-3 rounded getpaid-invoice-status-$status'>$status_label</span></span>"; |
|
| 330 | - } |
|
| 329 | + return "<span class='bsui'><span class='d-inline-block py-2 px-3 rounded getpaid-invoice-status-$status'>$status_label</span></span>"; |
|
| 330 | + } |
|
| 331 | 331 | |
| 332 | 332 | /** |
| 333 | - * Get plugin version when the invoice was created. |
|
| 334 | - * |
|
| 335 | - * @since 1.0.19 |
|
| 336 | - * @param string $context View or edit context. |
|
| 337 | - * @return string |
|
| 338 | - */ |
|
| 339 | - public function get_version( $context = 'view' ) { |
|
| 340 | - return $this->get_prop( 'version', $context ); |
|
| 341 | - } |
|
| 333 | + * Get plugin version when the invoice was created. |
|
| 334 | + * |
|
| 335 | + * @since 1.0.19 |
|
| 336 | + * @param string $context View or edit context. |
|
| 337 | + * @return string |
|
| 338 | + */ |
|
| 339 | + public function get_version( $context = 'view' ) { |
|
| 340 | + return $this->get_prop( 'version', $context ); |
|
| 341 | + } |
|
| 342 | 342 | |
| 343 | - /** |
|
| 344 | - * @deprecated |
|
| 345 | - */ |
|
| 346 | - public function get_invoice_date( $format = true ) { |
|
| 347 | - $date = getpaid_format_date( $this->get_date_completed() ); |
|
| 348 | - $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
| 349 | - $formatted = getpaid_format_date( $date ); |
|
| 343 | + /** |
|
| 344 | + * @deprecated |
|
| 345 | + */ |
|
| 346 | + public function get_invoice_date( $format = true ) { |
|
| 347 | + $date = getpaid_format_date( $this->get_date_completed() ); |
|
| 348 | + $date = empty( $date ) ? $this->get_date_created() : $this->get_date_completed(); |
|
| 349 | + $formatted = getpaid_format_date( $date ); |
|
| 350 | 350 | |
| 351 | - if ( $format ) { |
|
| 352 | - return $formatted; |
|
| 353 | - } |
|
| 351 | + if ( $format ) { |
|
| 352 | + return $formatted; |
|
| 353 | + } |
|
| 354 | 354 | |
| 355 | - return empty( $formatted ) ? '' : $date; |
|
| 355 | + return empty( $formatted ) ? '' : $date; |
|
| 356 | 356 | |
| 357 | 357 | } |
| 358 | 358 | |
| 359 | 359 | /** |
| 360 | - * Get date when the invoice was created. |
|
| 361 | - * |
|
| 362 | - * @since 1.0.19 |
|
| 363 | - * @param string $context View or edit context. |
|
| 364 | - * @return string |
|
| 365 | - */ |
|
| 366 | - public function get_date_created( $context = 'view' ) { |
|
| 367 | - return $this->get_prop( 'date_created', $context ); |
|
| 368 | - } |
|
| 360 | + * Get date when the invoice was created. |
|
| 361 | + * |
|
| 362 | + * @since 1.0.19 |
|
| 363 | + * @param string $context View or edit context. |
|
| 364 | + * @return string |
|
| 365 | + */ |
|
| 366 | + public function get_date_created( $context = 'view' ) { |
|
| 367 | + return $this->get_prop( 'date_created', $context ); |
|
| 368 | + } |
|
| 369 | 369 | |
| 370 | - /** |
|
| 371 | - * Alias for self::get_date_created(). |
|
| 372 | - * |
|
| 373 | - * @since 1.0.19 |
|
| 374 | - * @param string $context View or edit context. |
|
| 375 | - * @return string |
|
| 376 | - */ |
|
| 377 | - public function get_created_date( $context = 'view' ) { |
|
| 378 | - return $this->get_date_created( $context ); |
|
| 379 | - } |
|
| 380 | - |
|
| 381 | - /** |
|
| 382 | - * Get GMT date when the invoice was created. |
|
| 383 | - * |
|
| 384 | - * @since 1.0.19 |
|
| 385 | - * @param string $context View or edit context. |
|
| 386 | - * @return string |
|
| 387 | - */ |
|
| 388 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 370 | + /** |
|
| 371 | + * Alias for self::get_date_created(). |
|
| 372 | + * |
|
| 373 | + * @since 1.0.19 |
|
| 374 | + * @param string $context View or edit context. |
|
| 375 | + * @return string |
|
| 376 | + */ |
|
| 377 | + public function get_created_date( $context = 'view' ) { |
|
| 378 | + return $this->get_date_created( $context ); |
|
| 379 | + } |
|
| 380 | + |
|
| 381 | + /** |
|
| 382 | + * Get GMT date when the invoice was created. |
|
| 383 | + * |
|
| 384 | + * @since 1.0.19 |
|
| 385 | + * @param string $context View or edit context. |
|
| 386 | + * @return string |
|
| 387 | + */ |
|
| 388 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 389 | 389 | $date = $this->get_date_created( $context ); |
| 390 | 390 | |
| 391 | 391 | if ( $date ) { |
| 392 | 392 | $date = get_gmt_from_date( $date ); |
| 393 | 393 | } |
| 394 | - return $date; |
|
| 394 | + return $date; |
|
| 395 | 395 | } |
| 396 | 396 | |
| 397 | 397 | /** |
| 398 | - * Get date when the invoice was last modified. |
|
| 399 | - * |
|
| 400 | - * @since 1.0.19 |
|
| 401 | - * @param string $context View or edit context. |
|
| 402 | - * @return string |
|
| 403 | - */ |
|
| 404 | - public function get_date_modified( $context = 'view' ) { |
|
| 405 | - return $this->get_prop( 'date_modified', $context ); |
|
| 406 | - } |
|
| 398 | + * Get date when the invoice was last modified. |
|
| 399 | + * |
|
| 400 | + * @since 1.0.19 |
|
| 401 | + * @param string $context View or edit context. |
|
| 402 | + * @return string |
|
| 403 | + */ |
|
| 404 | + public function get_date_modified( $context = 'view' ) { |
|
| 405 | + return $this->get_prop( 'date_modified', $context ); |
|
| 406 | + } |
|
| 407 | 407 | |
| 408 | - /** |
|
| 409 | - * Alias for self::get_date_modified(). |
|
| 410 | - * |
|
| 411 | - * @since 1.0.19 |
|
| 412 | - * @param string $context View or edit context. |
|
| 413 | - * @return string |
|
| 414 | - */ |
|
| 415 | - public function get_modified_date( $context = 'view' ) { |
|
| 416 | - return $this->get_date_modified( $context ); |
|
| 408 | + /** |
|
| 409 | + * Alias for self::get_date_modified(). |
|
| 410 | + * |
|
| 411 | + * @since 1.0.19 |
|
| 412 | + * @param string $context View or edit context. |
|
| 413 | + * @return string |
|
| 414 | + */ |
|
| 415 | + public function get_modified_date( $context = 'view' ) { |
|
| 416 | + return $this->get_date_modified( $context ); |
|
| 417 | 417 | } |
| 418 | 418 | |
| 419 | 419 | /** |
| 420 | - * Get GMT date when the invoice was last modified. |
|
| 421 | - * |
|
| 422 | - * @since 1.0.19 |
|
| 423 | - * @param string $context View or edit context. |
|
| 424 | - * @return string |
|
| 425 | - */ |
|
| 426 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 420 | + * Get GMT date when the invoice was last modified. |
|
| 421 | + * |
|
| 422 | + * @since 1.0.19 |
|
| 423 | + * @param string $context View or edit context. |
|
| 424 | + * @return string |
|
| 425 | + */ |
|
| 426 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 427 | 427 | $date = $this->get_date_modified( $context ); |
| 428 | 428 | |
| 429 | 429 | if ( $date ) { |
| 430 | 430 | $date = get_gmt_from_date( $date ); |
| 431 | 431 | } |
| 432 | - return $date; |
|
| 432 | + return $date; |
|
| 433 | 433 | } |
| 434 | 434 | |
| 435 | 435 | /** |
| 436 | - * Get the invoice due date. |
|
| 437 | - * |
|
| 438 | - * @since 1.0.19 |
|
| 439 | - * @param string $context View or edit context. |
|
| 440 | - * @return string |
|
| 441 | - */ |
|
| 442 | - public function get_due_date( $context = 'view' ) { |
|
| 443 | - return $this->get_prop( 'due_date', $context ); |
|
| 436 | + * Get the invoice due date. |
|
| 437 | + * |
|
| 438 | + * @since 1.0.19 |
|
| 439 | + * @param string $context View or edit context. |
|
| 440 | + * @return string |
|
| 441 | + */ |
|
| 442 | + public function get_due_date( $context = 'view' ) { |
|
| 443 | + return $this->get_prop( 'due_date', $context ); |
|
| 444 | 444 | } |
| 445 | 445 | |
| 446 | 446 | /** |
| 447 | - * Alias for self::get_due_date(). |
|
| 448 | - * |
|
| 449 | - * @since 1.0.19 |
|
| 450 | - * @param string $context View or edit context. |
|
| 451 | - * @return string |
|
| 452 | - */ |
|
| 453 | - public function get_date_due( $context = 'view' ) { |
|
| 454 | - return $this->get_due_date( $context ); |
|
| 447 | + * Alias for self::get_due_date(). |
|
| 448 | + * |
|
| 449 | + * @since 1.0.19 |
|
| 450 | + * @param string $context View or edit context. |
|
| 451 | + * @return string |
|
| 452 | + */ |
|
| 453 | + public function get_date_due( $context = 'view' ) { |
|
| 454 | + return $this->get_due_date( $context ); |
|
| 455 | 455 | } |
| 456 | 456 | |
| 457 | 457 | /** |
| 458 | - * Get the invoice GMT due date. |
|
| 459 | - * |
|
| 460 | - * @since 1.0.19 |
|
| 461 | - * @param string $context View or edit context. |
|
| 462 | - * @return string |
|
| 463 | - */ |
|
| 464 | - public function get_due_date_gmt( $context = 'view' ) { |
|
| 458 | + * Get the invoice GMT due date. |
|
| 459 | + * |
|
| 460 | + * @since 1.0.19 |
|
| 461 | + * @param string $context View or edit context. |
|
| 462 | + * @return string |
|
| 463 | + */ |
|
| 464 | + public function get_due_date_gmt( $context = 'view' ) { |
|
| 465 | 465 | $date = $this->get_due_date( $context ); |
| 466 | 466 | |
| 467 | 467 | if ( $date ) { |
| 468 | 468 | $date = get_gmt_from_date( $date ); |
| 469 | 469 | } |
| 470 | - return $date; |
|
| 470 | + return $date; |
|
| 471 | 471 | } |
| 472 | 472 | |
| 473 | 473 | /** |
| 474 | - * Alias for self::get_due_date_gmt(). |
|
| 475 | - * |
|
| 476 | - * @since 1.0.19 |
|
| 477 | - * @param string $context View or edit context. |
|
| 478 | - * @return string |
|
| 479 | - */ |
|
| 480 | - public function get_gmt_date_due( $context = 'view' ) { |
|
| 481 | - return $this->get_due_date_gmt( $context ); |
|
| 474 | + * Alias for self::get_due_date_gmt(). |
|
| 475 | + * |
|
| 476 | + * @since 1.0.19 |
|
| 477 | + * @param string $context View or edit context. |
|
| 478 | + * @return string |
|
| 479 | + */ |
|
| 480 | + public function get_gmt_date_due( $context = 'view' ) { |
|
| 481 | + return $this->get_due_date_gmt( $context ); |
|
| 482 | 482 | } |
| 483 | 483 | |
| 484 | 484 | /** |
| 485 | - * Get date when the invoice was completed. |
|
| 486 | - * |
|
| 487 | - * @since 1.0.19 |
|
| 488 | - * @param string $context View or edit context. |
|
| 489 | - * @return string |
|
| 490 | - */ |
|
| 491 | - public function get_completed_date( $context = 'view' ) { |
|
| 492 | - return $this->get_prop( 'completed_date', $context ); |
|
| 485 | + * Get date when the invoice was completed. |
|
| 486 | + * |
|
| 487 | + * @since 1.0.19 |
|
| 488 | + * @param string $context View or edit context. |
|
| 489 | + * @return string |
|
| 490 | + */ |
|
| 491 | + public function get_completed_date( $context = 'view' ) { |
|
| 492 | + return $this->get_prop( 'completed_date', $context ); |
|
| 493 | 493 | } |
| 494 | 494 | |
| 495 | 495 | /** |
| 496 | - * Alias for self::get_completed_date(). |
|
| 497 | - * |
|
| 498 | - * @since 1.0.19 |
|
| 499 | - * @param string $context View or edit context. |
|
| 500 | - * @return string |
|
| 501 | - */ |
|
| 502 | - public function get_date_completed( $context = 'view' ) { |
|
| 503 | - return $this->get_completed_date( $context ); |
|
| 496 | + * Alias for self::get_completed_date(). |
|
| 497 | + * |
|
| 498 | + * @since 1.0.19 |
|
| 499 | + * @param string $context View or edit context. |
|
| 500 | + * @return string |
|
| 501 | + */ |
|
| 502 | + public function get_date_completed( $context = 'view' ) { |
|
| 503 | + return $this->get_completed_date( $context ); |
|
| 504 | 504 | } |
| 505 | 505 | |
| 506 | 506 | /** |
| 507 | - * Get GMT date when the invoice was was completed. |
|
| 508 | - * |
|
| 509 | - * @since 1.0.19 |
|
| 510 | - * @param string $context View or edit context. |
|
| 511 | - * @return string |
|
| 512 | - */ |
|
| 513 | - public function get_completed_date_gmt( $context = 'view' ) { |
|
| 507 | + * Get GMT date when the invoice was was completed. |
|
| 508 | + * |
|
| 509 | + * @since 1.0.19 |
|
| 510 | + * @param string $context View or edit context. |
|
| 511 | + * @return string |
|
| 512 | + */ |
|
| 513 | + public function get_completed_date_gmt( $context = 'view' ) { |
|
| 514 | 514 | $date = $this->get_completed_date( $context ); |
| 515 | 515 | |
| 516 | 516 | if ( $date ) { |
| 517 | 517 | $date = get_gmt_from_date( $date ); |
| 518 | 518 | } |
| 519 | - return $date; |
|
| 519 | + return $date; |
|
| 520 | 520 | } |
| 521 | 521 | |
| 522 | 522 | /** |
| 523 | - * Alias for self::get_completed_date_gmt(). |
|
| 524 | - * |
|
| 525 | - * @since 1.0.19 |
|
| 526 | - * @param string $context View or edit context. |
|
| 527 | - * @return string |
|
| 528 | - */ |
|
| 529 | - public function get_gmt_completed_date( $context = 'view' ) { |
|
| 530 | - return $this->get_completed_date_gmt( $context ); |
|
| 523 | + * Alias for self::get_completed_date_gmt(). |
|
| 524 | + * |
|
| 525 | + * @since 1.0.19 |
|
| 526 | + * @param string $context View or edit context. |
|
| 527 | + * @return string |
|
| 528 | + */ |
|
| 529 | + public function get_gmt_completed_date( $context = 'view' ) { |
|
| 530 | + return $this->get_completed_date_gmt( $context ); |
|
| 531 | 531 | } |
| 532 | 532 | |
| 533 | 533 | /** |
| 534 | - * Get the invoice number. |
|
| 535 | - * |
|
| 536 | - * @since 1.0.19 |
|
| 537 | - * @param string $context View or edit context. |
|
| 538 | - * @return string |
|
| 539 | - */ |
|
| 540 | - public function get_number( $context = 'view' ) { |
|
| 541 | - $number = $this->get_prop( 'number', $context ); |
|
| 534 | + * Get the invoice number. |
|
| 535 | + * |
|
| 536 | + * @since 1.0.19 |
|
| 537 | + * @param string $context View or edit context. |
|
| 538 | + * @return string |
|
| 539 | + */ |
|
| 540 | + public function get_number( $context = 'view' ) { |
|
| 541 | + $number = $this->get_prop( 'number', $context ); |
|
| 542 | 542 | |
| 543 | - if ( empty( $number ) ) { |
|
| 544 | - $number = $this->generate_number(); |
|
| 545 | - $this->set_number( $this->generate_number() ); |
|
| 546 | - } |
|
| 543 | + if ( empty( $number ) ) { |
|
| 544 | + $number = $this->generate_number(); |
|
| 545 | + $this->set_number( $this->generate_number() ); |
|
| 546 | + } |
|
| 547 | 547 | |
| 548 | - return $number; |
|
| 548 | + return $number; |
|
| 549 | 549 | } |
| 550 | 550 | |
| 551 | - /** |
|
| 552 | - * Set the invoice number. |
|
| 553 | - * |
|
| 554 | - * @since 1.0.19 |
|
| 555 | - */ |
|
| 556 | - public function maybe_set_number() { |
|
| 551 | + /** |
|
| 552 | + * Set the invoice number. |
|
| 553 | + * |
|
| 554 | + * @since 1.0.19 |
|
| 555 | + */ |
|
| 556 | + public function maybe_set_number() { |
|
| 557 | 557 | $number = $this->get_number(); |
| 558 | 558 | |
| 559 | 559 | if ( empty( $number ) || $this->get_id() == $number ) { |
| 560 | - $this->set_number( $this->generate_number() ); |
|
| 560 | + $this->set_number( $this->generate_number() ); |
|
| 561 | 561 | } |
| 562 | 562 | |
| 563 | - } |
|
| 563 | + } |
|
| 564 | 564 | |
| 565 | 565 | /** |
| 566 | - * Get the invoice key. |
|
| 567 | - * |
|
| 568 | - * @since 1.0.19 |
|
| 569 | - * @param string $context View or edit context. |
|
| 570 | - * @return string |
|
| 571 | - */ |
|
| 572 | - public function get_key( $context = 'view' ) { |
|
| 566 | + * Get the invoice key. |
|
| 567 | + * |
|
| 568 | + * @since 1.0.19 |
|
| 569 | + * @param string $context View or edit context. |
|
| 570 | + * @return string |
|
| 571 | + */ |
|
| 572 | + public function get_key( $context = 'view' ) { |
|
| 573 | 573 | return $this->get_prop( 'key', $context ); |
| 574 | - } |
|
| 575 | - |
|
| 576 | - /** |
|
| 577 | - * Set the invoice key. |
|
| 578 | - * |
|
| 579 | - * @since 1.0.19 |
|
| 580 | - */ |
|
| 581 | - public function maybe_set_key() { |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + /** |
|
| 577 | + * Set the invoice key. |
|
| 578 | + * |
|
| 579 | + * @since 1.0.19 |
|
| 580 | + */ |
|
| 581 | + public function maybe_set_key() { |
|
| 582 | 582 | $key = $this->get_key(); |
| 583 | 583 | |
| 584 | 584 | if ( empty( $key ) ) { |
@@ -589,126 +589,126 @@ discard block |
||
| 589 | 589 | } |
| 590 | 590 | |
| 591 | 591 | /** |
| 592 | - * Get the invoice type. |
|
| 593 | - * |
|
| 594 | - * @since 1.0.19 |
|
| 595 | - * @param string $context View or edit context. |
|
| 596 | - * @return string |
|
| 597 | - */ |
|
| 598 | - public function get_type( $context = 'view' ) { |
|
| 592 | + * Get the invoice type. |
|
| 593 | + * |
|
| 594 | + * @since 1.0.19 |
|
| 595 | + * @param string $context View or edit context. |
|
| 596 | + * @return string |
|
| 597 | + */ |
|
| 598 | + public function get_type( $context = 'view' ) { |
|
| 599 | 599 | return $this->get_prop( 'type', $context ); |
| 600 | - } |
|
| 600 | + } |
|
| 601 | 601 | |
| 602 | - /** |
|
| 603 | - * @deprecated |
|
| 604 | - */ |
|
| 605 | - public function get_invoice_quote_type() { |
|
| 602 | + /** |
|
| 603 | + * @deprecated |
|
| 604 | + */ |
|
| 605 | + public function get_invoice_quote_type() { |
|
| 606 | 606 | ucfirst( $this->get_type() ); |
| 607 | 607 | } |
| 608 | 608 | |
| 609 | 609 | /** |
| 610 | - * Get the invoice post type. |
|
| 611 | - * |
|
| 612 | - * @since 1.0.19 |
|
| 613 | - * @param string $context View or edit context. |
|
| 614 | - * @return string |
|
| 615 | - */ |
|
| 616 | - public function get_post_type( $context = 'view' ) { |
|
| 610 | + * Get the invoice post type. |
|
| 611 | + * |
|
| 612 | + * @since 1.0.19 |
|
| 613 | + * @param string $context View or edit context. |
|
| 614 | + * @return string |
|
| 615 | + */ |
|
| 616 | + public function get_post_type( $context = 'view' ) { |
|
| 617 | 617 | return $this->get_prop( 'post_type', $context ); |
| 618 | 618 | } |
| 619 | 619 | |
| 620 | 620 | /** |
| 621 | - * Get the invoice mode. |
|
| 622 | - * |
|
| 623 | - * @since 1.0.19 |
|
| 624 | - * @param string $context View or edit context. |
|
| 625 | - * @return string |
|
| 626 | - */ |
|
| 627 | - public function get_mode( $context = 'view' ) { |
|
| 621 | + * Get the invoice mode. |
|
| 622 | + * |
|
| 623 | + * @since 1.0.19 |
|
| 624 | + * @param string $context View or edit context. |
|
| 625 | + * @return string |
|
| 626 | + */ |
|
| 627 | + public function get_mode( $context = 'view' ) { |
|
| 628 | 628 | return $this->get_prop( 'mode', $context ); |
| 629 | 629 | } |
| 630 | 630 | |
| 631 | 631 | /** |
| 632 | - * Get the invoice path. |
|
| 633 | - * |
|
| 634 | - * @since 1.0.19 |
|
| 635 | - * @param string $context View or edit context. |
|
| 636 | - * @return string |
|
| 637 | - */ |
|
| 638 | - public function get_path( $context = 'view' ) { |
|
| 632 | + * Get the invoice path. |
|
| 633 | + * |
|
| 634 | + * @since 1.0.19 |
|
| 635 | + * @param string $context View or edit context. |
|
| 636 | + * @return string |
|
| 637 | + */ |
|
| 638 | + public function get_path( $context = 'view' ) { |
|
| 639 | 639 | $path = $this->get_prop( 'path', $context ); |
| 640 | - $prefix = wpinv_post_name_prefix( $this->get_post_type() ); |
|
| 640 | + $prefix = wpinv_post_name_prefix( $this->get_post_type() ); |
|
| 641 | 641 | |
| 642 | - if ( 0 !== strpos( $path, $prefix ) ) { |
|
| 643 | - $path = sanitize_title( $prefix . $this->get_id() ); |
|
| 644 | - $this->set_path( $path ); |
|
| 645 | - } |
|
| 642 | + if ( 0 !== strpos( $path, $prefix ) ) { |
|
| 643 | + $path = sanitize_title( $prefix . $this->get_id() ); |
|
| 644 | + $this->set_path( $path ); |
|
| 645 | + } |
|
| 646 | 646 | |
| 647 | - return $path; |
|
| 647 | + return $path; |
|
| 648 | 648 | } |
| 649 | 649 | |
| 650 | 650 | /** |
| 651 | - * Get the invoice name/title. |
|
| 652 | - * |
|
| 653 | - * @since 1.0.19 |
|
| 654 | - * @param string $context View or edit context. |
|
| 655 | - * @return string |
|
| 656 | - */ |
|
| 657 | - public function get_name( $context = 'view' ) { |
|
| 651 | + * Get the invoice name/title. |
|
| 652 | + * |
|
| 653 | + * @since 1.0.19 |
|
| 654 | + * @param string $context View or edit context. |
|
| 655 | + * @return string |
|
| 656 | + */ |
|
| 657 | + public function get_name( $context = 'view' ) { |
|
| 658 | 658 | return $this->get_prop( 'title', $context ); |
| 659 | 659 | } |
| 660 | 660 | |
| 661 | 661 | /** |
| 662 | - * Alias of self::get_name(). |
|
| 663 | - * |
|
| 664 | - * @since 1.0.19 |
|
| 665 | - * @param string $context View or edit context. |
|
| 666 | - * @return string |
|
| 667 | - */ |
|
| 668 | - public function get_title( $context = 'view' ) { |
|
| 669 | - return $this->get_name( $context ); |
|
| 662 | + * Alias of self::get_name(). |
|
| 663 | + * |
|
| 664 | + * @since 1.0.19 |
|
| 665 | + * @param string $context View or edit context. |
|
| 666 | + * @return string |
|
| 667 | + */ |
|
| 668 | + public function get_title( $context = 'view' ) { |
|
| 669 | + return $this->get_name( $context ); |
|
| 670 | 670 | } |
| 671 | 671 | |
| 672 | 672 | /** |
| 673 | - * Get the invoice description. |
|
| 674 | - * |
|
| 675 | - * @since 1.0.19 |
|
| 676 | - * @param string $context View or edit context. |
|
| 677 | - * @return string |
|
| 678 | - */ |
|
| 679 | - public function get_description( $context = 'view' ) { |
|
| 680 | - return $this->get_prop( 'description', $context ); |
|
| 673 | + * Get the invoice description. |
|
| 674 | + * |
|
| 675 | + * @since 1.0.19 |
|
| 676 | + * @param string $context View or edit context. |
|
| 677 | + * @return string |
|
| 678 | + */ |
|
| 679 | + public function get_description( $context = 'view' ) { |
|
| 680 | + return $this->get_prop( 'description', $context ); |
|
| 681 | 681 | } |
| 682 | 682 | |
| 683 | 683 | /** |
| 684 | - * Alias of self::get_description(). |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $context View or edit context. |
|
| 688 | - * @return string |
|
| 689 | - */ |
|
| 690 | - public function get_excerpt( $context = 'view' ) { |
|
| 691 | - return $this->get_description( $context ); |
|
| 684 | + * Alias of self::get_description(). |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $context View or edit context. |
|
| 688 | + * @return string |
|
| 689 | + */ |
|
| 690 | + public function get_excerpt( $context = 'view' ) { |
|
| 691 | + return $this->get_description( $context ); |
|
| 692 | 692 | } |
| 693 | 693 | |
| 694 | 694 | /** |
| 695 | - * Alias of self::get_description(). |
|
| 696 | - * |
|
| 697 | - * @since 1.0.19 |
|
| 698 | - * @param string $context View or edit context. |
|
| 699 | - * @return string |
|
| 700 | - */ |
|
| 701 | - public function get_summary( $context = 'view' ) { |
|
| 702 | - return $this->get_description( $context ); |
|
| 695 | + * Alias of self::get_description(). |
|
| 696 | + * |
|
| 697 | + * @since 1.0.19 |
|
| 698 | + * @param string $context View or edit context. |
|
| 699 | + * @return string |
|
| 700 | + */ |
|
| 701 | + public function get_summary( $context = 'view' ) { |
|
| 702 | + return $this->get_description( $context ); |
|
| 703 | 703 | } |
| 704 | 704 | |
| 705 | 705 | /** |
| 706 | - * Returns the user info. |
|
| 707 | - * |
|
| 708 | - * @since 1.0.19 |
|
| 706 | + * Returns the user info. |
|
| 707 | + * |
|
| 708 | + * @since 1.0.19 |
|
| 709 | 709 | * @param string $context View or edit context. |
| 710 | - * @return array |
|
| 711 | - */ |
|
| 710 | + * @return array |
|
| 711 | + */ |
|
| 712 | 712 | public function get_user_info( $context = 'view' ) { |
| 713 | 713 | |
| 714 | 714 | $user_info = array( |
@@ -725,616 +725,616 @@ discard block |
||
| 725 | 725 | 'company' => $this->get_company( $context ), |
| 726 | 726 | 'vat_number' => $this->get_vat_number( $context ), |
| 727 | 727 | 'discount' => $this->get_discount_code( $context ), |
| 728 | - ); |
|
| 728 | + ); |
|
| 729 | + |
|
| 730 | + return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
| 731 | + |
|
| 732 | + } |
|
| 733 | + |
|
| 734 | + /** |
|
| 735 | + * Get the customer id. |
|
| 736 | + * |
|
| 737 | + * @since 1.0.19 |
|
| 738 | + * @param string $context View or edit context. |
|
| 739 | + * @return int |
|
| 740 | + */ |
|
| 741 | + public function get_author( $context = 'view' ) { |
|
| 742 | + return (int) $this->get_prop( 'author', $context ); |
|
| 743 | + } |
|
| 744 | + |
|
| 745 | + /** |
|
| 746 | + * Alias of self::get_author(). |
|
| 747 | + * |
|
| 748 | + * @since 1.0.19 |
|
| 749 | + * @param string $context View or edit context. |
|
| 750 | + * @return int |
|
| 751 | + */ |
|
| 752 | + public function get_user_id( $context = 'view' ) { |
|
| 753 | + return $this->get_author( $context ); |
|
| 754 | + } |
|
| 755 | + |
|
| 756 | + /** |
|
| 757 | + * Alias of self::get_author(). |
|
| 758 | + * |
|
| 759 | + * @since 1.0.19 |
|
| 760 | + * @param string $context View or edit context. |
|
| 761 | + * @return int |
|
| 762 | + */ |
|
| 763 | + public function get_customer_id( $context = 'view' ) { |
|
| 764 | + return $this->get_author( $context ); |
|
| 765 | + } |
|
| 729 | 766 | |
| 730 | - return apply_filters( 'wpinv_user_info', $user_info, $this->get_id(), $this ); |
|
| 767 | + /** |
|
| 768 | + * Get the customer's ip. |
|
| 769 | + * |
|
| 770 | + * @since 1.0.19 |
|
| 771 | + * @param string $context View or edit context. |
|
| 772 | + * @return string |
|
| 773 | + */ |
|
| 774 | + public function get_ip( $context = 'view' ) { |
|
| 775 | + return $this->get_prop( 'user_ip', $context ); |
|
| 776 | + } |
|
| 731 | 777 | |
| 778 | + /** |
|
| 779 | + * Alias of self::get_ip(). |
|
| 780 | + * |
|
| 781 | + * @since 1.0.19 |
|
| 782 | + * @param string $context View or edit context. |
|
| 783 | + * @return string |
|
| 784 | + */ |
|
| 785 | + public function get_user_ip( $context = 'view' ) { |
|
| 786 | + return $this->get_ip( $context ); |
|
| 787 | + } |
|
| 788 | + |
|
| 789 | + /** |
|
| 790 | + * Alias of self::get_ip(). |
|
| 791 | + * |
|
| 792 | + * @since 1.0.19 |
|
| 793 | + * @param string $context View or edit context. |
|
| 794 | + * @return string |
|
| 795 | + */ |
|
| 796 | + public function get_customer_ip( $context = 'view' ) { |
|
| 797 | + return $this->get_ip( $context ); |
|
| 732 | 798 | } |
| 733 | 799 | |
| 734 | 800 | /** |
| 735 | - * Get the customer id. |
|
| 736 | - * |
|
| 737 | - * @since 1.0.19 |
|
| 738 | - * @param string $context View or edit context. |
|
| 739 | - * @return int |
|
| 740 | - */ |
|
| 741 | - public function get_author( $context = 'view' ) { |
|
| 742 | - return (int) $this->get_prop( 'author', $context ); |
|
| 801 | + * Get the customer's first name. |
|
| 802 | + * |
|
| 803 | + * @since 1.0.19 |
|
| 804 | + * @param string $context View or edit context. |
|
| 805 | + * @return string |
|
| 806 | + */ |
|
| 807 | + public function get_first_name( $context = 'view' ) { |
|
| 808 | + return $this->get_prop( 'first_name', $context ); |
|
| 743 | 809 | } |
| 744 | 810 | |
| 745 | 811 | /** |
| 746 | - * Alias of self::get_author(). |
|
| 747 | - * |
|
| 748 | - * @since 1.0.19 |
|
| 749 | - * @param string $context View or edit context. |
|
| 750 | - * @return int |
|
| 751 | - */ |
|
| 752 | - public function get_user_id( $context = 'view' ) { |
|
| 753 | - return $this->get_author( $context ); |
|
| 812 | + * Alias of self::get_first_name(). |
|
| 813 | + * |
|
| 814 | + * @since 1.0.19 |
|
| 815 | + * @param string $context View or edit context. |
|
| 816 | + * @return int |
|
| 817 | + */ |
|
| 818 | + public function get_user_first_name( $context = 'view' ) { |
|
| 819 | + return $this->get_first_name( $context ); |
|
| 754 | 820 | } |
| 755 | 821 | |
| 756 | - /** |
|
| 757 | - * Alias of self::get_author(). |
|
| 758 | - * |
|
| 759 | - * @since 1.0.19 |
|
| 760 | - * @param string $context View or edit context. |
|
| 761 | - * @return int |
|
| 762 | - */ |
|
| 763 | - public function get_customer_id( $context = 'view' ) { |
|
| 764 | - return $this->get_author( $context ); |
|
| 822 | + /** |
|
| 823 | + * Alias of self::get_first_name(). |
|
| 824 | + * |
|
| 825 | + * @since 1.0.19 |
|
| 826 | + * @param string $context View or edit context. |
|
| 827 | + * @return int |
|
| 828 | + */ |
|
| 829 | + public function get_customer_first_name( $context = 'view' ) { |
|
| 830 | + return $this->get_first_name( $context ); |
|
| 765 | 831 | } |
| 766 | 832 | |
| 767 | 833 | /** |
| 768 | - * Get the customer's ip. |
|
| 769 | - * |
|
| 770 | - * @since 1.0.19 |
|
| 771 | - * @param string $context View or edit context. |
|
| 772 | - * @return string |
|
| 773 | - */ |
|
| 774 | - public function get_ip( $context = 'view' ) { |
|
| 775 | - return $this->get_prop( 'user_ip', $context ); |
|
| 834 | + * Get the customer's last name. |
|
| 835 | + * |
|
| 836 | + * @since 1.0.19 |
|
| 837 | + * @param string $context View or edit context. |
|
| 838 | + * @return string |
|
| 839 | + */ |
|
| 840 | + public function get_last_name( $context = 'view' ) { |
|
| 841 | + return $this->get_prop( 'last_name', $context ); |
|
| 776 | 842 | } |
| 777 | 843 | |
| 778 | 844 | /** |
| 779 | - * Alias of self::get_ip(). |
|
| 780 | - * |
|
| 781 | - * @since 1.0.19 |
|
| 782 | - * @param string $context View or edit context. |
|
| 783 | - * @return string |
|
| 784 | - */ |
|
| 785 | - public function get_user_ip( $context = 'view' ) { |
|
| 786 | - return $this->get_ip( $context ); |
|
| 845 | + * Alias of self::get_last_name(). |
|
| 846 | + * |
|
| 847 | + * @since 1.0.19 |
|
| 848 | + * @param string $context View or edit context. |
|
| 849 | + * @return int |
|
| 850 | + */ |
|
| 851 | + public function get_user_last_name( $context = 'view' ) { |
|
| 852 | + return $this->get_last_name( $context ); |
|
| 787 | 853 | } |
| 788 | 854 | |
| 789 | - /** |
|
| 790 | - * Alias of self::get_ip(). |
|
| 791 | - * |
|
| 792 | - * @since 1.0.19 |
|
| 793 | - * @param string $context View or edit context. |
|
| 794 | - * @return string |
|
| 795 | - */ |
|
| 796 | - public function get_customer_ip( $context = 'view' ) { |
|
| 797 | - return $this->get_ip( $context ); |
|
| 855 | + /** |
|
| 856 | + * Alias of self::get_last_name(). |
|
| 857 | + * |
|
| 858 | + * @since 1.0.19 |
|
| 859 | + * @param string $context View or edit context. |
|
| 860 | + * @return int |
|
| 861 | + */ |
|
| 862 | + public function get_customer_last_name( $context = 'view' ) { |
|
| 863 | + return $this->get_last_name( $context ); |
|
| 798 | 864 | } |
| 799 | 865 | |
| 800 | 866 | /** |
| 801 | - * Get the customer's first name. |
|
| 802 | - * |
|
| 803 | - * @since 1.0.19 |
|
| 804 | - * @param string $context View or edit context. |
|
| 805 | - * @return string |
|
| 806 | - */ |
|
| 807 | - public function get_first_name( $context = 'view' ) { |
|
| 808 | - return $this->get_prop( 'first_name', $context ); |
|
| 867 | + * Get the customer's full name. |
|
| 868 | + * |
|
| 869 | + * @since 1.0.19 |
|
| 870 | + * @param string $context View or edit context. |
|
| 871 | + * @return string |
|
| 872 | + */ |
|
| 873 | + public function get_full_name( $context = 'view' ) { |
|
| 874 | + return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
| 809 | 875 | } |
| 810 | 876 | |
| 811 | 877 | /** |
| 812 | - * Alias of self::get_first_name(). |
|
| 813 | - * |
|
| 814 | - * @since 1.0.19 |
|
| 815 | - * @param string $context View or edit context. |
|
| 816 | - * @return int |
|
| 817 | - */ |
|
| 818 | - public function get_user_first_name( $context = 'view' ) { |
|
| 819 | - return $this->get_first_name( $context ); |
|
| 878 | + * Alias of self::get_full_name(). |
|
| 879 | + * |
|
| 880 | + * @since 1.0.19 |
|
| 881 | + * @param string $context View or edit context. |
|
| 882 | + * @return int |
|
| 883 | + */ |
|
| 884 | + public function get_user_full_name( $context = 'view' ) { |
|
| 885 | + return $this->get_full_name( $context ); |
|
| 820 | 886 | } |
| 821 | 887 | |
| 822 | - /** |
|
| 823 | - * Alias of self::get_first_name(). |
|
| 824 | - * |
|
| 825 | - * @since 1.0.19 |
|
| 826 | - * @param string $context View or edit context. |
|
| 827 | - * @return int |
|
| 828 | - */ |
|
| 829 | - public function get_customer_first_name( $context = 'view' ) { |
|
| 830 | - return $this->get_first_name( $context ); |
|
| 888 | + /** |
|
| 889 | + * Alias of self::get_full_name(). |
|
| 890 | + * |
|
| 891 | + * @since 1.0.19 |
|
| 892 | + * @param string $context View or edit context. |
|
| 893 | + * @return int |
|
| 894 | + */ |
|
| 895 | + public function get_customer_full_name( $context = 'view' ) { |
|
| 896 | + return $this->get_full_name( $context ); |
|
| 831 | 897 | } |
| 832 | 898 | |
| 833 | 899 | /** |
| 834 | - * Get the customer's last name. |
|
| 835 | - * |
|
| 836 | - * @since 1.0.19 |
|
| 837 | - * @param string $context View or edit context. |
|
| 838 | - * @return string |
|
| 839 | - */ |
|
| 840 | - public function get_last_name( $context = 'view' ) { |
|
| 841 | - return $this->get_prop( 'last_name', $context ); |
|
| 900 | + * Get the customer's phone number. |
|
| 901 | + * |
|
| 902 | + * @since 1.0.19 |
|
| 903 | + * @param string $context View or edit context. |
|
| 904 | + * @return string |
|
| 905 | + */ |
|
| 906 | + public function get_phone( $context = 'view' ) { |
|
| 907 | + return $this->get_prop( 'phone', $context ); |
|
| 842 | 908 | } |
| 843 | 909 | |
| 844 | 910 | /** |
| 845 | - * Alias of self::get_last_name(). |
|
| 846 | - * |
|
| 847 | - * @since 1.0.19 |
|
| 848 | - * @param string $context View or edit context. |
|
| 849 | - * @return int |
|
| 850 | - */ |
|
| 851 | - public function get_user_last_name( $context = 'view' ) { |
|
| 852 | - return $this->get_last_name( $context ); |
|
| 911 | + * Alias of self::get_phone(). |
|
| 912 | + * |
|
| 913 | + * @since 1.0.19 |
|
| 914 | + * @param string $context View or edit context. |
|
| 915 | + * @return int |
|
| 916 | + */ |
|
| 917 | + public function get_phone_number( $context = 'view' ) { |
|
| 918 | + return $this->get_phone( $context ); |
|
| 853 | 919 | } |
| 854 | 920 | |
| 855 | 921 | /** |
| 856 | - * Alias of self::get_last_name(). |
|
| 857 | - * |
|
| 858 | - * @since 1.0.19 |
|
| 859 | - * @param string $context View or edit context. |
|
| 860 | - * @return int |
|
| 861 | - */ |
|
| 862 | - public function get_customer_last_name( $context = 'view' ) { |
|
| 863 | - return $this->get_last_name( $context ); |
|
| 922 | + * Alias of self::get_phone(). |
|
| 923 | + * |
|
| 924 | + * @since 1.0.19 |
|
| 925 | + * @param string $context View or edit context. |
|
| 926 | + * @return int |
|
| 927 | + */ |
|
| 928 | + public function get_user_phone( $context = 'view' ) { |
|
| 929 | + return $this->get_phone( $context ); |
|
| 864 | 930 | } |
| 865 | 931 | |
| 866 | 932 | /** |
| 867 | - * Get the customer's full name. |
|
| 868 | - * |
|
| 869 | - * @since 1.0.19 |
|
| 870 | - * @param string $context View or edit context. |
|
| 871 | - * @return string |
|
| 872 | - */ |
|
| 873 | - public function get_full_name( $context = 'view' ) { |
|
| 874 | - return trim( $this->get_first_name( $context ) . ' ' . $this->get_last_name( $context ) ); |
|
| 933 | + * Alias of self::get_phone(). |
|
| 934 | + * |
|
| 935 | + * @since 1.0.19 |
|
| 936 | + * @param string $context View or edit context. |
|
| 937 | + * @return int |
|
| 938 | + */ |
|
| 939 | + public function get_customer_phone( $context = 'view' ) { |
|
| 940 | + return $this->get_phone( $context ); |
|
| 941 | + } |
|
| 942 | + |
|
| 943 | + /** |
|
| 944 | + * Get the customer's email address. |
|
| 945 | + * |
|
| 946 | + * @since 1.0.19 |
|
| 947 | + * @param string $context View or edit context. |
|
| 948 | + * @return string |
|
| 949 | + */ |
|
| 950 | + public function get_email( $context = 'view' ) { |
|
| 951 | + return $this->get_prop( 'email', $context ); |
|
| 952 | + } |
|
| 953 | + |
|
| 954 | + /** |
|
| 955 | + * Alias of self::get_email(). |
|
| 956 | + * |
|
| 957 | + * @since 1.0.19 |
|
| 958 | + * @param string $context View or edit context. |
|
| 959 | + * @return string |
|
| 960 | + */ |
|
| 961 | + public function get_email_address( $context = 'view' ) { |
|
| 962 | + return $this->get_email( $context ); |
|
| 963 | + } |
|
| 964 | + |
|
| 965 | + /** |
|
| 966 | + * Alias of self::get_email(). |
|
| 967 | + * |
|
| 968 | + * @since 1.0.19 |
|
| 969 | + * @param string $context View or edit context. |
|
| 970 | + * @return int |
|
| 971 | + */ |
|
| 972 | + public function get_user_email( $context = 'view' ) { |
|
| 973 | + return $this->get_email( $context ); |
|
| 974 | + } |
|
| 975 | + |
|
| 976 | + /** |
|
| 977 | + * Alias of self::get_email(). |
|
| 978 | + * |
|
| 979 | + * @since 1.0.19 |
|
| 980 | + * @param string $context View or edit context. |
|
| 981 | + * @return int |
|
| 982 | + */ |
|
| 983 | + public function get_customer_email( $context = 'view' ) { |
|
| 984 | + return $this->get_email( $context ); |
|
| 985 | + } |
|
| 986 | + |
|
| 987 | + /** |
|
| 988 | + * Get the customer's country. |
|
| 989 | + * |
|
| 990 | + * @since 1.0.19 |
|
| 991 | + * @param string $context View or edit context. |
|
| 992 | + * @return string |
|
| 993 | + */ |
|
| 994 | + public function get_country( $context = 'view' ) { |
|
| 995 | + $country = $this->get_prop( 'country', $context ); |
|
| 996 | + return empty( $country ) ? wpinv_get_default_country() : $country; |
|
| 997 | + } |
|
| 998 | + |
|
| 999 | + /** |
|
| 1000 | + * Alias of self::get_country(). |
|
| 1001 | + * |
|
| 1002 | + * @since 1.0.19 |
|
| 1003 | + * @param string $context View or edit context. |
|
| 1004 | + * @return int |
|
| 1005 | + */ |
|
| 1006 | + public function get_user_country( $context = 'view' ) { |
|
| 1007 | + return $this->get_country( $context ); |
|
| 1008 | + } |
|
| 1009 | + |
|
| 1010 | + /** |
|
| 1011 | + * Alias of self::get_country(). |
|
| 1012 | + * |
|
| 1013 | + * @since 1.0.19 |
|
| 1014 | + * @param string $context View or edit context. |
|
| 1015 | + * @return int |
|
| 1016 | + */ |
|
| 1017 | + public function get_customer_country( $context = 'view' ) { |
|
| 1018 | + return $this->get_country( $context ); |
|
| 875 | 1019 | } |
| 876 | 1020 | |
| 877 | 1021 | /** |
| 878 | - * Alias of self::get_full_name(). |
|
| 879 | - * |
|
| 880 | - * @since 1.0.19 |
|
| 881 | - * @param string $context View or edit context. |
|
| 882 | - * @return int |
|
| 883 | - */ |
|
| 884 | - public function get_user_full_name( $context = 'view' ) { |
|
| 885 | - return $this->get_full_name( $context ); |
|
| 1022 | + * Get the customer's state. |
|
| 1023 | + * |
|
| 1024 | + * @since 1.0.19 |
|
| 1025 | + * @param string $context View or edit context. |
|
| 1026 | + * @return string |
|
| 1027 | + */ |
|
| 1028 | + public function get_state( $context = 'view' ) { |
|
| 1029 | + $state = $this->get_prop( 'state', $context ); |
|
| 1030 | + return empty( $state ) ? wpinv_get_default_state() : $state; |
|
| 886 | 1031 | } |
| 887 | 1032 | |
| 888 | 1033 | /** |
| 889 | - * Alias of self::get_full_name(). |
|
| 890 | - * |
|
| 891 | - * @since 1.0.19 |
|
| 892 | - * @param string $context View or edit context. |
|
| 893 | - * @return int |
|
| 894 | - */ |
|
| 895 | - public function get_customer_full_name( $context = 'view' ) { |
|
| 896 | - return $this->get_full_name( $context ); |
|
| 1034 | + * Alias of self::get_state(). |
|
| 1035 | + * |
|
| 1036 | + * @since 1.0.19 |
|
| 1037 | + * @param string $context View or edit context. |
|
| 1038 | + * @return int |
|
| 1039 | + */ |
|
| 1040 | + public function get_user_state( $context = 'view' ) { |
|
| 1041 | + return $this->get_state( $context ); |
|
| 897 | 1042 | } |
| 898 | 1043 | |
| 899 | 1044 | /** |
| 900 | - * Get the customer's phone number. |
|
| 901 | - * |
|
| 902 | - * @since 1.0.19 |
|
| 903 | - * @param string $context View or edit context. |
|
| 904 | - * @return string |
|
| 905 | - */ |
|
| 906 | - public function get_phone( $context = 'view' ) { |
|
| 907 | - return $this->get_prop( 'phone', $context ); |
|
| 1045 | + * Alias of self::get_state(). |
|
| 1046 | + * |
|
| 1047 | + * @since 1.0.19 |
|
| 1048 | + * @param string $context View or edit context. |
|
| 1049 | + * @return int |
|
| 1050 | + */ |
|
| 1051 | + public function get_customer_state( $context = 'view' ) { |
|
| 1052 | + return $this->get_state( $context ); |
|
| 908 | 1053 | } |
| 909 | 1054 | |
| 910 | 1055 | /** |
| 911 | - * Alias of self::get_phone(). |
|
| 912 | - * |
|
| 913 | - * @since 1.0.19 |
|
| 914 | - * @param string $context View or edit context. |
|
| 915 | - * @return int |
|
| 916 | - */ |
|
| 917 | - public function get_phone_number( $context = 'view' ) { |
|
| 918 | - return $this->get_phone( $context ); |
|
| 1056 | + * Get the customer's city. |
|
| 1057 | + * |
|
| 1058 | + * @since 1.0.19 |
|
| 1059 | + * @param string $context View or edit context. |
|
| 1060 | + * @return string |
|
| 1061 | + */ |
|
| 1062 | + public function get_city( $context = 'view' ) { |
|
| 1063 | + return $this->get_prop( 'city', $context ); |
|
| 919 | 1064 | } |
| 920 | 1065 | |
| 921 | 1066 | /** |
| 922 | - * Alias of self::get_phone(). |
|
| 923 | - * |
|
| 924 | - * @since 1.0.19 |
|
| 925 | - * @param string $context View or edit context. |
|
| 926 | - * @return int |
|
| 927 | - */ |
|
| 928 | - public function get_user_phone( $context = 'view' ) { |
|
| 929 | - return $this->get_phone( $context ); |
|
| 1067 | + * Alias of self::get_city(). |
|
| 1068 | + * |
|
| 1069 | + * @since 1.0.19 |
|
| 1070 | + * @param string $context View or edit context. |
|
| 1071 | + * @return string |
|
| 1072 | + */ |
|
| 1073 | + public function get_user_city( $context = 'view' ) { |
|
| 1074 | + return $this->get_city( $context ); |
|
| 930 | 1075 | } |
| 931 | 1076 | |
| 932 | 1077 | /** |
| 933 | - * Alias of self::get_phone(). |
|
| 934 | - * |
|
| 935 | - * @since 1.0.19 |
|
| 936 | - * @param string $context View or edit context. |
|
| 937 | - * @return int |
|
| 938 | - */ |
|
| 939 | - public function get_customer_phone( $context = 'view' ) { |
|
| 940 | - return $this->get_phone( $context ); |
|
| 1078 | + * Alias of self::get_city(). |
|
| 1079 | + * |
|
| 1080 | + * @since 1.0.19 |
|
| 1081 | + * @param string $context View or edit context. |
|
| 1082 | + * @return string |
|
| 1083 | + */ |
|
| 1084 | + public function get_customer_city( $context = 'view' ) { |
|
| 1085 | + return $this->get_city( $context ); |
|
| 941 | 1086 | } |
| 942 | 1087 | |
| 943 | 1088 | /** |
| 944 | - * Get the customer's email address. |
|
| 945 | - * |
|
| 946 | - * @since 1.0.19 |
|
| 947 | - * @param string $context View or edit context. |
|
| 948 | - * @return string |
|
| 949 | - */ |
|
| 950 | - public function get_email( $context = 'view' ) { |
|
| 951 | - return $this->get_prop( 'email', $context ); |
|
| 1089 | + * Get the customer's zip. |
|
| 1090 | + * |
|
| 1091 | + * @since 1.0.19 |
|
| 1092 | + * @param string $context View or edit context. |
|
| 1093 | + * @return string |
|
| 1094 | + */ |
|
| 1095 | + public function get_zip( $context = 'view' ) { |
|
| 1096 | + return $this->get_prop( 'zip', $context ); |
|
| 952 | 1097 | } |
| 953 | 1098 | |
| 954 | 1099 | /** |
| 955 | - * Alias of self::get_email(). |
|
| 956 | - * |
|
| 957 | - * @since 1.0.19 |
|
| 958 | - * @param string $context View or edit context. |
|
| 959 | - * @return string |
|
| 960 | - */ |
|
| 961 | - public function get_email_address( $context = 'view' ) { |
|
| 962 | - return $this->get_email( $context ); |
|
| 1100 | + * Alias of self::get_zip(). |
|
| 1101 | + * |
|
| 1102 | + * @since 1.0.19 |
|
| 1103 | + * @param string $context View or edit context. |
|
| 1104 | + * @return string |
|
| 1105 | + */ |
|
| 1106 | + public function get_user_zip( $context = 'view' ) { |
|
| 1107 | + return $this->get_zip( $context ); |
|
| 963 | 1108 | } |
| 964 | 1109 | |
| 965 | 1110 | /** |
| 966 | - * Alias of self::get_email(). |
|
| 967 | - * |
|
| 968 | - * @since 1.0.19 |
|
| 969 | - * @param string $context View or edit context. |
|
| 970 | - * @return int |
|
| 971 | - */ |
|
| 972 | - public function get_user_email( $context = 'view' ) { |
|
| 973 | - return $this->get_email( $context ); |
|
| 1111 | + * Alias of self::get_zip(). |
|
| 1112 | + * |
|
| 1113 | + * @since 1.0.19 |
|
| 1114 | + * @param string $context View or edit context. |
|
| 1115 | + * @return string |
|
| 1116 | + */ |
|
| 1117 | + public function get_customer_zip( $context = 'view' ) { |
|
| 1118 | + return $this->get_zip( $context ); |
|
| 974 | 1119 | } |
| 975 | 1120 | |
| 976 | 1121 | /** |
| 977 | - * Alias of self::get_email(). |
|
| 978 | - * |
|
| 979 | - * @since 1.0.19 |
|
| 980 | - * @param string $context View or edit context. |
|
| 981 | - * @return int |
|
| 982 | - */ |
|
| 983 | - public function get_customer_email( $context = 'view' ) { |
|
| 984 | - return $this->get_email( $context ); |
|
| 1122 | + * Get the customer's company. |
|
| 1123 | + * |
|
| 1124 | + * @since 1.0.19 |
|
| 1125 | + * @param string $context View or edit context. |
|
| 1126 | + * @return string |
|
| 1127 | + */ |
|
| 1128 | + public function get_company( $context = 'view' ) { |
|
| 1129 | + return $this->get_prop( 'company', $context ); |
|
| 985 | 1130 | } |
| 986 | 1131 | |
| 987 | 1132 | /** |
| 988 | - * Get the customer's country. |
|
| 989 | - * |
|
| 990 | - * @since 1.0.19 |
|
| 991 | - * @param string $context View or edit context. |
|
| 992 | - * @return string |
|
| 993 | - */ |
|
| 994 | - public function get_country( $context = 'view' ) { |
|
| 995 | - $country = $this->get_prop( 'country', $context ); |
|
| 996 | - return empty( $country ) ? wpinv_get_default_country() : $country; |
|
| 1133 | + * Alias of self::get_company(). |
|
| 1134 | + * |
|
| 1135 | + * @since 1.0.19 |
|
| 1136 | + * @param string $context View or edit context. |
|
| 1137 | + * @return string |
|
| 1138 | + */ |
|
| 1139 | + public function get_user_company( $context = 'view' ) { |
|
| 1140 | + return $this->get_company( $context ); |
|
| 997 | 1141 | } |
| 998 | 1142 | |
| 999 | 1143 | /** |
| 1000 | - * Alias of self::get_country(). |
|
| 1001 | - * |
|
| 1002 | - * @since 1.0.19 |
|
| 1003 | - * @param string $context View or edit context. |
|
| 1004 | - * @return int |
|
| 1005 | - */ |
|
| 1006 | - public function get_user_country( $context = 'view' ) { |
|
| 1007 | - return $this->get_country( $context ); |
|
| 1144 | + * Alias of self::get_company(). |
|
| 1145 | + * |
|
| 1146 | + * @since 1.0.19 |
|
| 1147 | + * @param string $context View or edit context. |
|
| 1148 | + * @return string |
|
| 1149 | + */ |
|
| 1150 | + public function get_customer_company( $context = 'view' ) { |
|
| 1151 | + return $this->get_company( $context ); |
|
| 1008 | 1152 | } |
| 1009 | 1153 | |
| 1010 | 1154 | /** |
| 1011 | - * Alias of self::get_country(). |
|
| 1012 | - * |
|
| 1013 | - * @since 1.0.19 |
|
| 1014 | - * @param string $context View or edit context. |
|
| 1015 | - * @return int |
|
| 1016 | - */ |
|
| 1017 | - public function get_customer_country( $context = 'view' ) { |
|
| 1018 | - return $this->get_country( $context ); |
|
| 1155 | + * Get the customer's vat number. |
|
| 1156 | + * |
|
| 1157 | + * @since 1.0.19 |
|
| 1158 | + * @param string $context View or edit context. |
|
| 1159 | + * @return string |
|
| 1160 | + */ |
|
| 1161 | + public function get_vat_number( $context = 'view' ) { |
|
| 1162 | + return $this->get_prop( 'vat_number', $context ); |
|
| 1019 | 1163 | } |
| 1020 | 1164 | |
| 1021 | 1165 | /** |
| 1022 | - * Get the customer's state. |
|
| 1023 | - * |
|
| 1024 | - * @since 1.0.19 |
|
| 1025 | - * @param string $context View or edit context. |
|
| 1026 | - * @return string |
|
| 1027 | - */ |
|
| 1028 | - public function get_state( $context = 'view' ) { |
|
| 1029 | - $state = $this->get_prop( 'state', $context ); |
|
| 1030 | - return empty( $state ) ? wpinv_get_default_state() : $state; |
|
| 1166 | + * Alias of self::get_vat_number(). |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.19 |
|
| 1169 | + * @param string $context View or edit context. |
|
| 1170 | + * @return string |
|
| 1171 | + */ |
|
| 1172 | + public function get_user_vat_number( $context = 'view' ) { |
|
| 1173 | + return $this->get_vat_number( $context ); |
|
| 1031 | 1174 | } |
| 1032 | 1175 | |
| 1033 | 1176 | /** |
| 1034 | - * Alias of self::get_state(). |
|
| 1035 | - * |
|
| 1036 | - * @since 1.0.19 |
|
| 1037 | - * @param string $context View or edit context. |
|
| 1038 | - * @return int |
|
| 1039 | - */ |
|
| 1040 | - public function get_user_state( $context = 'view' ) { |
|
| 1041 | - return $this->get_state( $context ); |
|
| 1177 | + * Alias of self::get_vat_number(). |
|
| 1178 | + * |
|
| 1179 | + * @since 1.0.19 |
|
| 1180 | + * @param string $context View or edit context. |
|
| 1181 | + * @return string |
|
| 1182 | + */ |
|
| 1183 | + public function get_customer_vat_number( $context = 'view' ) { |
|
| 1184 | + return $this->get_vat_number( $context ); |
|
| 1042 | 1185 | } |
| 1043 | 1186 | |
| 1044 | 1187 | /** |
| 1045 | - * Alias of self::get_state(). |
|
| 1046 | - * |
|
| 1047 | - * @since 1.0.19 |
|
| 1048 | - * @param string $context View or edit context. |
|
| 1049 | - * @return int |
|
| 1050 | - */ |
|
| 1051 | - public function get_customer_state( $context = 'view' ) { |
|
| 1052 | - return $this->get_state( $context ); |
|
| 1188 | + * Get the customer's vat rate. |
|
| 1189 | + * |
|
| 1190 | + * @since 1.0.19 |
|
| 1191 | + * @param string $context View or edit context. |
|
| 1192 | + * @return string |
|
| 1193 | + */ |
|
| 1194 | + public function get_vat_rate( $context = 'view' ) { |
|
| 1195 | + return $this->get_prop( 'vat_rate', $context ); |
|
| 1053 | 1196 | } |
| 1054 | 1197 | |
| 1055 | 1198 | /** |
| 1056 | - * Get the customer's city. |
|
| 1057 | - * |
|
| 1058 | - * @since 1.0.19 |
|
| 1059 | - * @param string $context View or edit context. |
|
| 1060 | - * @return string |
|
| 1061 | - */ |
|
| 1062 | - public function get_city( $context = 'view' ) { |
|
| 1063 | - return $this->get_prop( 'city', $context ); |
|
| 1199 | + * Alias of self::get_vat_rate(). |
|
| 1200 | + * |
|
| 1201 | + * @since 1.0.19 |
|
| 1202 | + * @param string $context View or edit context. |
|
| 1203 | + * @return string |
|
| 1204 | + */ |
|
| 1205 | + public function get_user_vat_rate( $context = 'view' ) { |
|
| 1206 | + return $this->get_vat_rate( $context ); |
|
| 1064 | 1207 | } |
| 1065 | 1208 | |
| 1066 | 1209 | /** |
| 1067 | - * Alias of self::get_city(). |
|
| 1068 | - * |
|
| 1069 | - * @since 1.0.19 |
|
| 1070 | - * @param string $context View or edit context. |
|
| 1071 | - * @return string |
|
| 1072 | - */ |
|
| 1073 | - public function get_user_city( $context = 'view' ) { |
|
| 1074 | - return $this->get_city( $context ); |
|
| 1210 | + * Alias of self::get_vat_rate(). |
|
| 1211 | + * |
|
| 1212 | + * @since 1.0.19 |
|
| 1213 | + * @param string $context View or edit context. |
|
| 1214 | + * @return string |
|
| 1215 | + */ |
|
| 1216 | + public function get_customer_vat_rate( $context = 'view' ) { |
|
| 1217 | + return $this->get_vat_rate( $context ); |
|
| 1075 | 1218 | } |
| 1076 | 1219 | |
| 1077 | 1220 | /** |
| 1078 | - * Alias of self::get_city(). |
|
| 1079 | - * |
|
| 1080 | - * @since 1.0.19 |
|
| 1081 | - * @param string $context View or edit context. |
|
| 1082 | - * @return string |
|
| 1083 | - */ |
|
| 1084 | - public function get_customer_city( $context = 'view' ) { |
|
| 1085 | - return $this->get_city( $context ); |
|
| 1221 | + * Get the customer's address. |
|
| 1222 | + * |
|
| 1223 | + * @since 1.0.19 |
|
| 1224 | + * @param string $context View or edit context. |
|
| 1225 | + * @return string |
|
| 1226 | + */ |
|
| 1227 | + public function get_address( $context = 'view' ) { |
|
| 1228 | + return $this->get_prop( 'address', $context ); |
|
| 1086 | 1229 | } |
| 1087 | 1230 | |
| 1088 | 1231 | /** |
| 1089 | - * Get the customer's zip. |
|
| 1090 | - * |
|
| 1091 | - * @since 1.0.19 |
|
| 1092 | - * @param string $context View or edit context. |
|
| 1093 | - * @return string |
|
| 1094 | - */ |
|
| 1095 | - public function get_zip( $context = 'view' ) { |
|
| 1096 | - return $this->get_prop( 'zip', $context ); |
|
| 1232 | + * Alias of self::get_address(). |
|
| 1233 | + * |
|
| 1234 | + * @since 1.0.19 |
|
| 1235 | + * @param string $context View or edit context. |
|
| 1236 | + * @return string |
|
| 1237 | + */ |
|
| 1238 | + public function get_user_address( $context = 'view' ) { |
|
| 1239 | + return $this->get_address( $context ); |
|
| 1097 | 1240 | } |
| 1098 | 1241 | |
| 1099 | 1242 | /** |
| 1100 | - * Alias of self::get_zip(). |
|
| 1101 | - * |
|
| 1102 | - * @since 1.0.19 |
|
| 1103 | - * @param string $context View or edit context. |
|
| 1104 | - * @return string |
|
| 1105 | - */ |
|
| 1106 | - public function get_user_zip( $context = 'view' ) { |
|
| 1107 | - return $this->get_zip( $context ); |
|
| 1243 | + * Alias of self::get_address(). |
|
| 1244 | + * |
|
| 1245 | + * @since 1.0.19 |
|
| 1246 | + * @param string $context View or edit context. |
|
| 1247 | + * @return string |
|
| 1248 | + */ |
|
| 1249 | + public function get_customer_address( $context = 'view' ) { |
|
| 1250 | + return $this->get_address( $context ); |
|
| 1108 | 1251 | } |
| 1109 | 1252 | |
| 1110 | 1253 | /** |
| 1111 | - * Alias of self::get_zip(). |
|
| 1112 | - * |
|
| 1113 | - * @since 1.0.19 |
|
| 1114 | - * @param string $context View or edit context. |
|
| 1115 | - * @return string |
|
| 1116 | - */ |
|
| 1117 | - public function get_customer_zip( $context = 'view' ) { |
|
| 1118 | - return $this->get_zip( $context ); |
|
| 1254 | + * Get whether the customer has viewed the invoice or not. |
|
| 1255 | + * |
|
| 1256 | + * @since 1.0.19 |
|
| 1257 | + * @param string $context View or edit context. |
|
| 1258 | + * @return bool |
|
| 1259 | + */ |
|
| 1260 | + public function get_is_viewed( $context = 'view' ) { |
|
| 1261 | + return (bool) $this->get_prop( 'is_viewed', $context ); |
|
| 1119 | 1262 | } |
| 1120 | 1263 | |
| 1121 | 1264 | /** |
| 1122 | - * Get the customer's company. |
|
| 1123 | - * |
|
| 1124 | - * @since 1.0.19 |
|
| 1125 | - * @param string $context View or edit context. |
|
| 1126 | - * @return string |
|
| 1127 | - */ |
|
| 1128 | - public function get_company( $context = 'view' ) { |
|
| 1129 | - return $this->get_prop( 'company', $context ); |
|
| 1265 | + * Get other recipients for invoice communications. |
|
| 1266 | + * |
|
| 1267 | + * @since 1.0.19 |
|
| 1268 | + * @param string $context View or edit context. |
|
| 1269 | + * @return bool |
|
| 1270 | + */ |
|
| 1271 | + public function get_email_cc( $context = 'view' ) { |
|
| 1272 | + return $this->get_prop( 'email_cc', $context ); |
|
| 1130 | 1273 | } |
| 1131 | 1274 | |
| 1132 | 1275 | /** |
| 1133 | - * Alias of self::get_company(). |
|
| 1134 | - * |
|
| 1135 | - * @since 1.0.19 |
|
| 1136 | - * @param string $context View or edit context. |
|
| 1137 | - * @return string |
|
| 1138 | - */ |
|
| 1139 | - public function get_user_company( $context = 'view' ) { |
|
| 1140 | - return $this->get_company( $context ); |
|
| 1276 | + * Get invoice template. |
|
| 1277 | + * |
|
| 1278 | + * @since 1.0.19 |
|
| 1279 | + * @param string $context View or edit context. |
|
| 1280 | + * @return bool |
|
| 1281 | + */ |
|
| 1282 | + public function get_template( $context = 'view' ) { |
|
| 1283 | + return $this->get_prop( 'template', $context ); |
|
| 1141 | 1284 | } |
| 1142 | 1285 | |
| 1143 | 1286 | /** |
| 1144 | - * Alias of self::get_company(). |
|
| 1145 | - * |
|
| 1146 | - * @since 1.0.19 |
|
| 1147 | - * @param string $context View or edit context. |
|
| 1148 | - * @return string |
|
| 1149 | - */ |
|
| 1150 | - public function get_customer_company( $context = 'view' ) { |
|
| 1151 | - return $this->get_company( $context ); |
|
| 1287 | + * Get invoice source. |
|
| 1288 | + * |
|
| 1289 | + * @since 1.0.19 |
|
| 1290 | + * @param string $context View or edit context. |
|
| 1291 | + * @return bool |
|
| 1292 | + */ |
|
| 1293 | + public function get_created_via( $context = 'view' ) { |
|
| 1294 | + return $this->get_prop( 'created_via', $context ); |
|
| 1152 | 1295 | } |
| 1153 | 1296 | |
| 1154 | 1297 | /** |
| 1155 | - * Get the customer's vat number. |
|
| 1156 | - * |
|
| 1157 | - * @since 1.0.19 |
|
| 1158 | - * @param string $context View or edit context. |
|
| 1159 | - * @return string |
|
| 1160 | - */ |
|
| 1161 | - public function get_vat_number( $context = 'view' ) { |
|
| 1162 | - return $this->get_prop( 'vat_number', $context ); |
|
| 1298 | + * Get whether the customer has confirmed their address. |
|
| 1299 | + * |
|
| 1300 | + * @since 1.0.19 |
|
| 1301 | + * @param string $context View or edit context. |
|
| 1302 | + * @return bool |
|
| 1303 | + */ |
|
| 1304 | + public function get_address_confirmed( $context = 'view' ) { |
|
| 1305 | + return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
| 1163 | 1306 | } |
| 1164 | 1307 | |
| 1165 | 1308 | /** |
| 1166 | - * Alias of self::get_vat_number(). |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.19 |
|
| 1169 | - * @param string $context View or edit context. |
|
| 1170 | - * @return string |
|
| 1171 | - */ |
|
| 1172 | - public function get_user_vat_number( $context = 'view' ) { |
|
| 1173 | - return $this->get_vat_number( $context ); |
|
| 1309 | + * Alias of self::get_address_confirmed(). |
|
| 1310 | + * |
|
| 1311 | + * @since 1.0.19 |
|
| 1312 | + * @param string $context View or edit context. |
|
| 1313 | + * @return bool |
|
| 1314 | + */ |
|
| 1315 | + public function get_user_address_confirmed( $context = 'view' ) { |
|
| 1316 | + return $this->get_address_confirmed( $context ); |
|
| 1174 | 1317 | } |
| 1175 | 1318 | |
| 1176 | 1319 | /** |
| 1177 | - * Alias of self::get_vat_number(). |
|
| 1178 | - * |
|
| 1179 | - * @since 1.0.19 |
|
| 1180 | - * @param string $context View or edit context. |
|
| 1181 | - * @return string |
|
| 1182 | - */ |
|
| 1183 | - public function get_customer_vat_number( $context = 'view' ) { |
|
| 1184 | - return $this->get_vat_number( $context ); |
|
| 1320 | + * Alias of self::get_address(). |
|
| 1321 | + * |
|
| 1322 | + * @since 1.0.19 |
|
| 1323 | + * @param string $context View or edit context. |
|
| 1324 | + * @return bool |
|
| 1325 | + */ |
|
| 1326 | + public function get_customer_address_confirmed( $context = 'view' ) { |
|
| 1327 | + return $this->get_address_confirmed( $context ); |
|
| 1185 | 1328 | } |
| 1186 | 1329 | |
| 1187 | 1330 | /** |
| 1188 | - * Get the customer's vat rate. |
|
| 1189 | - * |
|
| 1190 | - * @since 1.0.19 |
|
| 1191 | - * @param string $context View or edit context. |
|
| 1192 | - * @return string |
|
| 1193 | - */ |
|
| 1194 | - public function get_vat_rate( $context = 'view' ) { |
|
| 1195 | - return $this->get_prop( 'vat_rate', $context ); |
|
| 1196 | - } |
|
| 1197 | - |
|
| 1198 | - /** |
|
| 1199 | - * Alias of self::get_vat_rate(). |
|
| 1200 | - * |
|
| 1201 | - * @since 1.0.19 |
|
| 1202 | - * @param string $context View or edit context. |
|
| 1203 | - * @return string |
|
| 1204 | - */ |
|
| 1205 | - public function get_user_vat_rate( $context = 'view' ) { |
|
| 1206 | - return $this->get_vat_rate( $context ); |
|
| 1207 | - } |
|
| 1208 | - |
|
| 1209 | - /** |
|
| 1210 | - * Alias of self::get_vat_rate(). |
|
| 1211 | - * |
|
| 1212 | - * @since 1.0.19 |
|
| 1213 | - * @param string $context View or edit context. |
|
| 1214 | - * @return string |
|
| 1215 | - */ |
|
| 1216 | - public function get_customer_vat_rate( $context = 'view' ) { |
|
| 1217 | - return $this->get_vat_rate( $context ); |
|
| 1218 | - } |
|
| 1219 | - |
|
| 1220 | - /** |
|
| 1221 | - * Get the customer's address. |
|
| 1222 | - * |
|
| 1223 | - * @since 1.0.19 |
|
| 1224 | - * @param string $context View or edit context. |
|
| 1225 | - * @return string |
|
| 1226 | - */ |
|
| 1227 | - public function get_address( $context = 'view' ) { |
|
| 1228 | - return $this->get_prop( 'address', $context ); |
|
| 1229 | - } |
|
| 1230 | - |
|
| 1231 | - /** |
|
| 1232 | - * Alias of self::get_address(). |
|
| 1233 | - * |
|
| 1234 | - * @since 1.0.19 |
|
| 1235 | - * @param string $context View or edit context. |
|
| 1236 | - * @return string |
|
| 1237 | - */ |
|
| 1238 | - public function get_user_address( $context = 'view' ) { |
|
| 1239 | - return $this->get_address( $context ); |
|
| 1240 | - } |
|
| 1241 | - |
|
| 1242 | - /** |
|
| 1243 | - * Alias of self::get_address(). |
|
| 1244 | - * |
|
| 1245 | - * @since 1.0.19 |
|
| 1246 | - * @param string $context View or edit context. |
|
| 1247 | - * @return string |
|
| 1248 | - */ |
|
| 1249 | - public function get_customer_address( $context = 'view' ) { |
|
| 1250 | - return $this->get_address( $context ); |
|
| 1251 | - } |
|
| 1252 | - |
|
| 1253 | - /** |
|
| 1254 | - * Get whether the customer has viewed the invoice or not. |
|
| 1255 | - * |
|
| 1256 | - * @since 1.0.19 |
|
| 1257 | - * @param string $context View or edit context. |
|
| 1258 | - * @return bool |
|
| 1259 | - */ |
|
| 1260 | - public function get_is_viewed( $context = 'view' ) { |
|
| 1261 | - return (bool) $this->get_prop( 'is_viewed', $context ); |
|
| 1262 | - } |
|
| 1263 | - |
|
| 1264 | - /** |
|
| 1265 | - * Get other recipients for invoice communications. |
|
| 1266 | - * |
|
| 1267 | - * @since 1.0.19 |
|
| 1268 | - * @param string $context View or edit context. |
|
| 1269 | - * @return bool |
|
| 1270 | - */ |
|
| 1271 | - public function get_email_cc( $context = 'view' ) { |
|
| 1272 | - return $this->get_prop( 'email_cc', $context ); |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - /** |
|
| 1276 | - * Get invoice template. |
|
| 1277 | - * |
|
| 1278 | - * @since 1.0.19 |
|
| 1279 | - * @param string $context View or edit context. |
|
| 1280 | - * @return bool |
|
| 1281 | - */ |
|
| 1282 | - public function get_template( $context = 'view' ) { |
|
| 1283 | - return $this->get_prop( 'template', $context ); |
|
| 1284 | - } |
|
| 1285 | - |
|
| 1286 | - /** |
|
| 1287 | - * Get invoice source. |
|
| 1288 | - * |
|
| 1289 | - * @since 1.0.19 |
|
| 1290 | - * @param string $context View or edit context. |
|
| 1291 | - * @return bool |
|
| 1292 | - */ |
|
| 1293 | - public function get_created_via( $context = 'view' ) { |
|
| 1294 | - return $this->get_prop( 'created_via', $context ); |
|
| 1295 | - } |
|
| 1296 | - |
|
| 1297 | - /** |
|
| 1298 | - * Get whether the customer has confirmed their address. |
|
| 1299 | - * |
|
| 1300 | - * @since 1.0.19 |
|
| 1301 | - * @param string $context View or edit context. |
|
| 1302 | - * @return bool |
|
| 1303 | - */ |
|
| 1304 | - public function get_address_confirmed( $context = 'view' ) { |
|
| 1305 | - return (bool) $this->get_prop( 'address_confirmed', $context ); |
|
| 1306 | - } |
|
| 1307 | - |
|
| 1308 | - /** |
|
| 1309 | - * Alias of self::get_address_confirmed(). |
|
| 1310 | - * |
|
| 1311 | - * @since 1.0.19 |
|
| 1312 | - * @param string $context View or edit context. |
|
| 1313 | - * @return bool |
|
| 1314 | - */ |
|
| 1315 | - public function get_user_address_confirmed( $context = 'view' ) { |
|
| 1316 | - return $this->get_address_confirmed( $context ); |
|
| 1317 | - } |
|
| 1318 | - |
|
| 1319 | - /** |
|
| 1320 | - * Alias of self::get_address(). |
|
| 1321 | - * |
|
| 1322 | - * @since 1.0.19 |
|
| 1323 | - * @param string $context View or edit context. |
|
| 1324 | - * @return bool |
|
| 1325 | - */ |
|
| 1326 | - public function get_customer_address_confirmed( $context = 'view' ) { |
|
| 1327 | - return $this->get_address_confirmed( $context ); |
|
| 1328 | - } |
|
| 1329 | - |
|
| 1330 | - /** |
|
| 1331 | - * Get the invoice subtotal. |
|
| 1332 | - * |
|
| 1333 | - * @since 1.0.19 |
|
| 1334 | - * @param string $context View or edit context. |
|
| 1335 | - * @return float |
|
| 1336 | - */ |
|
| 1337 | - public function get_subtotal( $context = 'view' ) { |
|
| 1331 | + * Get the invoice subtotal. |
|
| 1332 | + * |
|
| 1333 | + * @since 1.0.19 |
|
| 1334 | + * @param string $context View or edit context. |
|
| 1335 | + * @return float |
|
| 1336 | + */ |
|
| 1337 | + public function get_subtotal( $context = 'view' ) { |
|
| 1338 | 1338 | $subtotal = (float) $this->get_prop( 'subtotal', $context ); |
| 1339 | 1339 | |
| 1340 | 1340 | // Backwards compatibility. |
@@ -1346,165 +1346,165 @@ discard block |
||
| 1346 | 1346 | } |
| 1347 | 1347 | |
| 1348 | 1348 | /** |
| 1349 | - * Get the invoice discount total. |
|
| 1350 | - * |
|
| 1351 | - * @since 1.0.19 |
|
| 1352 | - * @param string $context View or edit context. |
|
| 1353 | - * @return float |
|
| 1354 | - */ |
|
| 1355 | - public function get_total_discount( $context = 'view' ) { |
|
| 1356 | - return (float) $this->get_prop( 'total_discount', $context ); |
|
| 1349 | + * Get the invoice discount total. |
|
| 1350 | + * |
|
| 1351 | + * @since 1.0.19 |
|
| 1352 | + * @param string $context View or edit context. |
|
| 1353 | + * @return float |
|
| 1354 | + */ |
|
| 1355 | + public function get_total_discount( $context = 'view' ) { |
|
| 1356 | + return (float) $this->get_prop( 'total_discount', $context ); |
|
| 1357 | 1357 | } |
| 1358 | 1358 | |
| 1359 | 1359 | /** |
| 1360 | - * Get the invoice tax total. |
|
| 1361 | - * |
|
| 1362 | - * @since 1.0.19 |
|
| 1363 | - * @param string $context View or edit context. |
|
| 1364 | - * @return float |
|
| 1365 | - */ |
|
| 1366 | - public function get_total_tax( $context = 'view' ) { |
|
| 1367 | - return (float) $this->get_prop( 'total_tax', $context ); |
|
| 1368 | - } |
|
| 1360 | + * Get the invoice tax total. |
|
| 1361 | + * |
|
| 1362 | + * @since 1.0.19 |
|
| 1363 | + * @param string $context View or edit context. |
|
| 1364 | + * @return float |
|
| 1365 | + */ |
|
| 1366 | + public function get_total_tax( $context = 'view' ) { |
|
| 1367 | + return (float) $this->get_prop( 'total_tax', $context ); |
|
| 1368 | + } |
|
| 1369 | 1369 | |
| 1370 | - /** |
|
| 1371 | - * @deprecated |
|
| 1372 | - */ |
|
| 1373 | - public function get_final_tax( $currency = false ) { |
|
| 1374 | - $tax = $this->get_total_tax(); |
|
| 1370 | + /** |
|
| 1371 | + * @deprecated |
|
| 1372 | + */ |
|
| 1373 | + public function get_final_tax( $currency = false ) { |
|
| 1374 | + $tax = $this->get_total_tax(); |
|
| 1375 | 1375 | |
| 1376 | 1376 | if ( $currency ) { |
| 1377 | - return wpinv_price( wpinv_format_amount( $tax, NULL, false ), $this->get_currency() ); |
|
| 1377 | + return wpinv_price( wpinv_format_amount( $tax, NULL, false ), $this->get_currency() ); |
|
| 1378 | 1378 | } |
| 1379 | 1379 | |
| 1380 | 1380 | return $tax; |
| 1381 | 1381 | } |
| 1382 | 1382 | |
| 1383 | 1383 | /** |
| 1384 | - * Get the invoice fees total. |
|
| 1385 | - * |
|
| 1386 | - * @since 1.0.19 |
|
| 1387 | - * @param string $context View or edit context. |
|
| 1388 | - * @return float |
|
| 1389 | - */ |
|
| 1390 | - public function get_total_fees( $context = 'view' ) { |
|
| 1391 | - return (float) $this->get_prop( 'total_fees', $context ); |
|
| 1384 | + * Get the invoice fees total. |
|
| 1385 | + * |
|
| 1386 | + * @since 1.0.19 |
|
| 1387 | + * @param string $context View or edit context. |
|
| 1388 | + * @return float |
|
| 1389 | + */ |
|
| 1390 | + public function get_total_fees( $context = 'view' ) { |
|
| 1391 | + return (float) $this->get_prop( 'total_fees', $context ); |
|
| 1392 | 1392 | } |
| 1393 | 1393 | |
| 1394 | 1394 | /** |
| 1395 | - * Alias for self::get_total_fees(). |
|
| 1396 | - * |
|
| 1397 | - * @since 1.0.19 |
|
| 1398 | - * @param string $context View or edit context. |
|
| 1399 | - * @return float |
|
| 1400 | - */ |
|
| 1401 | - public function get_fees_total( $context = 'view' ) { |
|
| 1402 | - return $this->get_total_fees( $context ); |
|
| 1395 | + * Alias for self::get_total_fees(). |
|
| 1396 | + * |
|
| 1397 | + * @since 1.0.19 |
|
| 1398 | + * @param string $context View or edit context. |
|
| 1399 | + * @return float |
|
| 1400 | + */ |
|
| 1401 | + public function get_fees_total( $context = 'view' ) { |
|
| 1402 | + return $this->get_total_fees( $context ); |
|
| 1403 | 1403 | } |
| 1404 | 1404 | |
| 1405 | 1405 | /** |
| 1406 | - * Get the invoice total. |
|
| 1407 | - * |
|
| 1408 | - * @since 1.0.19 |
|
| 1406 | + * Get the invoice total. |
|
| 1407 | + * |
|
| 1408 | + * @since 1.0.19 |
|
| 1409 | 1409 | * @return float |
| 1410 | - */ |
|
| 1411 | - public function get_total() { |
|
| 1412 | - $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total(); |
|
| 1413 | - return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this ); |
|
| 1414 | - } |
|
| 1410 | + */ |
|
| 1411 | + public function get_total() { |
|
| 1412 | + $total = $this->is_renewal() ? $this->get_recurring_total() : $this->get_initial_total(); |
|
| 1413 | + return apply_filters( 'getpaid_get_invoice_total_amount', $total, $this ); |
|
| 1414 | + } |
|
| 1415 | 1415 | |
| 1416 | - /** |
|
| 1417 | - * Get the invoice totals. |
|
| 1418 | - * |
|
| 1419 | - * @since 1.0.19 |
|
| 1416 | + /** |
|
| 1417 | + * Get the invoice totals. |
|
| 1418 | + * |
|
| 1419 | + * @since 1.0.19 |
|
| 1420 | 1420 | * @return float |
| 1421 | - */ |
|
| 1422 | - public function get_totals() { |
|
| 1423 | - return $this->totals; |
|
| 1421 | + */ |
|
| 1422 | + public function get_totals() { |
|
| 1423 | + return $this->totals; |
|
| 1424 | 1424 | } |
| 1425 | 1425 | |
| 1426 | 1426 | /** |
| 1427 | - * Get the initial invoice total. |
|
| 1428 | - * |
|
| 1429 | - * @since 1.0.19 |
|
| 1427 | + * Get the initial invoice total. |
|
| 1428 | + * |
|
| 1429 | + * @since 1.0.19 |
|
| 1430 | 1430 | * @param string $context View or edit context. |
| 1431 | 1431 | * @return float |
| 1432 | - */ |
|
| 1432 | + */ |
|
| 1433 | 1433 | public function get_initial_total() { |
| 1434 | 1434 | |
| 1435 | - if ( empty( $this->totals ) ) { |
|
| 1436 | - $this->recalculate_total(); |
|
| 1437 | - } |
|
| 1435 | + if ( empty( $this->totals ) ) { |
|
| 1436 | + $this->recalculate_total(); |
|
| 1437 | + } |
|
| 1438 | 1438 | |
| 1439 | - $tax = $this->totals['tax']['initial']; |
|
| 1440 | - $fee = $this->totals['fee']['initial']; |
|
| 1441 | - $discount = $this->totals['discount']['initial']; |
|
| 1442 | - $subtotal = $this->totals['subtotal']['initial']; |
|
| 1443 | - $total = $tax + $fee - $discount + $subtotal; |
|
| 1439 | + $tax = $this->totals['tax']['initial']; |
|
| 1440 | + $fee = $this->totals['fee']['initial']; |
|
| 1441 | + $discount = $this->totals['discount']['initial']; |
|
| 1442 | + $subtotal = $this->totals['subtotal']['initial']; |
|
| 1443 | + $total = $tax + $fee - $discount + $subtotal; |
|
| 1444 | 1444 | |
| 1445 | - if ( 0 > $total ) { |
|
| 1446 | - $total = 0; |
|
| 1447 | - } |
|
| 1445 | + if ( 0 > $total ) { |
|
| 1446 | + $total = 0; |
|
| 1447 | + } |
|
| 1448 | 1448 | |
| 1449 | 1449 | return apply_filters( 'wpinv_get_initial_invoice_total', $total, $this ); |
| 1450 | - } |
|
| 1450 | + } |
|
| 1451 | 1451 | |
| 1452 | - /** |
|
| 1453 | - * Get the recurring invoice total. |
|
| 1454 | - * |
|
| 1455 | - * @since 1.0.19 |
|
| 1452 | + /** |
|
| 1453 | + * Get the recurring invoice total. |
|
| 1454 | + * |
|
| 1455 | + * @since 1.0.19 |
|
| 1456 | 1456 | * @param string $context View or edit context. |
| 1457 | 1457 | * @return float |
| 1458 | - */ |
|
| 1458 | + */ |
|
| 1459 | 1459 | public function get_recurring_total() { |
| 1460 | 1460 | |
| 1461 | - if ( empty( $this->totals ) ) { |
|
| 1462 | - $this->recalculate_total(); |
|
| 1463 | - } |
|
| 1461 | + if ( empty( $this->totals ) ) { |
|
| 1462 | + $this->recalculate_total(); |
|
| 1463 | + } |
|
| 1464 | 1464 | |
| 1465 | - $tax = $this->totals['tax']['recurring']; |
|
| 1466 | - $fee = $this->totals['fee']['recurring']; |
|
| 1467 | - $discount = $this->totals['discount']['recurring']; |
|
| 1468 | - $subtotal = $this->totals['subtotal']['recurring']; |
|
| 1469 | - $total = $tax + $fee - $discount + $subtotal; |
|
| 1465 | + $tax = $this->totals['tax']['recurring']; |
|
| 1466 | + $fee = $this->totals['fee']['recurring']; |
|
| 1467 | + $discount = $this->totals['discount']['recurring']; |
|
| 1468 | + $subtotal = $this->totals['subtotal']['recurring']; |
|
| 1469 | + $total = $tax + $fee - $discount + $subtotal; |
|
| 1470 | 1470 | |
| 1471 | - if ( 0 > $total ) { |
|
| 1472 | - $total = 0; |
|
| 1473 | - } |
|
| 1471 | + if ( 0 > $total ) { |
|
| 1472 | + $total = 0; |
|
| 1473 | + } |
|
| 1474 | 1474 | |
| 1475 | 1475 | return apply_filters( 'wpinv_get_recurring_invoice_total', $total, $this ); |
| 1476 | - } |
|
| 1476 | + } |
|
| 1477 | 1477 | |
| 1478 | - /** |
|
| 1479 | - * Returns recurring payment details. |
|
| 1480 | - * |
|
| 1481 | - * @since 1.0.19 |
|
| 1478 | + /** |
|
| 1479 | + * Returns recurring payment details. |
|
| 1480 | + * |
|
| 1481 | + * @since 1.0.19 |
|
| 1482 | 1482 | * @param string $field Optionally provide a field to return. |
| 1483 | - * @param string $currency Whether to include the currency. |
|
| 1483 | + * @param string $currency Whether to include the currency. |
|
| 1484 | 1484 | * @return float |
| 1485 | - */ |
|
| 1485 | + */ |
|
| 1486 | 1486 | public function get_recurring_details( $field = '', $currency = false ) { |
| 1487 | 1487 | |
| 1488 | - // Maybe recalculate totals. |
|
| 1489 | - if ( empty( $this->totals ) ) { |
|
| 1490 | - $this->recalculate_total(); |
|
| 1491 | - } |
|
| 1488 | + // Maybe recalculate totals. |
|
| 1489 | + if ( empty( $this->totals ) ) { |
|
| 1490 | + $this->recalculate_total(); |
|
| 1491 | + } |
|
| 1492 | 1492 | |
| 1493 | - // Prepare recurring totals. |
|
| 1493 | + // Prepare recurring totals. |
|
| 1494 | 1494 | $data = apply_filters( |
| 1495 | - 'wpinv_get_invoice_recurring_details', |
|
| 1496 | - array( |
|
| 1497 | - 'cart_details' => $this->get_cart_details(), |
|
| 1498 | - 'subtotal' => $this->totals['subtotal']['recurring'], |
|
| 1499 | - 'discount' => $this->totals['discount']['recurring'], |
|
| 1500 | - 'tax' => $this->totals['tax']['recurring'], |
|
| 1501 | - 'fee' => $this->totals['fee']['recurring'], |
|
| 1502 | - 'total' => $this->get_recurring_total(), |
|
| 1503 | - ), |
|
| 1504 | - $this, |
|
| 1505 | - $field, |
|
| 1506 | - $currency |
|
| 1507 | - ); |
|
| 1495 | + 'wpinv_get_invoice_recurring_details', |
|
| 1496 | + array( |
|
| 1497 | + 'cart_details' => $this->get_cart_details(), |
|
| 1498 | + 'subtotal' => $this->totals['subtotal']['recurring'], |
|
| 1499 | + 'discount' => $this->totals['discount']['recurring'], |
|
| 1500 | + 'tax' => $this->totals['tax']['recurring'], |
|
| 1501 | + 'fee' => $this->totals['fee']['recurring'], |
|
| 1502 | + 'total' => $this->get_recurring_total(), |
|
| 1503 | + ), |
|
| 1504 | + $this, |
|
| 1505 | + $field, |
|
| 1506 | + $currency |
|
| 1507 | + ); |
|
| 1508 | 1508 | |
| 1509 | 1509 | if ( isset( $data[$field] ) ) { |
| 1510 | 1510 | return ( $currency ? wpinv_price( $data[$field], $this->get_currency() ) : $data[$field] ); |
@@ -1514,156 +1514,156 @@ discard block |
||
| 1514 | 1514 | } |
| 1515 | 1515 | |
| 1516 | 1516 | /** |
| 1517 | - * Get the invoice fees. |
|
| 1518 | - * |
|
| 1519 | - * @since 1.0.19 |
|
| 1520 | - * @param string $context View or edit context. |
|
| 1521 | - * @return array |
|
| 1522 | - */ |
|
| 1523 | - public function get_fees( $context = 'view' ) { |
|
| 1524 | - return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
| 1517 | + * Get the invoice fees. |
|
| 1518 | + * |
|
| 1519 | + * @since 1.0.19 |
|
| 1520 | + * @param string $context View or edit context. |
|
| 1521 | + * @return array |
|
| 1522 | + */ |
|
| 1523 | + public function get_fees( $context = 'view' ) { |
|
| 1524 | + return wpinv_parse_list( $this->get_prop( 'fees', $context ) ); |
|
| 1525 | 1525 | } |
| 1526 | 1526 | |
| 1527 | 1527 | /** |
| 1528 | - * Get the invoice discounts. |
|
| 1529 | - * |
|
| 1530 | - * @since 1.0.19 |
|
| 1531 | - * @param string $context View or edit context. |
|
| 1532 | - * @return array |
|
| 1533 | - */ |
|
| 1534 | - public function get_discounts( $context = 'view' ) { |
|
| 1535 | - return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
| 1528 | + * Get the invoice discounts. |
|
| 1529 | + * |
|
| 1530 | + * @since 1.0.19 |
|
| 1531 | + * @param string $context View or edit context. |
|
| 1532 | + * @return array |
|
| 1533 | + */ |
|
| 1534 | + public function get_discounts( $context = 'view' ) { |
|
| 1535 | + return wpinv_parse_list( $this->get_prop( 'discounts', $context ) ); |
|
| 1536 | 1536 | } |
| 1537 | 1537 | |
| 1538 | 1538 | /** |
| 1539 | - * Get the invoice taxes. |
|
| 1540 | - * |
|
| 1541 | - * @since 1.0.19 |
|
| 1542 | - * @param string $context View or edit context. |
|
| 1543 | - * @return array |
|
| 1544 | - */ |
|
| 1545 | - public function get_taxes( $context = 'view' ) { |
|
| 1546 | - return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
| 1539 | + * Get the invoice taxes. |
|
| 1540 | + * |
|
| 1541 | + * @since 1.0.19 |
|
| 1542 | + * @param string $context View or edit context. |
|
| 1543 | + * @return array |
|
| 1544 | + */ |
|
| 1545 | + public function get_taxes( $context = 'view' ) { |
|
| 1546 | + return wpinv_parse_list( $this->get_prop( 'taxes', $context ) ); |
|
| 1547 | 1547 | } |
| 1548 | 1548 | |
| 1549 | 1549 | /** |
| 1550 | - * Get the invoice items. |
|
| 1551 | - * |
|
| 1552 | - * @since 1.0.19 |
|
| 1553 | - * @param string $context View or edit context. |
|
| 1554 | - * @return GetPaid_Form_Item[] |
|
| 1555 | - */ |
|
| 1556 | - public function get_items( $context = 'view' ) { |
|
| 1550 | + * Get the invoice items. |
|
| 1551 | + * |
|
| 1552 | + * @since 1.0.19 |
|
| 1553 | + * @param string $context View or edit context. |
|
| 1554 | + * @return GetPaid_Form_Item[] |
|
| 1555 | + */ |
|
| 1556 | + public function get_items( $context = 'view' ) { |
|
| 1557 | 1557 | return $this->get_prop( 'items', $context ); |
| 1558 | 1558 | } |
| 1559 | 1559 | |
| 1560 | 1560 | /** |
| 1561 | - * Get the invoice's payment form. |
|
| 1562 | - * |
|
| 1563 | - * @since 1.0.19 |
|
| 1564 | - * @param string $context View or edit context. |
|
| 1565 | - * @return int |
|
| 1566 | - */ |
|
| 1567 | - public function get_payment_form( $context = 'view' ) { |
|
| 1568 | - return intval( $this->get_prop( 'payment_form', $context ) ); |
|
| 1561 | + * Get the invoice's payment form. |
|
| 1562 | + * |
|
| 1563 | + * @since 1.0.19 |
|
| 1564 | + * @param string $context View or edit context. |
|
| 1565 | + * @return int |
|
| 1566 | + */ |
|
| 1567 | + public function get_payment_form( $context = 'view' ) { |
|
| 1568 | + return intval( $this->get_prop( 'payment_form', $context ) ); |
|
| 1569 | 1569 | } |
| 1570 | 1570 | |
| 1571 | 1571 | /** |
| 1572 | - * Get the invoice's submission id. |
|
| 1573 | - * |
|
| 1574 | - * @since 1.0.19 |
|
| 1575 | - * @param string $context View or edit context. |
|
| 1576 | - * @return string |
|
| 1577 | - */ |
|
| 1578 | - public function get_submission_id( $context = 'view' ) { |
|
| 1579 | - return $this->get_prop( 'submission_id', $context ); |
|
| 1572 | + * Get the invoice's submission id. |
|
| 1573 | + * |
|
| 1574 | + * @since 1.0.19 |
|
| 1575 | + * @param string $context View or edit context. |
|
| 1576 | + * @return string |
|
| 1577 | + */ |
|
| 1578 | + public function get_submission_id( $context = 'view' ) { |
|
| 1579 | + return $this->get_prop( 'submission_id', $context ); |
|
| 1580 | 1580 | } |
| 1581 | 1581 | |
| 1582 | 1582 | /** |
| 1583 | - * Get the invoice's discount code. |
|
| 1584 | - * |
|
| 1585 | - * @since 1.0.19 |
|
| 1586 | - * @param string $context View or edit context. |
|
| 1587 | - * @return string |
|
| 1588 | - */ |
|
| 1589 | - public function get_discount_code( $context = 'view' ) { |
|
| 1590 | - return $this->get_prop( 'discount_code', $context ); |
|
| 1583 | + * Get the invoice's discount code. |
|
| 1584 | + * |
|
| 1585 | + * @since 1.0.19 |
|
| 1586 | + * @param string $context View or edit context. |
|
| 1587 | + * @return string |
|
| 1588 | + */ |
|
| 1589 | + public function get_discount_code( $context = 'view' ) { |
|
| 1590 | + return $this->get_prop( 'discount_code', $context ); |
|
| 1591 | 1591 | } |
| 1592 | 1592 | |
| 1593 | 1593 | /** |
| 1594 | - * Get the invoice's gateway. |
|
| 1595 | - * |
|
| 1596 | - * @since 1.0.19 |
|
| 1597 | - * @param string $context View or edit context. |
|
| 1598 | - * @return string |
|
| 1599 | - */ |
|
| 1600 | - public function get_gateway( $context = 'view' ) { |
|
| 1601 | - return $this->get_prop( 'gateway', $context ); |
|
| 1594 | + * Get the invoice's gateway. |
|
| 1595 | + * |
|
| 1596 | + * @since 1.0.19 |
|
| 1597 | + * @param string $context View or edit context. |
|
| 1598 | + * @return string |
|
| 1599 | + */ |
|
| 1600 | + public function get_gateway( $context = 'view' ) { |
|
| 1601 | + return $this->get_prop( 'gateway', $context ); |
|
| 1602 | 1602 | } |
| 1603 | 1603 | |
| 1604 | 1604 | /** |
| 1605 | - * Get the invoice's gateway display title. |
|
| 1606 | - * |
|
| 1607 | - * @since 1.0.19 |
|
| 1608 | - * @return string |
|
| 1609 | - */ |
|
| 1605 | + * Get the invoice's gateway display title. |
|
| 1606 | + * |
|
| 1607 | + * @since 1.0.19 |
|
| 1608 | + * @return string |
|
| 1609 | + */ |
|
| 1610 | 1610 | public function get_gateway_title() { |
| 1611 | 1611 | $title = wpinv_get_gateway_checkout_label( $this->get_gateway() ); |
| 1612 | 1612 | return apply_filters( 'wpinv_gateway_title', $title, $this->get_id(), $this ); |
| 1613 | 1613 | } |
| 1614 | 1614 | |
| 1615 | 1615 | /** |
| 1616 | - * Get the invoice's transaction id. |
|
| 1617 | - * |
|
| 1618 | - * @since 1.0.19 |
|
| 1619 | - * @param string $context View or edit context. |
|
| 1620 | - * @return string |
|
| 1621 | - */ |
|
| 1622 | - public function get_transaction_id( $context = 'view' ) { |
|
| 1623 | - return $this->get_prop( 'transaction_id', $context ); |
|
| 1616 | + * Get the invoice's transaction id. |
|
| 1617 | + * |
|
| 1618 | + * @since 1.0.19 |
|
| 1619 | + * @param string $context View or edit context. |
|
| 1620 | + * @return string |
|
| 1621 | + */ |
|
| 1622 | + public function get_transaction_id( $context = 'view' ) { |
|
| 1623 | + return $this->get_prop( 'transaction_id', $context ); |
|
| 1624 | 1624 | } |
| 1625 | 1625 | |
| 1626 | 1626 | /** |
| 1627 | - * Get the invoice's currency. |
|
| 1628 | - * |
|
| 1629 | - * @since 1.0.19 |
|
| 1630 | - * @param string $context View or edit context. |
|
| 1631 | - * @return string |
|
| 1632 | - */ |
|
| 1633 | - public function get_currency( $context = 'view' ) { |
|
| 1627 | + * Get the invoice's currency. |
|
| 1628 | + * |
|
| 1629 | + * @since 1.0.19 |
|
| 1630 | + * @param string $context View or edit context. |
|
| 1631 | + * @return string |
|
| 1632 | + */ |
|
| 1633 | + public function get_currency( $context = 'view' ) { |
|
| 1634 | 1634 | $currency = $this->get_prop( 'currency', $context ); |
| 1635 | 1635 | return empty( $currency ) ? wpinv_get_currency() : $currency; |
| 1636 | 1636 | } |
| 1637 | 1637 | |
| 1638 | 1638 | /** |
| 1639 | - * Checks if we are charging taxes for this invoice. |
|
| 1640 | - * |
|
| 1641 | - * @since 1.0.19 |
|
| 1642 | - * @param string $context View or edit context. |
|
| 1643 | - * @return bool |
|
| 1644 | - */ |
|
| 1645 | - public function get_disable_taxes( $context = 'view' ) { |
|
| 1639 | + * Checks if we are charging taxes for this invoice. |
|
| 1640 | + * |
|
| 1641 | + * @since 1.0.19 |
|
| 1642 | + * @param string $context View or edit context. |
|
| 1643 | + * @return bool |
|
| 1644 | + */ |
|
| 1645 | + public function get_disable_taxes( $context = 'view' ) { |
|
| 1646 | 1646 | return (bool) $this->get_prop( 'disable_taxes', $context ); |
| 1647 | 1647 | } |
| 1648 | 1648 | |
| 1649 | 1649 | /** |
| 1650 | - * Retrieves the subscription id for an invoice. |
|
| 1651 | - * |
|
| 1652 | - * @since 1.0.19 |
|
| 1653 | - * @param string $context View or edit context. |
|
| 1654 | - * @return int |
|
| 1655 | - */ |
|
| 1650 | + * Retrieves the subscription id for an invoice. |
|
| 1651 | + * |
|
| 1652 | + * @since 1.0.19 |
|
| 1653 | + * @param string $context View or edit context. |
|
| 1654 | + * @return int |
|
| 1655 | + */ |
|
| 1656 | 1656 | public function get_subscription_id( $context = 'view' ) { |
| 1657 | - return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
| 1658 | - } |
|
| 1659 | - |
|
| 1660 | - /** |
|
| 1661 | - * Retrieves the remote subscription id for an invoice. |
|
| 1662 | - * |
|
| 1663 | - * @since 1.0.19 |
|
| 1664 | - * @param string $context View or edit context. |
|
| 1665 | - * @return int |
|
| 1666 | - */ |
|
| 1657 | + return $this->is_renewal() ? $this->get_parent()->get_subscription_id( $context ) : $this->get_prop( 'subscription_id', $context ); |
|
| 1658 | + } |
|
| 1659 | + |
|
| 1660 | + /** |
|
| 1661 | + * Retrieves the remote subscription id for an invoice. |
|
| 1662 | + * |
|
| 1663 | + * @since 1.0.19 |
|
| 1664 | + * @param string $context View or edit context. |
|
| 1665 | + * @return int |
|
| 1666 | + */ |
|
| 1667 | 1667 | public function get_remote_subscription_id( $context = 'view' ) { |
| 1668 | 1668 | $subscription_id = $this->get_prop( 'remote_subscription_id', $context ); |
| 1669 | 1669 | |
@@ -1676,12 +1676,12 @@ discard block |
||
| 1676 | 1676 | } |
| 1677 | 1677 | |
| 1678 | 1678 | /** |
| 1679 | - * Retrieves the payment meta for an invoice. |
|
| 1680 | - * |
|
| 1681 | - * @since 1.0.19 |
|
| 1682 | - * @param string $context View or edit context. |
|
| 1683 | - * @return array |
|
| 1684 | - */ |
|
| 1679 | + * Retrieves the payment meta for an invoice. |
|
| 1680 | + * |
|
| 1681 | + * @since 1.0.19 |
|
| 1682 | + * @param string $context View or edit context. |
|
| 1683 | + * @return array |
|
| 1684 | + */ |
|
| 1685 | 1685 | public function get_payment_meta( $context = 'view' ) { |
| 1686 | 1686 | |
| 1687 | 1687 | return array( |
@@ -1701,31 +1701,31 @@ discard block |
||
| 1701 | 1701 | } |
| 1702 | 1702 | |
| 1703 | 1703 | /** |
| 1704 | - * Retrieves the cart details for an invoice. |
|
| 1705 | - * |
|
| 1706 | - * @since 1.0.19 |
|
| 1707 | - * @return array |
|
| 1708 | - */ |
|
| 1704 | + * Retrieves the cart details for an invoice. |
|
| 1705 | + * |
|
| 1706 | + * @since 1.0.19 |
|
| 1707 | + * @return array |
|
| 1708 | + */ |
|
| 1709 | 1709 | public function get_cart_details() { |
| 1710 | 1710 | $items = $this->get_items(); |
| 1711 | 1711 | $cart_details = array(); |
| 1712 | 1712 | |
| 1713 | 1713 | foreach ( $items as $item_id => $item ) { |
| 1714 | - $item->invoice_id = $this->get_id(); |
|
| 1714 | + $item->invoice_id = $this->get_id(); |
|
| 1715 | 1715 | $cart_details[] = $item->prepare_data_for_saving(); |
| 1716 | 1716 | } |
| 1717 | 1717 | |
| 1718 | 1718 | return $cart_details; |
| 1719 | - } |
|
| 1719 | + } |
|
| 1720 | 1720 | |
| 1721 | - /** |
|
| 1722 | - * Retrieves the recurring item. |
|
| 1723 | - * |
|
| 1724 | - * @return null|GetPaid_Form_Item|int |
|
| 1725 | - */ |
|
| 1726 | - public function get_recurring( $object = false ) { |
|
| 1721 | + /** |
|
| 1722 | + * Retrieves the recurring item. |
|
| 1723 | + * |
|
| 1724 | + * @return null|GetPaid_Form_Item|int |
|
| 1725 | + */ |
|
| 1726 | + public function get_recurring( $object = false ) { |
|
| 1727 | 1727 | |
| 1728 | - // Are we returning an object? |
|
| 1728 | + // Are we returning an object? |
|
| 1729 | 1729 | if ( $object ) { |
| 1730 | 1730 | return $this->get_item( $this->recurring_item ); |
| 1731 | 1731 | } |
@@ -1733,100 +1733,100 @@ discard block |
||
| 1733 | 1733 | return $this->recurring_item; |
| 1734 | 1734 | } |
| 1735 | 1735 | |
| 1736 | - /** |
|
| 1737 | - * Retrieves the subscription name. |
|
| 1738 | - * |
|
| 1739 | - * @since 1.0.19 |
|
| 1740 | - * @return string |
|
| 1741 | - */ |
|
| 1742 | - public function get_subscription_name() { |
|
| 1736 | + /** |
|
| 1737 | + * Retrieves the subscription name. |
|
| 1738 | + * |
|
| 1739 | + * @since 1.0.19 |
|
| 1740 | + * @return string |
|
| 1741 | + */ |
|
| 1742 | + public function get_subscription_name() { |
|
| 1743 | 1743 | |
| 1744 | - // Retrieve the recurring name |
|
| 1744 | + // Retrieve the recurring name |
|
| 1745 | 1745 | $item = $this->get_recurring( true ); |
| 1746 | 1746 | |
| 1747 | - // Abort if it does not exist. |
|
| 1747 | + // Abort if it does not exist. |
|
| 1748 | 1748 | if ( empty( $item ) ) { |
| 1749 | 1749 | return ''; |
| 1750 | 1750 | } |
| 1751 | 1751 | |
| 1752 | - // Return the item name. |
|
| 1752 | + // Return the item name. |
|
| 1753 | 1753 | return apply_filters( 'wpinv_invoice_get_subscription_name', $item->get_name(), $this ); |
| 1754 | - } |
|
| 1755 | - |
|
| 1756 | - /** |
|
| 1757 | - * Retrieves the view url. |
|
| 1758 | - * |
|
| 1759 | - * @since 1.0.19 |
|
| 1760 | - * @return string |
|
| 1761 | - */ |
|
| 1762 | - public function get_view_url() { |
|
| 1754 | + } |
|
| 1755 | + |
|
| 1756 | + /** |
|
| 1757 | + * Retrieves the view url. |
|
| 1758 | + * |
|
| 1759 | + * @since 1.0.19 |
|
| 1760 | + * @return string |
|
| 1761 | + */ |
|
| 1762 | + public function get_view_url() { |
|
| 1763 | 1763 | $invoice_url = get_permalink( $this->get_id() ); |
| 1764 | - $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
| 1764 | + $invoice_url = add_query_arg( 'invoice_key', $this->get_key(), $invoice_url ); |
|
| 1765 | 1765 | return apply_filters( 'wpinv_get_view_url', $invoice_url, $this ); |
| 1766 | - } |
|
| 1766 | + } |
|
| 1767 | 1767 | |
| 1768 | - /** |
|
| 1769 | - * Retrieves the payment url. |
|
| 1770 | - * |
|
| 1771 | - * @since 1.0.19 |
|
| 1772 | - * @return string |
|
| 1773 | - */ |
|
| 1774 | - public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
| 1768 | + /** |
|
| 1769 | + * Retrieves the payment url. |
|
| 1770 | + * |
|
| 1771 | + * @since 1.0.19 |
|
| 1772 | + * @return string |
|
| 1773 | + */ |
|
| 1774 | + public function get_checkout_payment_url( $deprecated = false, $secret = false ) { |
|
| 1775 | 1775 | |
| 1776 | - // Retrieve the checkout url. |
|
| 1776 | + // Retrieve the checkout url. |
|
| 1777 | 1777 | $pay_url = wpinv_get_checkout_uri(); |
| 1778 | 1778 | |
| 1779 | - // Maybe force ssl. |
|
| 1779 | + // Maybe force ssl. |
|
| 1780 | 1780 | if ( is_ssl() ) { |
| 1781 | 1781 | $pay_url = str_replace( 'http:', 'https:', $pay_url ); |
| 1782 | 1782 | } |
| 1783 | 1783 | |
| 1784 | - // Add the invoice key. |
|
| 1785 | - $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
| 1784 | + // Add the invoice key. |
|
| 1785 | + $pay_url = add_query_arg( 'invoice_key', $this->get_key(), $pay_url ); |
|
| 1786 | 1786 | |
| 1787 | - // (Maybe?) add a secret |
|
| 1787 | + // (Maybe?) add a secret |
|
| 1788 | 1788 | if ( $secret ) { |
| 1789 | 1789 | $pay_url = add_query_arg( array( '_wpipay' => md5( $this->get_user_id() . '::' . $this->get_email() . '::' . $this->get_key() ) ), $pay_url ); |
| 1790 | 1790 | } |
| 1791 | 1791 | |
| 1792 | 1792 | return apply_filters( 'wpinv_get_checkout_payment_url', $pay_url, $this, $deprecated, $secret ); |
| 1793 | - } |
|
| 1793 | + } |
|
| 1794 | 1794 | |
| 1795 | - /** |
|
| 1796 | - * Retrieves the receipt url. |
|
| 1797 | - * |
|
| 1798 | - * @since 1.0.19 |
|
| 1799 | - * @return string |
|
| 1800 | - */ |
|
| 1801 | - public function get_receipt_url() { |
|
| 1802 | - |
|
| 1803 | - // Retrieve the checkout url. |
|
| 1795 | + /** |
|
| 1796 | + * Retrieves the receipt url. |
|
| 1797 | + * |
|
| 1798 | + * @since 1.0.19 |
|
| 1799 | + * @return string |
|
| 1800 | + */ |
|
| 1801 | + public function get_receipt_url() { |
|
| 1802 | + |
|
| 1803 | + // Retrieve the checkout url. |
|
| 1804 | 1804 | $receipt_url = wpinv_get_success_page_uri(); |
| 1805 | 1805 | |
| 1806 | - // Maybe force ssl. |
|
| 1806 | + // Maybe force ssl. |
|
| 1807 | 1807 | if ( is_ssl() ) { |
| 1808 | 1808 | $receipt_url = str_replace( 'http:', 'https:', $receipt_url ); |
| 1809 | 1809 | } |
| 1810 | 1810 | |
| 1811 | - // Add the invoice key. |
|
| 1812 | - $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
| 1811 | + // Add the invoice key. |
|
| 1812 | + $receipt_url = add_query_arg( 'invoice_key', $this->get_key(), $receipt_url ); |
|
| 1813 | 1813 | |
| 1814 | 1814 | return apply_filters( 'getpaid_get_invoice_receipt_url', $receipt_url, $this ); |
| 1815 | 1815 | } |
| 1816 | 1816 | |
| 1817 | 1817 | /** |
| 1818 | - * Magic method for accessing invoice properties. |
|
| 1819 | - * |
|
| 1820 | - * @since 1.0.15 |
|
| 1821 | - * @access public |
|
| 1822 | - * |
|
| 1823 | - * @param string $key Discount data to retrieve |
|
| 1824 | - * @param string $context View or edit context. |
|
| 1825 | - * @return mixed Value of the given invoice property (if set). |
|
| 1826 | - */ |
|
| 1827 | - public function get( $key, $context = 'view' ) { |
|
| 1818 | + * Magic method for accessing invoice properties. |
|
| 1819 | + * |
|
| 1820 | + * @since 1.0.15 |
|
| 1821 | + * @access public |
|
| 1822 | + * |
|
| 1823 | + * @param string $key Discount data to retrieve |
|
| 1824 | + * @param string $context View or edit context. |
|
| 1825 | + * @return mixed Value of the given invoice property (if set). |
|
| 1826 | + */ |
|
| 1827 | + public function get( $key, $context = 'view' ) { |
|
| 1828 | 1828 | return $this->get_prop( $key, $context ); |
| 1829 | - } |
|
| 1829 | + } |
|
| 1830 | 1830 | |
| 1831 | 1831 | /* |
| 1832 | 1832 | |-------------------------------------------------------------------------- |
@@ -1839,130 +1839,130 @@ discard block |
||
| 1839 | 1839 | */ |
| 1840 | 1840 | |
| 1841 | 1841 | /** |
| 1842 | - * Magic method for setting invoice properties. |
|
| 1843 | - * |
|
| 1844 | - * @since 1.0.19 |
|
| 1845 | - * @access public |
|
| 1846 | - * |
|
| 1847 | - * @param string $key Discount data to retrieve |
|
| 1848 | - * @param mixed $value new value. |
|
| 1849 | - * @return mixed Value of the given invoice property (if set). |
|
| 1850 | - */ |
|
| 1851 | - public function set( $key, $value ) { |
|
| 1842 | + * Magic method for setting invoice properties. |
|
| 1843 | + * |
|
| 1844 | + * @since 1.0.19 |
|
| 1845 | + * @access public |
|
| 1846 | + * |
|
| 1847 | + * @param string $key Discount data to retrieve |
|
| 1848 | + * @param mixed $value new value. |
|
| 1849 | + * @return mixed Value of the given invoice property (if set). |
|
| 1850 | + */ |
|
| 1851 | + public function set( $key, $value ) { |
|
| 1852 | 1852 | |
| 1853 | 1853 | $setter = "set_$key"; |
| 1854 | 1854 | if ( is_callable( array( $this, $setter ) ) ) { |
| 1855 | 1855 | $this->{$setter}( $value ); |
| 1856 | 1856 | } |
| 1857 | 1857 | |
| 1858 | - } |
|
| 1858 | + } |
|
| 1859 | 1859 | |
| 1860 | - /** |
|
| 1861 | - * Sets item status. |
|
| 1862 | - * |
|
| 1863 | - * @since 1.0.19 |
|
| 1864 | - * @param string $new_status New status. |
|
| 1865 | - * @param string $note Optional note to add. |
|
| 1866 | - * @param bool $manual_update Is this a manual status change?. |
|
| 1867 | - * @return array details of change. |
|
| 1868 | - */ |
|
| 1869 | - public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
| 1870 | - $old_status = $this->get_status(); |
|
| 1860 | + /** |
|
| 1861 | + * Sets item status. |
|
| 1862 | + * |
|
| 1863 | + * @since 1.0.19 |
|
| 1864 | + * @param string $new_status New status. |
|
| 1865 | + * @param string $note Optional note to add. |
|
| 1866 | + * @param bool $manual_update Is this a manual status change?. |
|
| 1867 | + * @return array details of change. |
|
| 1868 | + */ |
|
| 1869 | + public function set_status( $new_status, $note = '', $manual_update = false ) { |
|
| 1870 | + $old_status = $this->get_status(); |
|
| 1871 | 1871 | |
| 1872 | - $statuses = $this->get_all_statuses(); |
|
| 1872 | + $statuses = $this->get_all_statuses(); |
|
| 1873 | 1873 | |
| 1874 | - if ( isset( $statuses[ 'draft' ] ) ) { |
|
| 1875 | - unset( $statuses[ 'draft' ] ); |
|
| 1876 | - } |
|
| 1874 | + if ( isset( $statuses[ 'draft' ] ) ) { |
|
| 1875 | + unset( $statuses[ 'draft' ] ); |
|
| 1876 | + } |
|
| 1877 | 1877 | |
| 1878 | - $this->set_prop( 'status', $new_status ); |
|
| 1878 | + $this->set_prop( 'status', $new_status ); |
|
| 1879 | 1879 | |
| 1880 | - // If setting the status, ensure it's set to a valid status. |
|
| 1881 | - if ( true === $this->object_read ) { |
|
| 1880 | + // If setting the status, ensure it's set to a valid status. |
|
| 1881 | + if ( true === $this->object_read ) { |
|
| 1882 | 1882 | |
| 1883 | - // Only allow valid new status. |
|
| 1884 | - if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
| 1885 | - $new_status = 'wpi-pending'; |
|
| 1886 | - } |
|
| 1883 | + // Only allow valid new status. |
|
| 1884 | + if ( ! array_key_exists( $new_status, $statuses ) ) { |
|
| 1885 | + $new_status = 'wpi-pending'; |
|
| 1886 | + } |
|
| 1887 | 1887 | |
| 1888 | - // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
| 1889 | - if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
| 1890 | - $old_status = 'wpi-pending'; |
|
| 1891 | - } |
|
| 1888 | + // If the old status is set but unknown (e.g. draft) assume its pending for action usage. |
|
| 1889 | + if ( $old_status && ! array_key_exists( $new_status, $statuses ) ) { |
|
| 1890 | + $old_status = 'wpi-pending'; |
|
| 1891 | + } |
|
| 1892 | 1892 | |
| 1893 | - // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
| 1894 | - if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
| 1895 | - $old_status = 'wpi-pending'; |
|
| 1896 | - } |
|
| 1893 | + // Paid - Renewal (i.e when duplicating a parent invoice ) |
|
| 1894 | + if ( $new_status == 'wpi-pending' && $old_status == 'publish' && ! $this->get_id() ) { |
|
| 1895 | + $old_status = 'wpi-pending'; |
|
| 1896 | + } |
|
| 1897 | 1897 | |
| 1898 | - } |
|
| 1898 | + } |
|
| 1899 | 1899 | |
| 1900 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 1901 | - $this->status_transition = array( |
|
| 1902 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 1903 | - 'to' => $new_status, |
|
| 1904 | - 'note' => $note, |
|
| 1905 | - 'manual' => (bool) $manual_update, |
|
| 1906 | - ); |
|
| 1900 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 1901 | + $this->status_transition = array( |
|
| 1902 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 1903 | + 'to' => $new_status, |
|
| 1904 | + 'note' => $note, |
|
| 1905 | + 'manual' => (bool) $manual_update, |
|
| 1906 | + ); |
|
| 1907 | 1907 | |
| 1908 | - if ( $manual_update ) { |
|
| 1909 | - do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
| 1910 | - } |
|
| 1908 | + if ( $manual_update ) { |
|
| 1909 | + do_action( 'getpaid_' . $this->object_type .'_edit_status', $this->get_id(), $new_status ); |
|
| 1910 | + } |
|
| 1911 | 1911 | |
| 1912 | - $this->maybe_set_date_paid(); |
|
| 1912 | + $this->maybe_set_date_paid(); |
|
| 1913 | 1913 | |
| 1914 | - } |
|
| 1914 | + } |
|
| 1915 | 1915 | |
| 1916 | - return array( |
|
| 1917 | - 'from' => $old_status, |
|
| 1918 | - 'to' => $new_status, |
|
| 1919 | - ); |
|
| 1920 | - } |
|
| 1916 | + return array( |
|
| 1917 | + 'from' => $old_status, |
|
| 1918 | + 'to' => $new_status, |
|
| 1919 | + ); |
|
| 1920 | + } |
|
| 1921 | 1921 | |
| 1922 | - /** |
|
| 1923 | - * Maybe set date paid. |
|
| 1924 | - * |
|
| 1925 | - * Sets the date paid variable when transitioning to the payment complete |
|
| 1926 | - * order status. |
|
| 1927 | - * |
|
| 1928 | - * @since 1.0.19 |
|
| 1929 | - */ |
|
| 1930 | - public function maybe_set_date_paid() { |
|
| 1922 | + /** |
|
| 1923 | + * Maybe set date paid. |
|
| 1924 | + * |
|
| 1925 | + * Sets the date paid variable when transitioning to the payment complete |
|
| 1926 | + * order status. |
|
| 1927 | + * |
|
| 1928 | + * @since 1.0.19 |
|
| 1929 | + */ |
|
| 1930 | + public function maybe_set_date_paid() { |
|
| 1931 | 1931 | |
| 1932 | - if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
| 1933 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 1934 | - } |
|
| 1935 | - } |
|
| 1932 | + if ( ! $this->get_date_completed( 'edit' ) && $this->is_paid() ) { |
|
| 1933 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 1934 | + } |
|
| 1935 | + } |
|
| 1936 | 1936 | |
| 1937 | 1937 | /** |
| 1938 | - * Set parent invoice ID. |
|
| 1939 | - * |
|
| 1940 | - * @since 1.0.19 |
|
| 1941 | - */ |
|
| 1942 | - public function set_parent_id( $value ) { |
|
| 1943 | - if ( $value && ( $value === $this->get_id() ) ) { |
|
| 1944 | - return; |
|
| 1945 | - } |
|
| 1946 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 1938 | + * Set parent invoice ID. |
|
| 1939 | + * |
|
| 1940 | + * @since 1.0.19 |
|
| 1941 | + */ |
|
| 1942 | + public function set_parent_id( $value ) { |
|
| 1943 | + if ( $value && ( $value === $this->get_id() ) ) { |
|
| 1944 | + return; |
|
| 1945 | + } |
|
| 1946 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 1947 | 1947 | } |
| 1948 | 1948 | |
| 1949 | 1949 | /** |
| 1950 | - * Set plugin version when the invoice was created. |
|
| 1951 | - * |
|
| 1952 | - * @since 1.0.19 |
|
| 1953 | - */ |
|
| 1954 | - public function set_version( $value ) { |
|
| 1955 | - $this->set_prop( 'version', $value ); |
|
| 1950 | + * Set plugin version when the invoice was created. |
|
| 1951 | + * |
|
| 1952 | + * @since 1.0.19 |
|
| 1953 | + */ |
|
| 1954 | + public function set_version( $value ) { |
|
| 1955 | + $this->set_prop( 'version', $value ); |
|
| 1956 | 1956 | } |
| 1957 | - |
|
| 1958 | - /** |
|
| 1959 | - * Set date when the invoice was created. |
|
| 1960 | - * |
|
| 1961 | - * @since 1.0.19 |
|
| 1962 | - * @param string $value Value to set. |
|
| 1957 | + |
|
| 1958 | + /** |
|
| 1959 | + * Set date when the invoice was created. |
|
| 1960 | + * |
|
| 1961 | + * @since 1.0.19 |
|
| 1962 | + * @param string $value Value to set. |
|
| 1963 | 1963 | * @return bool Whether or not the date was set. |
| 1964 | - */ |
|
| 1965 | - public function set_date_created( $value ) { |
|
| 1964 | + */ |
|
| 1965 | + public function set_date_created( $value ) { |
|
| 1966 | 1966 | $date = strtotime( $value ); |
| 1967 | 1967 | |
| 1968 | 1968 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -1975,13 +1975,13 @@ discard block |
||
| 1975 | 1975 | } |
| 1976 | 1976 | |
| 1977 | 1977 | /** |
| 1978 | - * Set date invoice due date. |
|
| 1979 | - * |
|
| 1980 | - * @since 1.0.19 |
|
| 1981 | - * @param string $value Value to set. |
|
| 1978 | + * Set date invoice due date. |
|
| 1979 | + * |
|
| 1980 | + * @since 1.0.19 |
|
| 1981 | + * @param string $value Value to set. |
|
| 1982 | 1982 | * @return bool Whether or not the date was set. |
| 1983 | - */ |
|
| 1984 | - public function set_due_date( $value ) { |
|
| 1983 | + */ |
|
| 1984 | + public function set_due_date( $value ) { |
|
| 1985 | 1985 | $date = strtotime( $value ); |
| 1986 | 1986 | |
| 1987 | 1987 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -1989,29 +1989,29 @@ discard block |
||
| 1989 | 1989 | return true; |
| 1990 | 1990 | } |
| 1991 | 1991 | |
| 1992 | - $this->set_prop( 'due_date', '' ); |
|
| 1992 | + $this->set_prop( 'due_date', '' ); |
|
| 1993 | 1993 | return false; |
| 1994 | 1994 | |
| 1995 | 1995 | } |
| 1996 | 1996 | |
| 1997 | 1997 | /** |
| 1998 | - * Alias of self::set_due_date(). |
|
| 1999 | - * |
|
| 2000 | - * @since 1.0.19 |
|
| 2001 | - * @param string $value New name. |
|
| 2002 | - */ |
|
| 2003 | - public function set_date_due( $value ) { |
|
| 2004 | - $this->set_due_date( $value ); |
|
| 1998 | + * Alias of self::set_due_date(). |
|
| 1999 | + * |
|
| 2000 | + * @since 1.0.19 |
|
| 2001 | + * @param string $value New name. |
|
| 2002 | + */ |
|
| 2003 | + public function set_date_due( $value ) { |
|
| 2004 | + $this->set_due_date( $value ); |
|
| 2005 | 2005 | } |
| 2006 | 2006 | |
| 2007 | 2007 | /** |
| 2008 | - * Set date invoice was completed. |
|
| 2009 | - * |
|
| 2010 | - * @since 1.0.19 |
|
| 2011 | - * @param string $value Value to set. |
|
| 2008 | + * Set date invoice was completed. |
|
| 2009 | + * |
|
| 2010 | + * @since 1.0.19 |
|
| 2011 | + * @param string $value Value to set. |
|
| 2012 | 2012 | * @return bool Whether or not the date was set. |
| 2013 | - */ |
|
| 2014 | - public function set_completed_date( $value ) { |
|
| 2013 | + */ |
|
| 2014 | + public function set_completed_date( $value ) { |
|
| 2015 | 2015 | $date = strtotime( $value ); |
| 2016 | 2016 | |
| 2017 | 2017 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2019,29 +2019,29 @@ discard block |
||
| 2019 | 2019 | return true; |
| 2020 | 2020 | } |
| 2021 | 2021 | |
| 2022 | - $this->set_prop( 'completed_date', '' ); |
|
| 2022 | + $this->set_prop( 'completed_date', '' ); |
|
| 2023 | 2023 | return false; |
| 2024 | 2024 | |
| 2025 | 2025 | } |
| 2026 | 2026 | |
| 2027 | 2027 | /** |
| 2028 | - * Alias of self::set_completed_date(). |
|
| 2029 | - * |
|
| 2030 | - * @since 1.0.19 |
|
| 2031 | - * @param string $value New name. |
|
| 2032 | - */ |
|
| 2033 | - public function set_date_completed( $value ) { |
|
| 2034 | - $this->set_completed_date( $value ); |
|
| 2028 | + * Alias of self::set_completed_date(). |
|
| 2029 | + * |
|
| 2030 | + * @since 1.0.19 |
|
| 2031 | + * @param string $value New name. |
|
| 2032 | + */ |
|
| 2033 | + public function set_date_completed( $value ) { |
|
| 2034 | + $this->set_completed_date( $value ); |
|
| 2035 | 2035 | } |
| 2036 | 2036 | |
| 2037 | 2037 | /** |
| 2038 | - * Set date when the invoice was last modified. |
|
| 2039 | - * |
|
| 2040 | - * @since 1.0.19 |
|
| 2041 | - * @param string $value Value to set. |
|
| 2038 | + * Set date when the invoice was last modified. |
|
| 2039 | + * |
|
| 2040 | + * @since 1.0.19 |
|
| 2041 | + * @param string $value Value to set. |
|
| 2042 | 2042 | * @return bool Whether or not the date was set. |
| 2043 | - */ |
|
| 2044 | - public function set_date_modified( $value ) { |
|
| 2043 | + */ |
|
| 2044 | + public function set_date_modified( $value ) { |
|
| 2045 | 2045 | $date = strtotime( $value ); |
| 2046 | 2046 | |
| 2047 | 2047 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
@@ -2049,763 +2049,763 @@ discard block |
||
| 2049 | 2049 | return true; |
| 2050 | 2050 | } |
| 2051 | 2051 | |
| 2052 | - $this->set_prop( 'date_modified', '' ); |
|
| 2052 | + $this->set_prop( 'date_modified', '' ); |
|
| 2053 | 2053 | return false; |
| 2054 | 2054 | |
| 2055 | 2055 | } |
| 2056 | 2056 | |
| 2057 | 2057 | /** |
| 2058 | - * Set the invoice number. |
|
| 2059 | - * |
|
| 2060 | - * @since 1.0.19 |
|
| 2061 | - * @param string $value New number. |
|
| 2062 | - */ |
|
| 2063 | - public function set_number( $value ) { |
|
| 2058 | + * Set the invoice number. |
|
| 2059 | + * |
|
| 2060 | + * @since 1.0.19 |
|
| 2061 | + * @param string $value New number. |
|
| 2062 | + */ |
|
| 2063 | + public function set_number( $value ) { |
|
| 2064 | 2064 | $number = sanitize_text_field( $value ); |
| 2065 | - $this->set_prop( 'number', $number ); |
|
| 2065 | + $this->set_prop( 'number', $number ); |
|
| 2066 | 2066 | } |
| 2067 | 2067 | |
| 2068 | 2068 | /** |
| 2069 | - * Set the invoice type. |
|
| 2070 | - * |
|
| 2071 | - * @since 1.0.19 |
|
| 2072 | - * @param string $value Type. |
|
| 2073 | - */ |
|
| 2074 | - public function set_type( $value ) { |
|
| 2069 | + * Set the invoice type. |
|
| 2070 | + * |
|
| 2071 | + * @since 1.0.19 |
|
| 2072 | + * @param string $value Type. |
|
| 2073 | + */ |
|
| 2074 | + public function set_type( $value ) { |
|
| 2075 | 2075 | $type = sanitize_text_field( str_replace( 'wpi_', '', $value ) ); |
| 2076 | - $this->set_prop( 'type', $type ); |
|
| 2077 | - } |
|
| 2076 | + $this->set_prop( 'type', $type ); |
|
| 2077 | + } |
|
| 2078 | 2078 | |
| 2079 | 2079 | /** |
| 2080 | - * Set the invoice post type. |
|
| 2081 | - * |
|
| 2082 | - * @since 1.0.19 |
|
| 2083 | - * @param string $value Post type. |
|
| 2084 | - */ |
|
| 2085 | - public function set_post_type( $value ) { |
|
| 2080 | + * Set the invoice post type. |
|
| 2081 | + * |
|
| 2082 | + * @since 1.0.19 |
|
| 2083 | + * @param string $value Post type. |
|
| 2084 | + */ |
|
| 2085 | + public function set_post_type( $value ) { |
|
| 2086 | 2086 | if ( getpaid_is_invoice_post_type( $value ) ) { |
| 2087 | - $this->set_type( $value ); |
|
| 2087 | + $this->set_type( $value ); |
|
| 2088 | 2088 | $this->set_prop( 'post_type', $value ); |
| 2089 | 2089 | } |
| 2090 | 2090 | } |
| 2091 | 2091 | |
| 2092 | 2092 | /** |
| 2093 | - * Set the invoice key. |
|
| 2094 | - * |
|
| 2095 | - * @since 1.0.19 |
|
| 2096 | - * @param string $value New key. |
|
| 2097 | - */ |
|
| 2098 | - public function set_key( $value ) { |
|
| 2093 | + * Set the invoice key. |
|
| 2094 | + * |
|
| 2095 | + * @since 1.0.19 |
|
| 2096 | + * @param string $value New key. |
|
| 2097 | + */ |
|
| 2098 | + public function set_key( $value ) { |
|
| 2099 | 2099 | $key = sanitize_text_field( $value ); |
| 2100 | - $this->set_prop( 'key', $key ); |
|
| 2100 | + $this->set_prop( 'key', $key ); |
|
| 2101 | 2101 | } |
| 2102 | 2102 | |
| 2103 | 2103 | /** |
| 2104 | - * Set the invoice mode. |
|
| 2105 | - * |
|
| 2106 | - * @since 1.0.19 |
|
| 2107 | - * @param string $value mode. |
|
| 2108 | - */ |
|
| 2109 | - public function set_mode( $value ) { |
|
| 2104 | + * Set the invoice mode. |
|
| 2105 | + * |
|
| 2106 | + * @since 1.0.19 |
|
| 2107 | + * @param string $value mode. |
|
| 2108 | + */ |
|
| 2109 | + public function set_mode( $value ) { |
|
| 2110 | 2110 | if ( ! in_array( $value, array( 'live', 'test' ) ) ) { |
| 2111 | 2111 | $this->set_prop( 'value', $value ); |
| 2112 | 2112 | } |
| 2113 | 2113 | } |
| 2114 | 2114 | |
| 2115 | 2115 | /** |
| 2116 | - * Set the invoice path. |
|
| 2117 | - * |
|
| 2118 | - * @since 1.0.19 |
|
| 2119 | - * @param string $value path. |
|
| 2120 | - */ |
|
| 2121 | - public function set_path( $value ) { |
|
| 2116 | + * Set the invoice path. |
|
| 2117 | + * |
|
| 2118 | + * @since 1.0.19 |
|
| 2119 | + * @param string $value path. |
|
| 2120 | + */ |
|
| 2121 | + public function set_path( $value ) { |
|
| 2122 | 2122 | $this->set_prop( 'path', $value ); |
| 2123 | 2123 | } |
| 2124 | 2124 | |
| 2125 | 2125 | /** |
| 2126 | - * Set the invoice name. |
|
| 2127 | - * |
|
| 2128 | - * @since 1.0.19 |
|
| 2129 | - * @param string $value New name. |
|
| 2130 | - */ |
|
| 2131 | - public function set_name( $value ) { |
|
| 2126 | + * Set the invoice name. |
|
| 2127 | + * |
|
| 2128 | + * @since 1.0.19 |
|
| 2129 | + * @param string $value New name. |
|
| 2130 | + */ |
|
| 2131 | + public function set_name( $value ) { |
|
| 2132 | 2132 | $name = sanitize_text_field( $value ); |
| 2133 | - $this->set_prop( 'name', $name ); |
|
| 2133 | + $this->set_prop( 'name', $name ); |
|
| 2134 | 2134 | } |
| 2135 | 2135 | |
| 2136 | 2136 | /** |
| 2137 | - * Alias of self::set_name(). |
|
| 2138 | - * |
|
| 2139 | - * @since 1.0.19 |
|
| 2140 | - * @param string $value New name. |
|
| 2141 | - */ |
|
| 2142 | - public function set_title( $value ) { |
|
| 2143 | - $this->set_name( $value ); |
|
| 2137 | + * Alias of self::set_name(). |
|
| 2138 | + * |
|
| 2139 | + * @since 1.0.19 |
|
| 2140 | + * @param string $value New name. |
|
| 2141 | + */ |
|
| 2142 | + public function set_title( $value ) { |
|
| 2143 | + $this->set_name( $value ); |
|
| 2144 | 2144 | } |
| 2145 | 2145 | |
| 2146 | 2146 | /** |
| 2147 | - * Set the invoice description. |
|
| 2148 | - * |
|
| 2149 | - * @since 1.0.19 |
|
| 2150 | - * @param string $value New description. |
|
| 2151 | - */ |
|
| 2152 | - public function set_description( $value ) { |
|
| 2147 | + * Set the invoice description. |
|
| 2148 | + * |
|
| 2149 | + * @since 1.0.19 |
|
| 2150 | + * @param string $value New description. |
|
| 2151 | + */ |
|
| 2152 | + public function set_description( $value ) { |
|
| 2153 | 2153 | $description = wp_kses_post( $value ); |
| 2154 | - return $this->set_prop( 'description', $description ); |
|
| 2154 | + return $this->set_prop( 'description', $description ); |
|
| 2155 | 2155 | } |
| 2156 | 2156 | |
| 2157 | 2157 | /** |
| 2158 | - * Alias of self::set_description(). |
|
| 2159 | - * |
|
| 2160 | - * @since 1.0.19 |
|
| 2161 | - * @param string $value New description. |
|
| 2162 | - */ |
|
| 2163 | - public function set_excerpt( $value ) { |
|
| 2164 | - $this->set_description( $value ); |
|
| 2158 | + * Alias of self::set_description(). |
|
| 2159 | + * |
|
| 2160 | + * @since 1.0.19 |
|
| 2161 | + * @param string $value New description. |
|
| 2162 | + */ |
|
| 2163 | + public function set_excerpt( $value ) { |
|
| 2164 | + $this->set_description( $value ); |
|
| 2165 | 2165 | } |
| 2166 | 2166 | |
| 2167 | 2167 | /** |
| 2168 | - * Alias of self::set_description(). |
|
| 2169 | - * |
|
| 2170 | - * @since 1.0.19 |
|
| 2171 | - * @param string $value New description. |
|
| 2172 | - */ |
|
| 2173 | - public function set_summary( $value ) { |
|
| 2174 | - $this->set_description( $value ); |
|
| 2168 | + * Alias of self::set_description(). |
|
| 2169 | + * |
|
| 2170 | + * @since 1.0.19 |
|
| 2171 | + * @param string $value New description. |
|
| 2172 | + */ |
|
| 2173 | + public function set_summary( $value ) { |
|
| 2174 | + $this->set_description( $value ); |
|
| 2175 | 2175 | } |
| 2176 | 2176 | |
| 2177 | 2177 | /** |
| 2178 | - * Set the receiver of the invoice. |
|
| 2179 | - * |
|
| 2180 | - * @since 1.0.19 |
|
| 2181 | - * @param int $value New author. |
|
| 2182 | - */ |
|
| 2183 | - public function set_author( $value ) { |
|
| 2184 | - $user = get_user_by( 'id', (int) $value ); |
|
| 2178 | + * Set the receiver of the invoice. |
|
| 2179 | + * |
|
| 2180 | + * @since 1.0.19 |
|
| 2181 | + * @param int $value New author. |
|
| 2182 | + */ |
|
| 2183 | + public function set_author( $value ) { |
|
| 2184 | + $user = get_user_by( 'id', (int) $value ); |
|
| 2185 | 2185 | |
| 2186 | - if ( $user && $user->ID ) { |
|
| 2187 | - $this->set_prop( 'author', $user->ID ); |
|
| 2188 | - $this->set_prop( 'email', $user->user_email ); |
|
| 2189 | - } |
|
| 2186 | + if ( $user && $user->ID ) { |
|
| 2187 | + $this->set_prop( 'author', $user->ID ); |
|
| 2188 | + $this->set_prop( 'email', $user->user_email ); |
|
| 2189 | + } |
|
| 2190 | 2190 | |
| 2191 | 2191 | } |
| 2192 | 2192 | |
| 2193 | 2193 | /** |
| 2194 | - * Alias of self::set_author(). |
|
| 2195 | - * |
|
| 2196 | - * @since 1.0.19 |
|
| 2197 | - * @param int $value New user id. |
|
| 2198 | - */ |
|
| 2199 | - public function set_user_id( $value ) { |
|
| 2200 | - $this->set_author( $value ); |
|
| 2194 | + * Alias of self::set_author(). |
|
| 2195 | + * |
|
| 2196 | + * @since 1.0.19 |
|
| 2197 | + * @param int $value New user id. |
|
| 2198 | + */ |
|
| 2199 | + public function set_user_id( $value ) { |
|
| 2200 | + $this->set_author( $value ); |
|
| 2201 | + } |
|
| 2202 | + |
|
| 2203 | + /** |
|
| 2204 | + * Alias of self::set_author(). |
|
| 2205 | + * |
|
| 2206 | + * @since 1.0.19 |
|
| 2207 | + * @param int $value New user id. |
|
| 2208 | + */ |
|
| 2209 | + public function set_customer_id( $value ) { |
|
| 2210 | + $this->set_author( $value ); |
|
| 2211 | + } |
|
| 2212 | + |
|
| 2213 | + /** |
|
| 2214 | + * Set the customer's ip. |
|
| 2215 | + * |
|
| 2216 | + * @since 1.0.19 |
|
| 2217 | + * @param string $value ip address. |
|
| 2218 | + */ |
|
| 2219 | + public function set_ip( $value ) { |
|
| 2220 | + $this->set_prop( 'ip', $value ); |
|
| 2221 | + } |
|
| 2222 | + |
|
| 2223 | + /** |
|
| 2224 | + * Alias of self::set_ip(). |
|
| 2225 | + * |
|
| 2226 | + * @since 1.0.19 |
|
| 2227 | + * @param string $value ip address. |
|
| 2228 | + */ |
|
| 2229 | + public function set_user_ip( $value ) { |
|
| 2230 | + $this->set_ip( $value ); |
|
| 2231 | + } |
|
| 2232 | + |
|
| 2233 | + /** |
|
| 2234 | + * Set the customer's first name. |
|
| 2235 | + * |
|
| 2236 | + * @since 1.0.19 |
|
| 2237 | + * @param string $value first name. |
|
| 2238 | + */ |
|
| 2239 | + public function set_first_name( $value ) { |
|
| 2240 | + $this->set_prop( 'first_name', $value ); |
|
| 2201 | 2241 | } |
| 2202 | 2242 | |
| 2203 | 2243 | /** |
| 2204 | - * Alias of self::set_author(). |
|
| 2205 | - * |
|
| 2206 | - * @since 1.0.19 |
|
| 2207 | - * @param int $value New user id. |
|
| 2208 | - */ |
|
| 2209 | - public function set_customer_id( $value ) { |
|
| 2210 | - $this->set_author( $value ); |
|
| 2244 | + * Alias of self::set_first_name(). |
|
| 2245 | + * |
|
| 2246 | + * @since 1.0.19 |
|
| 2247 | + * @param string $value first name. |
|
| 2248 | + */ |
|
| 2249 | + public function set_user_first_name( $value ) { |
|
| 2250 | + $this->set_first_name( $value ); |
|
| 2211 | 2251 | } |
| 2212 | 2252 | |
| 2213 | 2253 | /** |
| 2214 | - * Set the customer's ip. |
|
| 2215 | - * |
|
| 2216 | - * @since 1.0.19 |
|
| 2217 | - * @param string $value ip address. |
|
| 2218 | - */ |
|
| 2219 | - public function set_ip( $value ) { |
|
| 2220 | - $this->set_prop( 'ip', $value ); |
|
| 2254 | + * Alias of self::set_first_name(). |
|
| 2255 | + * |
|
| 2256 | + * @since 1.0.19 |
|
| 2257 | + * @param string $value first name. |
|
| 2258 | + */ |
|
| 2259 | + public function set_customer_first_name( $value ) { |
|
| 2260 | + $this->set_first_name( $value ); |
|
| 2221 | 2261 | } |
| 2222 | 2262 | |
| 2223 | 2263 | /** |
| 2224 | - * Alias of self::set_ip(). |
|
| 2225 | - * |
|
| 2226 | - * @since 1.0.19 |
|
| 2227 | - * @param string $value ip address. |
|
| 2228 | - */ |
|
| 2229 | - public function set_user_ip( $value ) { |
|
| 2230 | - $this->set_ip( $value ); |
|
| 2264 | + * Set the customer's last name. |
|
| 2265 | + * |
|
| 2266 | + * @since 1.0.19 |
|
| 2267 | + * @param string $value last name. |
|
| 2268 | + */ |
|
| 2269 | + public function set_last_name( $value ) { |
|
| 2270 | + $this->set_prop( 'last_name', $value ); |
|
| 2231 | 2271 | } |
| 2232 | 2272 | |
| 2233 | 2273 | /** |
| 2234 | - * Set the customer's first name. |
|
| 2235 | - * |
|
| 2236 | - * @since 1.0.19 |
|
| 2237 | - * @param string $value first name. |
|
| 2238 | - */ |
|
| 2239 | - public function set_first_name( $value ) { |
|
| 2240 | - $this->set_prop( 'first_name', $value ); |
|
| 2274 | + * Alias of self::set_last_name(). |
|
| 2275 | + * |
|
| 2276 | + * @since 1.0.19 |
|
| 2277 | + * @param string $value last name. |
|
| 2278 | + */ |
|
| 2279 | + public function set_user_last_name( $value ) { |
|
| 2280 | + $this->set_last_name( $value ); |
|
| 2241 | 2281 | } |
| 2242 | 2282 | |
| 2243 | 2283 | /** |
| 2244 | - * Alias of self::set_first_name(). |
|
| 2245 | - * |
|
| 2246 | - * @since 1.0.19 |
|
| 2247 | - * @param string $value first name. |
|
| 2248 | - */ |
|
| 2249 | - public function set_user_first_name( $value ) { |
|
| 2250 | - $this->set_first_name( $value ); |
|
| 2284 | + * Alias of self::set_last_name(). |
|
| 2285 | + * |
|
| 2286 | + * @since 1.0.19 |
|
| 2287 | + * @param string $value last name. |
|
| 2288 | + */ |
|
| 2289 | + public function set_customer_last_name( $value ) { |
|
| 2290 | + $this->set_last_name( $value ); |
|
| 2251 | 2291 | } |
| 2252 | 2292 | |
| 2253 | 2293 | /** |
| 2254 | - * Alias of self::set_first_name(). |
|
| 2255 | - * |
|
| 2256 | - * @since 1.0.19 |
|
| 2257 | - * @param string $value first name. |
|
| 2258 | - */ |
|
| 2259 | - public function set_customer_first_name( $value ) { |
|
| 2260 | - $this->set_first_name( $value ); |
|
| 2294 | + * Set the customer's phone number. |
|
| 2295 | + * |
|
| 2296 | + * @since 1.0.19 |
|
| 2297 | + * @param string $value phone. |
|
| 2298 | + */ |
|
| 2299 | + public function set_phone( $value ) { |
|
| 2300 | + $this->set_prop( 'phone', $value ); |
|
| 2261 | 2301 | } |
| 2262 | 2302 | |
| 2263 | 2303 | /** |
| 2264 | - * Set the customer's last name. |
|
| 2265 | - * |
|
| 2266 | - * @since 1.0.19 |
|
| 2267 | - * @param string $value last name. |
|
| 2268 | - */ |
|
| 2269 | - public function set_last_name( $value ) { |
|
| 2270 | - $this->set_prop( 'last_name', $value ); |
|
| 2304 | + * Alias of self::set_phone(). |
|
| 2305 | + * |
|
| 2306 | + * @since 1.0.19 |
|
| 2307 | + * @param string $value phone. |
|
| 2308 | + */ |
|
| 2309 | + public function set_user_phone( $value ) { |
|
| 2310 | + $this->set_phone( $value ); |
|
| 2271 | 2311 | } |
| 2272 | 2312 | |
| 2273 | 2313 | /** |
| 2274 | - * Alias of self::set_last_name(). |
|
| 2275 | - * |
|
| 2276 | - * @since 1.0.19 |
|
| 2277 | - * @param string $value last name. |
|
| 2278 | - */ |
|
| 2279 | - public function set_user_last_name( $value ) { |
|
| 2280 | - $this->set_last_name( $value ); |
|
| 2314 | + * Alias of self::set_phone(). |
|
| 2315 | + * |
|
| 2316 | + * @since 1.0.19 |
|
| 2317 | + * @param string $value phone. |
|
| 2318 | + */ |
|
| 2319 | + public function set_customer_phone( $value ) { |
|
| 2320 | + $this->set_phone( $value ); |
|
| 2281 | 2321 | } |
| 2282 | 2322 | |
| 2283 | 2323 | /** |
| 2284 | - * Alias of self::set_last_name(). |
|
| 2285 | - * |
|
| 2286 | - * @since 1.0.19 |
|
| 2287 | - * @param string $value last name. |
|
| 2288 | - */ |
|
| 2289 | - public function set_customer_last_name( $value ) { |
|
| 2290 | - $this->set_last_name( $value ); |
|
| 2324 | + * Alias of self::set_phone(). |
|
| 2325 | + * |
|
| 2326 | + * @since 1.0.19 |
|
| 2327 | + * @param string $value phone. |
|
| 2328 | + */ |
|
| 2329 | + public function set_phone_number( $value ) { |
|
| 2330 | + $this->set_phone( $value ); |
|
| 2291 | 2331 | } |
| 2292 | 2332 | |
| 2293 | 2333 | /** |
| 2294 | - * Set the customer's phone number. |
|
| 2295 | - * |
|
| 2296 | - * @since 1.0.19 |
|
| 2297 | - * @param string $value phone. |
|
| 2298 | - */ |
|
| 2299 | - public function set_phone( $value ) { |
|
| 2300 | - $this->set_prop( 'phone', $value ); |
|
| 2334 | + * Set the customer's email address. |
|
| 2335 | + * |
|
| 2336 | + * @since 1.0.19 |
|
| 2337 | + * @param string $value email address. |
|
| 2338 | + */ |
|
| 2339 | + public function set_email( $value ) { |
|
| 2340 | + $this->set_prop( 'email', $value ); |
|
| 2301 | 2341 | } |
| 2302 | 2342 | |
| 2303 | 2343 | /** |
| 2304 | - * Alias of self::set_phone(). |
|
| 2305 | - * |
|
| 2306 | - * @since 1.0.19 |
|
| 2307 | - * @param string $value phone. |
|
| 2308 | - */ |
|
| 2309 | - public function set_user_phone( $value ) { |
|
| 2310 | - $this->set_phone( $value ); |
|
| 2344 | + * Alias of self::set_email(). |
|
| 2345 | + * |
|
| 2346 | + * @since 1.0.19 |
|
| 2347 | + * @param string $value email address. |
|
| 2348 | + */ |
|
| 2349 | + public function set_user_email( $value ) { |
|
| 2350 | + $this->set_email( $value ); |
|
| 2311 | 2351 | } |
| 2312 | 2352 | |
| 2313 | 2353 | /** |
| 2314 | - * Alias of self::set_phone(). |
|
| 2315 | - * |
|
| 2316 | - * @since 1.0.19 |
|
| 2317 | - * @param string $value phone. |
|
| 2318 | - */ |
|
| 2319 | - public function set_customer_phone( $value ) { |
|
| 2320 | - $this->set_phone( $value ); |
|
| 2354 | + * Alias of self::set_email(). |
|
| 2355 | + * |
|
| 2356 | + * @since 1.0.19 |
|
| 2357 | + * @param string $value email address. |
|
| 2358 | + */ |
|
| 2359 | + public function set_email_address( $value ) { |
|
| 2360 | + $this->set_email( $value ); |
|
| 2321 | 2361 | } |
| 2322 | 2362 | |
| 2323 | 2363 | /** |
| 2324 | - * Alias of self::set_phone(). |
|
| 2325 | - * |
|
| 2326 | - * @since 1.0.19 |
|
| 2327 | - * @param string $value phone. |
|
| 2328 | - */ |
|
| 2329 | - public function set_phone_number( $value ) { |
|
| 2330 | - $this->set_phone( $value ); |
|
| 2364 | + * Alias of self::set_email(). |
|
| 2365 | + * |
|
| 2366 | + * @since 1.0.19 |
|
| 2367 | + * @param string $value email address. |
|
| 2368 | + */ |
|
| 2369 | + public function set_customer_email( $value ) { |
|
| 2370 | + $this->set_email( $value ); |
|
| 2331 | 2371 | } |
| 2332 | 2372 | |
| 2333 | 2373 | /** |
| 2334 | - * Set the customer's email address. |
|
| 2335 | - * |
|
| 2336 | - * @since 1.0.19 |
|
| 2337 | - * @param string $value email address. |
|
| 2338 | - */ |
|
| 2339 | - public function set_email( $value ) { |
|
| 2340 | - $this->set_prop( 'email', $value ); |
|
| 2374 | + * Set the customer's country. |
|
| 2375 | + * |
|
| 2376 | + * @since 1.0.19 |
|
| 2377 | + * @param string $value country. |
|
| 2378 | + */ |
|
| 2379 | + public function set_country( $value ) { |
|
| 2380 | + $this->set_prop( 'country', $value ); |
|
| 2341 | 2381 | } |
| 2342 | 2382 | |
| 2343 | 2383 | /** |
| 2344 | - * Alias of self::set_email(). |
|
| 2345 | - * |
|
| 2346 | - * @since 1.0.19 |
|
| 2347 | - * @param string $value email address. |
|
| 2348 | - */ |
|
| 2349 | - public function set_user_email( $value ) { |
|
| 2350 | - $this->set_email( $value ); |
|
| 2384 | + * Alias of self::set_country(). |
|
| 2385 | + * |
|
| 2386 | + * @since 1.0.19 |
|
| 2387 | + * @param string $value country. |
|
| 2388 | + */ |
|
| 2389 | + public function set_user_country( $value ) { |
|
| 2390 | + $this->set_country( $value ); |
|
| 2351 | 2391 | } |
| 2352 | 2392 | |
| 2353 | 2393 | /** |
| 2354 | - * Alias of self::set_email(). |
|
| 2355 | - * |
|
| 2356 | - * @since 1.0.19 |
|
| 2357 | - * @param string $value email address. |
|
| 2358 | - */ |
|
| 2359 | - public function set_email_address( $value ) { |
|
| 2360 | - $this->set_email( $value ); |
|
| 2394 | + * Alias of self::set_country(). |
|
| 2395 | + * |
|
| 2396 | + * @since 1.0.19 |
|
| 2397 | + * @param string $value country. |
|
| 2398 | + */ |
|
| 2399 | + public function set_customer_country( $value ) { |
|
| 2400 | + $this->set_country( $value ); |
|
| 2361 | 2401 | } |
| 2362 | 2402 | |
| 2363 | 2403 | /** |
| 2364 | - * Alias of self::set_email(). |
|
| 2365 | - * |
|
| 2366 | - * @since 1.0.19 |
|
| 2367 | - * @param string $value email address. |
|
| 2368 | - */ |
|
| 2369 | - public function set_customer_email( $value ) { |
|
| 2370 | - $this->set_email( $value ); |
|
| 2404 | + * Set the customer's state. |
|
| 2405 | + * |
|
| 2406 | + * @since 1.0.19 |
|
| 2407 | + * @param string $value state. |
|
| 2408 | + */ |
|
| 2409 | + public function set_state( $value ) { |
|
| 2410 | + $this->set_prop( 'state', $value ); |
|
| 2371 | 2411 | } |
| 2372 | 2412 | |
| 2373 | 2413 | /** |
| 2374 | - * Set the customer's country. |
|
| 2375 | - * |
|
| 2376 | - * @since 1.0.19 |
|
| 2377 | - * @param string $value country. |
|
| 2378 | - */ |
|
| 2379 | - public function set_country( $value ) { |
|
| 2380 | - $this->set_prop( 'country', $value ); |
|
| 2414 | + * Alias of self::set_state(). |
|
| 2415 | + * |
|
| 2416 | + * @since 1.0.19 |
|
| 2417 | + * @param string $value state. |
|
| 2418 | + */ |
|
| 2419 | + public function set_user_state( $value ) { |
|
| 2420 | + $this->set_state( $value ); |
|
| 2381 | 2421 | } |
| 2382 | 2422 | |
| 2383 | 2423 | /** |
| 2384 | - * Alias of self::set_country(). |
|
| 2385 | - * |
|
| 2386 | - * @since 1.0.19 |
|
| 2387 | - * @param string $value country. |
|
| 2388 | - */ |
|
| 2389 | - public function set_user_country( $value ) { |
|
| 2390 | - $this->set_country( $value ); |
|
| 2424 | + * Alias of self::set_state(). |
|
| 2425 | + * |
|
| 2426 | + * @since 1.0.19 |
|
| 2427 | + * @param string $value state. |
|
| 2428 | + */ |
|
| 2429 | + public function set_customer_state( $value ) { |
|
| 2430 | + $this->set_state( $value ); |
|
| 2391 | 2431 | } |
| 2392 | 2432 | |
| 2393 | 2433 | /** |
| 2394 | - * Alias of self::set_country(). |
|
| 2395 | - * |
|
| 2396 | - * @since 1.0.19 |
|
| 2397 | - * @param string $value country. |
|
| 2398 | - */ |
|
| 2399 | - public function set_customer_country( $value ) { |
|
| 2400 | - $this->set_country( $value ); |
|
| 2434 | + * Set the customer's city. |
|
| 2435 | + * |
|
| 2436 | + * @since 1.0.19 |
|
| 2437 | + * @param string $value city. |
|
| 2438 | + */ |
|
| 2439 | + public function set_city( $value ) { |
|
| 2440 | + $this->set_prop( 'city', $value ); |
|
| 2401 | 2441 | } |
| 2402 | 2442 | |
| 2403 | 2443 | /** |
| 2404 | - * Set the customer's state. |
|
| 2405 | - * |
|
| 2406 | - * @since 1.0.19 |
|
| 2407 | - * @param string $value state. |
|
| 2408 | - */ |
|
| 2409 | - public function set_state( $value ) { |
|
| 2410 | - $this->set_prop( 'state', $value ); |
|
| 2444 | + * Alias of self::set_city(). |
|
| 2445 | + * |
|
| 2446 | + * @since 1.0.19 |
|
| 2447 | + * @param string $value city. |
|
| 2448 | + */ |
|
| 2449 | + public function set_user_city( $value ) { |
|
| 2450 | + $this->set_city( $value ); |
|
| 2411 | 2451 | } |
| 2412 | 2452 | |
| 2413 | 2453 | /** |
| 2414 | - * Alias of self::set_state(). |
|
| 2415 | - * |
|
| 2416 | - * @since 1.0.19 |
|
| 2417 | - * @param string $value state. |
|
| 2418 | - */ |
|
| 2419 | - public function set_user_state( $value ) { |
|
| 2420 | - $this->set_state( $value ); |
|
| 2454 | + * Alias of self::set_city(). |
|
| 2455 | + * |
|
| 2456 | + * @since 1.0.19 |
|
| 2457 | + * @param string $value city. |
|
| 2458 | + */ |
|
| 2459 | + public function set_customer_city( $value ) { |
|
| 2460 | + $this->set_city( $value ); |
|
| 2421 | 2461 | } |
| 2422 | 2462 | |
| 2423 | 2463 | /** |
| 2424 | - * Alias of self::set_state(). |
|
| 2425 | - * |
|
| 2426 | - * @since 1.0.19 |
|
| 2427 | - * @param string $value state. |
|
| 2428 | - */ |
|
| 2429 | - public function set_customer_state( $value ) { |
|
| 2430 | - $this->set_state( $value ); |
|
| 2464 | + * Set the customer's zip code. |
|
| 2465 | + * |
|
| 2466 | + * @since 1.0.19 |
|
| 2467 | + * @param string $value zip. |
|
| 2468 | + */ |
|
| 2469 | + public function set_zip( $value ) { |
|
| 2470 | + $this->set_prop( 'zip', $value ); |
|
| 2431 | 2471 | } |
| 2432 | 2472 | |
| 2433 | 2473 | /** |
| 2434 | - * Set the customer's city. |
|
| 2435 | - * |
|
| 2436 | - * @since 1.0.19 |
|
| 2437 | - * @param string $value city. |
|
| 2438 | - */ |
|
| 2439 | - public function set_city( $value ) { |
|
| 2440 | - $this->set_prop( 'city', $value ); |
|
| 2474 | + * Alias of self::set_zip(). |
|
| 2475 | + * |
|
| 2476 | + * @since 1.0.19 |
|
| 2477 | + * @param string $value zip. |
|
| 2478 | + */ |
|
| 2479 | + public function set_user_zip( $value ) { |
|
| 2480 | + $this->set_zip( $value ); |
|
| 2441 | 2481 | } |
| 2442 | 2482 | |
| 2443 | 2483 | /** |
| 2444 | - * Alias of self::set_city(). |
|
| 2445 | - * |
|
| 2446 | - * @since 1.0.19 |
|
| 2447 | - * @param string $value city. |
|
| 2448 | - */ |
|
| 2449 | - public function set_user_city( $value ) { |
|
| 2450 | - $this->set_city( $value ); |
|
| 2484 | + * Alias of self::set_zip(). |
|
| 2485 | + * |
|
| 2486 | + * @since 1.0.19 |
|
| 2487 | + * @param string $value zip. |
|
| 2488 | + */ |
|
| 2489 | + public function set_customer_zip( $value ) { |
|
| 2490 | + $this->set_zip( $value ); |
|
| 2451 | 2491 | } |
| 2452 | 2492 | |
| 2453 | 2493 | /** |
| 2454 | - * Alias of self::set_city(). |
|
| 2455 | - * |
|
| 2456 | - * @since 1.0.19 |
|
| 2457 | - * @param string $value city. |
|
| 2458 | - */ |
|
| 2459 | - public function set_customer_city( $value ) { |
|
| 2460 | - $this->set_city( $value ); |
|
| 2494 | + * Set the customer's company. |
|
| 2495 | + * |
|
| 2496 | + * @since 1.0.19 |
|
| 2497 | + * @param string $value company. |
|
| 2498 | + */ |
|
| 2499 | + public function set_company( $value ) { |
|
| 2500 | + $this->set_prop( 'company', $value ); |
|
| 2461 | 2501 | } |
| 2462 | 2502 | |
| 2463 | 2503 | /** |
| 2464 | - * Set the customer's zip code. |
|
| 2465 | - * |
|
| 2466 | - * @since 1.0.19 |
|
| 2467 | - * @param string $value zip. |
|
| 2468 | - */ |
|
| 2469 | - public function set_zip( $value ) { |
|
| 2470 | - $this->set_prop( 'zip', $value ); |
|
| 2504 | + * Alias of self::set_company(). |
|
| 2505 | + * |
|
| 2506 | + * @since 1.0.19 |
|
| 2507 | + * @param string $value company. |
|
| 2508 | + */ |
|
| 2509 | + public function set_user_company( $value ) { |
|
| 2510 | + $this->set_company( $value ); |
|
| 2471 | 2511 | } |
| 2472 | 2512 | |
| 2473 | 2513 | /** |
| 2474 | - * Alias of self::set_zip(). |
|
| 2475 | - * |
|
| 2476 | - * @since 1.0.19 |
|
| 2477 | - * @param string $value zip. |
|
| 2478 | - */ |
|
| 2479 | - public function set_user_zip( $value ) { |
|
| 2480 | - $this->set_zip( $value ); |
|
| 2514 | + * Alias of self::set_company(). |
|
| 2515 | + * |
|
| 2516 | + * @since 1.0.19 |
|
| 2517 | + * @param string $value company. |
|
| 2518 | + */ |
|
| 2519 | + public function set_customer_company( $value ) { |
|
| 2520 | + $this->set_company( $value ); |
|
| 2481 | 2521 | } |
| 2482 | 2522 | |
| 2483 | 2523 | /** |
| 2484 | - * Alias of self::set_zip(). |
|
| 2485 | - * |
|
| 2486 | - * @since 1.0.19 |
|
| 2487 | - * @param string $value zip. |
|
| 2488 | - */ |
|
| 2489 | - public function set_customer_zip( $value ) { |
|
| 2490 | - $this->set_zip( $value ); |
|
| 2524 | + * Set the customer's var number. |
|
| 2525 | + * |
|
| 2526 | + * @since 1.0.19 |
|
| 2527 | + * @param string $value var number. |
|
| 2528 | + */ |
|
| 2529 | + public function set_vat_number( $value ) { |
|
| 2530 | + $this->set_prop( 'vat_number', $value ); |
|
| 2491 | 2531 | } |
| 2492 | 2532 | |
| 2493 | 2533 | /** |
| 2494 | - * Set the customer's company. |
|
| 2495 | - * |
|
| 2496 | - * @since 1.0.19 |
|
| 2497 | - * @param string $value company. |
|
| 2498 | - */ |
|
| 2499 | - public function set_company( $value ) { |
|
| 2500 | - $this->set_prop( 'company', $value ); |
|
| 2534 | + * Alias of self::set_vat_number(). |
|
| 2535 | + * |
|
| 2536 | + * @since 1.0.19 |
|
| 2537 | + * @param string $value var number. |
|
| 2538 | + */ |
|
| 2539 | + public function set_user_vat_number( $value ) { |
|
| 2540 | + $this->set_vat_number( $value ); |
|
| 2501 | 2541 | } |
| 2502 | 2542 | |
| 2503 | 2543 | /** |
| 2504 | - * Alias of self::set_company(). |
|
| 2505 | - * |
|
| 2506 | - * @since 1.0.19 |
|
| 2507 | - * @param string $value company. |
|
| 2508 | - */ |
|
| 2509 | - public function set_user_company( $value ) { |
|
| 2510 | - $this->set_company( $value ); |
|
| 2544 | + * Alias of self::set_vat_number(). |
|
| 2545 | + * |
|
| 2546 | + * @since 1.0.19 |
|
| 2547 | + * @param string $value var number. |
|
| 2548 | + */ |
|
| 2549 | + public function set_customer_vat_number( $value ) { |
|
| 2550 | + $this->set_vat_number( $value ); |
|
| 2511 | 2551 | } |
| 2512 | 2552 | |
| 2513 | 2553 | /** |
| 2514 | - * Alias of self::set_company(). |
|
| 2515 | - * |
|
| 2516 | - * @since 1.0.19 |
|
| 2517 | - * @param string $value company. |
|
| 2518 | - */ |
|
| 2519 | - public function set_customer_company( $value ) { |
|
| 2520 | - $this->set_company( $value ); |
|
| 2554 | + * Set the customer's vat rate. |
|
| 2555 | + * |
|
| 2556 | + * @since 1.0.19 |
|
| 2557 | + * @param string $value var rate. |
|
| 2558 | + */ |
|
| 2559 | + public function set_vat_rate( $value ) { |
|
| 2560 | + $this->set_prop( 'vat_rate', $value ); |
|
| 2521 | 2561 | } |
| 2522 | 2562 | |
| 2523 | 2563 | /** |
| 2524 | - * Set the customer's var number. |
|
| 2525 | - * |
|
| 2526 | - * @since 1.0.19 |
|
| 2527 | - * @param string $value var number. |
|
| 2528 | - */ |
|
| 2529 | - public function set_vat_number( $value ) { |
|
| 2530 | - $this->set_prop( 'vat_number', $value ); |
|
| 2564 | + * Alias of self::set_vat_rate(). |
|
| 2565 | + * |
|
| 2566 | + * @since 1.0.19 |
|
| 2567 | + * @param string $value var number. |
|
| 2568 | + */ |
|
| 2569 | + public function set_user_vat_rate( $value ) { |
|
| 2570 | + $this->set_vat_rate( $value ); |
|
| 2531 | 2571 | } |
| 2532 | 2572 | |
| 2533 | 2573 | /** |
| 2534 | - * Alias of self::set_vat_number(). |
|
| 2535 | - * |
|
| 2536 | - * @since 1.0.19 |
|
| 2537 | - * @param string $value var number. |
|
| 2538 | - */ |
|
| 2539 | - public function set_user_vat_number( $value ) { |
|
| 2540 | - $this->set_vat_number( $value ); |
|
| 2574 | + * Alias of self::set_vat_rate(). |
|
| 2575 | + * |
|
| 2576 | + * @since 1.0.19 |
|
| 2577 | + * @param string $value var number. |
|
| 2578 | + */ |
|
| 2579 | + public function set_customer_vat_rate( $value ) { |
|
| 2580 | + $this->set_vat_rate( $value ); |
|
| 2541 | 2581 | } |
| 2542 | 2582 | |
| 2543 | 2583 | /** |
| 2544 | - * Alias of self::set_vat_number(). |
|
| 2545 | - * |
|
| 2546 | - * @since 1.0.19 |
|
| 2547 | - * @param string $value var number. |
|
| 2548 | - */ |
|
| 2549 | - public function set_customer_vat_number( $value ) { |
|
| 2550 | - $this->set_vat_number( $value ); |
|
| 2584 | + * Set the customer's address. |
|
| 2585 | + * |
|
| 2586 | + * @since 1.0.19 |
|
| 2587 | + * @param string $value address. |
|
| 2588 | + */ |
|
| 2589 | + public function set_address( $value ) { |
|
| 2590 | + $this->set_prop( 'address', $value ); |
|
| 2551 | 2591 | } |
| 2552 | 2592 | |
| 2553 | 2593 | /** |
| 2554 | - * Set the customer's vat rate. |
|
| 2555 | - * |
|
| 2556 | - * @since 1.0.19 |
|
| 2557 | - * @param string $value var rate. |
|
| 2558 | - */ |
|
| 2559 | - public function set_vat_rate( $value ) { |
|
| 2560 | - $this->set_prop( 'vat_rate', $value ); |
|
| 2594 | + * Alias of self::set_address(). |
|
| 2595 | + * |
|
| 2596 | + * @since 1.0.19 |
|
| 2597 | + * @param string $value address. |
|
| 2598 | + */ |
|
| 2599 | + public function set_user_address( $value ) { |
|
| 2600 | + $this->set_address( $value ); |
|
| 2561 | 2601 | } |
| 2562 | 2602 | |
| 2563 | 2603 | /** |
| 2564 | - * Alias of self::set_vat_rate(). |
|
| 2565 | - * |
|
| 2566 | - * @since 1.0.19 |
|
| 2567 | - * @param string $value var number. |
|
| 2568 | - */ |
|
| 2569 | - public function set_user_vat_rate( $value ) { |
|
| 2570 | - $this->set_vat_rate( $value ); |
|
| 2604 | + * Alias of self::set_address(). |
|
| 2605 | + * |
|
| 2606 | + * @since 1.0.19 |
|
| 2607 | + * @param string $value address. |
|
| 2608 | + */ |
|
| 2609 | + public function set_customer_address( $value ) { |
|
| 2610 | + $this->set_address( $value ); |
|
| 2571 | 2611 | } |
| 2572 | 2612 | |
| 2573 | 2613 | /** |
| 2574 | - * Alias of self::set_vat_rate(). |
|
| 2575 | - * |
|
| 2576 | - * @since 1.0.19 |
|
| 2577 | - * @param string $value var number. |
|
| 2578 | - */ |
|
| 2579 | - public function set_customer_vat_rate( $value ) { |
|
| 2580 | - $this->set_vat_rate( $value ); |
|
| 2614 | + * Set whether the customer has viewed the invoice or not. |
|
| 2615 | + * |
|
| 2616 | + * @since 1.0.19 |
|
| 2617 | + * @param int|bool $value confirmed. |
|
| 2618 | + */ |
|
| 2619 | + public function set_is_viewed( $value ) { |
|
| 2620 | + $this->set_prop( 'is_viewed', $value ); |
|
| 2581 | 2621 | } |
| 2582 | 2622 | |
| 2583 | 2623 | /** |
| 2584 | - * Set the customer's address. |
|
| 2585 | - * |
|
| 2586 | - * @since 1.0.19 |
|
| 2587 | - * @param string $value address. |
|
| 2588 | - */ |
|
| 2589 | - public function set_address( $value ) { |
|
| 2590 | - $this->set_prop( 'address', $value ); |
|
| 2624 | + * Set extra email recipients. |
|
| 2625 | + * |
|
| 2626 | + * @since 1.0.19 |
|
| 2627 | + * @param string $value email recipients. |
|
| 2628 | + */ |
|
| 2629 | + public function set_email_cc( $value ) { |
|
| 2630 | + $this->set_prop( 'email_cc', $value ); |
|
| 2591 | 2631 | } |
| 2592 | 2632 | |
| 2593 | 2633 | /** |
| 2594 | - * Alias of self::set_address(). |
|
| 2595 | - * |
|
| 2596 | - * @since 1.0.19 |
|
| 2597 | - * @param string $value address. |
|
| 2598 | - */ |
|
| 2599 | - public function set_user_address( $value ) { |
|
| 2600 | - $this->set_address( $value ); |
|
| 2634 | + * Set the invoice template. |
|
| 2635 | + * |
|
| 2636 | + * @since 1.0.19 |
|
| 2637 | + * @param string $value template. |
|
| 2638 | + */ |
|
| 2639 | + public function set_template( $value ) { |
|
| 2640 | + if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
| 2641 | + $this->set_prop( 'template', $value ); |
|
| 2642 | + } |
|
| 2601 | 2643 | } |
| 2602 | 2644 | |
| 2603 | 2645 | /** |
| 2604 | - * Alias of self::set_address(). |
|
| 2605 | - * |
|
| 2606 | - * @since 1.0.19 |
|
| 2607 | - * @param string $value address. |
|
| 2608 | - */ |
|
| 2609 | - public function set_customer_address( $value ) { |
|
| 2610 | - $this->set_address( $value ); |
|
| 2646 | + * Set the invoice source. |
|
| 2647 | + * |
|
| 2648 | + * @since 1.0.19 |
|
| 2649 | + * @param string $value email recipients. |
|
| 2650 | + */ |
|
| 2651 | + public function created_via( $value ) { |
|
| 2652 | + $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
| 2611 | 2653 | } |
| 2612 | 2654 | |
| 2613 | 2655 | /** |
| 2614 | - * Set whether the customer has viewed the invoice or not. |
|
| 2615 | - * |
|
| 2616 | - * @since 1.0.19 |
|
| 2617 | - * @param int|bool $value confirmed. |
|
| 2618 | - */ |
|
| 2619 | - public function set_is_viewed( $value ) { |
|
| 2620 | - $this->set_prop( 'is_viewed', $value ); |
|
| 2621 | - } |
|
| 2622 | - |
|
| 2623 | - /** |
|
| 2624 | - * Set extra email recipients. |
|
| 2625 | - * |
|
| 2626 | - * @since 1.0.19 |
|
| 2627 | - * @param string $value email recipients. |
|
| 2628 | - */ |
|
| 2629 | - public function set_email_cc( $value ) { |
|
| 2630 | - $this->set_prop( 'email_cc', $value ); |
|
| 2631 | - } |
|
| 2632 | - |
|
| 2633 | - /** |
|
| 2634 | - * Set the invoice template. |
|
| 2635 | - * |
|
| 2636 | - * @since 1.0.19 |
|
| 2637 | - * @param string $value template. |
|
| 2638 | - */ |
|
| 2639 | - public function set_template( $value ) { |
|
| 2640 | - if ( in_array( $value, array( 'quantity', 'hours', 'amount' ) ) ) { |
|
| 2641 | - $this->set_prop( 'template', $value ); |
|
| 2642 | - } |
|
| 2643 | - } |
|
| 2644 | - |
|
| 2645 | - /** |
|
| 2646 | - * Set the invoice source. |
|
| 2647 | - * |
|
| 2648 | - * @since 1.0.19 |
|
| 2649 | - * @param string $value email recipients. |
|
| 2650 | - */ |
|
| 2651 | - public function created_via( $value ) { |
|
| 2652 | - $this->set_prop( 'created_via', sanitize_text_field( $value ) ); |
|
| 2653 | - } |
|
| 2654 | - |
|
| 2655 | - /** |
|
| 2656 | - * Set the customer's address confirmed status. |
|
| 2657 | - * |
|
| 2658 | - * @since 1.0.19 |
|
| 2659 | - * @param int|bool $value confirmed. |
|
| 2660 | - */ |
|
| 2661 | - public function set_address_confirmed( $value ) { |
|
| 2662 | - $this->set_prop( 'address_confirmed', $value ); |
|
| 2656 | + * Set the customer's address confirmed status. |
|
| 2657 | + * |
|
| 2658 | + * @since 1.0.19 |
|
| 2659 | + * @param int|bool $value confirmed. |
|
| 2660 | + */ |
|
| 2661 | + public function set_address_confirmed( $value ) { |
|
| 2662 | + $this->set_prop( 'address_confirmed', $value ); |
|
| 2663 | 2663 | } |
| 2664 | 2664 | |
| 2665 | 2665 | /** |
| 2666 | - * Alias of self::set_address_confirmed(). |
|
| 2667 | - * |
|
| 2668 | - * @since 1.0.19 |
|
| 2669 | - * @param int|bool $value confirmed. |
|
| 2670 | - */ |
|
| 2671 | - public function set_user_address_confirmed( $value ) { |
|
| 2672 | - $this->set_address_confirmed( $value ); |
|
| 2666 | + * Alias of self::set_address_confirmed(). |
|
| 2667 | + * |
|
| 2668 | + * @since 1.0.19 |
|
| 2669 | + * @param int|bool $value confirmed. |
|
| 2670 | + */ |
|
| 2671 | + public function set_user_address_confirmed( $value ) { |
|
| 2672 | + $this->set_address_confirmed( $value ); |
|
| 2673 | 2673 | } |
| 2674 | 2674 | |
| 2675 | 2675 | /** |
| 2676 | - * Alias of self::set_address_confirmed(). |
|
| 2677 | - * |
|
| 2678 | - * @since 1.0.19 |
|
| 2679 | - * @param int|bool $value confirmed. |
|
| 2680 | - */ |
|
| 2681 | - public function set_customer_address_confirmed( $value ) { |
|
| 2682 | - $this->set_address_confirmed( $value ); |
|
| 2676 | + * Alias of self::set_address_confirmed(). |
|
| 2677 | + * |
|
| 2678 | + * @since 1.0.19 |
|
| 2679 | + * @param int|bool $value confirmed. |
|
| 2680 | + */ |
|
| 2681 | + public function set_customer_address_confirmed( $value ) { |
|
| 2682 | + $this->set_address_confirmed( $value ); |
|
| 2683 | 2683 | } |
| 2684 | 2684 | |
| 2685 | 2685 | /** |
| 2686 | - * Set the invoice sub total. |
|
| 2687 | - * |
|
| 2688 | - * @since 1.0.19 |
|
| 2689 | - * @param float $value sub total. |
|
| 2690 | - */ |
|
| 2691 | - public function set_subtotal( $value ) { |
|
| 2692 | - $this->set_prop( 'subtotal', $value ); |
|
| 2686 | + * Set the invoice sub total. |
|
| 2687 | + * |
|
| 2688 | + * @since 1.0.19 |
|
| 2689 | + * @param float $value sub total. |
|
| 2690 | + */ |
|
| 2691 | + public function set_subtotal( $value ) { |
|
| 2692 | + $this->set_prop( 'subtotal', $value ); |
|
| 2693 | 2693 | } |
| 2694 | 2694 | |
| 2695 | 2695 | /** |
| 2696 | - * Set the invoice discount amount. |
|
| 2697 | - * |
|
| 2698 | - * @since 1.0.19 |
|
| 2699 | - * @param float $value discount total. |
|
| 2700 | - */ |
|
| 2701 | - public function set_total_discount( $value ) { |
|
| 2702 | - $this->set_prop( 'total_discount', $value ); |
|
| 2696 | + * Set the invoice discount amount. |
|
| 2697 | + * |
|
| 2698 | + * @since 1.0.19 |
|
| 2699 | + * @param float $value discount total. |
|
| 2700 | + */ |
|
| 2701 | + public function set_total_discount( $value ) { |
|
| 2702 | + $this->set_prop( 'total_discount', $value ); |
|
| 2703 | 2703 | } |
| 2704 | 2704 | |
| 2705 | 2705 | /** |
| 2706 | - * Alias of self::set_total_discount(). |
|
| 2707 | - * |
|
| 2708 | - * @since 1.0.19 |
|
| 2709 | - * @param float $value discount total. |
|
| 2710 | - */ |
|
| 2711 | - public function set_discount( $value ) { |
|
| 2712 | - $this->set_total_discount( $value ); |
|
| 2706 | + * Alias of self::set_total_discount(). |
|
| 2707 | + * |
|
| 2708 | + * @since 1.0.19 |
|
| 2709 | + * @param float $value discount total. |
|
| 2710 | + */ |
|
| 2711 | + public function set_discount( $value ) { |
|
| 2712 | + $this->set_total_discount( $value ); |
|
| 2713 | 2713 | } |
| 2714 | 2714 | |
| 2715 | 2715 | /** |
| 2716 | - * Set the invoice tax amount. |
|
| 2717 | - * |
|
| 2718 | - * @since 1.0.19 |
|
| 2719 | - * @param float $value tax total. |
|
| 2720 | - */ |
|
| 2721 | - public function set_total_tax( $value ) { |
|
| 2722 | - $this->set_prop( 'total_tax', $value ); |
|
| 2716 | + * Set the invoice tax amount. |
|
| 2717 | + * |
|
| 2718 | + * @since 1.0.19 |
|
| 2719 | + * @param float $value tax total. |
|
| 2720 | + */ |
|
| 2721 | + public function set_total_tax( $value ) { |
|
| 2722 | + $this->set_prop( 'total_tax', $value ); |
|
| 2723 | 2723 | } |
| 2724 | 2724 | |
| 2725 | 2725 | /** |
| 2726 | - * Alias of self::set_total_tax(). |
|
| 2727 | - * |
|
| 2728 | - * @since 1.0.19 |
|
| 2729 | - * @param float $value tax total. |
|
| 2730 | - */ |
|
| 2731 | - public function set_tax_total( $value ) { |
|
| 2732 | - $this->set_total_tax( $value ); |
|
| 2726 | + * Alias of self::set_total_tax(). |
|
| 2727 | + * |
|
| 2728 | + * @since 1.0.19 |
|
| 2729 | + * @param float $value tax total. |
|
| 2730 | + */ |
|
| 2731 | + public function set_tax_total( $value ) { |
|
| 2732 | + $this->set_total_tax( $value ); |
|
| 2733 | 2733 | } |
| 2734 | 2734 | |
| 2735 | 2735 | /** |
| 2736 | - * Set the invoice fees amount. |
|
| 2737 | - * |
|
| 2738 | - * @since 1.0.19 |
|
| 2739 | - * @param float $value fees total. |
|
| 2740 | - */ |
|
| 2741 | - public function set_total_fees( $value ) { |
|
| 2742 | - $this->set_prop( 'total_fees', $value ); |
|
| 2736 | + * Set the invoice fees amount. |
|
| 2737 | + * |
|
| 2738 | + * @since 1.0.19 |
|
| 2739 | + * @param float $value fees total. |
|
| 2740 | + */ |
|
| 2741 | + public function set_total_fees( $value ) { |
|
| 2742 | + $this->set_prop( 'total_fees', $value ); |
|
| 2743 | 2743 | } |
| 2744 | 2744 | |
| 2745 | 2745 | /** |
| 2746 | - * Alias of self::set_total_fees(). |
|
| 2747 | - * |
|
| 2748 | - * @since 1.0.19 |
|
| 2749 | - * @param float $value fees total. |
|
| 2750 | - */ |
|
| 2751 | - public function set_fees_total( $value ) { |
|
| 2752 | - $this->set_total_fees( $value ); |
|
| 2746 | + * Alias of self::set_total_fees(). |
|
| 2747 | + * |
|
| 2748 | + * @since 1.0.19 |
|
| 2749 | + * @param float $value fees total. |
|
| 2750 | + */ |
|
| 2751 | + public function set_fees_total( $value ) { |
|
| 2752 | + $this->set_total_fees( $value ); |
|
| 2753 | 2753 | } |
| 2754 | 2754 | |
| 2755 | 2755 | /** |
| 2756 | - * Set the invoice fees. |
|
| 2757 | - * |
|
| 2758 | - * @since 1.0.19 |
|
| 2759 | - * @param array $value fees. |
|
| 2760 | - */ |
|
| 2761 | - public function set_fees( $value ) { |
|
| 2756 | + * Set the invoice fees. |
|
| 2757 | + * |
|
| 2758 | + * @since 1.0.19 |
|
| 2759 | + * @param array $value fees. |
|
| 2760 | + */ |
|
| 2761 | + public function set_fees( $value ) { |
|
| 2762 | 2762 | |
| 2763 | - if ( ! is_array( $value ) ) { |
|
| 2764 | - $value = array(); |
|
| 2765 | - } |
|
| 2763 | + if ( ! is_array( $value ) ) { |
|
| 2764 | + $value = array(); |
|
| 2765 | + } |
|
| 2766 | 2766 | |
| 2767 | - $this->set_prop( 'fees', $value ); |
|
| 2767 | + $this->set_prop( 'fees', $value ); |
|
| 2768 | 2768 | |
| 2769 | 2769 | } |
| 2770 | 2770 | |
| 2771 | 2771 | /** |
| 2772 | - * Set the invoice taxes. |
|
| 2773 | - * |
|
| 2774 | - * @since 1.0.19 |
|
| 2775 | - * @param array $value taxes. |
|
| 2776 | - */ |
|
| 2777 | - public function set_taxes( $value ) { |
|
| 2772 | + * Set the invoice taxes. |
|
| 2773 | + * |
|
| 2774 | + * @since 1.0.19 |
|
| 2775 | + * @param array $value taxes. |
|
| 2776 | + */ |
|
| 2777 | + public function set_taxes( $value ) { |
|
| 2778 | 2778 | |
| 2779 | - if ( ! is_array( $value ) ) { |
|
| 2780 | - $value = array(); |
|
| 2781 | - } |
|
| 2779 | + if ( ! is_array( $value ) ) { |
|
| 2780 | + $value = array(); |
|
| 2781 | + } |
|
| 2782 | 2782 | |
| 2783 | - $this->set_prop( 'taxes', $value ); |
|
| 2783 | + $this->set_prop( 'taxes', $value ); |
|
| 2784 | 2784 | |
| 2785 | 2785 | } |
| 2786 | 2786 | |
| 2787 | 2787 | /** |
| 2788 | - * Set the invoice discounts. |
|
| 2789 | - * |
|
| 2790 | - * @since 1.0.19 |
|
| 2791 | - * @param array $value discounts. |
|
| 2792 | - */ |
|
| 2793 | - public function set_discounts( $value ) { |
|
| 2788 | + * Set the invoice discounts. |
|
| 2789 | + * |
|
| 2790 | + * @since 1.0.19 |
|
| 2791 | + * @param array $value discounts. |
|
| 2792 | + */ |
|
| 2793 | + public function set_discounts( $value ) { |
|
| 2794 | 2794 | |
| 2795 | - if ( ! is_array( $value ) ) { |
|
| 2796 | - $value = array(); |
|
| 2797 | - } |
|
| 2795 | + if ( ! is_array( $value ) ) { |
|
| 2796 | + $value = array(); |
|
| 2797 | + } |
|
| 2798 | 2798 | |
| 2799 | - $this->set_prop( 'discounts', $value ); |
|
| 2799 | + $this->set_prop( 'discounts', $value ); |
|
| 2800 | 2800 | } |
| 2801 | 2801 | |
| 2802 | 2802 | /** |
| 2803 | - * Set the invoice items. |
|
| 2804 | - * |
|
| 2805 | - * @since 1.0.19 |
|
| 2806 | - * @param GetPaid_Form_Item[] $value items. |
|
| 2807 | - */ |
|
| 2808 | - public function set_items( $value ) { |
|
| 2803 | + * Set the invoice items. |
|
| 2804 | + * |
|
| 2805 | + * @since 1.0.19 |
|
| 2806 | + * @param GetPaid_Form_Item[] $value items. |
|
| 2807 | + */ |
|
| 2808 | + public function set_items( $value ) { |
|
| 2809 | 2809 | |
| 2810 | 2810 | // Remove existing items. |
| 2811 | 2811 | $this->set_prop( 'items', array() ); |
@@ -2822,95 +2822,95 @@ discard block |
||
| 2822 | 2822 | } |
| 2823 | 2823 | |
| 2824 | 2824 | /** |
| 2825 | - * Set the payment form. |
|
| 2826 | - * |
|
| 2827 | - * @since 1.0.19 |
|
| 2828 | - * @param int $value payment form. |
|
| 2829 | - */ |
|
| 2830 | - public function set_payment_form( $value ) { |
|
| 2831 | - $this->set_prop( 'payment_form', $value ); |
|
| 2825 | + * Set the payment form. |
|
| 2826 | + * |
|
| 2827 | + * @since 1.0.19 |
|
| 2828 | + * @param int $value payment form. |
|
| 2829 | + */ |
|
| 2830 | + public function set_payment_form( $value ) { |
|
| 2831 | + $this->set_prop( 'payment_form', $value ); |
|
| 2832 | 2832 | } |
| 2833 | 2833 | |
| 2834 | 2834 | /** |
| 2835 | - * Set the submission id. |
|
| 2836 | - * |
|
| 2837 | - * @since 1.0.19 |
|
| 2838 | - * @param string $value submission id. |
|
| 2839 | - */ |
|
| 2840 | - public function set_submission_id( $value ) { |
|
| 2841 | - $this->set_prop( 'submission_id', $value ); |
|
| 2835 | + * Set the submission id. |
|
| 2836 | + * |
|
| 2837 | + * @since 1.0.19 |
|
| 2838 | + * @param string $value submission id. |
|
| 2839 | + */ |
|
| 2840 | + public function set_submission_id( $value ) { |
|
| 2841 | + $this->set_prop( 'submission_id', $value ); |
|
| 2842 | 2842 | } |
| 2843 | 2843 | |
| 2844 | 2844 | /** |
| 2845 | - * Set the discount code. |
|
| 2846 | - * |
|
| 2847 | - * @since 1.0.19 |
|
| 2848 | - * @param string $value discount code. |
|
| 2849 | - */ |
|
| 2850 | - public function set_discount_code( $value ) { |
|
| 2851 | - $this->set_prop( 'discount_code', $value ); |
|
| 2845 | + * Set the discount code. |
|
| 2846 | + * |
|
| 2847 | + * @since 1.0.19 |
|
| 2848 | + * @param string $value discount code. |
|
| 2849 | + */ |
|
| 2850 | + public function set_discount_code( $value ) { |
|
| 2851 | + $this->set_prop( 'discount_code', $value ); |
|
| 2852 | 2852 | } |
| 2853 | 2853 | |
| 2854 | 2854 | /** |
| 2855 | - * Set the gateway. |
|
| 2856 | - * |
|
| 2857 | - * @since 1.0.19 |
|
| 2858 | - * @param string $value gateway. |
|
| 2859 | - */ |
|
| 2860 | - public function set_gateway( $value ) { |
|
| 2861 | - $this->set_prop( 'gateway', $value ); |
|
| 2855 | + * Set the gateway. |
|
| 2856 | + * |
|
| 2857 | + * @since 1.0.19 |
|
| 2858 | + * @param string $value gateway. |
|
| 2859 | + */ |
|
| 2860 | + public function set_gateway( $value ) { |
|
| 2861 | + $this->set_prop( 'gateway', $value ); |
|
| 2862 | 2862 | } |
| 2863 | 2863 | |
| 2864 | 2864 | /** |
| 2865 | - * Set the transaction id. |
|
| 2866 | - * |
|
| 2867 | - * @since 1.0.19 |
|
| 2868 | - * @param string $value transaction id. |
|
| 2869 | - */ |
|
| 2870 | - public function set_transaction_id( $value ) { |
|
| 2871 | - if ( ! empty( $value ) ) { |
|
| 2872 | - $this->set_prop( 'transaction_id', $value ); |
|
| 2873 | - } |
|
| 2865 | + * Set the transaction id. |
|
| 2866 | + * |
|
| 2867 | + * @since 1.0.19 |
|
| 2868 | + * @param string $value transaction id. |
|
| 2869 | + */ |
|
| 2870 | + public function set_transaction_id( $value ) { |
|
| 2871 | + if ( ! empty( $value ) ) { |
|
| 2872 | + $this->set_prop( 'transaction_id', $value ); |
|
| 2873 | + } |
|
| 2874 | 2874 | } |
| 2875 | 2875 | |
| 2876 | 2876 | /** |
| 2877 | - * Set the currency id. |
|
| 2878 | - * |
|
| 2879 | - * @since 1.0.19 |
|
| 2880 | - * @param string $value currency id. |
|
| 2881 | - */ |
|
| 2882 | - public function set_currency( $value ) { |
|
| 2883 | - $this->set_prop( 'currency', $value ); |
|
| 2877 | + * Set the currency id. |
|
| 2878 | + * |
|
| 2879 | + * @since 1.0.19 |
|
| 2880 | + * @param string $value currency id. |
|
| 2881 | + */ |
|
| 2882 | + public function set_currency( $value ) { |
|
| 2883 | + $this->set_prop( 'currency', $value ); |
|
| 2884 | 2884 | } |
| 2885 | 2885 | |
| 2886 | - /** |
|
| 2887 | - * Set whether to disable taxes. |
|
| 2888 | - * |
|
| 2889 | - * @since 1.0.19 |
|
| 2890 | - * @param bool $value value. |
|
| 2891 | - */ |
|
| 2892 | - public function set_disable_taxes( $value ) { |
|
| 2893 | - $this->set_prop( 'disable_taxes', (bool) $value ); |
|
| 2894 | - } |
|
| 2886 | + /** |
|
| 2887 | + * Set whether to disable taxes. |
|
| 2888 | + * |
|
| 2889 | + * @since 1.0.19 |
|
| 2890 | + * @param bool $value value. |
|
| 2891 | + */ |
|
| 2892 | + public function set_disable_taxes( $value ) { |
|
| 2893 | + $this->set_prop( 'disable_taxes', (bool) $value ); |
|
| 2894 | + } |
|
| 2895 | 2895 | |
| 2896 | 2896 | /** |
| 2897 | - * Set the subscription id. |
|
| 2898 | - * |
|
| 2899 | - * @since 1.0.19 |
|
| 2900 | - * @param string $value subscription id. |
|
| 2901 | - */ |
|
| 2902 | - public function set_subscription_id( $value ) { |
|
| 2903 | - $this->set_prop( 'subscription_id', $value ); |
|
| 2904 | - } |
|
| 2897 | + * Set the subscription id. |
|
| 2898 | + * |
|
| 2899 | + * @since 1.0.19 |
|
| 2900 | + * @param string $value subscription id. |
|
| 2901 | + */ |
|
| 2902 | + public function set_subscription_id( $value ) { |
|
| 2903 | + $this->set_prop( 'subscription_id', $value ); |
|
| 2904 | + } |
|
| 2905 | 2905 | |
| 2906 | - /** |
|
| 2907 | - * Set the remote subscription id. |
|
| 2908 | - * |
|
| 2909 | - * @since 1.0.19 |
|
| 2910 | - * @param string $value subscription id. |
|
| 2911 | - */ |
|
| 2912 | - public function set_remote_subscription_id( $value ) { |
|
| 2913 | - $this->set_prop( 'remote_subscription_id', $value ); |
|
| 2906 | + /** |
|
| 2907 | + * Set the remote subscription id. |
|
| 2908 | + * |
|
| 2909 | + * @since 1.0.19 |
|
| 2910 | + * @param string $value subscription id. |
|
| 2911 | + */ |
|
| 2912 | + public function set_remote_subscription_id( $value ) { |
|
| 2913 | + $this->set_prop( 'remote_subscription_id', $value ); |
|
| 2914 | 2914 | } |
| 2915 | 2915 | |
| 2916 | 2916 | /* |
@@ -2949,12 +2949,12 @@ discard block |
||
| 2949 | 2949 | */ |
| 2950 | 2950 | public function is_taxable() { |
| 2951 | 2951 | return ! $this->get_disable_taxes(); |
| 2952 | - } |
|
| 2952 | + } |
|
| 2953 | 2953 | |
| 2954 | - /** |
|
| 2955 | - * @deprecated |
|
| 2956 | - */ |
|
| 2957 | - public function has_vat() { |
|
| 2954 | + /** |
|
| 2955 | + * @deprecated |
|
| 2956 | + */ |
|
| 2957 | + public function has_vat() { |
|
| 2958 | 2958 | global $wpinv_euvat, $wpi_country; |
| 2959 | 2959 | |
| 2960 | 2960 | $requires_vat = false; |
@@ -2965,17 +2965,17 @@ discard block |
||
| 2965 | 2965 | } |
| 2966 | 2966 | |
| 2967 | 2967 | return apply_filters( 'wpinv_invoice_has_vat', $requires_vat, $this ); |
| 2968 | - } |
|
| 2968 | + } |
|
| 2969 | 2969 | |
| 2970 | - /** |
|
| 2971 | - * Checks to see if the invoice requires payment. |
|
| 2972 | - */ |
|
| 2973 | - public function is_free() { |
|
| 2970 | + /** |
|
| 2971 | + * Checks to see if the invoice requires payment. |
|
| 2972 | + */ |
|
| 2973 | + public function is_free() { |
|
| 2974 | 2974 | $is_free = ( (float) wpinv_round_amount( $this->get_initial_total() ) == 0 ); |
| 2975 | 2975 | |
| 2976 | - if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
| 2977 | - $is_free = false; |
|
| 2978 | - } |
|
| 2976 | + if ( $this->is_recurring() && $this->get_recurring_total() > 0 ) { |
|
| 2977 | + $is_free = false; |
|
| 2978 | + } |
|
| 2979 | 2979 | |
| 2980 | 2980 | return apply_filters( 'wpinv_invoice_is_free', $is_free, $this ); |
| 2981 | 2981 | } |
@@ -2986,46 +2986,46 @@ discard block |
||
| 2986 | 2986 | public function is_paid() { |
| 2987 | 2987 | $is_paid = $this->has_status( array( 'publish', 'wpi-processing', 'wpi-renewal' ) ); |
| 2988 | 2988 | return apply_filters( 'wpinv_invoice_is_paid', $is_paid, $this ); |
| 2989 | - } |
|
| 2989 | + } |
|
| 2990 | 2990 | |
| 2991 | - /** |
|
| 2991 | + /** |
|
| 2992 | 2992 | * Checks if the invoice needs payment. |
| 2993 | 2993 | */ |
| 2994 | - public function needs_payment() { |
|
| 2995 | - $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
| 2994 | + public function needs_payment() { |
|
| 2995 | + $needs_payment = ! $this->is_paid() && ! $this->is_refunded() && ! $this->is_free(); |
|
| 2996 | 2996 | return apply_filters( 'wpinv_needs_payment', $needs_payment, $this ); |
| 2997 | 2997 | } |
| 2998 | 2998 | |
| 2999 | - /** |
|
| 2999 | + /** |
|
| 3000 | 3000 | * Checks if the invoice is refunded. |
| 3001 | 3001 | */ |
| 3002 | - public function is_refunded() { |
|
| 3002 | + public function is_refunded() { |
|
| 3003 | 3003 | $is_refunded = $this->has_status( 'wpi-refunded' ); |
| 3004 | 3004 | return apply_filters( 'wpinv_invoice_is_refunded', $is_refunded, $this ); |
| 3005 | - } |
|
| 3005 | + } |
|
| 3006 | 3006 | |
| 3007 | - /** |
|
| 3007 | + /** |
|
| 3008 | 3008 | * Checks if the invoice is held. |
| 3009 | 3009 | */ |
| 3010 | - public function is_held() { |
|
| 3010 | + public function is_held() { |
|
| 3011 | 3011 | $is_held = $this->has_status( 'wpi-onhold' ); |
| 3012 | 3012 | return apply_filters( 'wpinv_invoice_is_held', $is_held, $this ); |
| 3013 | - } |
|
| 3013 | + } |
|
| 3014 | 3014 | |
| 3015 | - /** |
|
| 3015 | + /** |
|
| 3016 | 3016 | * Checks if the invoice is due. |
| 3017 | 3017 | */ |
| 3018 | - public function is_due() { |
|
| 3019 | - $due_date = $this->get_due_date(); |
|
| 3020 | - return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
| 3021 | - } |
|
| 3018 | + public function is_due() { |
|
| 3019 | + $due_date = $this->get_due_date(); |
|
| 3020 | + return empty( $due_date ) ? false : current_time( 'timestamp' ) > strtotime( $due_date ); |
|
| 3021 | + } |
|
| 3022 | 3022 | |
| 3023 | - /** |
|
| 3023 | + /** |
|
| 3024 | 3024 | * Checks if the invoice is draft. |
| 3025 | 3025 | */ |
| 3026 | - public function is_draft() { |
|
| 3026 | + public function is_draft() { |
|
| 3027 | 3027 | return $this->has_status( 'draft, auto-draft' ); |
| 3028 | - } |
|
| 3028 | + } |
|
| 3029 | 3029 | |
| 3030 | 3030 | /** |
| 3031 | 3031 | * Checks if the invoice has a given status. |
@@ -3033,9 +3033,9 @@ discard block |
||
| 3033 | 3033 | public function has_status( $status ) { |
| 3034 | 3034 | $status = wpinv_parse_list( $status ); |
| 3035 | 3035 | return apply_filters( 'wpinv_has_status', in_array( $this->get_status(), $status ), $status ); |
| 3036 | - } |
|
| 3036 | + } |
|
| 3037 | 3037 | |
| 3038 | - /** |
|
| 3038 | + /** |
|
| 3039 | 3039 | * Checks if the invoice is of a given type. |
| 3040 | 3040 | */ |
| 3041 | 3041 | public function is_type( $type ) { |
@@ -3058,25 +3058,25 @@ discard block |
||
| 3058 | 3058 | */ |
| 3059 | 3059 | public function has_free_trial() { |
| 3060 | 3060 | return $this->is_recurring() && 0 == $this->get_initial_total(); |
| 3061 | - } |
|
| 3061 | + } |
|
| 3062 | 3062 | |
| 3063 | - /** |
|
| 3063 | + /** |
|
| 3064 | 3064 | * @deprecated |
| 3065 | 3065 | */ |
| 3066 | 3066 | public function is_free_trial() { |
| 3067 | 3067 | $this->has_free_trial(); |
| 3068 | 3068 | } |
| 3069 | 3069 | |
| 3070 | - /** |
|
| 3070 | + /** |
|
| 3071 | 3071 | * Check if the initial payment if 0. |
| 3072 | 3072 | * |
| 3073 | 3073 | */ |
| 3074 | - public function is_initial_free() { |
|
| 3074 | + public function is_initial_free() { |
|
| 3075 | 3075 | $is_initial_free = ! ( (float) wpinv_round_amount( $this->get_initial_total() ) > 0 ); |
| 3076 | 3076 | return apply_filters( 'wpinv_invoice_is_initial_free', $is_initial_free, $this->get_cart_details(), $this ); |
| 3077 | 3077 | } |
| 3078 | 3078 | |
| 3079 | - /** |
|
| 3079 | + /** |
|
| 3080 | 3080 | * Check if the recurring item has a free trial. |
| 3081 | 3081 | * |
| 3082 | 3082 | */ |
@@ -3089,21 +3089,21 @@ discard block |
||
| 3089 | 3089 | |
| 3090 | 3090 | $item = $this->get_recurring( true ); |
| 3091 | 3091 | return $item->has_free_trial(); |
| 3092 | - } |
|
| 3092 | + } |
|
| 3093 | 3093 | |
| 3094 | - /** |
|
| 3094 | + /** |
|
| 3095 | 3095 | * Check if the free trial is a result of a discount. |
| 3096 | 3096 | */ |
| 3097 | 3097 | public function is_free_trial_from_discount() { |
| 3098 | - return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
| 3099 | - } |
|
| 3098 | + return $this->has_free_trial() && ! $this->item_has_free_trial(); |
|
| 3099 | + } |
|
| 3100 | 3100 | |
| 3101 | - /** |
|
| 3101 | + /** |
|
| 3102 | 3102 | * @deprecated |
| 3103 | 3103 | */ |
| 3104 | 3104 | public function discount_first_payment_only() { |
| 3105 | 3105 | |
| 3106 | - $discount_code = $this->get_discount_code(); |
|
| 3106 | + $discount_code = $this->get_discount_code(); |
|
| 3107 | 3107 | if ( empty( $this->discount_code ) || ! $this->is_recurring() ) { |
| 3108 | 3108 | return true; |
| 3109 | 3109 | } |
@@ -3134,28 +3134,28 @@ discard block |
||
| 3134 | 3134 | */ |
| 3135 | 3135 | public function add_item( $item ) { |
| 3136 | 3136 | |
| 3137 | - if ( is_array( $item ) ) { |
|
| 3138 | - $item = $this->process_array_item( $item ); |
|
| 3139 | - } |
|
| 3137 | + if ( is_array( $item ) ) { |
|
| 3138 | + $item = $this->process_array_item( $item ); |
|
| 3139 | + } |
|
| 3140 | 3140 | |
| 3141 | - if ( is_numeric( $item ) ) { |
|
| 3142 | - $item = new GetPaid_Form_Item( $item ); |
|
| 3143 | - } |
|
| 3141 | + if ( is_numeric( $item ) ) { |
|
| 3142 | + $item = new GetPaid_Form_Item( $item ); |
|
| 3143 | + } |
|
| 3144 | 3144 | |
| 3145 | 3145 | // Make sure that it is available for purchase. |
| 3146 | - if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
| 3147 | - return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
| 3146 | + if ( $item->get_id() > 0 && ! $item->can_purchase() ) { |
|
| 3147 | + return new WP_Error( 'invalid_item', __( 'This item is not available for purchase', 'invoicing' ) ); |
|
| 3148 | 3148 | } |
| 3149 | 3149 | |
| 3150 | 3150 | // Do we have a recurring item? |
| 3151 | - if ( $item->is_recurring() ) { |
|
| 3151 | + if ( $item->is_recurring() ) { |
|
| 3152 | 3152 | |
| 3153 | - // An invoice can only contain one recurring item. |
|
| 3154 | - if ( ! empty( $this->recurring_item && $this->recurring_item != (int) $item->get_id() ) ) { |
|
| 3155 | - return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
| 3156 | - } |
|
| 3153 | + // An invoice can only contain one recurring item. |
|
| 3154 | + if ( ! empty( $this->recurring_item && $this->recurring_item != (int) $item->get_id() ) ) { |
|
| 3155 | + return new WP_Error( 'recurring_item', __( 'An invoice can only contain one recurring item', 'invoicing' ) ); |
|
| 3156 | + } |
|
| 3157 | 3157 | |
| 3158 | - $this->recurring_item = $item->get_id(); |
|
| 3158 | + $this->recurring_item = $item->get_id(); |
|
| 3159 | 3159 | } |
| 3160 | 3160 | |
| 3161 | 3161 | // Invoice id. |
@@ -3166,60 +3166,60 @@ discard block |
||
| 3166 | 3166 | $items[ (int) $item->get_id() ] = $item; |
| 3167 | 3167 | |
| 3168 | 3168 | $this->set_prop( 'items', $items ); |
| 3169 | - return true; |
|
| 3170 | - } |
|
| 3169 | + return true; |
|
| 3170 | + } |
|
| 3171 | 3171 | |
| 3172 | - /** |
|
| 3173 | - * Converts an array to an item. |
|
| 3174 | - * |
|
| 3175 | - * @since 1.0.19 |
|
| 3176 | - * @return GetPaid_Form_Item |
|
| 3177 | - */ |
|
| 3178 | - protected function process_array_item( $array ) { |
|
| 3172 | + /** |
|
| 3173 | + * Converts an array to an item. |
|
| 3174 | + * |
|
| 3175 | + * @since 1.0.19 |
|
| 3176 | + * @return GetPaid_Form_Item |
|
| 3177 | + */ |
|
| 3178 | + protected function process_array_item( $array ) { |
|
| 3179 | 3179 | |
| 3180 | - $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
| 3181 | - $item = new GetPaid_Form_Item( $item_id ); |
|
| 3180 | + $item_id = isset( $array['item_id'] ) ? $array['item_id'] : 0; |
|
| 3181 | + $item = new GetPaid_Form_Item( $item_id ); |
|
| 3182 | 3182 | |
| 3183 | - // Set item data. |
|
| 3184 | - foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
| 3185 | - if ( isset( $array[ "item_$key" ] ) ) { |
|
| 3186 | - $method = "set_$key"; |
|
| 3187 | - $item->$method( $array[ "item_$key" ] ); |
|
| 3188 | - } |
|
| 3189 | - } |
|
| 3183 | + // Set item data. |
|
| 3184 | + foreach ( array( 'name', 'price', 'description' ) as $key ) { |
|
| 3185 | + if ( isset( $array[ "item_$key" ] ) ) { |
|
| 3186 | + $method = "set_$key"; |
|
| 3187 | + $item->$method( $array[ "item_$key" ] ); |
|
| 3188 | + } |
|
| 3189 | + } |
|
| 3190 | 3190 | |
| 3191 | - if ( isset( $array['quantity'] ) ) { |
|
| 3192 | - $item->set_quantity( $array['quantity'] ); |
|
| 3193 | - } |
|
| 3191 | + if ( isset( $array['quantity'] ) ) { |
|
| 3192 | + $item->set_quantity( $array['quantity'] ); |
|
| 3193 | + } |
|
| 3194 | 3194 | |
| 3195 | - // Set item meta. |
|
| 3196 | - if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
| 3197 | - $item->set_item_meta( $array['meta'] ); |
|
| 3198 | - } |
|
| 3195 | + // Set item meta. |
|
| 3196 | + if ( isset( $array['meta'] ) && is_array( $array['meta'] ) ) { |
|
| 3197 | + $item->set_item_meta( $array['meta'] ); |
|
| 3198 | + } |
|
| 3199 | 3199 | |
| 3200 | - return $item; |
|
| 3200 | + return $item; |
|
| 3201 | 3201 | |
| 3202 | - } |
|
| 3202 | + } |
|
| 3203 | 3203 | |
| 3204 | 3204 | /** |
| 3205 | - * Retrieves a specific item. |
|
| 3206 | - * |
|
| 3207 | - * @since 1.0.19 |
|
| 3208 | - */ |
|
| 3209 | - public function get_item( $item_id ) { |
|
| 3210 | - $items = $this->get_items(); |
|
| 3211 | - $item_id = (int) $item_id; |
|
| 3212 | - return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null; |
|
| 3205 | + * Retrieves a specific item. |
|
| 3206 | + * |
|
| 3207 | + * @since 1.0.19 |
|
| 3208 | + */ |
|
| 3209 | + public function get_item( $item_id ) { |
|
| 3210 | + $items = $this->get_items(); |
|
| 3211 | + $item_id = (int) $item_id; |
|
| 3212 | + return ( ! empty( $item_id ) && isset( $items[ $item_id ] ) ) ? $items[ $item_id ] : null; |
|
| 3213 | 3213 | } |
| 3214 | 3214 | |
| 3215 | 3215 | /** |
| 3216 | - * Removes a specific item. |
|
| 3217 | - * |
|
| 3218 | - * @since 1.0.19 |
|
| 3219 | - */ |
|
| 3220 | - public function remove_item( $item_id ) { |
|
| 3221 | - $items = $this->get_items(); |
|
| 3222 | - $item_id = (int) $item_id; |
|
| 3216 | + * Removes a specific item. |
|
| 3217 | + * |
|
| 3218 | + * @since 1.0.19 |
|
| 3219 | + */ |
|
| 3220 | + public function remove_item( $item_id ) { |
|
| 3221 | + $items = $this->get_items(); |
|
| 3222 | + $item_id = (int) $item_id; |
|
| 3223 | 3223 | |
| 3224 | 3224 | if ( $item_id == $this->recurring_item ) { |
| 3225 | 3225 | $this->recurring_item = null; |
@@ -3232,35 +3232,35 @@ discard block |
||
| 3232 | 3232 | } |
| 3233 | 3233 | |
| 3234 | 3234 | /** |
| 3235 | - * Adds a fee to the invoice. |
|
| 3236 | - * |
|
| 3237 | - * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 3238 | - * @since 1.0.19 |
|
| 3239 | - */ |
|
| 3235 | + * Adds a fee to the invoice. |
|
| 3236 | + * |
|
| 3237 | + * @param array $fee An array of fee details. name, initial_fee, and recurring_fee are required. |
|
| 3238 | + * @since 1.0.19 |
|
| 3239 | + */ |
|
| 3240 | 3240 | public function add_fee( $fee ) { |
| 3241 | 3241 | |
| 3242 | - $fees = $this->get_fees(); |
|
| 3243 | - $fees[ $fee['name'] ] = $fee; |
|
| 3244 | - $this->set_prop( 'fees', $fees ); |
|
| 3242 | + $fees = $this->get_fees(); |
|
| 3243 | + $fees[ $fee['name'] ] = $fee; |
|
| 3244 | + $this->set_prop( 'fees', $fees ); |
|
| 3245 | 3245 | |
| 3246 | 3246 | } |
| 3247 | 3247 | |
| 3248 | 3248 | /** |
| 3249 | - * Retrieves a specific fee. |
|
| 3250 | - * |
|
| 3251 | - * @since 1.0.19 |
|
| 3252 | - */ |
|
| 3253 | - public function get_fee( $fee ) { |
|
| 3249 | + * Retrieves a specific fee. |
|
| 3250 | + * |
|
| 3251 | + * @since 1.0.19 |
|
| 3252 | + */ |
|
| 3253 | + public function get_fee( $fee ) { |
|
| 3254 | 3254 | $fees = $this->get_fees(); |
| 3255 | - return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
| 3255 | + return isset( $fees[ $fee ] ) ? $fees[ $fee ] : null; |
|
| 3256 | 3256 | } |
| 3257 | 3257 | |
| 3258 | 3258 | /** |
| 3259 | - * Removes a specific fee. |
|
| 3260 | - * |
|
| 3261 | - * @since 1.0.19 |
|
| 3262 | - */ |
|
| 3263 | - public function remove_fee( $fee ) { |
|
| 3259 | + * Removes a specific fee. |
|
| 3260 | + * |
|
| 3261 | + * @since 1.0.19 |
|
| 3262 | + */ |
|
| 3263 | + public function remove_fee( $fee ) { |
|
| 3264 | 3264 | $fees = $this->get_fees(); |
| 3265 | 3265 | if ( isset( $fees[ $fee ] ) ) { |
| 3266 | 3266 | unset( $fees[ $fee ] ); |
@@ -3268,43 +3268,43 @@ discard block |
||
| 3268 | 3268 | } |
| 3269 | 3269 | } |
| 3270 | 3270 | |
| 3271 | - /** |
|
| 3272 | - * Adds a discount to the invoice. |
|
| 3273 | - * |
|
| 3274 | - * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
| 3275 | - * @since 1.0.19 |
|
| 3276 | - */ |
|
| 3277 | - public function add_discount( $discount ) { |
|
| 3271 | + /** |
|
| 3272 | + * Adds a discount to the invoice. |
|
| 3273 | + * |
|
| 3274 | + * @param array $discount An array of discount details. name, initial_discount, and recurring_discount are required. Include discount_code if the discount is from a discount code. |
|
| 3275 | + * @since 1.0.19 |
|
| 3276 | + */ |
|
| 3277 | + public function add_discount( $discount ) { |
|
| 3278 | 3278 | |
| 3279 | - $discounts = $this->get_discounts(); |
|
| 3280 | - $discounts[ $discount['name'] ] = $discount; |
|
| 3281 | - $this->set_prop( 'discounts', $discounts ); |
|
| 3279 | + $discounts = $this->get_discounts(); |
|
| 3280 | + $discounts[ $discount['name'] ] = $discount; |
|
| 3281 | + $this->set_prop( 'discounts', $discounts ); |
|
| 3282 | 3282 | |
| 3283 | - } |
|
| 3283 | + } |
|
| 3284 | 3284 | |
| 3285 | 3285 | /** |
| 3286 | - * Retrieves a specific discount. |
|
| 3287 | - * |
|
| 3288 | - * @since 1.0.19 |
|
| 3289 | - * @return float |
|
| 3290 | - */ |
|
| 3291 | - public function get_discount( $discount = false ) { |
|
| 3286 | + * Retrieves a specific discount. |
|
| 3287 | + * |
|
| 3288 | + * @since 1.0.19 |
|
| 3289 | + * @return float |
|
| 3290 | + */ |
|
| 3291 | + public function get_discount( $discount = false ) { |
|
| 3292 | 3292 | |
| 3293 | - // Backwards compatibilty. |
|
| 3294 | - if ( empty( $discount ) ) { |
|
| 3295 | - return $this->get_total_discount(); |
|
| 3296 | - } |
|
| 3293 | + // Backwards compatibilty. |
|
| 3294 | + if ( empty( $discount ) ) { |
|
| 3295 | + return $this->get_total_discount(); |
|
| 3296 | + } |
|
| 3297 | 3297 | |
| 3298 | 3298 | $discounts = $this->get_discounts(); |
| 3299 | - return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
| 3299 | + return isset( $discounts[ $discount ] ) ? $discounts[ $discount ] : null; |
|
| 3300 | 3300 | } |
| 3301 | 3301 | |
| 3302 | 3302 | /** |
| 3303 | - * Removes a specific discount. |
|
| 3304 | - * |
|
| 3305 | - * @since 1.0.19 |
|
| 3306 | - */ |
|
| 3307 | - public function remove_discount( $discount ) { |
|
| 3303 | + * Removes a specific discount. |
|
| 3304 | + * |
|
| 3305 | + * @since 1.0.19 |
|
| 3306 | + */ |
|
| 3307 | + public function remove_discount( $discount ) { |
|
| 3308 | 3308 | $discounts = $this->get_discounts(); |
| 3309 | 3309 | if ( isset( $discounts[ $discount ] ) ) { |
| 3310 | 3310 | unset( $discounts[ $discount ] ); |
@@ -3321,34 +3321,34 @@ discard block |
||
| 3321 | 3321 | if ( $this->is_taxable() ) { |
| 3322 | 3322 | |
| 3323 | 3323 | $taxes = $this->get_taxes(); |
| 3324 | - $taxes[ $tax['name'] ] = $tax; |
|
| 3325 | - $this->set_prop( 'taxes', $tax ); |
|
| 3324 | + $taxes[ $tax['name'] ] = $tax; |
|
| 3325 | + $this->set_prop( 'taxes', $tax ); |
|
| 3326 | 3326 | |
| 3327 | 3327 | } |
| 3328 | 3328 | } |
| 3329 | 3329 | |
| 3330 | 3330 | /** |
| 3331 | - * Retrieves a specific tax. |
|
| 3332 | - * |
|
| 3333 | - * @since 1.0.19 |
|
| 3334 | - */ |
|
| 3335 | - public function get_tax( $tax = null ) { |
|
| 3331 | + * Retrieves a specific tax. |
|
| 3332 | + * |
|
| 3333 | + * @since 1.0.19 |
|
| 3334 | + */ |
|
| 3335 | + public function get_tax( $tax = null ) { |
|
| 3336 | 3336 | |
| 3337 | - // Backwards compatility. |
|
| 3338 | - if ( empty( $tax ) ) { |
|
| 3339 | - return $this->get_total_tax(); |
|
| 3340 | - } |
|
| 3337 | + // Backwards compatility. |
|
| 3338 | + if ( empty( $tax ) ) { |
|
| 3339 | + return $this->get_total_tax(); |
|
| 3340 | + } |
|
| 3341 | 3341 | |
| 3342 | 3342 | $taxes = $this->get_taxes(); |
| 3343 | - return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
| 3343 | + return isset( $taxes[ $tax ] ) ? $taxes[ $tax ] : null; |
|
| 3344 | 3344 | } |
| 3345 | 3345 | |
| 3346 | 3346 | /** |
| 3347 | - * Removes a specific tax. |
|
| 3348 | - * |
|
| 3349 | - * @since 1.0.19 |
|
| 3350 | - */ |
|
| 3351 | - public function remove_tax( $tax ) { |
|
| 3347 | + * Removes a specific tax. |
|
| 3348 | + * |
|
| 3349 | + * @since 1.0.19 |
|
| 3350 | + */ |
|
| 3351 | + public function remove_tax( $tax ) { |
|
| 3352 | 3352 | $taxes = $this->get_taxes(); |
| 3353 | 3353 | if ( isset( $taxes[ $tax ] ) ) { |
| 3354 | 3354 | unset( $taxes[ $tax ] ); |
@@ -3357,134 +3357,134 @@ discard block |
||
| 3357 | 3357 | } |
| 3358 | 3358 | |
| 3359 | 3359 | /** |
| 3360 | - * Recalculates the invoice subtotal. |
|
| 3361 | - * |
|
| 3362 | - * @since 1.0.19 |
|
| 3363 | - * @return float The recalculated subtotal |
|
| 3364 | - */ |
|
| 3365 | - public function recalculate_subtotal() { |
|
| 3360 | + * Recalculates the invoice subtotal. |
|
| 3361 | + * |
|
| 3362 | + * @since 1.0.19 |
|
| 3363 | + * @return float The recalculated subtotal |
|
| 3364 | + */ |
|
| 3365 | + public function recalculate_subtotal() { |
|
| 3366 | 3366 | $items = $this->get_items(); |
| 3367 | - $subtotal = 0; |
|
| 3368 | - $recurring = 0; |
|
| 3367 | + $subtotal = 0; |
|
| 3368 | + $recurring = 0; |
|
| 3369 | 3369 | |
| 3370 | 3370 | foreach ( $items as $item ) { |
| 3371 | - $subtotal += $item->get_sub_total(); |
|
| 3372 | - $recurring += $item->get_recurring_sub_total(); |
|
| 3371 | + $subtotal += $item->get_sub_total(); |
|
| 3372 | + $recurring += $item->get_recurring_sub_total(); |
|
| 3373 | 3373 | } |
| 3374 | 3374 | |
| 3375 | - $current = $this->is_renewal() ? $recurring : $subtotal; |
|
| 3376 | - $this->set_subtotal( $current ); |
|
| 3375 | + $current = $this->is_renewal() ? $recurring : $subtotal; |
|
| 3376 | + $this->set_subtotal( $current ); |
|
| 3377 | 3377 | |
| 3378 | - $this->totals['subtotal'] = array( |
|
| 3379 | - 'initial' => $subtotal, |
|
| 3380 | - 'recurring' => $recurring, |
|
| 3381 | - ); |
|
| 3378 | + $this->totals['subtotal'] = array( |
|
| 3379 | + 'initial' => $subtotal, |
|
| 3380 | + 'recurring' => $recurring, |
|
| 3381 | + ); |
|
| 3382 | 3382 | |
| 3383 | 3383 | return $current; |
| 3384 | 3384 | } |
| 3385 | 3385 | |
| 3386 | 3386 | /** |
| 3387 | - * Recalculates the invoice discount total. |
|
| 3388 | - * |
|
| 3389 | - * @since 1.0.19 |
|
| 3390 | - * @return float The recalculated discount |
|
| 3391 | - */ |
|
| 3392 | - public function recalculate_total_discount() { |
|
| 3387 | + * Recalculates the invoice discount total. |
|
| 3388 | + * |
|
| 3389 | + * @since 1.0.19 |
|
| 3390 | + * @return float The recalculated discount |
|
| 3391 | + */ |
|
| 3392 | + public function recalculate_total_discount() { |
|
| 3393 | 3393 | $discounts = $this->get_discounts(); |
| 3394 | - $discount = 0; |
|
| 3395 | - $recurring = 0; |
|
| 3394 | + $discount = 0; |
|
| 3395 | + $recurring = 0; |
|
| 3396 | 3396 | |
| 3397 | 3397 | foreach ( $discounts as $data ) { |
| 3398 | - $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
| 3399 | - $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
| 3400 | - } |
|
| 3398 | + $discount += wpinv_sanitize_amount( $data['initial_discount'] ); |
|
| 3399 | + $recurring += wpinv_sanitize_amount( $data['recurring_discount'] ); |
|
| 3400 | + } |
|
| 3401 | 3401 | |
| 3402 | - $current = $this->is_renewal() ? $recurring : $discount; |
|
| 3402 | + $current = $this->is_renewal() ? $recurring : $discount; |
|
| 3403 | 3403 | |
| 3404 | - $this->set_total_discount( $current ); |
|
| 3404 | + $this->set_total_discount( $current ); |
|
| 3405 | 3405 | |
| 3406 | - $this->totals['discount'] = array( |
|
| 3407 | - 'initial' => $discount, |
|
| 3408 | - 'recurring' => $recurring, |
|
| 3409 | - ); |
|
| 3406 | + $this->totals['discount'] = array( |
|
| 3407 | + 'initial' => $discount, |
|
| 3408 | + 'recurring' => $recurring, |
|
| 3409 | + ); |
|
| 3410 | 3410 | |
| 3411 | - return $current; |
|
| 3411 | + return $current; |
|
| 3412 | 3412 | |
| 3413 | 3413 | } |
| 3414 | 3414 | |
| 3415 | 3415 | /** |
| 3416 | - * Recalculates the invoice tax total. |
|
| 3417 | - * |
|
| 3418 | - * @since 1.0.19 |
|
| 3419 | - * @return float The recalculated tax |
|
| 3420 | - */ |
|
| 3421 | - public function recalculate_total_tax() { |
|
| 3416 | + * Recalculates the invoice tax total. |
|
| 3417 | + * |
|
| 3418 | + * @since 1.0.19 |
|
| 3419 | + * @return float The recalculated tax |
|
| 3420 | + */ |
|
| 3421 | + public function recalculate_total_tax() { |
|
| 3422 | 3422 | $taxes = $this->get_taxes(); |
| 3423 | - $tax = 0; |
|
| 3424 | - $recurring = 0; |
|
| 3423 | + $tax = 0; |
|
| 3424 | + $recurring = 0; |
|
| 3425 | 3425 | |
| 3426 | 3426 | foreach ( $taxes as $data ) { |
| 3427 | - $tax += wpinv_sanitize_amount( $data['initial_tax'] ); |
|
| 3428 | - $recurring += wpinv_sanitize_amount( $data['recurring_tax'] ); |
|
| 3429 | - } |
|
| 3427 | + $tax += wpinv_sanitize_amount( $data['initial_tax'] ); |
|
| 3428 | + $recurring += wpinv_sanitize_amount( $data['recurring_tax'] ); |
|
| 3429 | + } |
|
| 3430 | 3430 | |
| 3431 | - $current = $this->is_renewal() ? $recurring : $tax; |
|
| 3432 | - $this->set_total_tax( $current ); |
|
| 3431 | + $current = $this->is_renewal() ? $recurring : $tax; |
|
| 3432 | + $this->set_total_tax( $current ); |
|
| 3433 | 3433 | |
| 3434 | - $this->totals['tax'] = array( |
|
| 3435 | - 'initial' => $tax, |
|
| 3436 | - 'recurring' => $recurring, |
|
| 3437 | - ); |
|
| 3434 | + $this->totals['tax'] = array( |
|
| 3435 | + 'initial' => $tax, |
|
| 3436 | + 'recurring' => $recurring, |
|
| 3437 | + ); |
|
| 3438 | 3438 | |
| 3439 | - return $current; |
|
| 3439 | + return $current; |
|
| 3440 | 3440 | |
| 3441 | 3441 | } |
| 3442 | 3442 | |
| 3443 | 3443 | /** |
| 3444 | - * Recalculates the invoice fees total. |
|
| 3445 | - * |
|
| 3446 | - * @since 1.0.19 |
|
| 3447 | - * @return float The recalculated fee |
|
| 3448 | - */ |
|
| 3449 | - public function recalculate_total_fees() { |
|
| 3450 | - $fees = $this->get_fees(); |
|
| 3451 | - $fee = 0; |
|
| 3452 | - $recurring = 0; |
|
| 3444 | + * Recalculates the invoice fees total. |
|
| 3445 | + * |
|
| 3446 | + * @since 1.0.19 |
|
| 3447 | + * @return float The recalculated fee |
|
| 3448 | + */ |
|
| 3449 | + public function recalculate_total_fees() { |
|
| 3450 | + $fees = $this->get_fees(); |
|
| 3451 | + $fee = 0; |
|
| 3452 | + $recurring = 0; |
|
| 3453 | 3453 | |
| 3454 | 3454 | foreach ( $fees as $data ) { |
| 3455 | - $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
| 3456 | - $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
| 3457 | - } |
|
| 3455 | + $fee += wpinv_sanitize_amount( $data['initial_fee'] ); |
|
| 3456 | + $recurring += wpinv_sanitize_amount( $data['recurring_fee'] ); |
|
| 3457 | + } |
|
| 3458 | 3458 | |
| 3459 | - $current = $this->is_renewal() ? $recurring : $fee; |
|
| 3460 | - $this->set_total_fees( $current ); |
|
| 3459 | + $current = $this->is_renewal() ? $recurring : $fee; |
|
| 3460 | + $this->set_total_fees( $current ); |
|
| 3461 | 3461 | |
| 3462 | - $this->totals['fee'] = array( |
|
| 3463 | - 'initial' => $fee, |
|
| 3464 | - 'recurring' => $recurring, |
|
| 3465 | - ); |
|
| 3462 | + $this->totals['fee'] = array( |
|
| 3463 | + 'initial' => $fee, |
|
| 3464 | + 'recurring' => $recurring, |
|
| 3465 | + ); |
|
| 3466 | 3466 | |
| 3467 | 3467 | $this->set_total_fees( $fee ); |
| 3468 | 3468 | return $current; |
| 3469 | 3469 | } |
| 3470 | 3470 | |
| 3471 | 3471 | /** |
| 3472 | - * Recalculates the invoice total. |
|
| 3473 | - * |
|
| 3474 | - * @since 1.0.19 |
|
| 3472 | + * Recalculates the invoice total. |
|
| 3473 | + * |
|
| 3474 | + * @since 1.0.19 |
|
| 3475 | 3475 | * @return float The invoice total |
| 3476 | - */ |
|
| 3477 | - public function recalculate_total() { |
|
| 3476 | + */ |
|
| 3477 | + public function recalculate_total() { |
|
| 3478 | 3478 | $this->recalculate_subtotal(); |
| 3479 | 3479 | $this->recalculate_total_fees(); |
| 3480 | 3480 | $this->recalculate_total_discount(); |
| 3481 | 3481 | $this->recalculate_total_tax(); |
| 3482 | - return $this->get_total(); |
|
| 3483 | - } |
|
| 3482 | + return $this->get_total(); |
|
| 3483 | + } |
|
| 3484 | 3484 | |
| 3485 | - /** |
|
| 3486 | - * @deprecated |
|
| 3487 | - */ |
|
| 3485 | + /** |
|
| 3486 | + * @deprecated |
|
| 3487 | + */ |
|
| 3488 | 3488 | public function recalculate_totals( $temp = false ) { |
| 3489 | 3489 | $this->update_items( $temp ); |
| 3490 | 3490 | $this->save( true ); |
@@ -3502,7 +3502,7 @@ discard block |
||
| 3502 | 3502 | * Adds a note to an invoice. |
| 3503 | 3503 | * |
| 3504 | 3504 | * @param string $note The note being added. |
| 3505 | - * @return int|false The new note's ID on success, false on failure. |
|
| 3505 | + * @return int|false The new note's ID on success, false on failure. |
|
| 3506 | 3506 | * |
| 3507 | 3507 | */ |
| 3508 | 3508 | public function add_note( $note = '', $customer_type = false, $added_by_user = false, $system = false ) { |
@@ -3512,21 +3512,21 @@ discard block |
||
| 3512 | 3512 | return false; |
| 3513 | 3513 | } |
| 3514 | 3514 | |
| 3515 | - $author = 'System'; |
|
| 3516 | - $author_email = '[email protected]'; |
|
| 3515 | + $author = 'System'; |
|
| 3516 | + $author_email = '[email protected]'; |
|
| 3517 | 3517 | |
| 3518 | - // If this is an admin comment or it has been added by the user. |
|
| 3519 | - if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
| 3520 | - $user = get_user_by( 'id', get_current_user_id() ); |
|
| 3518 | + // If this is an admin comment or it has been added by the user. |
|
| 3519 | + if ( is_user_logged_in() && ( ! $system || $added_by_user ) ) { |
|
| 3520 | + $user = get_user_by( 'id', get_current_user_id() ); |
|
| 3521 | 3521 | $author = $user->display_name; |
| 3522 | 3522 | $author_email = $user->user_email; |
| 3523 | - } |
|
| 3523 | + } |
|
| 3524 | 3524 | |
| 3525 | - return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
| 3525 | + return getpaid_notes()->add_invoice_note( $this, $note, $author, $author_email, $customer_type ); |
|
| 3526 | 3526 | |
| 3527 | - } |
|
| 3527 | + } |
|
| 3528 | 3528 | |
| 3529 | - /** |
|
| 3529 | + /** |
|
| 3530 | 3530 | * Generates a unique key for the invoice. |
| 3531 | 3531 | */ |
| 3532 | 3532 | public function generate_key( $string = '' ) { |
@@ -3546,113 +3546,113 @@ discard block |
||
| 3546 | 3546 | $number = wpinv_get_next_invoice_number( $this->get_post_type() ); |
| 3547 | 3547 | } |
| 3548 | 3548 | |
| 3549 | - return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
| 3550 | - |
|
| 3551 | - } |
|
| 3552 | - |
|
| 3553 | - /** |
|
| 3554 | - * Handle the status transition. |
|
| 3555 | - */ |
|
| 3556 | - protected function status_transition() { |
|
| 3557 | - $status_transition = $this->status_transition; |
|
| 3558 | - |
|
| 3559 | - // Reset status transition variable. |
|
| 3560 | - $this->status_transition = false; |
|
| 3561 | - |
|
| 3562 | - if ( $status_transition ) { |
|
| 3563 | - try { |
|
| 3549 | + return wpinv_format_invoice_number( $number, $this->get_post_type() ); |
|
| 3564 | 3550 | |
| 3565 | - // Fire a hook for the status change. |
|
| 3566 | - do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
| 3567 | - |
|
| 3568 | - // @deprecated this is deprecated and will be removed in the future. |
|
| 3569 | - do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3570 | - |
|
| 3571 | - if ( ! empty( $status_transition['from'] ) ) { |
|
| 3572 | - |
|
| 3573 | - /* translators: 1: old invoice status 2: new invoice status */ |
|
| 3574 | - $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'] ), wpinv_status_nicename( $status_transition['to'] ) ); |
|
| 3575 | - |
|
| 3576 | - // Fire another hook. |
|
| 3577 | - do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
| 3578 | - do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 3579 | - |
|
| 3580 | - // @deprecated this is deprecated and will be removed in the future. |
|
| 3581 | - do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3582 | - |
|
| 3583 | - // Note the transition occurred. |
|
| 3584 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3585 | - |
|
| 3586 | - // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
| 3587 | - if ( |
|
| 3588 | - in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3589 | - && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3590 | - ) { |
|
| 3591 | - do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
| 3592 | - } |
|
| 3593 | - |
|
| 3594 | - // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
| 3595 | - if ( |
|
| 3596 | - in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3597 | - && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3598 | - ) { |
|
| 3599 | - do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
| 3600 | - } |
|
| 3601 | - } else { |
|
| 3602 | - /* translators: %s: new invoice status */ |
|
| 3603 | - $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'] ) ); |
|
| 3604 | - |
|
| 3605 | - // Note the transition occurred. |
|
| 3606 | - $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3551 | + } |
|
| 3607 | 3552 | |
| 3608 | - } |
|
| 3609 | - } catch ( Exception $e ) { |
|
| 3610 | - $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 3611 | - } |
|
| 3612 | - } |
|
| 3613 | - } |
|
| 3553 | + /** |
|
| 3554 | + * Handle the status transition. |
|
| 3555 | + */ |
|
| 3556 | + protected function status_transition() { |
|
| 3557 | + $status_transition = $this->status_transition; |
|
| 3558 | + |
|
| 3559 | + // Reset status transition variable. |
|
| 3560 | + $this->status_transition = false; |
|
| 3561 | + |
|
| 3562 | + if ( $status_transition ) { |
|
| 3563 | + try { |
|
| 3564 | + |
|
| 3565 | + // Fire a hook for the status change. |
|
| 3566 | + do_action( 'getpaid_invoice_status_' . $status_transition['to'], $this, $status_transition ); |
|
| 3567 | + |
|
| 3568 | + // @deprecated this is deprecated and will be removed in the future. |
|
| 3569 | + do_action( 'wpinv_status_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3570 | + |
|
| 3571 | + if ( ! empty( $status_transition['from'] ) ) { |
|
| 3572 | + |
|
| 3573 | + /* translators: 1: old invoice status 2: new invoice status */ |
|
| 3574 | + $transition_note = sprintf( __( 'Status changed from %1$s to %2$s.', 'invoicing' ), wpinv_status_nicename( $status_transition['from'] ), wpinv_status_nicename( $status_transition['to'] ) ); |
|
| 3575 | + |
|
| 3576 | + // Fire another hook. |
|
| 3577 | + do_action( 'getpaid_invoice_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this ); |
|
| 3578 | + do_action( 'getpaid_invoice_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 3579 | + |
|
| 3580 | + // @deprecated this is deprecated and will be removed in the future. |
|
| 3581 | + do_action( 'wpinv_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $status_transition['from'] ); |
|
| 3582 | + |
|
| 3583 | + // Note the transition occurred. |
|
| 3584 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3585 | + |
|
| 3586 | + // Work out if this was for a payment, and trigger a payment_status hook instead. |
|
| 3587 | + if ( |
|
| 3588 | + in_array( $status_transition['from'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3589 | + && in_array( $status_transition['to'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3590 | + ) { |
|
| 3591 | + do_action( 'getpaid_invoice_payment_status_changed', $this, $status_transition ); |
|
| 3592 | + } |
|
| 3593 | + |
|
| 3594 | + // Work out if this was for a payment reversal, and trigger a payment_status_reversed hook instead. |
|
| 3595 | + if ( |
|
| 3596 | + in_array( $status_transition['from'], array( 'publish', 'wpi-processing', 'wpi-renewal' ), true ) |
|
| 3597 | + && in_array( $status_transition['to'], array( 'wpi-cancelled', 'wpi-pending', 'wpi-failed', 'wpi-refunded', 'wpi-onhold' ), true ) |
|
| 3598 | + ) { |
|
| 3599 | + do_action( 'getpaid_invoice_payment_status_reversed', $this, $status_transition ); |
|
| 3600 | + } |
|
| 3601 | + } else { |
|
| 3602 | + /* translators: %s: new invoice status */ |
|
| 3603 | + $transition_note = sprintf( __( 'Status set to %s.', 'invoicing' ), wpinv_status_nicename( $status_transition['to'] ) ); |
|
| 3604 | + |
|
| 3605 | + // Note the transition occurred. |
|
| 3606 | + $this->add_note( trim( $status_transition['note'] . ' ' . $transition_note ), 0, $status_transition['manual'] ); |
|
| 3607 | + |
|
| 3608 | + } |
|
| 3609 | + } catch ( Exception $e ) { |
|
| 3610 | + $this->add_note( __( 'Error during status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 3611 | + } |
|
| 3612 | + } |
|
| 3613 | + } |
|
| 3614 | 3614 | |
| 3615 | - /** |
|
| 3616 | - * Updates an invoice status. |
|
| 3617 | - */ |
|
| 3618 | - public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
| 3615 | + /** |
|
| 3616 | + * Updates an invoice status. |
|
| 3617 | + */ |
|
| 3618 | + public function update_status( $new_status = false, $note = '', $manual = false ) { |
|
| 3619 | 3619 | |
| 3620 | - // Fires before updating a status. |
|
| 3621 | - do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
| 3620 | + // Fires before updating a status. |
|
| 3621 | + do_action( 'wpinv_before_invoice_status_change', $this->get_id(), $new_status, $this->get_status( 'edit' ) ); |
|
| 3622 | 3622 | |
| 3623 | - // Update the status. |
|
| 3624 | - $this->set_status( $new_status, $note, $manual ); |
|
| 3623 | + // Update the status. |
|
| 3624 | + $this->set_status( $new_status, $note, $manual ); |
|
| 3625 | 3625 | |
| 3626 | - // Save the order. |
|
| 3627 | - return $this->save(); |
|
| 3626 | + // Save the order. |
|
| 3627 | + return $this->save(); |
|
| 3628 | 3628 | |
| 3629 | - } |
|
| 3629 | + } |
|
| 3630 | 3630 | |
| 3631 | - /** |
|
| 3632 | - * @deprecated |
|
| 3633 | - */ |
|
| 3634 | - public function refresh_item_ids() { |
|
| 3631 | + /** |
|
| 3632 | + * @deprecated |
|
| 3633 | + */ |
|
| 3634 | + public function refresh_item_ids() { |
|
| 3635 | 3635 | $item_ids = implode( ',', array_unique( array_keys( $this->get_items() ) ) ); |
| 3636 | 3636 | update_post_meta( $this->get_id(), '_wpinv_item_ids', $item_ids ); |
| 3637 | - } |
|
| 3637 | + } |
|
| 3638 | 3638 | |
| 3639 | - /** |
|
| 3640 | - * @deprecated |
|
| 3641 | - */ |
|
| 3642 | - public function update_items( $temp = false ) { |
|
| 3639 | + /** |
|
| 3640 | + * @deprecated |
|
| 3641 | + */ |
|
| 3642 | + public function update_items( $temp = false ) { |
|
| 3643 | 3643 | |
| 3644 | - $this->set_items( $this->get_items() ); |
|
| 3644 | + $this->set_items( $this->get_items() ); |
|
| 3645 | 3645 | |
| 3646 | - if ( ! $temp ) { |
|
| 3647 | - $this->save(); |
|
| 3648 | - } |
|
| 3646 | + if ( ! $temp ) { |
|
| 3647 | + $this->save(); |
|
| 3648 | + } |
|
| 3649 | 3649 | |
| 3650 | 3650 | return $this; |
| 3651 | - } |
|
| 3651 | + } |
|
| 3652 | 3652 | |
| 3653 | - /** |
|
| 3654 | - * @deprecated |
|
| 3655 | - */ |
|
| 3653 | + /** |
|
| 3654 | + * @deprecated |
|
| 3655 | + */ |
|
| 3656 | 3656 | public function validate_discount() { |
| 3657 | 3657 | |
| 3658 | 3658 | $discount_code = $this->get_discount_code(); |
@@ -3668,97 +3668,97 @@ discard block |
||
| 3668 | 3668 | |
| 3669 | 3669 | } |
| 3670 | 3670 | |
| 3671 | - /** |
|
| 3672 | - * Refunds an invoice. |
|
| 3673 | - */ |
|
| 3671 | + /** |
|
| 3672 | + * Refunds an invoice. |
|
| 3673 | + */ |
|
| 3674 | 3674 | public function refund() { |
| 3675 | - $this->set_status( 'wpi-refunded' ); |
|
| 3675 | + $this->set_status( 'wpi-refunded' ); |
|
| 3676 | 3676 | $this->save(); |
| 3677 | - } |
|
| 3677 | + } |
|
| 3678 | 3678 | |
| 3679 | - /** |
|
| 3680 | - * Marks an invoice as paid. |
|
| 3681 | - * |
|
| 3682 | - * @param string $transaction_id |
|
| 3683 | - */ |
|
| 3679 | + /** |
|
| 3680 | + * Marks an invoice as paid. |
|
| 3681 | + * |
|
| 3682 | + * @param string $transaction_id |
|
| 3683 | + */ |
|
| 3684 | 3684 | public function mark_paid( $transaction_id = null, $note = '' ) { |
| 3685 | 3685 | |
| 3686 | - // Set the transaction id. |
|
| 3687 | - if ( empty( $transaction_id ) ) { |
|
| 3688 | - $transaction_id = $this->generate_key('trans_'); |
|
| 3689 | - } |
|
| 3686 | + // Set the transaction id. |
|
| 3687 | + if ( empty( $transaction_id ) ) { |
|
| 3688 | + $transaction_id = $this->generate_key('trans_'); |
|
| 3689 | + } |
|
| 3690 | 3690 | |
| 3691 | - if ( ! $this->get_transaction_id() ) { |
|
| 3692 | - $this->set_transaction_id( $transaction_id ); |
|
| 3693 | - } |
|
| 3691 | + if ( ! $this->get_transaction_id() ) { |
|
| 3692 | + $this->set_transaction_id( $transaction_id ); |
|
| 3693 | + } |
|
| 3694 | 3694 | |
| 3695 | - if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
| 3696 | - return $this->save(); |
|
| 3697 | - } |
|
| 3695 | + if ( $this->is_paid() && 'wpi-processing' != $this->get_status() ) { |
|
| 3696 | + return $this->save(); |
|
| 3697 | + } |
|
| 3698 | 3698 | |
| 3699 | - // Set the completed date. |
|
| 3700 | - $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 3699 | + // Set the completed date. |
|
| 3700 | + $this->set_date_completed( current_time( 'mysql' ) ); |
|
| 3701 | 3701 | |
| 3702 | - // Set the new status. |
|
| 3703 | - if ( $this->is_renewal() ) { |
|
| 3702 | + // Set the new status. |
|
| 3703 | + if ( $this->is_renewal() ) { |
|
| 3704 | 3704 | |
| 3705 | - $_note = sprintf( |
|
| 3706 | - __( 'Renewed via %s', 'invoicing' ), |
|
| 3707 | - $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
| 3708 | - ); |
|
| 3705 | + $_note = sprintf( |
|
| 3706 | + __( 'Renewed via %s', 'invoicing' ), |
|
| 3707 | + $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
| 3708 | + ); |
|
| 3709 | 3709 | |
| 3710 | - if ( 'none' == $this->get_gateway() ) { |
|
| 3711 | - $_note = $note; |
|
| 3712 | - } |
|
| 3710 | + if ( 'none' == $this->get_gateway() ) { |
|
| 3711 | + $_note = $note; |
|
| 3712 | + } |
|
| 3713 | 3713 | |
| 3714 | - $this->set_status( 'wpi-renewal', $_note ); |
|
| 3714 | + $this->set_status( 'wpi-renewal', $_note ); |
|
| 3715 | 3715 | |
| 3716 | - } else { |
|
| 3716 | + } else { |
|
| 3717 | 3717 | |
| 3718 | - $_note = sprintf( |
|
| 3719 | - __( 'Paid via %s', 'invoicing' ), |
|
| 3720 | - $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
| 3721 | - ); |
|
| 3718 | + $_note = sprintf( |
|
| 3719 | + __( 'Paid via %s', 'invoicing' ), |
|
| 3720 | + $this->get_gateway_title() . empty( $note ) ? '' : " ($note)" |
|
| 3721 | + ); |
|
| 3722 | 3722 | |
| 3723 | - if ( 'none' == $this->get_gateway() ) { |
|
| 3724 | - $_note = $note; |
|
| 3725 | - } |
|
| 3723 | + if ( 'none' == $this->get_gateway() ) { |
|
| 3724 | + $_note = $note; |
|
| 3725 | + } |
|
| 3726 | 3726 | |
| 3727 | - $this->set_status( 'publish',$_note ); |
|
| 3727 | + $this->set_status( 'publish',$_note ); |
|
| 3728 | 3728 | |
| 3729 | - } |
|
| 3729 | + } |
|
| 3730 | 3730 | |
| 3731 | - // Set checkout mode. |
|
| 3732 | - $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
| 3733 | - $this->set_mode( $mode ); |
|
| 3731 | + // Set checkout mode. |
|
| 3732 | + $mode = wpinv_is_test_mode( $this->get_gateway() ) ? 'test' : 'live'; |
|
| 3733 | + $this->set_mode( $mode ); |
|
| 3734 | 3734 | |
| 3735 | - // Save the invoice. |
|
| 3735 | + // Save the invoice. |
|
| 3736 | 3736 | $this->save(); |
| 3737 | - } |
|
| 3738 | - |
|
| 3739 | - |
|
| 3740 | - /** |
|
| 3741 | - * Save data to the database. |
|
| 3742 | - * |
|
| 3743 | - * @since 1.0.19 |
|
| 3744 | - * @return int invoice ID |
|
| 3745 | - */ |
|
| 3746 | - public function save() { |
|
| 3747 | - $this->maybe_set_date_paid(); |
|
| 3748 | - $this->maybe_set_key(); |
|
| 3749 | - parent::save(); |
|
| 3750 | - $this->clear_cache(); |
|
| 3751 | - $this->status_transition(); |
|
| 3752 | - return $this->get_id(); |
|
| 3753 | - } |
|
| 3754 | - |
|
| 3755 | - /** |
|
| 3737 | + } |
|
| 3738 | + |
|
| 3739 | + |
|
| 3740 | + /** |
|
| 3741 | + * Save data to the database. |
|
| 3742 | + * |
|
| 3743 | + * @since 1.0.19 |
|
| 3744 | + * @return int invoice ID |
|
| 3745 | + */ |
|
| 3746 | + public function save() { |
|
| 3747 | + $this->maybe_set_date_paid(); |
|
| 3748 | + $this->maybe_set_key(); |
|
| 3749 | + parent::save(); |
|
| 3750 | + $this->clear_cache(); |
|
| 3751 | + $this->status_transition(); |
|
| 3752 | + return $this->get_id(); |
|
| 3753 | + } |
|
| 3754 | + |
|
| 3755 | + /** |
|
| 3756 | 3756 | * Clears the subscription's cache. |
| 3757 | 3757 | */ |
| 3758 | 3758 | public function clear_cache() { |
| 3759 | - wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
| 3760 | - wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
| 3761 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
| 3762 | - } |
|
| 3759 | + wp_cache_delete( $this->get_key(), 'getpaid_invoice_keys_to_invoice_ids' ); |
|
| 3760 | + wp_cache_delete( $this->get_number(), 'getpaid_invoice_numbers_to_invoice_ids' ); |
|
| 3761 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_invoice_transaction_ids_to_invoice_ids' ); |
|
| 3762 | + } |
|
| 3763 | 3763 | |
| 3764 | 3764 | } |
@@ -15,125 +15,125 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class WPInv_Subscription extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 23 | - protected $data_store_name = 'subscription'; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'subscription'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Item 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 | - 'customer_id' => 0, |
|
| 40 | - 'frequency' => 1, |
|
| 41 | - 'period' => 'D', |
|
| 42 | - 'initial_amount' => null, |
|
| 43 | - 'recurring_amount' => null, |
|
| 44 | - 'bill_times' => 0, |
|
| 45 | - 'transaction_id' => '', |
|
| 46 | - 'parent_payment_id' => null, |
|
| 47 | - 'product_id' => 0, |
|
| 48 | - 'created' => '0000-00-00 00:00:00', |
|
| 49 | - 'expiration' => '0000-00-00 00:00:00', |
|
| 50 | - 'trial_period' => '', |
|
| 51 | - 'status' => 'pending', |
|
| 52 | - 'profile_id' => '', |
|
| 53 | - 'gateway' => '', |
|
| 54 | - 'customer' => '', |
|
| 55 | - ); |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Stores the status transition information. |
|
| 59 | - * |
|
| 60 | - * @since 1.0.19 |
|
| 61 | - * @var bool |
|
| 62 | - */ |
|
| 63 | - protected $status_transition = false; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Get the subscription if ID is passed, otherwise the subscription is new and empty. |
|
| 67 | - * |
|
| 68 | - * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
|
| 69 | - * @param bool $deprecated |
|
| 70 | - */ |
|
| 71 | - function __construct( $subscription = 0, $deprecated = false ) { |
|
| 72 | - |
|
| 73 | - parent::__construct( $subscription ); |
|
| 74 | - |
|
| 75 | - if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
| 76 | - $this->set_id( $subscription ); |
|
| 77 | - } elseif ( $subscription instanceof self ) { |
|
| 78 | - $this->set_id( $subscription->get_id() ); |
|
| 79 | - } elseif ( ! empty( $subscription->id ) ) { |
|
| 80 | - $this->set_id( $subscription->id ); |
|
| 81 | - } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
| 82 | - $this->set_id( $subscription_id ); |
|
| 83 | - } else { |
|
| 84 | - $this->set_object_read( true ); |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - // Load the datastore. |
|
| 88 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 89 | - |
|
| 90 | - if ( $this->get_id() > 0 ) { |
|
| 91 | - $this->data_store->read( $this ); |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - } |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * Given an invoice id, profile id, transaction id, it returns the subscription's id. |
|
| 98 | - * |
|
| 99 | - * |
|
| 100 | - * @static |
|
| 101 | - * @param string $value |
|
| 102 | - * @param string $field Either invoice_id, transaction_id or profile_id. |
|
| 103 | - * @since 1.0.19 |
|
| 104 | - * @return int |
|
| 105 | - */ |
|
| 106 | - public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | + protected $data_store_name = 'subscription'; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'subscription'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Item 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 | + 'customer_id' => 0, |
|
| 40 | + 'frequency' => 1, |
|
| 41 | + 'period' => 'D', |
|
| 42 | + 'initial_amount' => null, |
|
| 43 | + 'recurring_amount' => null, |
|
| 44 | + 'bill_times' => 0, |
|
| 45 | + 'transaction_id' => '', |
|
| 46 | + 'parent_payment_id' => null, |
|
| 47 | + 'product_id' => 0, |
|
| 48 | + 'created' => '0000-00-00 00:00:00', |
|
| 49 | + 'expiration' => '0000-00-00 00:00:00', |
|
| 50 | + 'trial_period' => '', |
|
| 51 | + 'status' => 'pending', |
|
| 52 | + 'profile_id' => '', |
|
| 53 | + 'gateway' => '', |
|
| 54 | + 'customer' => '', |
|
| 55 | + ); |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Stores the status transition information. |
|
| 59 | + * |
|
| 60 | + * @since 1.0.19 |
|
| 61 | + * @var bool |
|
| 62 | + */ |
|
| 63 | + protected $status_transition = false; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Get the subscription if ID is passed, otherwise the subscription is new and empty. |
|
| 67 | + * |
|
| 68 | + * @param int|string|object|WPInv_Subscription $subscription Subscription id, profile_id, or object to read. |
|
| 69 | + * @param bool $deprecated |
|
| 70 | + */ |
|
| 71 | + function __construct( $subscription = 0, $deprecated = false ) { |
|
| 72 | + |
|
| 73 | + parent::__construct( $subscription ); |
|
| 74 | + |
|
| 75 | + if ( ! $deprecated && ! empty( $subscription ) && is_numeric( $subscription ) ) { |
|
| 76 | + $this->set_id( $subscription ); |
|
| 77 | + } elseif ( $subscription instanceof self ) { |
|
| 78 | + $this->set_id( $subscription->get_id() ); |
|
| 79 | + } elseif ( ! empty( $subscription->id ) ) { |
|
| 80 | + $this->set_id( $subscription->id ); |
|
| 81 | + } elseif ( $deprecated && $subscription_id = self::get_subscription_id_by_field( $subscription, 'profile_id' ) ) { |
|
| 82 | + $this->set_id( $subscription_id ); |
|
| 83 | + } else { |
|
| 84 | + $this->set_object_read( true ); |
|
| 85 | + } |
|
| 86 | + |
|
| 87 | + // Load the datastore. |
|
| 88 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 89 | + |
|
| 90 | + if ( $this->get_id() > 0 ) { |
|
| 91 | + $this->data_store->read( $this ); |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + } |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * Given an invoice id, profile id, transaction id, it returns the subscription's id. |
|
| 98 | + * |
|
| 99 | + * |
|
| 100 | + * @static |
|
| 101 | + * @param string $value |
|
| 102 | + * @param string $field Either invoice_id, transaction_id or profile_id. |
|
| 103 | + * @since 1.0.19 |
|
| 104 | + * @return int |
|
| 105 | + */ |
|
| 106 | + public static function get_subscription_id_by_field( $value, $field = 'profile_id' ) { |
|
| 107 | 107 | global $wpdb; |
| 108 | 108 | |
| 109 | - // Trim the value. |
|
| 110 | - $value = trim( $value ); |
|
| 109 | + // Trim the value. |
|
| 110 | + $value = trim( $value ); |
|
| 111 | 111 | |
| 112 | - if ( empty( $value ) ) { |
|
| 113 | - return 0; |
|
| 114 | - } |
|
| 112 | + if ( empty( $value ) ) { |
|
| 113 | + return 0; |
|
| 114 | + } |
|
| 115 | 115 | |
| 116 | - if ( 'invoice_id' == $field ) { |
|
| 117 | - $field = 'parent_payment_id'; |
|
| 118 | - } |
|
| 116 | + if ( 'invoice_id' == $field ) { |
|
| 117 | + $field = 'parent_payment_id'; |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | 120 | // Valid fields. |
| 121 | 121 | $fields = array( |
| 122 | - 'parent_payment_id', |
|
| 123 | - 'transaction_id', |
|
| 124 | - 'profile_id' |
|
| 125 | - ); |
|
| 126 | - |
|
| 127 | - // Ensure a field has been passed. |
|
| 128 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 129 | - return 0; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - // Maybe retrieve from the cache. |
|
| 133 | - $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 134 | - if ( ! empty( $subscription_id ) ) { |
|
| 135 | - return $subscription_id; |
|
| 136 | - } |
|
| 122 | + 'parent_payment_id', |
|
| 123 | + 'transaction_id', |
|
| 124 | + 'profile_id' |
|
| 125 | + ); |
|
| 126 | + |
|
| 127 | + // Ensure a field has been passed. |
|
| 128 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 129 | + return 0; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + // Maybe retrieve from the cache. |
|
| 133 | + $subscription_id = wp_cache_get( $value, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 134 | + if ( ! empty( $subscription_id ) ) { |
|
| 135 | + return $subscription_id; |
|
| 136 | + } |
|
| 137 | 137 | |
| 138 | 138 | // Fetch from the db. |
| 139 | 139 | $table = $wpdb->prefix . 'wpinv_subscriptions'; |
@@ -141,34 +141,34 @@ discard block |
||
| 141 | 141 | $wpdb->prepare( "SELECT `id` FROM $table WHERE `$field`=%s LIMIT 1", $value ) |
| 142 | 142 | ); |
| 143 | 143 | |
| 144 | - if ( empty( $subscription_id ) ) { |
|
| 145 | - return 0; |
|
| 146 | - } |
|
| 144 | + if ( empty( $subscription_id ) ) { |
|
| 145 | + return 0; |
|
| 146 | + } |
|
| 147 | 147 | |
| 148 | - // Update the cache with our data. |
|
| 149 | - wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 148 | + // Update the cache with our data. |
|
| 149 | + wp_cache_set( $value, $subscription_id, "getpaid_subscription_{$field}s_to_subscription_ids" ); |
|
| 150 | 150 | |
| 151 | - return $subscription_id; |
|
| 152 | - } |
|
| 151 | + return $subscription_id; |
|
| 152 | + } |
|
| 153 | 153 | |
| 154 | - /** |
|
| 154 | + /** |
|
| 155 | 155 | * Clears the subscription's cache. |
| 156 | 156 | */ |
| 157 | 157 | public function clear_cache() { |
| 158 | - wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
| 159 | - wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 160 | - wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 161 | - wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
| 162 | - } |
|
| 158 | + wp_cache_delete( $this->get_parent_payment_id(), 'getpaid_subscription_parent_payment_ids_to_subscription_ids' ); |
|
| 159 | + wp_cache_delete( $this->get_transaction_id(), 'getpaid_subscription_transaction_ids_to_subscription_ids' ); |
|
| 160 | + wp_cache_delete( $this->get_profile_id(), 'getpaid_subscription_profile_ids_to_subscription_ids' ); |
|
| 161 | + wp_cache_delete( $this->get_id(), 'getpaid_subscriptions' ); |
|
| 162 | + } |
|
| 163 | 163 | |
| 164 | - /** |
|
| 164 | + /** |
|
| 165 | 165 | * Checks if a subscription key is set. |
| 166 | 166 | */ |
| 167 | 167 | public function _isset( $key ) { |
| 168 | 168 | return isset( $this->data[$key] ) || method_exists( $this, "get_$key" ); |
| 169 | - } |
|
| 169 | + } |
|
| 170 | 170 | |
| 171 | - /* |
|
| 171 | + /* |
|
| 172 | 172 | |-------------------------------------------------------------------------- |
| 173 | 173 | | CRUD methods |
| 174 | 174 | |-------------------------------------------------------------------------- |
@@ -177,545 +177,545 @@ discard block |
||
| 177 | 177 | | |
| 178 | 178 | */ |
| 179 | 179 | |
| 180 | - /* |
|
| 180 | + /* |
|
| 181 | 181 | |-------------------------------------------------------------------------- |
| 182 | 182 | | Getters |
| 183 | 183 | |-------------------------------------------------------------------------- |
| 184 | 184 | */ |
| 185 | 185 | |
| 186 | - /** |
|
| 187 | - * Get customer id. |
|
| 188 | - * |
|
| 189 | - * @since 1.0.19 |
|
| 190 | - * @param string $context View or edit context. |
|
| 191 | - * @return int |
|
| 192 | - */ |
|
| 193 | - public function get_customer_id( $context = 'view' ) { |
|
| 194 | - return (int) $this->get_prop( 'customer_id', $context ); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * Get customer information. |
|
| 199 | - * |
|
| 200 | - * @since 1.0.19 |
|
| 201 | - * @param string $context View or edit context. |
|
| 202 | - * @return WP_User|false WP_User object on success, false on failure. |
|
| 203 | - */ |
|
| 204 | - public function get_customer( $context = 'view' ) { |
|
| 205 | - return get_userdata( $this->get_customer_id( $context ) ); |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * Get parent invoice id. |
|
| 210 | - * |
|
| 211 | - * @since 1.0.19 |
|
| 212 | - * @param string $context View or edit context. |
|
| 213 | - * @return int |
|
| 214 | - */ |
|
| 215 | - public function get_parent_invoice_id( $context = 'view' ) { |
|
| 216 | - return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * Alias for self::get_parent_invoice_id(). |
|
| 221 | - * |
|
| 222 | - * @since 1.0.19 |
|
| 223 | - * @param string $context View or edit context. |
|
| 224 | - * @return int |
|
| 225 | - */ |
|
| 186 | + /** |
|
| 187 | + * Get customer id. |
|
| 188 | + * |
|
| 189 | + * @since 1.0.19 |
|
| 190 | + * @param string $context View or edit context. |
|
| 191 | + * @return int |
|
| 192 | + */ |
|
| 193 | + public function get_customer_id( $context = 'view' ) { |
|
| 194 | + return (int) $this->get_prop( 'customer_id', $context ); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * Get customer information. |
|
| 199 | + * |
|
| 200 | + * @since 1.0.19 |
|
| 201 | + * @param string $context View or edit context. |
|
| 202 | + * @return WP_User|false WP_User object on success, false on failure. |
|
| 203 | + */ |
|
| 204 | + public function get_customer( $context = 'view' ) { |
|
| 205 | + return get_userdata( $this->get_customer_id( $context ) ); |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * Get parent invoice id. |
|
| 210 | + * |
|
| 211 | + * @since 1.0.19 |
|
| 212 | + * @param string $context View or edit context. |
|
| 213 | + * @return int |
|
| 214 | + */ |
|
| 215 | + public function get_parent_invoice_id( $context = 'view' ) { |
|
| 216 | + return (int) $this->get_prop( 'parent_payment_id', $context ); |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Alias for self::get_parent_invoice_id(). |
|
| 221 | + * |
|
| 222 | + * @since 1.0.19 |
|
| 223 | + * @param string $context View or edit context. |
|
| 224 | + * @return int |
|
| 225 | + */ |
|
| 226 | 226 | public function get_parent_payment_id( $context = 'view' ) { |
| 227 | 227 | return $this->get_parent_invoice_id( $context ); |
| 228 | - } |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * Alias for self::get_parent_invoice_id(). |
|
| 232 | + * |
|
| 233 | + * @since 1.0.0 |
|
| 234 | + * @return int |
|
| 235 | + */ |
|
| 236 | + public function get_original_payment_id( $context = 'view' ) { |
|
| 237 | + return $this->get_parent_invoice_id( $context ); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Get parent invoice. |
|
| 242 | + * |
|
| 243 | + * @since 1.0.19 |
|
| 244 | + * @param string $context View or edit context. |
|
| 245 | + * @return WPInv_Invoice |
|
| 246 | + */ |
|
| 247 | + public function get_parent_invoice( $context = 'view' ) { |
|
| 248 | + return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * Alias for self::get_parent_invoice(). |
|
| 253 | + * |
|
| 254 | + * @since 1.0.19 |
|
| 255 | + * @param string $context View or edit context. |
|
| 256 | + * @return WPInv_Invoice |
|
| 257 | + */ |
|
| 258 | + public function get_parent_payment( $context = 'view' ) { |
|
| 259 | + return $this->get_parent_invoice( $context ); |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + /** |
|
| 263 | + * Get subscription's product id. |
|
| 264 | + * |
|
| 265 | + * @since 1.0.19 |
|
| 266 | + * @param string $context View or edit context. |
|
| 267 | + * @return int |
|
| 268 | + */ |
|
| 269 | + public function get_product_id( $context = 'view' ) { |
|
| 270 | + return (int) $this->get_prop( 'product_id', $context ); |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + /** |
|
| 274 | + * Get the subscription product. |
|
| 275 | + * |
|
| 276 | + * @since 1.0.19 |
|
| 277 | + * @param string $context View or edit context. |
|
| 278 | + * @return WPInv_Item |
|
| 279 | + */ |
|
| 280 | + public function get_product( $context = 'view' ) { |
|
| 281 | + return new WPInv_Item( $this->get_product_id( $context ) ); |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + /** |
|
| 285 | + * Get parent invoice's gateway. |
|
| 286 | + * |
|
| 287 | + * Here for backwards compatibility. |
|
| 288 | + * |
|
| 289 | + * @since 1.0.19 |
|
| 290 | + * @param string $context View or edit context. |
|
| 291 | + * @return string |
|
| 292 | + */ |
|
| 293 | + public function get_gateway( $context = 'view' ) { |
|
| 294 | + return $this->get_parent_invoice( $context )->get_gateway(); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Get the period of a renewal. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @param string $context View or edit context. |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function get_period( $context = 'view' ) { |
|
| 305 | + return $this->get_prop( 'period', $context ); |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * Get number of periods each renewal is valid for. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.19 |
|
| 312 | + * @param string $context View or edit context. |
|
| 313 | + * @return int |
|
| 314 | + */ |
|
| 315 | + public function get_frequency( $context = 'view' ) { |
|
| 316 | + return (int) $this->get_prop( 'frequency', $context ); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + /** |
|
| 320 | + * Get the initial amount for the subscription. |
|
| 321 | + * |
|
| 322 | + * @since 1.0.19 |
|
| 323 | + * @param string $context View or edit context. |
|
| 324 | + * @return float |
|
| 325 | + */ |
|
| 326 | + public function get_initial_amount( $context = 'view' ) { |
|
| 327 | + return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
| 328 | + } |
|
| 329 | + |
|
| 330 | + /** |
|
| 331 | + * Get the recurring amount for the subscription. |
|
| 332 | + * |
|
| 333 | + * @since 1.0.19 |
|
| 334 | + * @param string $context View or edit context. |
|
| 335 | + * @return float |
|
| 336 | + */ |
|
| 337 | + public function get_recurring_amount( $context = 'view' ) { |
|
| 338 | + return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + /** |
|
| 342 | + * Get number of times that this subscription can be renewed. |
|
| 343 | + * |
|
| 344 | + * @since 1.0.19 |
|
| 345 | + * @param string $context View or edit context. |
|
| 346 | + * @return int |
|
| 347 | + */ |
|
| 348 | + public function get_bill_times( $context = 'view' ) { |
|
| 349 | + return (int) $this->get_prop( 'bill_times', $context ); |
|
| 350 | + } |
|
| 351 | + |
|
| 352 | + /** |
|
| 353 | + * Get transaction id of this subscription's parent invoice. |
|
| 354 | + * |
|
| 355 | + * @since 1.0.19 |
|
| 356 | + * @param string $context View or edit context. |
|
| 357 | + * @return string |
|
| 358 | + */ |
|
| 359 | + public function get_transaction_id( $context = 'view' ) { |
|
| 360 | + return $this->get_prop( 'transaction_id', $context ); |
|
| 361 | + } |
|
| 362 | + |
|
| 363 | + /** |
|
| 364 | + * Get the date that the subscription was created. |
|
| 365 | + * |
|
| 366 | + * @since 1.0.19 |
|
| 367 | + * @param string $context View or edit context. |
|
| 368 | + * @return string |
|
| 369 | + */ |
|
| 370 | + public function get_created( $context = 'view' ) { |
|
| 371 | + return $this->get_prop( 'created', $context ); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Alias for self::get_created(). |
|
| 376 | + * |
|
| 377 | + * @since 1.0.19 |
|
| 378 | + * @param string $context View or edit context. |
|
| 379 | + * @return string |
|
| 380 | + */ |
|
| 381 | + public function get_date_created( $context = 'view' ) { |
|
| 382 | + return $this->get_created( $context ); |
|
| 383 | + } |
|
| 384 | + |
|
| 385 | + /** |
|
| 386 | + * Retrieves the creation date in a timestamp |
|
| 387 | + * |
|
| 388 | + * @since 1.0.0 |
|
| 389 | + * @return int |
|
| 390 | + */ |
|
| 391 | + public function get_time_created() { |
|
| 392 | + $created = $this->get_date_created(); |
|
| 393 | + return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + /** |
|
| 397 | + * Get GMT date when the subscription was created. |
|
| 398 | + * |
|
| 399 | + * @since 1.0.19 |
|
| 400 | + * @param string $context View or edit context. |
|
| 401 | + * @return string |
|
| 402 | + */ |
|
| 403 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 404 | + $date = $this->get_date_created( $context ); |
|
| 405 | + |
|
| 406 | + if ( $date ) { |
|
| 407 | + $date = get_gmt_from_date( $date ); |
|
| 408 | + } |
|
| 409 | + return $date; |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + /** |
|
| 413 | + * Get the date that the subscription will renew. |
|
| 414 | + * |
|
| 415 | + * @since 1.0.19 |
|
| 416 | + * @param string $context View or edit context. |
|
| 417 | + * @return string |
|
| 418 | + */ |
|
| 419 | + public function get_next_renewal_date( $context = 'view' ) { |
|
| 420 | + return $this->get_prop( 'expiration', $context ); |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * Alias for self::get_next_renewal_date(). |
|
| 425 | + * |
|
| 426 | + * @since 1.0.19 |
|
| 427 | + * @param string $context View or edit context. |
|
| 428 | + * @return string |
|
| 429 | + */ |
|
| 430 | + public function get_expiration( $context = 'view' ) { |
|
| 431 | + return $this->get_next_renewal_date( $context ); |
|
| 432 | + } |
|
| 433 | + |
|
| 434 | + /** |
|
| 435 | + * Retrieves the expiration date in a timestamp |
|
| 436 | + * |
|
| 437 | + * @since 1.0.0 |
|
| 438 | + * @return int |
|
| 439 | + */ |
|
| 440 | + public function get_expiration_time() { |
|
| 441 | + $expiration = $this->get_expiration(); |
|
| 442 | + |
|
| 443 | + if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
| 444 | + return current_time( 'timestamp' ); |
|
| 445 | + } |
|
| 446 | + |
|
| 447 | + $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
| 448 | + return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
| 449 | + } |
|
| 450 | + |
|
| 451 | + /** |
|
| 452 | + * Get GMT date when the subscription will renew. |
|
| 453 | + * |
|
| 454 | + * @since 1.0.19 |
|
| 455 | + * @param string $context View or edit context. |
|
| 456 | + * @return string |
|
| 457 | + */ |
|
| 458 | + public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
| 459 | + $date = $this->get_next_renewal_date( $context ); |
|
| 460 | + |
|
| 461 | + if ( $date ) { |
|
| 462 | + $date = get_gmt_from_date( $date ); |
|
| 463 | + } |
|
| 464 | + return $date; |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + /** |
|
| 468 | + * Get the subscription's trial period. |
|
| 469 | + * |
|
| 470 | + * @since 1.0.19 |
|
| 471 | + * @param string $context View or edit context. |
|
| 472 | + * @return string |
|
| 473 | + */ |
|
| 474 | + public function get_trial_period( $context = 'view' ) { |
|
| 475 | + return $this->get_prop( 'trial_period', $context ); |
|
| 476 | + } |
|
| 477 | + |
|
| 478 | + /** |
|
| 479 | + * Get the subscription's status. |
|
| 480 | + * |
|
| 481 | + * @since 1.0.19 |
|
| 482 | + * @param string $context View or edit context. |
|
| 483 | + * @return string |
|
| 484 | + */ |
|
| 485 | + public function get_status( $context = 'view' ) { |
|
| 486 | + return $this->get_prop( 'status', $context ); |
|
| 487 | + } |
|
| 488 | + |
|
| 489 | + /** |
|
| 490 | + * Get the subscription's profile id. |
|
| 491 | + * |
|
| 492 | + * @since 1.0.19 |
|
| 493 | + * @param string $context View or edit context. |
|
| 494 | + * @return string |
|
| 495 | + */ |
|
| 496 | + public function get_profile_id( $context = 'view' ) { |
|
| 497 | + return $this->get_prop( 'profile_id', $context ); |
|
| 498 | + } |
|
| 499 | + |
|
| 500 | + /* |
|
| 501 | + |-------------------------------------------------------------------------- |
|
| 502 | + | Setters |
|
| 503 | + |-------------------------------------------------------------------------- |
|
| 504 | + */ |
|
| 505 | + |
|
| 506 | + /** |
|
| 507 | + * Set customer id. |
|
| 508 | + * |
|
| 509 | + * @since 1.0.19 |
|
| 510 | + * @param int $value The customer's id. |
|
| 511 | + */ |
|
| 512 | + public function set_customer_id( $value ) { |
|
| 513 | + $this->set_prop( 'customer_id', (int) $value ); |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * Set parent invoice id. |
|
| 518 | + * |
|
| 519 | + * @since 1.0.19 |
|
| 520 | + * @param int $value The parent invoice id. |
|
| 521 | + */ |
|
| 522 | + public function set_parent_invoice_id( $value ) { |
|
| 523 | + $this->set_prop( 'parent_payment_id', (int) $value ); |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + /** |
|
| 527 | + * Alias for self::set_parent_invoice_id(). |
|
| 528 | + * |
|
| 529 | + * @since 1.0.19 |
|
| 530 | + * @param int $value The parent invoice id. |
|
| 531 | + */ |
|
| 532 | + public function set_parent_payment_id( $value ) { |
|
| 533 | + $this->set_parent_invoice_id( $value ); |
|
| 534 | + } |
|
| 535 | + |
|
| 536 | + /** |
|
| 537 | + * Alias for self::set_parent_invoice_id(). |
|
| 538 | + * |
|
| 539 | + * @since 1.0.19 |
|
| 540 | + * @param int $value The parent invoice id. |
|
| 541 | + */ |
|
| 542 | + public function set_original_payment_id( $value ) { |
|
| 543 | + $this->set_parent_invoice_id( $value ); |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * Set subscription's product id. |
|
| 548 | + * |
|
| 549 | + * @since 1.0.19 |
|
| 550 | + * @param int $value The subscription product id. |
|
| 551 | + */ |
|
| 552 | + public function set_product_id( $value ) { |
|
| 553 | + $this->set_prop( 'product_id', (int) $value ); |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + /** |
|
| 557 | + * Set the period of a renewal. |
|
| 558 | + * |
|
| 559 | + * @since 1.0.19 |
|
| 560 | + * @param string $value The renewal period. |
|
| 561 | + */ |
|
| 562 | + public function set_period( $value ) { |
|
| 563 | + $this->set_prop( 'period', $value ); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Set number of periods each renewal is valid for. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + * @param int $value The subscription frequency. |
|
| 571 | + */ |
|
| 572 | + public function set_frequency( $value ) { |
|
| 573 | + $value = empty( $value ) ? 1 : (int) $value; |
|
| 574 | + $this->set_prop( 'frequency', absint( $value ) ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Set the initial amount for the subscription. |
|
| 579 | + * |
|
| 580 | + * @since 1.0.19 |
|
| 581 | + * @param float $value The initial subcription amount. |
|
| 582 | + */ |
|
| 583 | + public function set_initial_amount( $value ) { |
|
| 584 | + $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
| 585 | + } |
|
| 586 | + |
|
| 587 | + /** |
|
| 588 | + * Set the recurring amount for the subscription. |
|
| 589 | + * |
|
| 590 | + * @since 1.0.19 |
|
| 591 | + * @param float $value The recurring subcription amount. |
|
| 592 | + */ |
|
| 593 | + public function set_recurring_amount( $value ) { |
|
| 594 | + $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
| 595 | + } |
|
| 596 | + |
|
| 597 | + /** |
|
| 598 | + * Set number of times that this subscription can be renewed. |
|
| 599 | + * |
|
| 600 | + * @since 1.0.19 |
|
| 601 | + * @param int $value Bill times. |
|
| 602 | + */ |
|
| 603 | + public function set_bill_times( $value ) { |
|
| 604 | + $this->set_prop( 'bill_times', (int) $value ); |
|
| 605 | + } |
|
| 229 | 606 | |
| 230 | - /** |
|
| 231 | - * Alias for self::get_parent_invoice_id(). |
|
| 607 | + /** |
|
| 608 | + * Get transaction id of this subscription's parent invoice. |
|
| 232 | 609 | * |
| 233 | - * @since 1.0.0 |
|
| 234 | - * @return int |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @param string $value Bill times. |
|
| 235 | 612 | */ |
| 236 | - public function get_original_payment_id( $context = 'view' ) { |
|
| 237 | - return $this->get_parent_invoice_id( $context ); |
|
| 613 | + public function set_transaction_id( $value ) { |
|
| 614 | + $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
| 238 | 615 | } |
| 239 | 616 | |
| 240 | - /** |
|
| 241 | - * Get parent invoice. |
|
| 242 | - * |
|
| 243 | - * @since 1.0.19 |
|
| 244 | - * @param string $context View or edit context. |
|
| 245 | - * @return WPInv_Invoice |
|
| 246 | - */ |
|
| 247 | - public function get_parent_invoice( $context = 'view' ) { |
|
| 248 | - return new WPInv_Invoice( $this->get_parent_invoice_id( $context ) ); |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * Alias for self::get_parent_invoice(). |
|
| 253 | - * |
|
| 254 | - * @since 1.0.19 |
|
| 255 | - * @param string $context View or edit context. |
|
| 256 | - * @return WPInv_Invoice |
|
| 257 | - */ |
|
| 258 | - public function get_parent_payment( $context = 'view' ) { |
|
| 259 | - return $this->get_parent_invoice( $context ); |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - /** |
|
| 263 | - * Get subscription's product id. |
|
| 264 | - * |
|
| 265 | - * @since 1.0.19 |
|
| 266 | - * @param string $context View or edit context. |
|
| 267 | - * @return int |
|
| 268 | - */ |
|
| 269 | - public function get_product_id( $context = 'view' ) { |
|
| 270 | - return (int) $this->get_prop( 'product_id', $context ); |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - /** |
|
| 274 | - * Get the subscription product. |
|
| 275 | - * |
|
| 276 | - * @since 1.0.19 |
|
| 277 | - * @param string $context View or edit context. |
|
| 278 | - * @return WPInv_Item |
|
| 279 | - */ |
|
| 280 | - public function get_product( $context = 'view' ) { |
|
| 281 | - return new WPInv_Item( $this->get_product_id( $context ) ); |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - /** |
|
| 285 | - * Get parent invoice's gateway. |
|
| 286 | - * |
|
| 287 | - * Here for backwards compatibility. |
|
| 288 | - * |
|
| 289 | - * @since 1.0.19 |
|
| 290 | - * @param string $context View or edit context. |
|
| 291 | - * @return string |
|
| 292 | - */ |
|
| 293 | - public function get_gateway( $context = 'view' ) { |
|
| 294 | - return $this->get_parent_invoice( $context )->get_gateway(); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Get the period of a renewal. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @param string $context View or edit context. |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function get_period( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'period', $context ); |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * Get number of periods each renewal is valid for. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.19 |
|
| 312 | - * @param string $context View or edit context. |
|
| 313 | - * @return int |
|
| 314 | - */ |
|
| 315 | - public function get_frequency( $context = 'view' ) { |
|
| 316 | - return (int) $this->get_prop( 'frequency', $context ); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - /** |
|
| 320 | - * Get the initial amount for the subscription. |
|
| 321 | - * |
|
| 322 | - * @since 1.0.19 |
|
| 323 | - * @param string $context View or edit context. |
|
| 324 | - * @return float |
|
| 325 | - */ |
|
| 326 | - public function get_initial_amount( $context = 'view' ) { |
|
| 327 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'initial_amount', $context ) ); |
|
| 328 | - } |
|
| 329 | - |
|
| 330 | - /** |
|
| 331 | - * Get the recurring amount for the subscription. |
|
| 332 | - * |
|
| 333 | - * @since 1.0.19 |
|
| 334 | - * @param string $context View or edit context. |
|
| 335 | - * @return float |
|
| 336 | - */ |
|
| 337 | - public function get_recurring_amount( $context = 'view' ) { |
|
| 338 | - return (float) wpinv_sanitize_amount( $this->get_prop( 'recurring_amount', $context ) ); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - /** |
|
| 342 | - * Get number of times that this subscription can be renewed. |
|
| 343 | - * |
|
| 344 | - * @since 1.0.19 |
|
| 345 | - * @param string $context View or edit context. |
|
| 346 | - * @return int |
|
| 347 | - */ |
|
| 348 | - public function get_bill_times( $context = 'view' ) { |
|
| 349 | - return (int) $this->get_prop( 'bill_times', $context ); |
|
| 350 | - } |
|
| 351 | - |
|
| 352 | - /** |
|
| 353 | - * Get transaction id of this subscription's parent invoice. |
|
| 354 | - * |
|
| 355 | - * @since 1.0.19 |
|
| 356 | - * @param string $context View or edit context. |
|
| 357 | - * @return string |
|
| 358 | - */ |
|
| 359 | - public function get_transaction_id( $context = 'view' ) { |
|
| 360 | - return $this->get_prop( 'transaction_id', $context ); |
|
| 361 | - } |
|
| 362 | - |
|
| 363 | - /** |
|
| 364 | - * Get the date that the subscription was created. |
|
| 365 | - * |
|
| 366 | - * @since 1.0.19 |
|
| 367 | - * @param string $context View or edit context. |
|
| 368 | - * @return string |
|
| 369 | - */ |
|
| 370 | - public function get_created( $context = 'view' ) { |
|
| 371 | - return $this->get_prop( 'created', $context ); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Alias for self::get_created(). |
|
| 376 | - * |
|
| 377 | - * @since 1.0.19 |
|
| 378 | - * @param string $context View or edit context. |
|
| 379 | - * @return string |
|
| 380 | - */ |
|
| 381 | - public function get_date_created( $context = 'view' ) { |
|
| 382 | - return $this->get_created( $context ); |
|
| 383 | - } |
|
| 384 | - |
|
| 385 | - /** |
|
| 386 | - * Retrieves the creation date in a timestamp |
|
| 387 | - * |
|
| 388 | - * @since 1.0.0 |
|
| 389 | - * @return int |
|
| 390 | - */ |
|
| 391 | - public function get_time_created() { |
|
| 392 | - $created = $this->get_date_created(); |
|
| 393 | - return empty( $created ) ? current_time( 'timestamp' ) : strtotime( $created, current_time( 'timestamp' ) ); |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - /** |
|
| 397 | - * Get GMT date when the subscription was created. |
|
| 398 | - * |
|
| 399 | - * @since 1.0.19 |
|
| 400 | - * @param string $context View or edit context. |
|
| 401 | - * @return string |
|
| 402 | - */ |
|
| 403 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 404 | - $date = $this->get_date_created( $context ); |
|
| 617 | + /** |
|
| 618 | + * Set date when this subscription started. |
|
| 619 | + * |
|
| 620 | + * @since 1.0.19 |
|
| 621 | + * @param string $value strtotime compliant date. |
|
| 622 | + */ |
|
| 623 | + public function set_created( $value ) { |
|
| 624 | + $date = strtotime( $value ); |
|
| 405 | 625 | |
| 406 | - if ( $date ) { |
|
| 407 | - $date = get_gmt_from_date( $date ); |
|
| 626 | + if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 627 | + $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
| 628 | + return; |
|
| 408 | 629 | } |
| 409 | - return $date; |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - /** |
|
| 413 | - * Get the date that the subscription will renew. |
|
| 414 | - * |
|
| 415 | - * @since 1.0.19 |
|
| 416 | - * @param string $context View or edit context. |
|
| 417 | - * @return string |
|
| 418 | - */ |
|
| 419 | - public function get_next_renewal_date( $context = 'view' ) { |
|
| 420 | - return $this->get_prop( 'expiration', $context ); |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * Alias for self::get_next_renewal_date(). |
|
| 425 | - * |
|
| 426 | - * @since 1.0.19 |
|
| 427 | - * @param string $context View or edit context. |
|
| 428 | - * @return string |
|
| 429 | - */ |
|
| 430 | - public function get_expiration( $context = 'view' ) { |
|
| 431 | - return $this->get_next_renewal_date( $context ); |
|
| 432 | - } |
|
| 433 | - |
|
| 434 | - /** |
|
| 435 | - * Retrieves the expiration date in a timestamp |
|
| 436 | - * |
|
| 437 | - * @since 1.0.0 |
|
| 438 | - * @return int |
|
| 439 | - */ |
|
| 440 | - public function get_expiration_time() { |
|
| 441 | - $expiration = $this->get_expiration(); |
|
| 442 | - |
|
| 443 | - if ( empty( $expiration ) || '0000-00-00 00:00:00' == $expiration ) { |
|
| 444 | - return current_time( 'timestamp' ); |
|
| 445 | - } |
|
| 446 | - |
|
| 447 | - $expiration = strtotime( $expiration, current_time( 'timestamp' ) ); |
|
| 448 | - return $expiration < current_time( 'timestamp' ) ? current_time( 'timestamp' ) : $expiration; |
|
| 449 | - } |
|
| 450 | - |
|
| 451 | - /** |
|
| 452 | - * Get GMT date when the subscription will renew. |
|
| 453 | - * |
|
| 454 | - * @since 1.0.19 |
|
| 455 | - * @param string $context View or edit context. |
|
| 456 | - * @return string |
|
| 457 | - */ |
|
| 458 | - public function get_next_renewal_date_gmt( $context = 'view' ) { |
|
| 459 | - $date = $this->get_next_renewal_date( $context ); |
|
| 460 | 630 | |
| 461 | - if ( $date ) { |
|
| 462 | - $date = get_gmt_from_date( $date ); |
|
| 463 | - } |
|
| 464 | - return $date; |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - /** |
|
| 468 | - * Get the subscription's trial period. |
|
| 469 | - * |
|
| 470 | - * @since 1.0.19 |
|
| 471 | - * @param string $context View or edit context. |
|
| 472 | - * @return string |
|
| 473 | - */ |
|
| 474 | - public function get_trial_period( $context = 'view' ) { |
|
| 475 | - return $this->get_prop( 'trial_period', $context ); |
|
| 476 | - } |
|
| 477 | - |
|
| 478 | - /** |
|
| 479 | - * Get the subscription's status. |
|
| 480 | - * |
|
| 481 | - * @since 1.0.19 |
|
| 482 | - * @param string $context View or edit context. |
|
| 483 | - * @return string |
|
| 484 | - */ |
|
| 485 | - public function get_status( $context = 'view' ) { |
|
| 486 | - return $this->get_prop( 'status', $context ); |
|
| 487 | - } |
|
| 488 | - |
|
| 489 | - /** |
|
| 490 | - * Get the subscription's profile id. |
|
| 491 | - * |
|
| 492 | - * @since 1.0.19 |
|
| 493 | - * @param string $context View or edit context. |
|
| 494 | - * @return string |
|
| 495 | - */ |
|
| 496 | - public function get_profile_id( $context = 'view' ) { |
|
| 497 | - return $this->get_prop( 'profile_id', $context ); |
|
| 498 | - } |
|
| 499 | - |
|
| 500 | - /* |
|
| 501 | - |-------------------------------------------------------------------------- |
|
| 502 | - | Setters |
|
| 503 | - |-------------------------------------------------------------------------- |
|
| 504 | - */ |
|
| 631 | + $this->set_prop( 'created', '' ); |
|
| 505 | 632 | |
| 506 | - /** |
|
| 507 | - * Set customer id. |
|
| 508 | - * |
|
| 509 | - * @since 1.0.19 |
|
| 510 | - * @param int $value The customer's id. |
|
| 511 | - */ |
|
| 512 | - public function set_customer_id( $value ) { |
|
| 513 | - $this->set_prop( 'customer_id', (int) $value ); |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * Set parent invoice id. |
|
| 518 | - * |
|
| 519 | - * @since 1.0.19 |
|
| 520 | - * @param int $value The parent invoice id. |
|
| 521 | - */ |
|
| 522 | - public function set_parent_invoice_id( $value ) { |
|
| 523 | - $this->set_prop( 'parent_payment_id', (int) $value ); |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - /** |
|
| 527 | - * Alias for self::set_parent_invoice_id(). |
|
| 528 | - * |
|
| 529 | - * @since 1.0.19 |
|
| 530 | - * @param int $value The parent invoice id. |
|
| 531 | - */ |
|
| 532 | - public function set_parent_payment_id( $value ) { |
|
| 533 | - $this->set_parent_invoice_id( $value ); |
|
| 534 | - } |
|
| 633 | + } |
|
| 535 | 634 | |
| 536 | - /** |
|
| 537 | - * Alias for self::set_parent_invoice_id(). |
|
| 635 | + /** |
|
| 636 | + * Alias for self::set_created(). |
|
| 538 | 637 | * |
| 539 | 638 | * @since 1.0.19 |
| 540 | - * @param int $value The parent invoice id. |
|
| 639 | + * @param string $value strtotime compliant date. |
|
| 541 | 640 | */ |
| 542 | - public function set_original_payment_id( $value ) { |
|
| 543 | - $this->set_parent_invoice_id( $value ); |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * Set subscription's product id. |
|
| 548 | - * |
|
| 549 | - * @since 1.0.19 |
|
| 550 | - * @param int $value The subscription product id. |
|
| 551 | - */ |
|
| 552 | - public function set_product_id( $value ) { |
|
| 553 | - $this->set_prop( 'product_id', (int) $value ); |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - /** |
|
| 557 | - * Set the period of a renewal. |
|
| 558 | - * |
|
| 559 | - * @since 1.0.19 |
|
| 560 | - * @param string $value The renewal period. |
|
| 561 | - */ |
|
| 562 | - public function set_period( $value ) { |
|
| 563 | - $this->set_prop( 'period', $value ); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Set number of periods each renewal is valid for. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - * @param int $value The subscription frequency. |
|
| 571 | - */ |
|
| 572 | - public function set_frequency( $value ) { |
|
| 573 | - $value = empty( $value ) ? 1 : (int) $value; |
|
| 574 | - $this->set_prop( 'frequency', absint( $value ) ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Set the initial amount for the subscription. |
|
| 579 | - * |
|
| 580 | - * @since 1.0.19 |
|
| 581 | - * @param float $value The initial subcription amount. |
|
| 582 | - */ |
|
| 583 | - public function set_initial_amount( $value ) { |
|
| 584 | - $this->set_prop( 'initial_amount', wpinv_sanitize_amount( $value ) ); |
|
| 585 | - } |
|
| 586 | - |
|
| 587 | - /** |
|
| 588 | - * Set the recurring amount for the subscription. |
|
| 589 | - * |
|
| 590 | - * @since 1.0.19 |
|
| 591 | - * @param float $value The recurring subcription amount. |
|
| 592 | - */ |
|
| 593 | - public function set_recurring_amount( $value ) { |
|
| 594 | - $this->set_prop( 'recurring_amount', wpinv_sanitize_amount( $value ) ); |
|
| 595 | - } |
|
| 596 | - |
|
| 597 | - /** |
|
| 598 | - * Set number of times that this subscription can be renewed. |
|
| 599 | - * |
|
| 600 | - * @since 1.0.19 |
|
| 601 | - * @param int $value Bill times. |
|
| 602 | - */ |
|
| 603 | - public function set_bill_times( $value ) { |
|
| 604 | - $this->set_prop( 'bill_times', (int) $value ); |
|
| 605 | - } |
|
| 606 | - |
|
| 607 | - /** |
|
| 608 | - * Get transaction id of this subscription's parent invoice. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @param string $value Bill times. |
|
| 612 | - */ |
|
| 613 | - public function set_transaction_id( $value ) { |
|
| 614 | - $this->set_prop( 'transaction_id', sanitize_text_field( $value ) ); |
|
| 615 | - } |
|
| 616 | - |
|
| 617 | - /** |
|
| 618 | - * Set date when this subscription started. |
|
| 619 | - * |
|
| 620 | - * @since 1.0.19 |
|
| 621 | - * @param string $value strtotime compliant date. |
|
| 622 | - */ |
|
| 623 | - public function set_created( $value ) { |
|
| 641 | + public function set_date_created( $value ) { |
|
| 642 | + $this->set_created( $value ); |
|
| 643 | + } |
|
| 644 | + |
|
| 645 | + /** |
|
| 646 | + * Set the date that the subscription will renew. |
|
| 647 | + * |
|
| 648 | + * @since 1.0.19 |
|
| 649 | + * @param string $value strtotime compliant date. |
|
| 650 | + */ |
|
| 651 | + public function set_next_renewal_date( $value ) { |
|
| 624 | 652 | $date = strtotime( $value ); |
| 625 | 653 | |
| 626 | 654 | if ( $date && $value !== '0000-00-00 00:00:00' ) { |
| 627 | - $this->set_prop( 'created', date( 'Y-m-d H:i:s', $date ) ); |
|
| 655 | + $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
| 628 | 656 | return; |
| 629 | 657 | } |
| 630 | 658 | |
| 631 | - $this->set_prop( 'created', '' ); |
|
| 659 | + $this->set_prop( 'expiration', '' ); |
|
| 632 | 660 | |
| 633 | - } |
|
| 661 | + } |
|
| 662 | + |
|
| 663 | + /** |
|
| 664 | + * Alias for self::set_next_renewal_date(). |
|
| 665 | + * |
|
| 666 | + * @since 1.0.19 |
|
| 667 | + * @param string $value strtotime compliant date. |
|
| 668 | + */ |
|
| 669 | + public function set_expiration( $value ) { |
|
| 670 | + $this->set_next_renewal_date( $value ); |
|
| 671 | + } |
|
| 634 | 672 | |
| 635 | - /** |
|
| 636 | - * Alias for self::set_created(). |
|
| 637 | - * |
|
| 638 | - * @since 1.0.19 |
|
| 639 | - * @param string $value strtotime compliant date. |
|
| 640 | - */ |
|
| 641 | - public function set_date_created( $value ) { |
|
| 642 | - $this->set_created( $value ); |
|
| 673 | + /** |
|
| 674 | + * Set the subscription's trial period. |
|
| 675 | + * |
|
| 676 | + * @since 1.0.19 |
|
| 677 | + * @param string $value trial period e.g 1 year. |
|
| 678 | + */ |
|
| 679 | + public function set_trial_period( $value ) { |
|
| 680 | + $this->set_prop( 'trial_period', $value ); |
|
| 643 | 681 | } |
| 644 | 682 | |
| 645 | - /** |
|
| 646 | - * Set the date that the subscription will renew. |
|
| 647 | - * |
|
| 648 | - * @since 1.0.19 |
|
| 649 | - * @param string $value strtotime compliant date. |
|
| 650 | - */ |
|
| 651 | - public function set_next_renewal_date( $value ) { |
|
| 652 | - $date = strtotime( $value ); |
|
| 683 | + /** |
|
| 684 | + * Set the subscription's status. |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $new_status New subscription status. |
|
| 688 | + */ |
|
| 689 | + public function set_status( $new_status ) { |
|
| 653 | 690 | |
| 654 | - if ( $date && $value !== '0000-00-00 00:00:00' ) { |
|
| 655 | - $this->set_prop( 'expiration', date( 'Y-m-d H:i:s', $date ) ); |
|
| 691 | + // Abort if this is not a valid status; |
|
| 692 | + if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
| 656 | 693 | return; |
| 657 | - } |
|
| 658 | - |
|
| 659 | - $this->set_prop( 'expiration', '' ); |
|
| 660 | - |
|
| 661 | - } |
|
| 662 | - |
|
| 663 | - /** |
|
| 664 | - * Alias for self::set_next_renewal_date(). |
|
| 665 | - * |
|
| 666 | - * @since 1.0.19 |
|
| 667 | - * @param string $value strtotime compliant date. |
|
| 668 | - */ |
|
| 669 | - public function set_expiration( $value ) { |
|
| 670 | - $this->set_next_renewal_date( $value ); |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - /** |
|
| 674 | - * Set the subscription's trial period. |
|
| 675 | - * |
|
| 676 | - * @since 1.0.19 |
|
| 677 | - * @param string $value trial period e.g 1 year. |
|
| 678 | - */ |
|
| 679 | - public function set_trial_period( $value ) { |
|
| 680 | - $this->set_prop( 'trial_period', $value ); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Set the subscription's status. |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $new_status New subscription status. |
|
| 688 | - */ |
|
| 689 | - public function set_status( $new_status ) { |
|
| 690 | - |
|
| 691 | - // Abort if this is not a valid status; |
|
| 692 | - if ( ! array_key_exists( $new_status, getpaid_get_subscription_statuses() ) ) { |
|
| 693 | - return; |
|
| 694 | - } |
|
| 695 | - |
|
| 696 | - $old_status = $this->get_status(); |
|
| 697 | - $this->set_prop( 'status', $new_status ); |
|
| 698 | - |
|
| 699 | - if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 700 | - $this->status_transition = array( |
|
| 701 | - 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 702 | - 'to' => $new_status, |
|
| 703 | - ); |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - } |
|
| 707 | - |
|
| 708 | - /** |
|
| 709 | - * Set the subscription's (remote) profile id. |
|
| 710 | - * |
|
| 711 | - * @since 1.0.19 |
|
| 712 | - * @param string $value the remote profile id. |
|
| 713 | - */ |
|
| 714 | - public function set_profile_id( $value ) { |
|
| 715 | - $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
| 716 | - } |
|
| 717 | - |
|
| 718 | - /* |
|
| 694 | + } |
|
| 695 | + |
|
| 696 | + $old_status = $this->get_status(); |
|
| 697 | + $this->set_prop( 'status', $new_status ); |
|
| 698 | + |
|
| 699 | + if ( true === $this->object_read && $old_status !== $new_status ) { |
|
| 700 | + $this->status_transition = array( |
|
| 701 | + 'from' => ! empty( $this->status_transition['from'] ) ? $this->status_transition['from'] : $old_status, |
|
| 702 | + 'to' => $new_status, |
|
| 703 | + ); |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + } |
|
| 707 | + |
|
| 708 | + /** |
|
| 709 | + * Set the subscription's (remote) profile id. |
|
| 710 | + * |
|
| 711 | + * @since 1.0.19 |
|
| 712 | + * @param string $value the remote profile id. |
|
| 713 | + */ |
|
| 714 | + public function set_profile_id( $value ) { |
|
| 715 | + $this->set_prop( 'profile_id', sanitize_text_field( $value ) ); |
|
| 716 | + } |
|
| 717 | + |
|
| 718 | + /* |
|
| 719 | 719 | |-------------------------------------------------------------------------- |
| 720 | 720 | | Boolean methods |
| 721 | 721 | |-------------------------------------------------------------------------- |
@@ -724,55 +724,55 @@ discard block |
||
| 724 | 724 | | |
| 725 | 725 | */ |
| 726 | 726 | |
| 727 | - /** |
|
| 727 | + /** |
|
| 728 | 728 | * Checks if the subscription has a given status. |
| 729 | - * |
|
| 730 | - * @param string|array String or array of strings to check for. |
|
| 731 | - * @return bool |
|
| 729 | + * |
|
| 730 | + * @param string|array String or array of strings to check for. |
|
| 731 | + * @return bool |
|
| 732 | 732 | */ |
| 733 | 733 | public function has_status( $status ) { |
| 734 | 734 | return in_array( $this->get_status(), wpinv_clean( wpinv_parse_list( $status ) ) ); |
| 735 | - } |
|
| 735 | + } |
|
| 736 | 736 | |
| 737 | - /** |
|
| 737 | + /** |
|
| 738 | 738 | * Checks if the subscription has a trial period. |
| 739 | - * |
|
| 740 | - * @return bool |
|
| 739 | + * |
|
| 740 | + * @return bool |
|
| 741 | 741 | */ |
| 742 | 742 | public function has_trial_period() { |
| 743 | - $period = $this->get_trial_period(); |
|
| 743 | + $period = $this->get_trial_period(); |
|
| 744 | 744 | return ! empty( $period ); |
| 745 | - } |
|
| 746 | - |
|
| 747 | - /** |
|
| 748 | - * Is the subscription active? |
|
| 749 | - * |
|
| 750 | - * @return bool |
|
| 751 | - */ |
|
| 752 | - public function is_active() { |
|
| 753 | - return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
| 754 | - } |
|
| 755 | - |
|
| 756 | - /** |
|
| 757 | - * Is the subscription expired? |
|
| 758 | - * |
|
| 759 | - * @return bool |
|
| 760 | - */ |
|
| 761 | - public function is_expired() { |
|
| 762 | - return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) ); |
|
| 763 | - } |
|
| 764 | - |
|
| 765 | - /** |
|
| 766 | - * Is this the last renewals? |
|
| 767 | - * |
|
| 768 | - * @return bool |
|
| 769 | - */ |
|
| 770 | - public function is_last_renewal() { |
|
| 771 | - $max_bills = $this->get_bill_times(); |
|
| 772 | - return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
| 773 | - } |
|
| 774 | - |
|
| 775 | - /* |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + /** |
|
| 748 | + * Is the subscription active? |
|
| 749 | + * |
|
| 750 | + * @return bool |
|
| 751 | + */ |
|
| 752 | + public function is_active() { |
|
| 753 | + return $this->has_status( 'active trialling' ) && ! $this->is_expired(); |
|
| 754 | + } |
|
| 755 | + |
|
| 756 | + /** |
|
| 757 | + * Is the subscription expired? |
|
| 758 | + * |
|
| 759 | + * @return bool |
|
| 760 | + */ |
|
| 761 | + public function is_expired() { |
|
| 762 | + return $this->has_status( 'expired' ) || ( $this->has_status( 'active cancelled trialling' ) && $this->get_expiration_time() < current_time( 'mysql' ) ); |
|
| 763 | + } |
|
| 764 | + |
|
| 765 | + /** |
|
| 766 | + * Is this the last renewals? |
|
| 767 | + * |
|
| 768 | + * @return bool |
|
| 769 | + */ |
|
| 770 | + public function is_last_renewal() { |
|
| 771 | + $max_bills = $this->get_bill_times(); |
|
| 772 | + return ! empty( $max_bills ) && $max_bills <= $this->get_times_billed(); |
|
| 773 | + } |
|
| 774 | + |
|
| 775 | + /* |
|
| 776 | 776 | |-------------------------------------------------------------------------- |
| 777 | 777 | | Additional methods |
| 778 | 778 | |-------------------------------------------------------------------------- |
@@ -781,27 +781,27 @@ discard block |
||
| 781 | 781 | | |
| 782 | 782 | */ |
| 783 | 783 | |
| 784 | - /** |
|
| 785 | - * Backwards compatibilty. |
|
| 786 | - */ |
|
| 787 | - public function create( $data = array() ) { |
|
| 784 | + /** |
|
| 785 | + * Backwards compatibilty. |
|
| 786 | + */ |
|
| 787 | + public function create( $data = array() ) { |
|
| 788 | 788 | |
| 789 | - // Set the properties. |
|
| 790 | - if ( is_array( $data ) ) { |
|
| 791 | - $this->set_props( $data ); |
|
| 792 | - } |
|
| 789 | + // Set the properties. |
|
| 790 | + if ( is_array( $data ) ) { |
|
| 791 | + $this->set_props( $data ); |
|
| 792 | + } |
|
| 793 | 793 | |
| 794 | - // Save the item. |
|
| 795 | - return $this->save(); |
|
| 794 | + // Save the item. |
|
| 795 | + return $this->save(); |
|
| 796 | 796 | |
| 797 | - } |
|
| 797 | + } |
|
| 798 | 798 | |
| 799 | - /** |
|
| 800 | - * Backwards compatibilty. |
|
| 801 | - */ |
|
| 802 | - public function update( $args = array() ) { |
|
| 803 | - return $this->create( $args ); |
|
| 804 | - } |
|
| 799 | + /** |
|
| 800 | + * Backwards compatibilty. |
|
| 801 | + */ |
|
| 802 | + public function update( $args = array() ) { |
|
| 803 | + return $this->create( $args ); |
|
| 804 | + } |
|
| 805 | 805 | |
| 806 | 806 | /** |
| 807 | 807 | * Retrieve renewal payments for a subscription |
@@ -811,22 +811,22 @@ discard block |
||
| 811 | 811 | */ |
| 812 | 812 | public function get_child_payments( $hide_pending = true ) { |
| 813 | 813 | |
| 814 | - $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
| 814 | + $statuses = array( 'publish', 'wpi-processing', 'wpi-renewal' ); |
|
| 815 | 815 | |
| 816 | - if ( ! $hide_pending ) { |
|
| 817 | - $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
| 818 | - } |
|
| 816 | + if ( ! $hide_pending ) { |
|
| 817 | + $statuses = array_keys( wpinv_get_invoice_statuses() ); |
|
| 818 | + } |
|
| 819 | 819 | |
| 820 | 820 | return get_posts( |
| 821 | - array( |
|
| 822 | - 'post_parent' => $this->get_parent_payment_id(), |
|
| 823 | - 'numberposts' => -1, |
|
| 824 | - 'post_status' => $statuses, |
|
| 825 | - 'orderby' => 'ID', |
|
| 826 | - 'order' => 'DESC', |
|
| 827 | - 'post_type' => 'wpi_invoice' |
|
| 828 | - ) |
|
| 829 | - ); |
|
| 821 | + array( |
|
| 822 | + 'post_parent' => $this->get_parent_payment_id(), |
|
| 823 | + 'numberposts' => -1, |
|
| 824 | + 'post_status' => $statuses, |
|
| 825 | + 'orderby' => 'ID', |
|
| 826 | + 'order' => 'DESC', |
|
| 827 | + 'post_type' => 'wpi_invoice' |
|
| 828 | + ) |
|
| 829 | + ); |
|
| 830 | 830 | } |
| 831 | 831 | |
| 832 | 832 | /** |
@@ -836,16 +836,16 @@ discard block |
||
| 836 | 836 | * @return int |
| 837 | 837 | */ |
| 838 | 838 | public function get_total_payments() { |
| 839 | - global $wpdb; |
|
| 839 | + global $wpdb; |
|
| 840 | 840 | |
| 841 | - $count = (int) $wpdb->get_var( |
|
| 842 | - $wpdb->prepare( |
|
| 843 | - "SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
| 844 | - $this->get_parent_invoice_id() |
|
| 845 | - ) |
|
| 846 | - ); |
|
| 841 | + $count = (int) $wpdb->get_var( |
|
| 842 | + $wpdb->prepare( |
|
| 843 | + "SELECT COUNT(ID) FROM $wpdb->posts WHERE post_parent=%d AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
| 844 | + $this->get_parent_invoice_id() |
|
| 845 | + ) |
|
| 846 | + ); |
|
| 847 | 847 | |
| 848 | - // Maybe include parent invoice. |
|
| 848 | + // Maybe include parent invoice. |
|
| 849 | 849 | if ( $this->get_parent_payment()->is_paid() ) { |
| 850 | 850 | $count++; |
| 851 | 851 | } |
@@ -874,57 +874,57 @@ discard block |
||
| 874 | 874 | * |
| 875 | 875 | * @since 2.4 |
| 876 | 876 | * @param array $args Array of values for the payment, including amount and transaction ID |
| 877 | - * @param WPInv_Invoice $invoice If adding an existing invoice. |
|
| 877 | + * @param WPInv_Invoice $invoice If adding an existing invoice. |
|
| 878 | 878 | * @return bool |
| 879 | 879 | */ |
| 880 | 880 | public function add_payment( $args = array(), $invoice = false ) { |
| 881 | 881 | |
| 882 | - // Process each payment once. |
|
| 882 | + // Process each payment once. |
|
| 883 | 883 | if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) { |
| 884 | 884 | return false; |
| 885 | 885 | } |
| 886 | 886 | |
| 887 | - // Are we creating a new invoice? |
|
| 888 | - if ( empty( $invoice ) ) { |
|
| 889 | - $invoice = $this->create_payment(); |
|
| 887 | + // Are we creating a new invoice? |
|
| 888 | + if ( empty( $invoice ) ) { |
|
| 889 | + $invoice = $this->create_payment(); |
|
| 890 | 890 | |
| 891 | - if ( empty( $invoice ) ) { |
|
| 892 | - return false; |
|
| 893 | - } |
|
| 891 | + if ( empty( $invoice ) ) { |
|
| 892 | + return false; |
|
| 893 | + } |
|
| 894 | 894 | |
| 895 | - } |
|
| 895 | + } |
|
| 896 | 896 | |
| 897 | - $invoice->set_status( 'wpi-renewal' ); |
|
| 897 | + $invoice->set_status( 'wpi-renewal' ); |
|
| 898 | 898 | |
| 899 | - // Maybe set a transaction id. |
|
| 900 | - if ( ! empty( $args['transaction_id'] ) ) { |
|
| 901 | - $invoice->set_transaction_id( $args['transaction_id'] ); |
|
| 902 | - } |
|
| 899 | + // Maybe set a transaction id. |
|
| 900 | + if ( ! empty( $args['transaction_id'] ) ) { |
|
| 901 | + $invoice->set_transaction_id( $args['transaction_id'] ); |
|
| 902 | + } |
|
| 903 | 903 | |
| 904 | - // Set the completed date. |
|
| 905 | - $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
| 904 | + // Set the completed date. |
|
| 905 | + $invoice->set_completed_date( current_time( 'mysql' ) ); |
|
| 906 | 906 | |
| 907 | - // And the gateway. |
|
| 908 | - if ( ! empty( $args['gateway'] ) ) { |
|
| 909 | - $invoice->set_gateway( $args['gateway'] ); |
|
| 910 | - } |
|
| 907 | + // And the gateway. |
|
| 908 | + if ( ! empty( $args['gateway'] ) ) { |
|
| 909 | + $invoice->set_gateway( $args['gateway'] ); |
|
| 910 | + } |
|
| 911 | 911 | |
| 912 | - $invoice->save(); |
|
| 912 | + $invoice->save(); |
|
| 913 | 913 | |
| 914 | - if ( ! $invoice->exists() ) { |
|
| 915 | - return false; |
|
| 916 | - } |
|
| 914 | + if ( ! $invoice->exists() ) { |
|
| 915 | + return false; |
|
| 916 | + } |
|
| 917 | 917 | |
| 918 | - do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
| 919 | - do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
| 918 | + do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this ); |
|
| 919 | + do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this ); |
|
| 920 | 920 | do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->get_parent_invoice_id(), $invoice->get_recurring_total(), $invoice->get_transaction_id() ); |
| 921 | 921 | |
| 922 | 922 | update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id ); |
| 923 | 923 | |
| 924 | 924 | return $invoice->get_id(); |
| 925 | - } |
|
| 925 | + } |
|
| 926 | 926 | |
| 927 | - /** |
|
| 927 | + /** |
|
| 928 | 928 | * Creates a new invoice and returns it. |
| 929 | 929 | * |
| 930 | 930 | * @since 1.0.19 |
@@ -932,97 +932,97 @@ discard block |
||
| 932 | 932 | */ |
| 933 | 933 | public function create_payment() { |
| 934 | 934 | |
| 935 | - $parent_invoice = $this->get_parent_payment(); |
|
| 936 | - |
|
| 937 | - if ( ! $parent_invoice->exists() ) { |
|
| 938 | - return false; |
|
| 939 | - } |
|
| 940 | - |
|
| 941 | - // Duplicate the parent invoice. |
|
| 942 | - $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
| 943 | - $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
| 944 | - $invoice->recalculate_total(); |
|
| 945 | - $invoice->set_status( 'wpi-pending' ); |
|
| 946 | - $invoice->save(); |
|
| 947 | - |
|
| 948 | - return $invoice->exists() ? $invoice : false; |
|
| 949 | - } |
|
| 950 | - |
|
| 951 | - /** |
|
| 952 | - * Renews or completes a subscription |
|
| 953 | - * |
|
| 954 | - * @since 1.0.0 |
|
| 955 | - * @return int The subscription's id |
|
| 956 | - */ |
|
| 957 | - public function renew() { |
|
| 958 | - |
|
| 959 | - // Complete subscription if applicable |
|
| 960 | - if ( $this->is_last_renewal() ) { |
|
| 961 | - return $this->complete(); |
|
| 962 | - } |
|
| 963 | - |
|
| 964 | - // Calculate new expiration |
|
| 965 | - $frequency = $this->get_frequency(); |
|
| 966 | - $period = $this->get_period(); |
|
| 967 | - $new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() ); |
|
| 968 | - |
|
| 969 | - $this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) ); |
|
| 970 | - $this->set_status( 'active' ); |
|
| 971 | - return $this->save(); |
|
| 972 | - |
|
| 973 | - do_action( 'getpaid_subscription_renewed', $this ); |
|
| 974 | - |
|
| 975 | - } |
|
| 976 | - |
|
| 977 | - /** |
|
| 978 | - * Marks a subscription as completed |
|
| 979 | - * |
|
| 980 | - * Subscription is completed when the number of payments matches the billing_times field |
|
| 981 | - * |
|
| 982 | - * @since 1.0.0 |
|
| 983 | - * @return int|bool Subscription id or false if the subscription is cancelled. |
|
| 984 | - */ |
|
| 985 | - public function complete() { |
|
| 986 | - |
|
| 987 | - // Only mark a subscription as complete if it's not already cancelled. |
|
| 988 | - if ( $this->has_status( 'cancelled' ) ) { |
|
| 989 | - return false; |
|
| 990 | - } |
|
| 991 | - |
|
| 992 | - $this->set_status( 'completed' ); |
|
| 993 | - return $this->save(); |
|
| 994 | - |
|
| 995 | - } |
|
| 996 | - |
|
| 997 | - /** |
|
| 998 | - * Marks a subscription as expired |
|
| 999 | - * |
|
| 1000 | - * @since 1.0.0 |
|
| 1001 | - * @param bool $check_expiration |
|
| 1002 | - * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
|
| 1003 | - */ |
|
| 1004 | - public function expire( $check_expiration = false ) { |
|
| 1005 | - |
|
| 1006 | - if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
| 1007 | - // Do not mark as expired since real expiration date is in the future |
|
| 1008 | - return false; |
|
| 1009 | - } |
|
| 1010 | - |
|
| 1011 | - $this->set_status( 'expired' ); |
|
| 1012 | - return $this->save(); |
|
| 1013 | - |
|
| 1014 | - } |
|
| 1015 | - |
|
| 1016 | - /** |
|
| 1017 | - * Marks a subscription as failing |
|
| 1018 | - * |
|
| 1019 | - * @since 2.4.2 |
|
| 1020 | - * @return int Subscription id. |
|
| 1021 | - */ |
|
| 1022 | - public function failing() { |
|
| 1023 | - $this->set_status( 'failing' ); |
|
| 1024 | - return $this->save(); |
|
| 1025 | - } |
|
| 935 | + $parent_invoice = $this->get_parent_payment(); |
|
| 936 | + |
|
| 937 | + if ( ! $parent_invoice->exists() ) { |
|
| 938 | + return false; |
|
| 939 | + } |
|
| 940 | + |
|
| 941 | + // Duplicate the parent invoice. |
|
| 942 | + $invoice = getpaid_duplicate_invoice( $parent_invoice ); |
|
| 943 | + $invoice->set_parent_id( $parent_invoice->get_id() ); |
|
| 944 | + $invoice->recalculate_total(); |
|
| 945 | + $invoice->set_status( 'wpi-pending' ); |
|
| 946 | + $invoice->save(); |
|
| 947 | + |
|
| 948 | + return $invoice->exists() ? $invoice : false; |
|
| 949 | + } |
|
| 950 | + |
|
| 951 | + /** |
|
| 952 | + * Renews or completes a subscription |
|
| 953 | + * |
|
| 954 | + * @since 1.0.0 |
|
| 955 | + * @return int The subscription's id |
|
| 956 | + */ |
|
| 957 | + public function renew() { |
|
| 958 | + |
|
| 959 | + // Complete subscription if applicable |
|
| 960 | + if ( $this->is_last_renewal() ) { |
|
| 961 | + return $this->complete(); |
|
| 962 | + } |
|
| 963 | + |
|
| 964 | + // Calculate new expiration |
|
| 965 | + $frequency = $this->get_frequency(); |
|
| 966 | + $period = $this->get_period(); |
|
| 967 | + $new_expiration = strtotime( "+ $frequency $period", $this->get_expiration_time() ); |
|
| 968 | + |
|
| 969 | + $this->set_expiration( date( 'Y-m-d H:i:s',$new_expiration ) ); |
|
| 970 | + $this->set_status( 'active' ); |
|
| 971 | + return $this->save(); |
|
| 972 | + |
|
| 973 | + do_action( 'getpaid_subscription_renewed', $this ); |
|
| 974 | + |
|
| 975 | + } |
|
| 976 | + |
|
| 977 | + /** |
|
| 978 | + * Marks a subscription as completed |
|
| 979 | + * |
|
| 980 | + * Subscription is completed when the number of payments matches the billing_times field |
|
| 981 | + * |
|
| 982 | + * @since 1.0.0 |
|
| 983 | + * @return int|bool Subscription id or false if the subscription is cancelled. |
|
| 984 | + */ |
|
| 985 | + public function complete() { |
|
| 986 | + |
|
| 987 | + // Only mark a subscription as complete if it's not already cancelled. |
|
| 988 | + if ( $this->has_status( 'cancelled' ) ) { |
|
| 989 | + return false; |
|
| 990 | + } |
|
| 991 | + |
|
| 992 | + $this->set_status( 'completed' ); |
|
| 993 | + return $this->save(); |
|
| 994 | + |
|
| 995 | + } |
|
| 996 | + |
|
| 997 | + /** |
|
| 998 | + * Marks a subscription as expired |
|
| 999 | + * |
|
| 1000 | + * @since 1.0.0 |
|
| 1001 | + * @param bool $check_expiration |
|
| 1002 | + * @return int|bool Subscription id or false if $check_expiration is true and expiration date is in the future. |
|
| 1003 | + */ |
|
| 1004 | + public function expire( $check_expiration = false ) { |
|
| 1005 | + |
|
| 1006 | + if ( $check_expiration && $this->get_expiration_time() > current_time( 'timestamp' ) ) { |
|
| 1007 | + // Do not mark as expired since real expiration date is in the future |
|
| 1008 | + return false; |
|
| 1009 | + } |
|
| 1010 | + |
|
| 1011 | + $this->set_status( 'expired' ); |
|
| 1012 | + return $this->save(); |
|
| 1013 | + |
|
| 1014 | + } |
|
| 1015 | + |
|
| 1016 | + /** |
|
| 1017 | + * Marks a subscription as failing |
|
| 1018 | + * |
|
| 1019 | + * @since 2.4.2 |
|
| 1020 | + * @return int Subscription id. |
|
| 1021 | + */ |
|
| 1022 | + public function failing() { |
|
| 1023 | + $this->set_status( 'failing' ); |
|
| 1024 | + return $this->save(); |
|
| 1025 | + } |
|
| 1026 | 1026 | |
| 1027 | 1027 | /** |
| 1028 | 1028 | * Marks a subscription as cancelled |
@@ -1031,19 +1031,19 @@ discard block |
||
| 1031 | 1031 | * @return int Subscription id. |
| 1032 | 1032 | */ |
| 1033 | 1033 | public function cancel() { |
| 1034 | - $this->set_status( 'cancelled' ); |
|
| 1035 | - return $this->save(); |
|
| 1034 | + $this->set_status( 'cancelled' ); |
|
| 1035 | + return $this->save(); |
|
| 1036 | 1036 | } |
| 1037 | 1037 | |
| 1038 | - /** |
|
| 1039 | - * Determines if a subscription can be cancelled both locally and with a payment processor. |
|
| 1040 | - * |
|
| 1041 | - * @since 1.0.0 |
|
| 1042 | - * @return bool |
|
| 1043 | - */ |
|
| 1044 | - public function can_cancel() { |
|
| 1045 | - return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
| 1046 | - } |
|
| 1038 | + /** |
|
| 1039 | + * Determines if a subscription can be cancelled both locally and with a payment processor. |
|
| 1040 | + * |
|
| 1041 | + * @since 1.0.0 |
|
| 1042 | + * @return bool |
|
| 1043 | + */ |
|
| 1044 | + public function can_cancel() { |
|
| 1045 | + return apply_filters( 'wpinv_subscription_can_cancel', $this->has_status( $this->get_cancellable_statuses() ), $this ); |
|
| 1046 | + } |
|
| 1047 | 1047 | |
| 1048 | 1048 | /** |
| 1049 | 1049 | * Returns an array of subscription statuses that can be cancelled |
@@ -1056,93 +1056,93 @@ discard block |
||
| 1056 | 1056 | return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) ); |
| 1057 | 1057 | } |
| 1058 | 1058 | |
| 1059 | - /** |
|
| 1060 | - * Retrieves the URL to cancel subscription |
|
| 1061 | - * |
|
| 1062 | - * @since 1.0.0 |
|
| 1063 | - * @return string |
|
| 1064 | - */ |
|
| 1065 | - public function get_cancel_url() { |
|
| 1066 | - $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
| 1067 | - return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
| 1068 | - } |
|
| 1069 | - |
|
| 1070 | - /** |
|
| 1071 | - * Retrieves the URL to view a subscription |
|
| 1072 | - * |
|
| 1073 | - * @since 1.0.19 |
|
| 1074 | - * @return string |
|
| 1075 | - */ |
|
| 1076 | - public function get_view_url() { |
|
| 1077 | - $url = add_query_arg( 'subscription', $this->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 1078 | - return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
| 1079 | - } |
|
| 1080 | - |
|
| 1081 | - /** |
|
| 1082 | - * Determines if subscription can be manually renewed |
|
| 1083 | - * |
|
| 1084 | - * This method is filtered by payment gateways in order to return true on subscriptions |
|
| 1085 | - * that can be renewed manually |
|
| 1086 | - * |
|
| 1087 | - * @since 2.5 |
|
| 1088 | - * @return bool |
|
| 1089 | - */ |
|
| 1090 | - public function can_renew() { |
|
| 1091 | - return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
| 1092 | - } |
|
| 1093 | - |
|
| 1094 | - /** |
|
| 1095 | - * Retrieves the URL to renew a subscription |
|
| 1096 | - * |
|
| 1097 | - * @since 2.5 |
|
| 1098 | - * @return string |
|
| 1099 | - */ |
|
| 1100 | - public function get_renew_url() { |
|
| 1101 | - $url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' ); |
|
| 1102 | - return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
| 1103 | - } |
|
| 1104 | - |
|
| 1105 | - /** |
|
| 1106 | - * Determines if subscription can have their payment method updated |
|
| 1107 | - * |
|
| 1108 | - * @since 1.0.0 |
|
| 1109 | - * @return bool |
|
| 1110 | - */ |
|
| 1111 | - public function can_update() { |
|
| 1112 | - return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
| 1113 | - } |
|
| 1114 | - |
|
| 1115 | - /** |
|
| 1116 | - * Retrieves the URL to update subscription |
|
| 1117 | - * |
|
| 1118 | - * @since 1.0.0 |
|
| 1119 | - * @return string |
|
| 1120 | - */ |
|
| 1121 | - public function get_update_url() { |
|
| 1122 | - $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) ); |
|
| 1123 | - return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
| 1124 | - } |
|
| 1125 | - |
|
| 1126 | - /** |
|
| 1127 | - * Retrieves the subscription status label |
|
| 1128 | - * |
|
| 1129 | - * @since 1.0.0 |
|
| 1130 | - * @return string |
|
| 1131 | - */ |
|
| 1132 | - public function get_status_label() { |
|
| 1133 | - return getpaid_get_subscription_status_label( $this->get_status() ); |
|
| 1134 | - } |
|
| 1135 | - |
|
| 1136 | - /** |
|
| 1137 | - * Retrieves the subscription status class |
|
| 1138 | - * |
|
| 1139 | - * @since 1.0.19 |
|
| 1140 | - * @return string |
|
| 1141 | - */ |
|
| 1142 | - public function get_status_class() { |
|
| 1143 | - $statuses = getpaid_get_subscription_status_classes(); |
|
| 1144 | - return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'text-white bg-secondary'; |
|
| 1145 | - } |
|
| 1059 | + /** |
|
| 1060 | + * Retrieves the URL to cancel subscription |
|
| 1061 | + * |
|
| 1062 | + * @since 1.0.0 |
|
| 1063 | + * @return string |
|
| 1064 | + */ |
|
| 1065 | + public function get_cancel_url() { |
|
| 1066 | + $url = getpaid_get_authenticated_action_url( 'subscription_cancel', $this->get_view_url() ); |
|
| 1067 | + return apply_filters( 'wpinv_subscription_cancel_url', $url, $this ); |
|
| 1068 | + } |
|
| 1069 | + |
|
| 1070 | + /** |
|
| 1071 | + * Retrieves the URL to view a subscription |
|
| 1072 | + * |
|
| 1073 | + * @since 1.0.19 |
|
| 1074 | + * @return string |
|
| 1075 | + */ |
|
| 1076 | + public function get_view_url() { |
|
| 1077 | + $url = add_query_arg( 'subscription', $this->get_id(), get_permalink( (int) wpinv_get_option( 'invoice_subscription_page' ) ) ); |
|
| 1078 | + return apply_filters( 'getpaid_get_subscription_view_url', $url, $this ); |
|
| 1079 | + } |
|
| 1080 | + |
|
| 1081 | + /** |
|
| 1082 | + * Determines if subscription can be manually renewed |
|
| 1083 | + * |
|
| 1084 | + * This method is filtered by payment gateways in order to return true on subscriptions |
|
| 1085 | + * that can be renewed manually |
|
| 1086 | + * |
|
| 1087 | + * @since 2.5 |
|
| 1088 | + * @return bool |
|
| 1089 | + */ |
|
| 1090 | + public function can_renew() { |
|
| 1091 | + return apply_filters( 'wpinv_subscription_can_renew', true, $this ); |
|
| 1092 | + } |
|
| 1093 | + |
|
| 1094 | + /** |
|
| 1095 | + * Retrieves the URL to renew a subscription |
|
| 1096 | + * |
|
| 1097 | + * @since 2.5 |
|
| 1098 | + * @return string |
|
| 1099 | + */ |
|
| 1100 | + public function get_renew_url() { |
|
| 1101 | + $url = wp_nonce_url( add_query_arg( array( 'getpaid-action' => 'renew_subscription', 'sub_id' => $this->get_id ) ), 'getpaid-nonce' ); |
|
| 1102 | + return apply_filters( 'wpinv_subscription_renew_url', $url, $this ); |
|
| 1103 | + } |
|
| 1104 | + |
|
| 1105 | + /** |
|
| 1106 | + * Determines if subscription can have their payment method updated |
|
| 1107 | + * |
|
| 1108 | + * @since 1.0.0 |
|
| 1109 | + * @return bool |
|
| 1110 | + */ |
|
| 1111 | + public function can_update() { |
|
| 1112 | + return apply_filters( 'wpinv_subscription_can_update', false, $this ); |
|
| 1113 | + } |
|
| 1114 | + |
|
| 1115 | + /** |
|
| 1116 | + * Retrieves the URL to update subscription |
|
| 1117 | + * |
|
| 1118 | + * @since 1.0.0 |
|
| 1119 | + * @return string |
|
| 1120 | + */ |
|
| 1121 | + public function get_update_url() { |
|
| 1122 | + $url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->get_id() ) ); |
|
| 1123 | + return apply_filters( 'wpinv_subscription_update_url', $url, $this ); |
|
| 1124 | + } |
|
| 1125 | + |
|
| 1126 | + /** |
|
| 1127 | + * Retrieves the subscription status label |
|
| 1128 | + * |
|
| 1129 | + * @since 1.0.0 |
|
| 1130 | + * @return string |
|
| 1131 | + */ |
|
| 1132 | + public function get_status_label() { |
|
| 1133 | + return getpaid_get_subscription_status_label( $this->get_status() ); |
|
| 1134 | + } |
|
| 1135 | + |
|
| 1136 | + /** |
|
| 1137 | + * Retrieves the subscription status class |
|
| 1138 | + * |
|
| 1139 | + * @since 1.0.19 |
|
| 1140 | + * @return string |
|
| 1141 | + */ |
|
| 1142 | + public function get_status_class() { |
|
| 1143 | + $statuses = getpaid_get_subscription_status_classes(); |
|
| 1144 | + return isset( $statuses[ $this->get_status() ] ) ? $statuses[ $this->get_status() ] : 'text-white bg-secondary'; |
|
| 1145 | + } |
|
| 1146 | 1146 | |
| 1147 | 1147 | /** |
| 1148 | 1148 | * Retrieves the subscription status label |
@@ -1152,11 +1152,11 @@ discard block |
||
| 1152 | 1152 | */ |
| 1153 | 1153 | public function get_status_label_html() { |
| 1154 | 1154 | |
| 1155 | - $status_label = sanitize_text_field( $this->get_status_label() ); |
|
| 1156 | - $class = esc_attr( $this->get_status_class() ); |
|
| 1157 | - $status = sanitize_html_class( $this->get_status_label() ); |
|
| 1155 | + $status_label = sanitize_text_field( $this->get_status_label() ); |
|
| 1156 | + $class = esc_attr( $this->get_status_class() ); |
|
| 1157 | + $status = sanitize_html_class( $this->get_status_label() ); |
|
| 1158 | 1158 | |
| 1159 | - return "<span class='bsui'><span class='d-inline-block py-2 px-3 rounded $class $status'>$status_label</span></span>"; |
|
| 1159 | + return "<span class='bsui'><span class='d-inline-block py-2 px-3 rounded $class $status'>$status_label</span></span>"; |
|
| 1160 | 1160 | } |
| 1161 | 1161 | |
| 1162 | 1162 | /** |
@@ -1167,75 +1167,75 @@ discard block |
||
| 1167 | 1167 | * @return bool |
| 1168 | 1168 | */ |
| 1169 | 1169 | public function payment_exists( $txn_id = '' ) { |
| 1170 | - $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
| 1170 | + $invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' ); |
|
| 1171 | 1171 | return ! empty( $invoice_id ); |
| 1172 | - } |
|
| 1173 | - |
|
| 1174 | - /** |
|
| 1175 | - * Handle the status transition. |
|
| 1176 | - */ |
|
| 1177 | - protected function status_transition() { |
|
| 1178 | - $status_transition = $this->status_transition; |
|
| 1179 | - |
|
| 1180 | - // Reset status transition variable. |
|
| 1181 | - $this->status_transition = false; |
|
| 1182 | - |
|
| 1183 | - if ( $status_transition ) { |
|
| 1184 | - try { |
|
| 1185 | - |
|
| 1186 | - // Fire a hook for the status change. |
|
| 1187 | - do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
| 1188 | - do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
| 1189 | - |
|
| 1190 | - if ( ! empty( $status_transition['from'] ) ) { |
|
| 1191 | - |
|
| 1192 | - /* translators: 1: old subscription status 2: new subscription status */ |
|
| 1193 | - $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1194 | - |
|
| 1195 | - // Note the transition occurred. |
|
| 1196 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1197 | - |
|
| 1198 | - // Fire another hook. |
|
| 1199 | - do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
| 1200 | - do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 1201 | - |
|
| 1202 | - } else { |
|
| 1203 | - /* translators: %s: new invoice status */ |
|
| 1204 | - $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1205 | - |
|
| 1206 | - // Note the transition occurred. |
|
| 1207 | - $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1208 | - |
|
| 1209 | - } |
|
| 1210 | - } catch ( Exception $e ) { |
|
| 1211 | - $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 1212 | - } |
|
| 1213 | - } |
|
| 1214 | - |
|
| 1215 | - } |
|
| 1216 | - |
|
| 1217 | - /** |
|
| 1218 | - * Save data to the database. |
|
| 1219 | - * |
|
| 1220 | - * @since 1.0.19 |
|
| 1221 | - * @return int subscription ID |
|
| 1222 | - */ |
|
| 1223 | - public function save() { |
|
| 1224 | - parent::save(); |
|
| 1225 | - $this->status_transition(); |
|
| 1226 | - return $this->get_id(); |
|
| 1227 | - } |
|
| 1228 | - |
|
| 1229 | - /** |
|
| 1230 | - * Activates a subscription. |
|
| 1231 | - * |
|
| 1232 | - * @since 1.0.19 |
|
| 1233 | - * @return int subscription ID |
|
| 1234 | - */ |
|
| 1235 | - public function activate() { |
|
| 1236 | - $status = 'trialling' == $this->get_status() ? 'trialling' : 'active'; |
|
| 1237 | - $this->set_status( $status ); |
|
| 1238 | - return $this->save(); |
|
| 1239 | - } |
|
| 1172 | + } |
|
| 1173 | + |
|
| 1174 | + /** |
|
| 1175 | + * Handle the status transition. |
|
| 1176 | + */ |
|
| 1177 | + protected function status_transition() { |
|
| 1178 | + $status_transition = $this->status_transition; |
|
| 1179 | + |
|
| 1180 | + // Reset status transition variable. |
|
| 1181 | + $this->status_transition = false; |
|
| 1182 | + |
|
| 1183 | + if ( $status_transition ) { |
|
| 1184 | + try { |
|
| 1185 | + |
|
| 1186 | + // Fire a hook for the status change. |
|
| 1187 | + do_action( 'wpinv_subscription_' . $status_transition['to'], $this->get_id(), $this, $status_transition ); |
|
| 1188 | + do_action( 'getpaid_subscription_' . $status_transition['to'], $this, $status_transition ); |
|
| 1189 | + |
|
| 1190 | + if ( ! empty( $status_transition['from'] ) ) { |
|
| 1191 | + |
|
| 1192 | + /* translators: 1: old subscription status 2: new subscription status */ |
|
| 1193 | + $transition_note = sprintf( __( 'Subscription status changed from %1$s to %2$s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['from'] ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1194 | + |
|
| 1195 | + // Note the transition occurred. |
|
| 1196 | + $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1197 | + |
|
| 1198 | + // Fire another hook. |
|
| 1199 | + do_action( 'getpaid_subscription_status_' . $status_transition['from'] . '_to_' . $status_transition['to'], $this->get_id(), $this ); |
|
| 1200 | + do_action( 'getpaid_subscription_status_changed', $this, $status_transition['from'], $status_transition['to'] ); |
|
| 1201 | + |
|
| 1202 | + } else { |
|
| 1203 | + /* translators: %s: new invoice status */ |
|
| 1204 | + $transition_note = sprintf( __( 'Subscription status set to %s.', 'invoicing' ), getpaid_get_subscription_status_label( $status_transition['to'] ) ); |
|
| 1205 | + |
|
| 1206 | + // Note the transition occurred. |
|
| 1207 | + $this->get_parent_payment()->add_note( $transition_note, false, false, true ); |
|
| 1208 | + |
|
| 1209 | + } |
|
| 1210 | + } catch ( Exception $e ) { |
|
| 1211 | + $this->get_parent_payment()->add_note( __( 'Error during subscription status transition.', 'invoicing' ) . ' ' . $e->getMessage() ); |
|
| 1212 | + } |
|
| 1213 | + } |
|
| 1214 | + |
|
| 1215 | + } |
|
| 1216 | + |
|
| 1217 | + /** |
|
| 1218 | + * Save data to the database. |
|
| 1219 | + * |
|
| 1220 | + * @since 1.0.19 |
|
| 1221 | + * @return int subscription ID |
|
| 1222 | + */ |
|
| 1223 | + public function save() { |
|
| 1224 | + parent::save(); |
|
| 1225 | + $this->status_transition(); |
|
| 1226 | + return $this->get_id(); |
|
| 1227 | + } |
|
| 1228 | + |
|
| 1229 | + /** |
|
| 1230 | + * Activates a subscription. |
|
| 1231 | + * |
|
| 1232 | + * @since 1.0.19 |
|
| 1233 | + * @return int subscription ID |
|
| 1234 | + */ |
|
| 1235 | + public function activate() { |
|
| 1236 | + $status = 'trialling' == $this->get_status() ? 'trialling' : 'active'; |
|
| 1237 | + $this->set_status( $status ); |
|
| 1238 | + return $this->save(); |
|
| 1239 | + } |
|
| 1240 | 1240 | |
| 1241 | 1241 | } |
@@ -13,58 +13,58 @@ discard block |
||
| 13 | 13 | class GetPaid_Authorize_Net_Gateway extends GetPaid_Authorize_Net_Legacy_Gateway { |
| 14 | 14 | |
| 15 | 15 | /** |
| 16 | - * Payment method id. |
|
| 17 | - * |
|
| 18 | - * @var string |
|
| 19 | - */ |
|
| 16 | + * Payment method id. |
|
| 17 | + * |
|
| 18 | + * @var string |
|
| 19 | + */ |
|
| 20 | 20 | public $id = 'authorizenet'; |
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | - * An array of features that this gateway supports. |
|
| 24 | - * |
|
| 25 | - * @var array |
|
| 26 | - */ |
|
| 23 | + * An array of features that this gateway supports. |
|
| 24 | + * |
|
| 25 | + * @var array |
|
| 26 | + */ |
|
| 27 | 27 | protected $supports = array( 'subscription', 'sandbox', 'tokens' ); |
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | - * Payment method order. |
|
| 31 | - * |
|
| 32 | - * @var int |
|
| 33 | - */ |
|
| 30 | + * Payment method order. |
|
| 31 | + * |
|
| 32 | + * @var int |
|
| 33 | + */ |
|
| 34 | 34 | public $order = 4; |
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | - * Endpoint for requests from Authorize.net. |
|
| 38 | - * |
|
| 39 | - * @var string |
|
| 40 | - */ |
|
| 41 | - protected $notify_url; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Endpoint for requests to Authorize.net. |
|
| 45 | - * |
|
| 46 | - * @var string |
|
| 47 | - */ |
|
| 37 | + * Endpoint for requests from Authorize.net. |
|
| 38 | + * |
|
| 39 | + * @var string |
|
| 40 | + */ |
|
| 41 | + protected $notify_url; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Endpoint for requests to Authorize.net. |
|
| 45 | + * |
|
| 46 | + * @var string |
|
| 47 | + */ |
|
| 48 | 48 | protected $endpoint; |
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | - * Currencies this gateway is allowed for. |
|
| 52 | - * |
|
| 53 | - * @var array |
|
| 54 | - */ |
|
| 55 | - public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' ); |
|
| 51 | + * Currencies this gateway is allowed for. |
|
| 52 | + * |
|
| 53 | + * @var array |
|
| 54 | + */ |
|
| 55 | + public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' ); |
|
| 56 | 56 | |
| 57 | 57 | /** |
| 58 | - * URL to view a transaction. |
|
| 59 | - * |
|
| 60 | - * @var string |
|
| 61 | - */ |
|
| 58 | + * URL to view a transaction. |
|
| 59 | + * |
|
| 60 | + * @var string |
|
| 61 | + */ |
|
| 62 | 62 | public $view_transaction_url = 'https://{sandbox}authorize.net/ui/themes/sandbox/Transaction/TransactionReceipt.aspx?transid=%s'; |
| 63 | 63 | |
| 64 | 64 | /** |
| 65 | - * Class constructor. |
|
| 66 | - */ |
|
| 67 | - public function __construct() { |
|
| 65 | + * Class constructor. |
|
| 66 | + */ |
|
| 67 | + public function __construct() { |
|
| 68 | 68 | |
| 69 | 69 | $this->title = __( 'Credit Card / Debit Card', 'invoicing' ); |
| 70 | 70 | $this->method_title = __( 'Authorize.Net', 'invoicing' ); |
@@ -76,11 +76,11 @@ discard block |
||
| 76 | 76 | } |
| 77 | 77 | |
| 78 | 78 | /** |
| 79 | - * Displays the payment method select field. |
|
| 80 | - * |
|
| 81 | - * @param int $invoice_id 0 or invoice id. |
|
| 82 | - * @param GetPaid_Payment_Form $form Current payment form. |
|
| 83 | - */ |
|
| 79 | + * Displays the payment method select field. |
|
| 80 | + * |
|
| 81 | + * @param int $invoice_id 0 or invoice id. |
|
| 82 | + * @param GetPaid_Payment_Form $form Current payment form. |
|
| 83 | + */ |
|
| 84 | 84 | public function payment_fields( $invoice_id, $form ) { |
| 85 | 85 | |
| 86 | 86 | // Let the user select a payment method. |
@@ -91,16 +91,16 @@ discard block |
||
| 91 | 91 | } |
| 92 | 92 | |
| 93 | 93 | /** |
| 94 | - * Creates a customer profile. |
|
| 95 | - * |
|
| 96 | - * |
|
| 97 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 94 | + * Creates a customer profile. |
|
| 95 | + * |
|
| 96 | + * |
|
| 97 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 98 | 98 | * @param array $submission_data Posted checkout fields. |
| 99 | 99 | * @param bool $save Whether or not to save the payment as a token. |
| 100 | 100 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile |
| 101 | - * @return string|WP_Error Payment profile id. |
|
| 102 | - */ |
|
| 103 | - public function create_customer_profile( $invoice, $submission_data, $save = true ) { |
|
| 101 | + * @return string|WP_Error Payment profile id. |
|
| 102 | + */ |
|
| 103 | + public function create_customer_profile( $invoice, $submission_data, $save = true ) { |
|
| 104 | 104 | |
| 105 | 105 | // Remove non-digits from the number |
| 106 | 106 | $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] ); |
@@ -167,14 +167,14 @@ discard block |
||
| 167 | 167 | } |
| 168 | 168 | |
| 169 | 169 | /** |
| 170 | - * Retrieves a customer profile. |
|
| 171 | - * |
|
| 172 | - * |
|
| 173 | - * @param string $profile_id profile id. |
|
| 174 | - * @return string|WP_Error Profile id. |
|
| 170 | + * Retrieves a customer profile. |
|
| 171 | + * |
|
| 172 | + * |
|
| 173 | + * @param string $profile_id profile id. |
|
| 174 | + * @return string|WP_Error Profile id. |
|
| 175 | 175 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile |
| 176 | - */ |
|
| 177 | - public function get_customer_profile( $profile_id ) { |
|
| 176 | + */ |
|
| 177 | + public function get_customer_profile( $profile_id ) { |
|
| 178 | 178 | |
| 179 | 179 | // Generate args. |
| 180 | 180 | $args = array( |
@@ -189,17 +189,17 @@ discard block |
||
| 189 | 189 | } |
| 190 | 190 | |
| 191 | 191 | /** |
| 192 | - * Creates a customer profile. |
|
| 193 | - * |
|
| 194 | - * |
|
| 192 | + * Creates a customer profile. |
|
| 193 | + * |
|
| 194 | + * |
|
| 195 | 195 | * @param string $profile_id profile id. |
| 196 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 196 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 197 | 197 | * @param array $submission_data Posted checkout fields. |
| 198 | 198 | * @param bool $save Whether or not to save the payment as a token. |
| 199 | 199 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile |
| 200 | - * @return string|WP_Error Profile id. |
|
| 201 | - */ |
|
| 202 | - public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) { |
|
| 200 | + * @return string|WP_Error Profile id. |
|
| 201 | + */ |
|
| 202 | + public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) { |
|
| 203 | 203 | |
| 204 | 204 | // Remove non-digits from the number |
| 205 | 205 | $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] ); |
@@ -259,15 +259,15 @@ discard block |
||
| 259 | 259 | } |
| 260 | 260 | |
| 261 | 261 | /** |
| 262 | - * Retrieves a customer payment profile. |
|
| 263 | - * |
|
| 264 | - * |
|
| 265 | - * @param string $customer_profile_id customer profile id. |
|
| 262 | + * Retrieves a customer payment profile. |
|
| 263 | + * |
|
| 264 | + * |
|
| 265 | + * @param string $customer_profile_id customer profile id. |
|
| 266 | 266 | * @param string $payment_profile_id payment profile id. |
| 267 | - * @return string|WP_Error Profile id. |
|
| 267 | + * @return string|WP_Error Profile id. |
|
| 268 | 268 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile |
| 269 | - */ |
|
| 270 | - public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) { |
|
| 269 | + */ |
|
| 270 | + public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) { |
|
| 271 | 271 | |
| 272 | 272 | // Generate args. |
| 273 | 273 | $args = array( |
@@ -283,15 +283,15 @@ discard block |
||
| 283 | 283 | } |
| 284 | 284 | |
| 285 | 285 | /** |
| 286 | - * Charges a customer payment profile. |
|
| 287 | - * |
|
| 286 | + * Charges a customer payment profile. |
|
| 287 | + * |
|
| 288 | 288 | * @param string $customer_profile_id customer profile id. |
| 289 | 289 | * @param string $payment_profile_id payment profile id. |
| 290 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 290 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 291 | 291 | * @link https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-customer-profile |
| 292 | - * @return WP_Error|object |
|
| 293 | - */ |
|
| 294 | - public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) { |
|
| 292 | + * @return WP_Error|object |
|
| 293 | + */ |
|
| 294 | + public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) { |
|
| 295 | 295 | |
| 296 | 296 | // Generate args. |
| 297 | 297 | $args = array( |
@@ -333,41 +333,41 @@ discard block |
||
| 333 | 333 | } |
| 334 | 334 | |
| 335 | 335 | /** |
| 336 | - * Processes a customer charge. |
|
| 337 | - * |
|
| 336 | + * Processes a customer charge. |
|
| 337 | + * |
|
| 338 | 338 | * @param stdClass $result Api response. |
| 339 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 340 | - */ |
|
| 341 | - public function process_charge_response( $result, $invoice ) { |
|
| 339 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 340 | + */ |
|
| 341 | + public function process_charge_response( $result, $invoice ) { |
|
| 342 | 342 | |
| 343 | 343 | wpinv_clear_errors(); |
| 344 | - $response_code = (int) $result->transactionResponse->responseCode; |
|
| 344 | + $response_code = (int) $result->transactionResponse->responseCode; |
|
| 345 | 345 | |
| 346 | - // Succeeded. |
|
| 347 | - if ( 1 == $response_code || 4 == $response_code ) { |
|
| 346 | + // Succeeded. |
|
| 347 | + if ( 1 == $response_code || 4 == $response_code ) { |
|
| 348 | 348 | |
| 349 | - // Maybe set a transaction id. |
|
| 350 | - if ( ! empty( $result->transactionResponse->transId ) ) { |
|
| 351 | - $invoice->set_transaction_id( $result->transactionResponse->transId ); |
|
| 352 | - } |
|
| 349 | + // Maybe set a transaction id. |
|
| 350 | + if ( ! empty( $result->transactionResponse->transId ) ) { |
|
| 351 | + $invoice->set_transaction_id( $result->transactionResponse->transId ); |
|
| 352 | + } |
|
| 353 | 353 | |
| 354 | - $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true ); |
|
| 354 | + $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true ); |
|
| 355 | 355 | |
| 356 | - if ( 1 == $response_code ) { |
|
| 357 | - return $invoice->mark_paid(); |
|
| 358 | - } |
|
| 356 | + if ( 1 == $response_code ) { |
|
| 357 | + return $invoice->mark_paid(); |
|
| 358 | + } |
|
| 359 | 359 | |
| 360 | - $invoice->set_status( 'wpi-onhold' ); |
|
| 361 | - $invoice->add_note( |
|
| 360 | + $invoice->set_status( 'wpi-onhold' ); |
|
| 361 | + $invoice->add_note( |
|
| 362 | 362 | sprintf( |
| 363 | 363 | __( 'Held for review: %s', 'invoicing' ), |
| 364 | 364 | $result->transactionResponse->messages->message[0]->description |
| 365 | 365 | ) |
| 366 | - ); |
|
| 366 | + ); |
|
| 367 | 367 | |
| 368 | - return $invoice->save(); |
|
| 368 | + return $invoice->save(); |
|
| 369 | 369 | |
| 370 | - } |
|
| 370 | + } |
|
| 371 | 371 | |
| 372 | 372 | wpinv_set_error( 'card_declined', __( 'Credit card declined.', 'invoicing' ) ); |
| 373 | 373 | |
@@ -379,13 +379,13 @@ discard block |
||
| 379 | 379 | } |
| 380 | 380 | |
| 381 | 381 | /** |
| 382 | - * Returns payment information. |
|
| 383 | - * |
|
| 384 | - * |
|
| 385 | - * @param array $card Card details. |
|
| 386 | - * @return array |
|
| 387 | - */ |
|
| 388 | - public function get_payment_information( $card ) { |
|
| 382 | + * Returns payment information. |
|
| 383 | + * |
|
| 384 | + * |
|
| 385 | + * @param array $card Card details. |
|
| 386 | + * @return array |
|
| 387 | + */ |
|
| 388 | + public function get_payment_information( $card ) { |
|
| 389 | 389 | return array( |
| 390 | 390 | |
| 391 | 391 | 'creditCard' => array ( |
@@ -398,25 +398,25 @@ discard block |
||
| 398 | 398 | } |
| 399 | 399 | |
| 400 | 400 | /** |
| 401 | - * Returns the customer profile meta name. |
|
| 402 | - * |
|
| 403 | - * |
|
| 404 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 405 | - * @return string |
|
| 406 | - */ |
|
| 407 | - public function get_customer_profile_meta_name( $invoice ) { |
|
| 401 | + * Returns the customer profile meta name. |
|
| 402 | + * |
|
| 403 | + * |
|
| 404 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 405 | + * @return string |
|
| 406 | + */ |
|
| 407 | + public function get_customer_profile_meta_name( $invoice ) { |
|
| 408 | 408 | return $this->is_sandbox( $invoice ) ? 'getpaid_authorizenet_sandbox_customer_profile_id' : 'getpaid_authorizenet_customer_profile_id'; |
| 409 | 409 | } |
| 410 | 410 | |
| 411 | 411 | /** |
| 412 | - * Validates the submitted data. |
|
| 413 | - * |
|
| 414 | - * |
|
| 415 | - * @param array $submission_data Posted checkout fields. |
|
| 412 | + * Validates the submitted data. |
|
| 413 | + * |
|
| 414 | + * |
|
| 415 | + * @param array $submission_data Posted checkout fields. |
|
| 416 | 416 | * @param WPInv_Invoice $invoice |
| 417 | - * @return WP_Error|string The payment profile id |
|
| 418 | - */ |
|
| 419 | - public function validate_submission_data( $submission_data, $invoice ) { |
|
| 417 | + * @return WP_Error|string The payment profile id |
|
| 418 | + */ |
|
| 419 | + public function validate_submission_data( $submission_data, $invoice ) { |
|
| 420 | 420 | |
| 421 | 421 | // Validate authentication details. |
| 422 | 422 | $auth = $this->get_auth_params(); |
@@ -448,13 +448,13 @@ discard block |
||
| 448 | 448 | } |
| 449 | 449 | |
| 450 | 450 | /** |
| 451 | - * Returns invoice line items. |
|
| 452 | - * |
|
| 453 | - * |
|
| 454 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 455 | - * @return array |
|
| 456 | - */ |
|
| 457 | - public function get_line_items( $invoice ) { |
|
| 451 | + * Returns invoice line items. |
|
| 452 | + * |
|
| 453 | + * |
|
| 454 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 455 | + * @return array |
|
| 456 | + */ |
|
| 457 | + public function get_line_items( $invoice ) { |
|
| 458 | 458 | $items = array(); |
| 459 | 459 | |
| 460 | 460 | foreach ( $invoice->get_items() as $item ) { |
@@ -474,15 +474,15 @@ discard block |
||
| 474 | 474 | } |
| 475 | 475 | |
| 476 | 476 | /** |
| 477 | - * Process Payment. |
|
| 478 | - * |
|
| 479 | - * |
|
| 480 | - * @param WPInv_Invoice $invoice Invoice. |
|
| 481 | - * @param array $submission_data Posted checkout fields. |
|
| 482 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
| 483 | - * @return array |
|
| 484 | - */ |
|
| 485 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
| 477 | + * Process Payment. |
|
| 478 | + * |
|
| 479 | + * |
|
| 480 | + * @param WPInv_Invoice $invoice Invoice. |
|
| 481 | + * @param array $submission_data Posted checkout fields. |
|
| 482 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
| 483 | + * @return array |
|
| 484 | + */ |
|
| 485 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
| 486 | 486 | |
| 487 | 487 | // Validate the submitted data. |
| 488 | 488 | $payment_profile_id = $this->validate_submission_data( $submission_data, $invoice ); |
@@ -515,69 +515,69 @@ discard block |
||
| 515 | 515 | |
| 516 | 516 | exit; |
| 517 | 517 | |
| 518 | - } |
|
| 518 | + } |
|
| 519 | 519 | |
| 520 | - /** |
|
| 521 | - * Processes the initial payment. |
|
| 522 | - * |
|
| 520 | + /** |
|
| 521 | + * Processes the initial payment. |
|
| 522 | + * |
|
| 523 | 523 | * @param WPInv_Invoice $invoice Invoice. |
| 524 | - */ |
|
| 525 | - protected function process_initial_payment( $invoice ) { |
|
| 524 | + */ |
|
| 525 | + protected function process_initial_payment( $invoice ) { |
|
| 526 | 526 | |
| 527 | - $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
| 527 | + $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
| 528 | 528 | $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
| 529 | - $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
|
| 529 | + $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
|
| 530 | 530 | |
| 531 | - // Do we have an error? |
|
| 532 | - if ( is_wp_error( $result ) ) { |
|
| 533 | - wpinv_set_error( $result->get_error_code(), $result->get_error_message() ); |
|
| 534 | - wpinv_send_back_to_checkout(); |
|
| 535 | - } |
|
| 531 | + // Do we have an error? |
|
| 532 | + if ( is_wp_error( $result ) ) { |
|
| 533 | + wpinv_set_error( $result->get_error_code(), $result->get_error_message() ); |
|
| 534 | + wpinv_send_back_to_checkout(); |
|
| 535 | + } |
|
| 536 | 536 | |
| 537 | - // Process the response. |
|
| 538 | - $this->process_charge_response( $result, $invoice ); |
|
| 537 | + // Process the response. |
|
| 538 | + $this->process_charge_response( $result, $invoice ); |
|
| 539 | 539 | |
| 540 | - if ( wpinv_get_errors() ) { |
|
| 541 | - wpinv_send_back_to_checkout(); |
|
| 542 | - } |
|
| 540 | + if ( wpinv_get_errors() ) { |
|
| 541 | + wpinv_send_back_to_checkout(); |
|
| 542 | + } |
|
| 543 | 543 | |
| 544 | - } |
|
| 544 | + } |
|
| 545 | 545 | |
| 546 | 546 | /** |
| 547 | - * Processes recurring payments. |
|
| 548 | - * |
|
| 547 | + * Processes recurring payments. |
|
| 548 | + * |
|
| 549 | 549 | * @param WPInv_Invoice $invoice Invoice. |
| 550 | 550 | * @param WPInv_Subscription $subscription Subscription. |
| 551 | - */ |
|
| 552 | - public function process_subscription( $invoice, $subscription ) { |
|
| 551 | + */ |
|
| 552 | + public function process_subscription( $invoice, $subscription ) { |
|
| 553 | 553 | |
| 554 | 554 | // Check if there is an initial amount to charge. |
| 555 | 555 | if ( (float) $invoice->get_total() > 0 ) { |
| 556 | - $this->process_initial_payment( $invoice ); |
|
| 556 | + $this->process_initial_payment( $invoice ); |
|
| 557 | 557 | } |
| 558 | 558 | |
| 559 | 559 | // Activate the subscription. |
| 560 | 560 | $duration = strtotime( $subscription->get_expiration() ) - strtotime( $subscription->get_date_created() ); |
| 561 | 561 | $expiry = date( 'Y-m-d H:i:s', ( current_time( 'timestamp' ) + $duration ) ); |
| 562 | 562 | |
| 563 | - $subscription->set_next_renewal_date( $expiry ); |
|
| 564 | - $subscription->set_date_created( current_time( 'mysql' ) ); |
|
| 565 | - $subscription->set_profile_id( $invoice->generate_key() ); |
|
| 566 | - $subscription->activate(); |
|
| 563 | + $subscription->set_next_renewal_date( $expiry ); |
|
| 564 | + $subscription->set_date_created( current_time( 'mysql' ) ); |
|
| 565 | + $subscription->set_profile_id( $invoice->generate_key() ); |
|
| 566 | + $subscription->activate(); |
|
| 567 | 567 | |
| 568 | - // Redirect to the success page. |
|
| 568 | + // Redirect to the success page. |
|
| 569 | 569 | wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) ); |
| 570 | 570 | |
| 571 | 571 | } |
| 572 | 572 | |
| 573 | - /** |
|
| 574 | - * (Maybe) renews an authorize.net subscription profile. |
|
| 575 | - * |
|
| 576 | - * |
|
| 577 | - * @param bool $should_expire |
|
| 573 | + /** |
|
| 574 | + * (Maybe) renews an authorize.net subscription profile. |
|
| 575 | + * |
|
| 576 | + * |
|
| 577 | + * @param bool $should_expire |
|
| 578 | 578 | * @param WPInv_Subscription $subscription |
| 579 | - */ |
|
| 580 | - public function maybe_renew_subscription( $should_expire, $subscription ) { |
|
| 579 | + */ |
|
| 580 | + public function maybe_renew_subscription( $should_expire, $subscription ) { |
|
| 581 | 581 | |
| 582 | 582 | // Ensure its our subscription && it's active. |
| 583 | 583 | if ( $this->id != $subscription->get_gateway() || ! $subscription->has_status( 'active trialling' ) ) { |
@@ -594,18 +594,18 @@ discard block |
||
| 594 | 594 | |
| 595 | 595 | return false; |
| 596 | 596 | |
| 597 | - } |
|
| 597 | + } |
|
| 598 | 598 | |
| 599 | 599 | /** |
| 600 | - * Renews a subscription. |
|
| 601 | - * |
|
| 600 | + * Renews a subscription. |
|
| 601 | + * |
|
| 602 | 602 | * @param WPInv_Subscription $subscription |
| 603 | - */ |
|
| 604 | - public function renew_subscription( $subscription ) { |
|
| 603 | + */ |
|
| 604 | + public function renew_subscription( $subscription ) { |
|
| 605 | 605 | |
| 606 | - // Generate the renewal invoice. |
|
| 607 | - $new_invoice = $subscription->create_payment(); |
|
| 608 | - $old_invoice = $subscription->get_parent_payment(); |
|
| 606 | + // Generate the renewal invoice. |
|
| 607 | + $new_invoice = $subscription->create_payment(); |
|
| 608 | + $old_invoice = $subscription->get_parent_payment(); |
|
| 609 | 609 | |
| 610 | 610 | if ( empty( $new_invoice ) ) { |
| 611 | 611 | $old_invoice->add_note( __( 'Error generating a renewal invoice.', 'invoicing' ), false, false, false ); |
@@ -614,37 +614,37 @@ discard block |
||
| 614 | 614 | } |
| 615 | 615 | |
| 616 | 616 | // Charge the payment method. |
| 617 | - $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
| 618 | - $customer_profile = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true ); |
|
| 619 | - $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice ); |
|
| 620 | - |
|
| 621 | - // Do we have an error? |
|
| 622 | - if ( is_wp_error( $result ) ) { |
|
| 623 | - |
|
| 624 | - $old_invoice->add_note( |
|
| 625 | - sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ), |
|
| 626 | - true, |
|
| 627 | - false, |
|
| 628 | - true |
|
| 629 | - ); |
|
| 630 | - $subscription->failing(); |
|
| 631 | - return; |
|
| 632 | - |
|
| 633 | - } |
|
| 634 | - |
|
| 635 | - // Process the response. |
|
| 636 | - $this->process_charge_response( $result, $new_invoice ); |
|
| 637 | - |
|
| 638 | - if ( wpinv_get_errors() ) { |
|
| 639 | - |
|
| 640 | - $old_invoice->add_note( |
|
| 641 | - sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ), |
|
| 642 | - true, |
|
| 643 | - false, |
|
| 644 | - true |
|
| 645 | - ); |
|
| 646 | - $subscription->failing(); |
|
| 647 | - return; |
|
| 617 | + $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
| 618 | + $customer_profile = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true ); |
|
| 619 | + $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice ); |
|
| 620 | + |
|
| 621 | + // Do we have an error? |
|
| 622 | + if ( is_wp_error( $result ) ) { |
|
| 623 | + |
|
| 624 | + $old_invoice->add_note( |
|
| 625 | + sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ), |
|
| 626 | + true, |
|
| 627 | + false, |
|
| 628 | + true |
|
| 629 | + ); |
|
| 630 | + $subscription->failing(); |
|
| 631 | + return; |
|
| 632 | + |
|
| 633 | + } |
|
| 634 | + |
|
| 635 | + // Process the response. |
|
| 636 | + $this->process_charge_response( $result, $new_invoice ); |
|
| 637 | + |
|
| 638 | + if ( wpinv_get_errors() ) { |
|
| 639 | + |
|
| 640 | + $old_invoice->add_note( |
|
| 641 | + sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ), |
|
| 642 | + true, |
|
| 643 | + false, |
|
| 644 | + true |
|
| 645 | + ); |
|
| 646 | + $subscription->failing(); |
|
| 647 | + return; |
|
| 648 | 648 | |
| 649 | 649 | } |
| 650 | 650 | |
@@ -670,11 +670,11 @@ discard block |
||
| 670 | 670 | } |
| 671 | 671 | |
| 672 | 672 | /** |
| 673 | - * Filters the gateway settings. |
|
| 674 | - * |
|
| 675 | - * @param array $admin_settings |
|
| 676 | - */ |
|
| 677 | - public function admin_settings( $admin_settings ) { |
|
| 673 | + * Filters the gateway settings. |
|
| 674 | + * |
|
| 675 | + * @param array $admin_settings |
|
| 676 | + */ |
|
| 677 | + public function admin_settings( $admin_settings ) { |
|
| 678 | 678 | |
| 679 | 679 | $currencies = sprintf( |
| 680 | 680 | __( 'Supported Currencies: %s', 'invoicing' ), |
@@ -714,7 +714,7 @@ discard block |
||
| 714 | 714 | 'readonly' => true, |
| 715 | 715 | ); |
| 716 | 716 | |
| 717 | - return $admin_settings; |
|
| 718 | - } |
|
| 717 | + return $admin_settings; |
|
| 718 | + } |
|
| 719 | 719 | |
| 720 | 720 | } |
@@ -12,443 +12,443 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Invoice_Notification_Emails { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * The array of invoice email actions. |
|
| 17 | - * |
|
| 18 | - * @param array |
|
| 19 | - */ |
|
| 20 | - public $invoice_actions; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Class constructor |
|
| 24 | - * |
|
| 25 | - */ |
|
| 26 | - public function __construct() { |
|
| 27 | - |
|
| 28 | - $this->invoice_actions = apply_filters( |
|
| 29 | - 'getpaid_notification_email_invoice_triggers', |
|
| 30 | - array( |
|
| 31 | - 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
| 32 | - 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
|
| 33 | - 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
|
| 34 | - 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
|
| 35 | - 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
|
| 36 | - 'getpaid_invoice_status_publish' => 'completed_invoice', |
|
| 37 | - 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
|
| 38 | - 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
|
| 39 | - 'getpaid_new_customer_note' => 'user_note', |
|
| 40 | - 'getpaid_daily_maintenance' => 'overdue', |
|
| 41 | - ) |
|
| 42 | - ); |
|
| 43 | - |
|
| 44 | - $this->init_hooks(); |
|
| 45 | - |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Registers email hooks. |
|
| 50 | - */ |
|
| 51 | - public function init_hooks() { |
|
| 52 | - |
|
| 53 | - add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
| 54 | - add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
| 55 | - |
|
| 56 | - foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
| 57 | - $this->init_email_type_hook( $hook, $email_type ); |
|
| 58 | - } |
|
| 59 | - } |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Registers an email hook for an invoice action. |
|
| 63 | - * |
|
| 64 | - * @param string $hook |
|
| 65 | - * @param string|array $email_type |
|
| 66 | - */ |
|
| 67 | - public function init_email_type_hook( $hook, $email_type ) { |
|
| 68 | - |
|
| 69 | - $email_type = wpinv_parse_list( $email_type ); |
|
| 70 | - |
|
| 71 | - foreach ( $email_type as $type ) { |
|
| 72 | - |
|
| 73 | - $email = new GetPaid_Notification_Email( $type ); |
|
| 74 | - |
|
| 75 | - // Abort if it is not active. |
|
| 76 | - if ( ! $email->is_active() ) { |
|
| 77 | - continue; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - if ( method_exists( $this, $type ) ) { |
|
| 81 | - add_action( $hook, array( $this, $type ), 100, 2 ); |
|
| 82 | - continue; |
|
| 83 | - } |
|
| 84 | - |
|
| 85 | - do_action( 'getpaid_invoice_init_email_type_hook', $type ); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Filters invoice merge tags. |
|
| 92 | - * |
|
| 93 | - * @param array $merge_tags |
|
| 94 | - * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
| 95 | - */ |
|
| 96 | - public function invoice_merge_tags( $merge_tags, $object ) { |
|
| 97 | - |
|
| 98 | - if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 99 | - return array_merge( |
|
| 100 | - $merge_tags, |
|
| 101 | - $this->get_invoice_merge_tags( $object ) |
|
| 102 | - ); |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 106 | - return array_merge( |
|
| 107 | - $merge_tags, |
|
| 108 | - $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
| 109 | - ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - return $merge_tags; |
|
| 113 | - |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Generates invoice merge tags. |
|
| 118 | - * |
|
| 119 | - * @param WPInv_Invoice $invoice |
|
| 120 | - * @return array |
|
| 121 | - */ |
|
| 122 | - public function get_invoice_merge_tags( $invoice ) { |
|
| 123 | - |
|
| 124 | - // Abort if it does not exist. |
|
| 125 | - if ( ! $invoice->get_id() ) { |
|
| 126 | - return array(); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - return array( |
|
| 130 | - '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 131 | - '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 132 | - '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
| 133 | - '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
| 134 | - '{email}' => sanitize_email( $invoice->get_email() ), |
|
| 135 | - '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
| 136 | - '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
| 137 | - '{invoice_total}' => wpinv_price( wpinv_format_amount( $invoice->get_total() ) ), |
|
| 138 | - '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
| 139 | - '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
| 140 | - '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ), |
|
| 141 | - '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
| 142 | - '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
| 143 | - '{invoice_quote}' => sanitize_text_field( $invoice->get_type() ), |
|
| 144 | - '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_type() ) ), |
|
| 145 | - '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
| 146 | - '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
| 147 | - '{is_was}' => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
| 148 | - ); |
|
| 149 | - |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Helper function to send an email. |
|
| 154 | - * |
|
| 155 | - * @param WPInv_Invoice $invoice |
|
| 156 | - * @param GetPaid_Notification_Email $email |
|
| 157 | - * @param string $type |
|
| 158 | - * @param string|array $recipients |
|
| 159 | - * @param array $extra_args Extra template args. |
|
| 160 | - */ |
|
| 161 | - public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
| 162 | - |
|
| 163 | - do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
| 164 | - |
|
| 165 | - $mailer = new GetPaid_Notification_Email_Sender(); |
|
| 166 | - $merge_tags = $email->get_merge_tags(); |
|
| 167 | - |
|
| 168 | - $result = $mailer->send( |
|
| 169 | - apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 170 | - $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
| 171 | - $email->get_content( $merge_tags, $extra_args ), |
|
| 172 | - $email->get_attachments() |
|
| 173 | - ); |
|
| 174 | - |
|
| 175 | - // Maybe send a copy to the admin. |
|
| 176 | - if ( $email->include_admin_bcc() ) { |
|
| 177 | - $mailer->send( |
|
| 178 | - wpinv_get_admin_email(), |
|
| 179 | - $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
| 180 | - $email->get_content( $merge_tags ), |
|
| 181 | - $email->get_attachments() |
|
| 182 | - ); |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - if ( ! $result ) { |
|
| 186 | - $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
| 190 | - |
|
| 191 | - return $result; |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - /** |
|
| 195 | - * Also send emails to any cc users. |
|
| 196 | - * |
|
| 197 | - * @param array $recipients |
|
| 198 | - * @param GetPaid_Notification_Email $email |
|
| 199 | - */ |
|
| 200 | - public function filter_email_recipients( $recipients, $email ) { |
|
| 201 | - |
|
| 202 | - if ( ! $email->is_admin_email() ) { |
|
| 203 | - $cc = $email->object->get_email_cc(); |
|
| 204 | - |
|
| 205 | - if ( ! empty( $cc ) ) { |
|
| 206 | - $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 207 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - return $recipients; |
|
| 213 | - |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - /** |
|
| 217 | - * Sends a new invoice notification. |
|
| 218 | - * |
|
| 219 | - * @param WPInv_Invoice $invoice |
|
| 220 | - */ |
|
| 221 | - public function new_invoice( $invoice ) { |
|
| 222 | - |
|
| 223 | - // Only send this email for invoices created via the admin page. |
|
| 224 | - if ( $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
| 225 | - return; |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 229 | - $recipient = wpinv_get_admin_email(); |
|
| 230 | - |
|
| 231 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 232 | - |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - /** |
|
| 236 | - * Sends a cancelled invoice notification. |
|
| 237 | - * |
|
| 238 | - * @param WPInv_Invoice $invoice |
|
| 239 | - */ |
|
| 240 | - public function cancelled_invoice( $invoice ) { |
|
| 15 | + /** |
|
| 16 | + * The array of invoice email actions. |
|
| 17 | + * |
|
| 18 | + * @param array |
|
| 19 | + */ |
|
| 20 | + public $invoice_actions; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Class constructor |
|
| 24 | + * |
|
| 25 | + */ |
|
| 26 | + public function __construct() { |
|
| 27 | + |
|
| 28 | + $this->invoice_actions = apply_filters( |
|
| 29 | + 'getpaid_notification_email_invoice_triggers', |
|
| 30 | + array( |
|
| 31 | + 'getpaid_new_invoice' => array( 'new_invoice', 'user_invoice' ), |
|
| 32 | + 'getpaid_invoice_status_wpi-cancelled' => 'cancelled_invoice', |
|
| 33 | + 'getpaid_invoice_status_wpi-failed' => 'failed_invoice', |
|
| 34 | + 'getpaid_invoice_status_wpi-onhold' => 'onhold_invoice', |
|
| 35 | + 'getpaid_invoice_status_wpi-processing' => 'processing_invoice', |
|
| 36 | + 'getpaid_invoice_status_publish' => 'completed_invoice', |
|
| 37 | + 'getpaid_invoice_status_wpi-renewal' => 'completed_invoice', |
|
| 38 | + 'getpaid_invoice_status_wpi-refunded' => 'refunded_invoice', |
|
| 39 | + 'getpaid_new_customer_note' => 'user_note', |
|
| 40 | + 'getpaid_daily_maintenance' => 'overdue', |
|
| 41 | + ) |
|
| 42 | + ); |
|
| 43 | + |
|
| 44 | + $this->init_hooks(); |
|
| 45 | + |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Registers email hooks. |
|
| 50 | + */ |
|
| 51 | + public function init_hooks() { |
|
| 52 | + |
|
| 53 | + add_filter( 'getpaid_get_email_merge_tags', array( $this, 'invoice_merge_tags' ), 10, 2 ); |
|
| 54 | + add_filter( 'getpaid_invoice_email_recipients', array( $this, 'filter_email_recipients' ), 10, 2 ); |
|
| 55 | + |
|
| 56 | + foreach ( $this->invoice_actions as $hook => $email_type ) { |
|
| 57 | + $this->init_email_type_hook( $hook, $email_type ); |
|
| 58 | + } |
|
| 59 | + } |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Registers an email hook for an invoice action. |
|
| 63 | + * |
|
| 64 | + * @param string $hook |
|
| 65 | + * @param string|array $email_type |
|
| 66 | + */ |
|
| 67 | + public function init_email_type_hook( $hook, $email_type ) { |
|
| 68 | + |
|
| 69 | + $email_type = wpinv_parse_list( $email_type ); |
|
| 70 | + |
|
| 71 | + foreach ( $email_type as $type ) { |
|
| 72 | + |
|
| 73 | + $email = new GetPaid_Notification_Email( $type ); |
|
| 74 | + |
|
| 75 | + // Abort if it is not active. |
|
| 76 | + if ( ! $email->is_active() ) { |
|
| 77 | + continue; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + if ( method_exists( $this, $type ) ) { |
|
| 81 | + add_action( $hook, array( $this, $type ), 100, 2 ); |
|
| 82 | + continue; |
|
| 83 | + } |
|
| 84 | + |
|
| 85 | + do_action( 'getpaid_invoice_init_email_type_hook', $type ); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Filters invoice merge tags. |
|
| 92 | + * |
|
| 93 | + * @param array $merge_tags |
|
| 94 | + * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
| 95 | + */ |
|
| 96 | + public function invoice_merge_tags( $merge_tags, $object ) { |
|
| 97 | + |
|
| 98 | + if ( is_a( $object, 'WPInv_Invoice' ) ) { |
|
| 99 | + return array_merge( |
|
| 100 | + $merge_tags, |
|
| 101 | + $this->get_invoice_merge_tags( $object ) |
|
| 102 | + ); |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 106 | + return array_merge( |
|
| 107 | + $merge_tags, |
|
| 108 | + $this->get_invoice_merge_tags( $object->get_parent_payment() ) |
|
| 109 | + ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + return $merge_tags; |
|
| 113 | + |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * Generates invoice merge tags. |
|
| 118 | + * |
|
| 119 | + * @param WPInv_Invoice $invoice |
|
| 120 | + * @return array |
|
| 121 | + */ |
|
| 122 | + public function get_invoice_merge_tags( $invoice ) { |
|
| 123 | + |
|
| 124 | + // Abort if it does not exist. |
|
| 125 | + if ( ! $invoice->get_id() ) { |
|
| 126 | + return array(); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + return array( |
|
| 130 | + '{name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 131 | + '{full_name}' => sanitize_text_field( $invoice->get_user_full_name() ), |
|
| 132 | + '{first_name}' => sanitize_text_field( $invoice->get_first_name() ), |
|
| 133 | + '{last_name}' => sanitize_text_field( $invoice->get_last_name() ), |
|
| 134 | + '{email}' => sanitize_email( $invoice->get_email() ), |
|
| 135 | + '{invoice_number}' => sanitize_text_field( $invoice->get_number() ), |
|
| 136 | + '{invoice_currency}' => sanitize_text_field( $invoice->get_currency() ), |
|
| 137 | + '{invoice_total}' => wpinv_price( wpinv_format_amount( $invoice->get_total() ) ), |
|
| 138 | + '{invoice_link}' => esc_url( $invoice->get_view_url() ), |
|
| 139 | + '{invoice_pay_link}' => esc_url( $invoice->get_checkout_payment_url() ), |
|
| 140 | + '{invoice_receipt_link}'=> esc_url( $invoice->get_receipt_url() ), |
|
| 141 | + '{invoice_date}' => getpaid_format_date_value( $invoice->get_date_created() ), |
|
| 142 | + '{invoice_due_date}' => getpaid_format_date_value( $invoice->get_due_date(), __( 'on receipt', 'invoicing' ) ), |
|
| 143 | + '{invoice_quote}' => sanitize_text_field( $invoice->get_type() ), |
|
| 144 | + '{invoice_label}' => sanitize_text_field( ucfirst( $invoice->get_type() ) ), |
|
| 145 | + '{invoice_description}' => wp_kses_post( $invoice->get_description() ), |
|
| 146 | + '{subscription_name}' => wp_kses_post( $invoice->get_subscription_name() ), |
|
| 147 | + '{is_was}' => strtotime( $invoice->get_due_date() ) < current_time( 'timestamp' ) ? __( 'was', 'invoicing' ) : __( 'is', 'invoicing' ), |
|
| 148 | + ); |
|
| 149 | + |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Helper function to send an email. |
|
| 154 | + * |
|
| 155 | + * @param WPInv_Invoice $invoice |
|
| 156 | + * @param GetPaid_Notification_Email $email |
|
| 157 | + * @param string $type |
|
| 158 | + * @param string|array $recipients |
|
| 159 | + * @param array $extra_args Extra template args. |
|
| 160 | + */ |
|
| 161 | + public function send_email( $invoice, $email, $type, $recipients, $extra_args = array() ) { |
|
| 162 | + |
|
| 163 | + do_action( 'getpaid_before_send_invoice_notification', $type, $invoice, $email ); |
|
| 164 | + |
|
| 165 | + $mailer = new GetPaid_Notification_Email_Sender(); |
|
| 166 | + $merge_tags = $email->get_merge_tags(); |
|
| 167 | + |
|
| 168 | + $result = $mailer->send( |
|
| 169 | + apply_filters( 'getpaid_invoice_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 170 | + $email->add_merge_tags( $email->get_subject(), $merge_tags ), |
|
| 171 | + $email->get_content( $merge_tags, $extra_args ), |
|
| 172 | + $email->get_attachments() |
|
| 173 | + ); |
|
| 174 | + |
|
| 175 | + // Maybe send a copy to the admin. |
|
| 176 | + if ( $email->include_admin_bcc() ) { |
|
| 177 | + $mailer->send( |
|
| 178 | + wpinv_get_admin_email(), |
|
| 179 | + $email->add_merge_tags( $email->get_subject() . __( ' - ADMIN BCC COPY', 'invoicing' ), $merge_tags ), |
|
| 180 | + $email->get_content( $merge_tags ), |
|
| 181 | + $email->get_attachments() |
|
| 182 | + ); |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + if ( ! $result ) { |
|
| 186 | + $invoice->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + do_action( 'getpaid_after_send_invoice_notification', $type, $invoice, $email ); |
|
| 190 | + |
|
| 191 | + return $result; |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + /** |
|
| 195 | + * Also send emails to any cc users. |
|
| 196 | + * |
|
| 197 | + * @param array $recipients |
|
| 198 | + * @param GetPaid_Notification_Email $email |
|
| 199 | + */ |
|
| 200 | + public function filter_email_recipients( $recipients, $email ) { |
|
| 201 | + |
|
| 202 | + if ( ! $email->is_admin_email() ) { |
|
| 203 | + $cc = $email->object->get_email_cc(); |
|
| 204 | + |
|
| 205 | + if ( ! empty( $cc ) ) { |
|
| 206 | + $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 207 | + $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + return $recipients; |
|
| 213 | + |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + /** |
|
| 217 | + * Sends a new invoice notification. |
|
| 218 | + * |
|
| 219 | + * @param WPInv_Invoice $invoice |
|
| 220 | + */ |
|
| 221 | + public function new_invoice( $invoice ) { |
|
| 222 | + |
|
| 223 | + // Only send this email for invoices created via the admin page. |
|
| 224 | + if ( $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
| 225 | + return; |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 229 | + $recipient = wpinv_get_admin_email(); |
|
| 230 | + |
|
| 231 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 232 | + |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + /** |
|
| 236 | + * Sends a cancelled invoice notification. |
|
| 237 | + * |
|
| 238 | + * @param WPInv_Invoice $invoice |
|
| 239 | + */ |
|
| 240 | + public function cancelled_invoice( $invoice ) { |
|
| 241 | 241 | |
| 242 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 243 | - $recipient = wpinv_get_admin_email(); |
|
| 242 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 243 | + $recipient = wpinv_get_admin_email(); |
|
| 244 | 244 | |
| 245 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 245 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 246 | 246 | |
| 247 | - } |
|
| 247 | + } |
|
| 248 | 248 | |
| 249 | - /** |
|
| 250 | - * Sends a failed invoice notification. |
|
| 251 | - * |
|
| 252 | - * @param WPInv_Invoice $invoice |
|
| 253 | - */ |
|
| 254 | - public function failed_invoice( $invoice ) { |
|
| 249 | + /** |
|
| 250 | + * Sends a failed invoice notification. |
|
| 251 | + * |
|
| 252 | + * @param WPInv_Invoice $invoice |
|
| 253 | + */ |
|
| 254 | + public function failed_invoice( $invoice ) { |
|
| 255 | 255 | |
| 256 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 257 | - $recipient = wpinv_get_admin_email(); |
|
| 256 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 257 | + $recipient = wpinv_get_admin_email(); |
|
| 258 | 258 | |
| 259 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 259 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 260 | 260 | |
| 261 | - } |
|
| 261 | + } |
|
| 262 | 262 | |
| 263 | - /** |
|
| 264 | - * Sends a notification whenever an invoice is put on hold. |
|
| 265 | - * |
|
| 266 | - * @param WPInv_Invoice $invoice |
|
| 267 | - */ |
|
| 268 | - public function onhold_invoice( $invoice ) { |
|
| 263 | + /** |
|
| 264 | + * Sends a notification whenever an invoice is put on hold. |
|
| 265 | + * |
|
| 266 | + * @param WPInv_Invoice $invoice |
|
| 267 | + */ |
|
| 268 | + public function onhold_invoice( $invoice ) { |
|
| 269 | 269 | |
| 270 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 271 | - $recipient = $invoice->get_email(); |
|
| 270 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 271 | + $recipient = $invoice->get_email(); |
|
| 272 | 272 | |
| 273 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 273 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 274 | 274 | |
| 275 | - } |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Sends a notification whenever an invoice is marked as processing payment. |
|
| 279 | - * |
|
| 280 | - * @param WPInv_Invoice $invoice |
|
| 281 | - */ |
|
| 282 | - public function processing_invoice( $invoice ) { |
|
| 277 | + /** |
|
| 278 | + * Sends a notification whenever an invoice is marked as processing payment. |
|
| 279 | + * |
|
| 280 | + * @param WPInv_Invoice $invoice |
|
| 281 | + */ |
|
| 282 | + public function processing_invoice( $invoice ) { |
|
| 283 | 283 | |
| 284 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 285 | - $recipient = $invoice->get_email(); |
|
| 284 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 285 | + $recipient = $invoice->get_email(); |
|
| 286 | 286 | |
| 287 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 287 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 288 | 288 | |
| 289 | - } |
|
| 289 | + } |
|
| 290 | 290 | |
| 291 | - /** |
|
| 292 | - * Sends a notification whenever an invoice is paid. |
|
| 293 | - * |
|
| 294 | - * @param WPInv_Invoice $invoice |
|
| 295 | - */ |
|
| 296 | - public function completed_invoice( $invoice ) { |
|
| 291 | + /** |
|
| 292 | + * Sends a notification whenever an invoice is paid. |
|
| 293 | + * |
|
| 294 | + * @param WPInv_Invoice $invoice |
|
| 295 | + */ |
|
| 296 | + public function completed_invoice( $invoice ) { |
|
| 297 | 297 | |
| 298 | - // (Maybe) abort if it is a renewal invoice. |
|
| 299 | - if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
| 300 | - return; |
|
| 301 | - } |
|
| 298 | + // (Maybe) abort if it is a renewal invoice. |
|
| 299 | + if ( $invoice->is_renewal() && ! wpinv_get_option( 'email_completed_invoice_renewal_active', false ) ) { |
|
| 300 | + return; |
|
| 301 | + } |
|
| 302 | 302 | |
| 303 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 304 | - $recipient = $invoice->get_email(); |
|
| 303 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 304 | + $recipient = $invoice->get_email(); |
|
| 305 | 305 | |
| 306 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 306 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 307 | 307 | |
| 308 | - } |
|
| 308 | + } |
|
| 309 | 309 | |
| 310 | - /** |
|
| 311 | - * Sends a notification whenever an invoice is refunded. |
|
| 312 | - * |
|
| 313 | - * @param WPInv_Invoice $invoice |
|
| 314 | - */ |
|
| 315 | - public function refunded_invoice( $invoice ) { |
|
| 310 | + /** |
|
| 311 | + * Sends a notification whenever an invoice is refunded. |
|
| 312 | + * |
|
| 313 | + * @param WPInv_Invoice $invoice |
|
| 314 | + */ |
|
| 315 | + public function refunded_invoice( $invoice ) { |
|
| 316 | 316 | |
| 317 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 318 | - $recipient = $invoice->get_email(); |
|
| 317 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 318 | + $recipient = $invoice->get_email(); |
|
| 319 | 319 | |
| 320 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 320 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 321 | 321 | |
| 322 | - } |
|
| 322 | + } |
|
| 323 | 323 | |
| 324 | - /** |
|
| 325 | - * Notifies a user about new invoices |
|
| 326 | - * |
|
| 327 | - * @param WPInv_Invoice $invoice |
|
| 328 | - */ |
|
| 329 | - public function user_invoice( $invoice ) { |
|
| 324 | + /** |
|
| 325 | + * Notifies a user about new invoices |
|
| 326 | + * |
|
| 327 | + * @param WPInv_Invoice $invoice |
|
| 328 | + */ |
|
| 329 | + public function user_invoice( $invoice ) { |
|
| 330 | 330 | |
| 331 | - // Only send this email for invoices created via the admin page. |
|
| 332 | - if ( $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
| 333 | - return; |
|
| 334 | - } |
|
| 331 | + // Only send this email for invoices created via the admin page. |
|
| 332 | + if ( $this->is_payment_form_invoice( $invoice->get_id() ) ) { |
|
| 333 | + return; |
|
| 334 | + } |
|
| 335 | 335 | |
| 336 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 337 | - $recipient = $invoice->get_email(); |
|
| 336 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 337 | + $recipient = $invoice->get_email(); |
|
| 338 | 338 | |
| 339 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 339 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient ); |
|
| 340 | 340 | |
| 341 | - } |
|
| 341 | + } |
|
| 342 | 342 | |
| 343 | - /** |
|
| 344 | - * Checks if an invoice is a payment form invoice. |
|
| 345 | - * |
|
| 346 | - * @param int $invoice |
|
| 347 | - * @return bool |
|
| 348 | - */ |
|
| 349 | - public function is_payment_form_invoice( $invoice ) { |
|
| 350 | - return empty( $_GET['getpaid-admin-action'] ) && 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ); |
|
| 351 | - } |
|
| 343 | + /** |
|
| 344 | + * Checks if an invoice is a payment form invoice. |
|
| 345 | + * |
|
| 346 | + * @param int $invoice |
|
| 347 | + * @return bool |
|
| 348 | + */ |
|
| 349 | + public function is_payment_form_invoice( $invoice ) { |
|
| 350 | + return empty( $_GET['getpaid-admin-action'] ) && 'payment_form' == get_post_meta( $invoice, 'wpinv_created_via', true ); |
|
| 351 | + } |
|
| 352 | 352 | |
| 353 | - /** |
|
| 354 | - * Notifies admin about new invoice notes |
|
| 355 | - * |
|
| 356 | - * @param WPInv_Invoice $invoice |
|
| 357 | - * @param string $note |
|
| 358 | - */ |
|
| 359 | - public function user_note( $invoice, $note ) { |
|
| 353 | + /** |
|
| 354 | + * Notifies admin about new invoice notes |
|
| 355 | + * |
|
| 356 | + * @param WPInv_Invoice $invoice |
|
| 357 | + * @param string $note |
|
| 358 | + */ |
|
| 359 | + public function user_note( $invoice, $note ) { |
|
| 360 | 360 | |
| 361 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 362 | - $recipient = $invoice->get_email(); |
|
| 363 | - |
|
| 364 | - return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
| 365 | - |
|
| 366 | - } |
|
| 361 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $invoice ); |
|
| 362 | + $recipient = $invoice->get_email(); |
|
| 363 | + |
|
| 364 | + return $this->send_email( $invoice, $email, __FUNCTION__, $recipient, array( 'customer_note' => $note ) ); |
|
| 365 | + |
|
| 366 | + } |
|
| 367 | 367 | |
| 368 | - /** |
|
| 369 | - * (Force) Sends overdue notices. |
|
| 370 | - * |
|
| 371 | - * @param WPInv_Invoice $invoice |
|
| 372 | - */ |
|
| 373 | - public function force_send_overdue_notice( $invoice ) { |
|
| 374 | - $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
| 375 | - return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - /** |
|
| 379 | - * Sends overdue notices. |
|
| 380 | - * |
|
| 381 | - * @TODO: Create an invoices query class. |
|
| 382 | - */ |
|
| 383 | - public function overdue() { |
|
| 384 | - global $wpdb; |
|
| 385 | - |
|
| 386 | - $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 387 | - |
|
| 388 | - // Fetch reminder days. |
|
| 389 | - $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 390 | - |
|
| 391 | - // Abort if non is set. |
|
| 392 | - if ( empty( $reminder_days ) ) { |
|
| 393 | - return; |
|
| 394 | - } |
|
| 395 | - |
|
| 396 | - // Retrieve date query. |
|
| 397 | - $date_query = $this->get_date_query( $reminder_days ); |
|
| 398 | - |
|
| 399 | - // Invoices table. |
|
| 400 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 401 | - |
|
| 402 | - // Fetch invoices. |
|
| 403 | - $invoices = $wpdb->get_col( |
|
| 404 | - "SELECT posts.ID FROM $wpdb->posts as posts |
|
| 368 | + /** |
|
| 369 | + * (Force) Sends overdue notices. |
|
| 370 | + * |
|
| 371 | + * @param WPInv_Invoice $invoice |
|
| 372 | + */ |
|
| 373 | + public function force_send_overdue_notice( $invoice ) { |
|
| 374 | + $email = new GetPaid_Notification_Email( 'overdue', $invoice ); |
|
| 375 | + return $this->send_email( $invoice, $email, 'overdue', $invoice->get_email() ); |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + /** |
|
| 379 | + * Sends overdue notices. |
|
| 380 | + * |
|
| 381 | + * @TODO: Create an invoices query class. |
|
| 382 | + */ |
|
| 383 | + public function overdue() { |
|
| 384 | + global $wpdb; |
|
| 385 | + |
|
| 386 | + $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 387 | + |
|
| 388 | + // Fetch reminder days. |
|
| 389 | + $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 390 | + |
|
| 391 | + // Abort if non is set. |
|
| 392 | + if ( empty( $reminder_days ) ) { |
|
| 393 | + return; |
|
| 394 | + } |
|
| 395 | + |
|
| 396 | + // Retrieve date query. |
|
| 397 | + $date_query = $this->get_date_query( $reminder_days ); |
|
| 398 | + |
|
| 399 | + // Invoices table. |
|
| 400 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 401 | + |
|
| 402 | + // Fetch invoices. |
|
| 403 | + $invoices = $wpdb->get_col( |
|
| 404 | + "SELECT posts.ID FROM $wpdb->posts as posts |
|
| 405 | 405 | LEFT JOIN $table as invoices ON invoices.post_id = posts.ID |
| 406 | 406 | WHERE posts.post_type = 'wpi_invoice' AND posts.post_status = 'wpi-pending' $date_query"); |
| 407 | 407 | |
| 408 | - foreach ( $invoices as $invoice ) { |
|
| 408 | + foreach ( $invoices as $invoice ) { |
|
| 409 | 409 | |
| 410 | - // Only send this email for invoices created via the admin page. |
|
| 411 | - if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
| 412 | - $invoice = new WPInv_Invoice( $invoice ); |
|
| 413 | - $email->object = $invoice; |
|
| 410 | + // Only send this email for invoices created via the admin page. |
|
| 411 | + if ( ! $this->is_payment_form_invoice( $invoice ) ) { |
|
| 412 | + $invoice = new WPInv_Invoice( $invoice ); |
|
| 413 | + $email->object = $invoice; |
|
| 414 | 414 | |
| 415 | - if ( $invoice->needs_payment() ) { |
|
| 416 | - $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
| 417 | - } |
|
| 415 | + if ( $invoice->needs_payment() ) { |
|
| 416 | + $this->send_email( $invoice, $email, __FUNCTION__, $invoice->get_email() ); |
|
| 417 | + } |
|
| 418 | 418 | |
| 419 | - } |
|
| 419 | + } |
|
| 420 | 420 | |
| 421 | - } |
|
| 421 | + } |
|
| 422 | 422 | |
| 423 | - } |
|
| 423 | + } |
|
| 424 | 424 | |
| 425 | - /** |
|
| 426 | - * Calculates the date query for an invoices query |
|
| 427 | - * |
|
| 428 | - * @param array $reminder_days |
|
| 429 | - * @return string |
|
| 430 | - */ |
|
| 431 | - public function get_date_query( $reminder_days ) { |
|
| 425 | + /** |
|
| 426 | + * Calculates the date query for an invoices query |
|
| 427 | + * |
|
| 428 | + * @param array $reminder_days |
|
| 429 | + * @return string |
|
| 430 | + */ |
|
| 431 | + public function get_date_query( $reminder_days ) { |
|
| 432 | 432 | |
| 433 | - $date_query = array( |
|
| 434 | - 'relation' => 'OR' |
|
| 435 | - ); |
|
| 433 | + $date_query = array( |
|
| 434 | + 'relation' => 'OR' |
|
| 435 | + ); |
|
| 436 | 436 | |
| 437 | - foreach ( $reminder_days as $days ) { |
|
| 438 | - $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
| 437 | + foreach ( $reminder_days as $days ) { |
|
| 438 | + $date = date_parse( date( 'Y-m-d', strtotime( "-$days days", current_time( 'timestamp' ) ) ) ); |
|
| 439 | 439 | |
| 440 | - $date_query[] = array( |
|
| 441 | - 'year' => $date['year'], |
|
| 442 | - 'month' => $date['month'], |
|
| 443 | - 'day' => $date['day'], |
|
| 444 | - ); |
|
| 440 | + $date_query[] = array( |
|
| 441 | + 'year' => $date['year'], |
|
| 442 | + 'month' => $date['month'], |
|
| 443 | + 'day' => $date['day'], |
|
| 444 | + ); |
|
| 445 | 445 | |
| 446 | - } |
|
| 446 | + } |
|
| 447 | 447 | |
| 448 | - $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
| 448 | + $date_query = new WP_Date_Query( $date_query, 'invoices.due_date' ); |
|
| 449 | 449 | |
| 450 | - return $date_query->get_sql(); |
|
| 450 | + return $date_query->get_sql(); |
|
| 451 | 451 | |
| 452 | - } |
|
| 452 | + } |
|
| 453 | 453 | |
| 454 | 454 | } |
@@ -13,17 +13,17 @@ discard block |
||
| 13 | 13 | class GetPaid_Notification_Email_Sender { |
| 14 | 14 | |
| 15 | 15 | /** |
| 16 | - * Whether or not we should inline CSS into the email. |
|
| 17 | - */ |
|
| 18 | - public $inline_css = true; |
|
| 16 | + * Whether or not we should inline CSS into the email. |
|
| 17 | + */ |
|
| 18 | + public $inline_css = true; |
|
| 19 | 19 | |
| 20 | 20 | /** |
| 21 | - * The wp_mail() data. |
|
| 22 | - */ |
|
| 21 | + * The wp_mail() data. |
|
| 22 | + */ |
|
| 23 | 23 | public $wp_mail_data = null; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * Sends a new email. |
|
| 26 | + * Sends a new email. |
|
| 27 | 27 | * |
| 28 | 28 | * @param string|array $to The recipients email or an array of recipient emails. |
| 29 | 29 | * @param string $subject The email's subject. |
@@ -31,49 +31,49 @@ discard block |
||
| 31 | 31 | * @param array $attachments The email attachments. |
| 32 | 32 | * |
| 33 | 33 | * @return bool |
| 34 | - */ |
|
| 35 | - public function send( $to, $subject, $email, $attachments = array() ) { |
|
| 34 | + */ |
|
| 35 | + public function send( $to, $subject, $email, $attachments = array() ) { |
|
| 36 | 36 | |
| 37 | - /* |
|
| 37 | + /* |
|
| 38 | 38 | * Allow to filter data on per-email basis. |
| 39 | 39 | */ |
| 40 | - $data = apply_filters( |
|
| 41 | - 'getpaid_email_data', |
|
| 42 | - array( |
|
| 43 | - 'to' => array_filter( array_unique( wpinv_parse_list( $to ) ) ), |
|
| 44 | - 'subject' => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ), |
|
| 45 | - 'email' => $email, |
|
| 46 | - 'headers' => $this->get_headers(), |
|
| 47 | - 'attachments' => $attachments, |
|
| 48 | - ), |
|
| 49 | - $this |
|
| 50 | - ); |
|
| 40 | + $data = apply_filters( |
|
| 41 | + 'getpaid_email_data', |
|
| 42 | + array( |
|
| 43 | + 'to' => array_filter( array_unique( wpinv_parse_list( $to ) ) ), |
|
| 44 | + 'subject' => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ), |
|
| 45 | + 'email' => $email, |
|
| 46 | + 'headers' => $this->get_headers(), |
|
| 47 | + 'attachments' => $attachments, |
|
| 48 | + ), |
|
| 49 | + $this |
|
| 50 | + ); |
|
| 51 | 51 | |
| 52 | 52 | // Remove slashes. |
| 53 | 53 | $data = (array) wp_unslash( $data ); |
| 54 | 54 | |
| 55 | 55 | // Cache it. |
| 56 | - $this->wp_mail_data = $data; |
|
| 56 | + $this->wp_mail_data = $data; |
|
| 57 | 57 | |
| 58 | - // Attach our own hooks. |
|
| 59 | - $this->before_sending(); |
|
| 58 | + // Attach our own hooks. |
|
| 59 | + $this->before_sending(); |
|
| 60 | 60 | |
| 61 | 61 | $result = false; |
| 62 | 62 | |
| 63 | 63 | foreach ( $this->wp_mail_data['to'] as $to ) { |
| 64 | - $result = $this->_send( $to, $data ); |
|
| 64 | + $result = $this->_send( $to, $data ); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | - // Remove our hooks. |
|
| 68 | - $this->after_sending(); |
|
| 67 | + // Remove our hooks. |
|
| 68 | + $this->after_sending(); |
|
| 69 | 69 | |
| 70 | - $this->wp_mail_data = null; |
|
| 70 | + $this->wp_mail_data = null; |
|
| 71 | 71 | |
| 72 | - return $result; |
|
| 73 | - } |
|
| 72 | + return $result; |
|
| 73 | + } |
|
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Does the actual sending. |
|
| 75 | + /** |
|
| 76 | + * Does the actual sending. |
|
| 77 | 77 | * |
| 78 | 78 | * @param string $to The recipient's email. |
| 79 | 79 | * @param array $data The email's data. |
@@ -81,81 +81,81 @@ discard block |
||
| 81 | 81 | * @param array $attachments The email attachments. |
| 82 | 82 | * |
| 83 | 83 | * @return bool |
| 84 | - */ |
|
| 85 | - protected function _send( $to, $data ) { |
|
| 86 | - |
|
| 87 | - // Prepare the sending function. |
|
| 88 | - $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' ); |
|
| 89 | - |
|
| 90 | - // Send the actual email. |
|
| 91 | - $result = call_user_func( |
|
| 92 | - $sending_function, |
|
| 93 | - $to, |
|
| 94 | - html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ), |
|
| 95 | - $data['email'], |
|
| 96 | - $data['headers'], |
|
| 97 | - $data['attachments'] |
|
| 98 | - ); |
|
| 99 | - |
|
| 100 | - if ( ! $result ) { |
|
| 101 | - $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] ); |
|
| 102 | - wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ ); |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - return $result; |
|
| 106 | - } |
|
| 84 | + */ |
|
| 85 | + protected function _send( $to, $data ) { |
|
| 86 | + |
|
| 87 | + // Prepare the sending function. |
|
| 88 | + $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' ); |
|
| 89 | + |
|
| 90 | + // Send the actual email. |
|
| 91 | + $result = call_user_func( |
|
| 92 | + $sending_function, |
|
| 93 | + $to, |
|
| 94 | + html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ), |
|
| 95 | + $data['email'], |
|
| 96 | + $data['headers'], |
|
| 97 | + $data['attachments'] |
|
| 98 | + ); |
|
| 99 | + |
|
| 100 | + if ( ! $result ) { |
|
| 101 | + $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] ); |
|
| 102 | + wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ ); |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + return $result; |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | 108 | /** |
| 109 | - * Retrieves email headers. |
|
| 110 | - */ |
|
| 111 | - public function get_headers() { |
|
| 109 | + * Retrieves email headers. |
|
| 110 | + */ |
|
| 111 | + public function get_headers() { |
|
| 112 | 112 | |
| 113 | - $name = $this->get_from_name(); |
|
| 114 | - $reply_to = $this->get_reply_to(); |
|
| 115 | - $headers = array( "Reply-To:$name <$reply_to>" ); |
|
| 113 | + $name = $this->get_from_name(); |
|
| 114 | + $reply_to = $this->get_reply_to(); |
|
| 115 | + $headers = array( "Reply-To:$name <$reply_to>" ); |
|
| 116 | 116 | |
| 117 | - return apply_filters( 'getpaid_email_headers', $headers, $this ); |
|
| 117 | + return apply_filters( 'getpaid_email_headers', $headers, $this ); |
|
| 118 | 118 | |
| 119 | - } |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | 121 | /** |
| 122 | - * Fires before an email is sent |
|
| 123 | - * |
|
| 124 | - * @since 1.0.0 |
|
| 125 | - */ |
|
| 126 | - public function before_sending() { |
|
| 122 | + * Fires before an email is sent |
|
| 123 | + * |
|
| 124 | + * @since 1.0.0 |
|
| 125 | + */ |
|
| 126 | + public function before_sending() { |
|
| 127 | 127 | |
| 128 | 128 | do_action( 'getpaid_before_send_email', $this ); |
| 129 | - add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
| 130 | - add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
| 131 | - add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
| 132 | - add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000000 ); |
|
| 129 | + add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
| 130 | + add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
| 131 | + add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
| 132 | + add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000000 ); |
|
| 133 | 133 | |
| 134 | - } |
|
| 134 | + } |
|
| 135 | 135 | |
| 136 | 136 | /** |
| 137 | - * Returns the from name. |
|
| 138 | - */ |
|
| 139 | - public function get_from_name() { |
|
| 137 | + * Returns the from name. |
|
| 138 | + */ |
|
| 139 | + public function get_from_name() { |
|
| 140 | 140 | |
| 141 | 141 | $from_name = wpinv_get_option( 'email_from_name', get_bloginfo( 'name' ) ); |
| 142 | 142 | |
| 143 | - if ( empty( $from_name ) ) { |
|
| 144 | - $from_name = get_bloginfo( 'name' ); |
|
| 143 | + if ( empty( $from_name ) ) { |
|
| 144 | + $from_name = get_bloginfo( 'name' ); |
|
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - return wp_specialchars_decode( $from_name, ENT_QUOTES ); |
|
| 147 | + return wp_specialchars_decode( $from_name, ENT_QUOTES ); |
|
| 148 | 148 | } |
| 149 | 149 | |
| 150 | 150 | /** |
| 151 | - * Returns the from email. |
|
| 152 | - */ |
|
| 153 | - public function get_from_address() { |
|
| 151 | + * Returns the from email. |
|
| 152 | + */ |
|
| 153 | + public function get_from_address() { |
|
| 154 | 154 | |
| 155 | 155 | $from_address = wpinv_get_option( 'email_from', $this->default_from_address() ); |
| 156 | 156 | |
| 157 | - if ( ! is_email( $from_address ) ) { |
|
| 158 | - $from_address = $this->default_from_address(); |
|
| 157 | + if ( ! is_email( $from_address ) ) { |
|
| 158 | + $from_address = $this->default_from_address(); |
|
| 159 | 159 | } |
| 160 | 160 | |
| 161 | 161 | return $from_address; |
@@ -163,75 +163,75 @@ discard block |
||
| 163 | 163 | } |
| 164 | 164 | |
| 165 | 165 | /** |
| 166 | - * The default emails from address. |
|
| 167 | - * |
|
| 168 | - * Defaults to wordpress@$sitename |
|
| 169 | - * Some hosts will block outgoing mail from this address if it doesn't exist, |
|
| 170 | - * but there's no easy alternative. Defaulting to admin_email might appear to be |
|
| 171 | - * another option, but some hosts may refuse to relay mail from an unknown domain. |
|
| 172 | - * |
|
| 173 | - */ |
|
| 174 | - public function default_from_address() { |
|
| 175 | - |
|
| 176 | - // Get the site domain and get rid of www. |
|
| 177 | - $sitename = strtolower( $_SERVER['SERVER_NAME'] ); |
|
| 178 | - if ( substr( $sitename, 0, 4 ) == 'www.' ) { |
|
| 179 | - $sitename = substr( $sitename, 4 ); |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - $from_email = 'wordpress@' . $sitename; |
|
| 183 | - |
|
| 184 | - return apply_filters( 'getpaid_default_from_address', $from_email ); |
|
| 166 | + * The default emails from address. |
|
| 167 | + * |
|
| 168 | + * Defaults to wordpress@$sitename |
|
| 169 | + * Some hosts will block outgoing mail from this address if it doesn't exist, |
|
| 170 | + * but there's no easy alternative. Defaulting to admin_email might appear to be |
|
| 171 | + * another option, but some hosts may refuse to relay mail from an unknown domain. |
|
| 172 | + * |
|
| 173 | + */ |
|
| 174 | + public function default_from_address() { |
|
| 175 | + |
|
| 176 | + // Get the site domain and get rid of www. |
|
| 177 | + $sitename = strtolower( $_SERVER['SERVER_NAME'] ); |
|
| 178 | + if ( substr( $sitename, 0, 4 ) == 'www.' ) { |
|
| 179 | + $sitename = substr( $sitename, 4 ); |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + $from_email = 'wordpress@' . $sitename; |
|
| 183 | + |
|
| 184 | + return apply_filters( 'getpaid_default_from_address', $from_email ); |
|
| 185 | 185 | |
| 186 | 186 | } |
| 187 | 187 | |
| 188 | 188 | /** |
| 189 | - * Get the email reply-to. |
|
| 190 | - * |
|
| 191 | - * |
|
| 192 | - * @return string The email reply-to address. |
|
| 193 | - */ |
|
| 194 | - public function get_reply_to() { |
|
| 189 | + * Get the email reply-to. |
|
| 190 | + * |
|
| 191 | + * |
|
| 192 | + * @return string The email reply-to address. |
|
| 193 | + */ |
|
| 194 | + public function get_reply_to() { |
|
| 195 | 195 | |
| 196 | - $reply_to = wpinv_get_admin_email(); |
|
| 196 | + $reply_to = wpinv_get_admin_email(); |
|
| 197 | 197 | |
| 198 | - if ( ! is_email( $reply_to ) ) { |
|
| 199 | - $reply_to = get_option( 'admin_email' ); |
|
| 200 | - } |
|
| 198 | + if ( ! is_email( $reply_to ) ) { |
|
| 199 | + $reply_to = get_option( 'admin_email' ); |
|
| 200 | + } |
|
| 201 | 201 | |
| 202 | - return $reply_to; |
|
| 202 | + return $reply_to; |
|
| 203 | 203 | } |
| 204 | 204 | |
| 205 | 205 | /** |
| 206 | - * Get the email content type. |
|
| 207 | - * |
|
| 208 | - */ |
|
| 209 | - public function get_content_type() { |
|
| 210 | - return apply_filters( 'getpaid_email_content_type', 'text/html', $this ); |
|
| 206 | + * Get the email content type. |
|
| 207 | + * |
|
| 208 | + */ |
|
| 209 | + public function get_content_type() { |
|
| 210 | + return apply_filters( 'getpaid_email_content_type', 'text/html', $this ); |
|
| 211 | 211 | } |
| 212 | 212 | |
| 213 | 213 | /** |
| 214 | - * Ensures that our email messages are not messed up by template plugins. |
|
| 215 | - * |
|
| 216 | - * @return array wp_mail_data. |
|
| 217 | - */ |
|
| 218 | - public function ensure_email_content( $args ) { |
|
| 219 | - $args['message'] = $this->wp_mail_data['email']; |
|
| 220 | - return $args; |
|
| 214 | + * Ensures that our email messages are not messed up by template plugins. |
|
| 215 | + * |
|
| 216 | + * @return array wp_mail_data. |
|
| 217 | + */ |
|
| 218 | + public function ensure_email_content( $args ) { |
|
| 219 | + $args['message'] = $this->wp_mail_data['email']; |
|
| 220 | + return $args; |
|
| 221 | 221 | } |
| 222 | 222 | |
| 223 | 223 | /** |
| 224 | - * A little house keeping after an email is sent. |
|
| 225 | - * |
|
| 226 | - */ |
|
| 227 | - public function after_sending() { |
|
| 224 | + * A little house keeping after an email is sent. |
|
| 225 | + * |
|
| 226 | + */ |
|
| 227 | + public function after_sending() { |
|
| 228 | 228 | |
| 229 | 229 | do_action( 'getpaid_after_send_email', $this->wp_mail_data ); |
| 230 | - remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
| 231 | - remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
| 232 | - remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
| 233 | - remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000000 ); |
|
| 230 | + remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
| 231 | + remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
| 232 | + remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
| 233 | + remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000000 ); |
|
| 234 | 234 | |
| 235 | - } |
|
| 235 | + } |
|
| 236 | 236 | |
| 237 | 237 | } |
@@ -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(!empty($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(!empty($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(!empty($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 && !empty($args['placeholder']) && empty($args['data-placeholder'])){ |
|
| 673 | - $args['data-placeholder'] = esc_attr($args['placeholder']); |
|
| 674 | - $args['data-allow-clear'] = empty($args['data-allow-clear']) ? true : esc_attr($args['data-allow-clear']); |
|
| 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(!empty($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(!empty($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 && !empty($args['placeholder']) && empty($args['data-placeholder'])){ |
|
| 673 | + $args['data-placeholder'] = esc_attr($args['placeholder']); |
|
| 674 | + $args['data-allow-clear'] = empty($args['data-allow-clear']) ? true : esc_attr($args['data-allow-clear']); |
|
| 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(!empty($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 |