@@ -12,219 +12,219 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Graph_Downloader { |
14 | 14 | |
15 | - /** |
|
16 | - * @var GetPaid_Reports_Report |
|
17 | - */ |
|
18 | - public $handler; |
|
19 | - |
|
20 | - /** |
|
21 | - * Class constructor. |
|
22 | - * |
|
23 | - */ |
|
24 | - public function __construct() { |
|
25 | - $this->handler = new GetPaid_Reports_Report(); |
|
26 | - } |
|
27 | - |
|
28 | - /** |
|
29 | - * Prepares the datastore handler. |
|
30 | - * |
|
31 | - * @return GetPaid_Reports_Report_Items|GetPaid_Reports_Report_Gateways|GetPaid_Reports_Report_Discounts |
|
32 | - */ |
|
33 | - public function prepare_handler( $graph ) { |
|
34 | - |
|
35 | - if ( empty( $this->handler->views[ $graph ] ) ) { |
|
36 | - wp_die( __( 'Invalid Graph', 'invoicing' ), 400 ); |
|
37 | - } |
|
38 | - |
|
39 | - return new $this->handler->views[ $graph ]['class'](); |
|
40 | - |
|
41 | - } |
|
42 | - |
|
43 | - /** |
|
44 | - * Prepares the output stream. |
|
45 | - * |
|
46 | - * @return resource |
|
47 | - */ |
|
48 | - public function prepare_output() { |
|
49 | - |
|
50 | - $output = fopen( 'php://output', 'w' ); |
|
51 | - |
|
52 | - if ( false === $output ) { |
|
53 | - wp_die( __( 'Unsupported server', 'invoicing' ), 500 ); |
|
54 | - } |
|
55 | - |
|
56 | - return $output; |
|
57 | - } |
|
58 | - |
|
59 | - /** |
|
60 | - * Prepares the file type. |
|
61 | - * |
|
62 | - * @return string |
|
63 | - */ |
|
64 | - public function prepare_file_type( $graph ) { |
|
65 | - |
|
66 | - $file_type = empty( $_REQUEST['file_type'] ) ? 'csv' : sanitize_text_field( $_REQUEST['file_type'] ); |
|
67 | - $file_name = wpinv_sanitize_key( "getpaid-$graph-" . current_time( 'Y-m-d' ) ); |
|
68 | - |
|
69 | - header( "Content-Type:application/$file_type" ); |
|
70 | - header( "Content-Disposition:attachment;filename=$file_name.$file_type" ); |
|
71 | - |
|
72 | - return $file_type; |
|
73 | - } |
|
74 | - |
|
75 | - /** |
|
76 | - * Handles the actual download. |
|
77 | - * |
|
78 | - */ |
|
79 | - public function download( $graph ) { |
|
80 | - global $wpdb; |
|
81 | - |
|
82 | - $handler = $this->prepare_handler( $graph ); |
|
83 | - $stream = $this->prepare_output(); |
|
84 | - $stats = $wpdb->get_results( $handler->get_sql( $handler->get_range() ) ); |
|
85 | - $headers = array( $handler->field, 'total', 'total_raw' ); |
|
86 | - $file_type = $this->prepare_file_type( $graph ); |
|
87 | - |
|
88 | - if ( 'csv' == $file_type ) { |
|
89 | - $this->download_csv( $stats, $stream, $headers ); |
|
90 | - } else if( 'xml' == $file_type ) { |
|
91 | - $this->download_xml( $stats, $stream, $headers ); |
|
92 | - } else { |
|
93 | - $this->download_json( $stats, $stream, $headers ); |
|
94 | - } |
|
95 | - |
|
96 | - fclose( $stream ); |
|
97 | - exit; |
|
98 | - } |
|
99 | - |
|
100 | - /** |
|
101 | - * Downloads graph as csv |
|
102 | - * |
|
103 | - * @param array $stats The stats being downloaded. |
|
104 | - * @param resource $stream The stream to output to. |
|
105 | - * @param array $headers The fields to stream. |
|
106 | - * @since 1.0.19 |
|
107 | - */ |
|
108 | - public function download_csv( $stats, $stream, $headers ) { |
|
109 | - |
|
110 | - // Output the csv column headers. |
|
111 | - fputcsv( $stream, $headers ); |
|
112 | - |
|
113 | - // Loop through |
|
114 | - foreach ( $stats as $stat ) { |
|
115 | - $row = array_values( $this->prepare_row( $stat, $headers ) ); |
|
116 | - $row = array_map( 'maybe_serialize', $row ); |
|
117 | - fputcsv( $stream, $row ); |
|
118 | - } |
|
119 | - |
|
120 | - } |
|
121 | - |
|
122 | - /** |
|
123 | - * Downloads graph as json |
|
124 | - * |
|
125 | - * @param array $stats The stats being downloaded. |
|
126 | - * @param resource $stream The stream to output to. |
|
127 | - * @param array $headers The fields to stream. |
|
128 | - * @since 1.0.19 |
|
129 | - */ |
|
130 | - public function download_json( $stats, $stream, $headers ) { |
|
131 | - |
|
132 | - $prepared = array(); |
|
133 | - |
|
134 | - // Loop through |
|
135 | - foreach ( $stats as $stat ) { |
|
136 | - $prepared[] = $this->prepare_row( $stat, $headers ); |
|
137 | - } |
|
138 | - |
|
139 | - fwrite( $stream, wp_json_encode( $prepared ) ); |
|
140 | - |
|
141 | - } |
|
142 | - |
|
143 | - /** |
|
144 | - * Downloads graph as xml |
|
145 | - * |
|
146 | - * @param array $stats The stats being downloaded. |
|
147 | - * @param resource $stream The stream to output to. |
|
148 | - * @param array $headers The fields to stream. |
|
149 | - * @since 1.0.19 |
|
150 | - */ |
|
151 | - public function download_xml( $stats, $stream, $headers ) { |
|
152 | - |
|
153 | - $prepared = array(); |
|
154 | - |
|
155 | - // Loop through |
|
156 | - foreach ( $stats as $stat ) { |
|
157 | - $prepared[] = $this->prepare_row( $stat, $headers ); |
|
158 | - } |
|
159 | - |
|
160 | - $xml = new SimpleXMLElement('<?xml version="1.0"?><data></data>'); |
|
161 | - $this->convert_array_xml( $prepared, $xml ); |
|
162 | - |
|
163 | - fwrite( $stream, $xml->asXML() ); |
|
164 | - |
|
165 | - } |
|
166 | - |
|
167 | - /** |
|
168 | - * Converts stats array to xml |
|
169 | - * |
|
170 | - * @access public |
|
171 | - * @since 1.0.19 |
|
172 | - */ |
|
173 | - public function convert_array_xml( $data, $xml ) { |
|
174 | - |
|
175 | - // Loop through |
|
176 | - foreach ( $data as $key => $value ) { |
|
177 | - |
|
178 | - $key = preg_replace( "/[^A-Za-z0-9_\-]/", '', $key ); |
|
179 | - |
|
180 | - if ( is_array( $value ) ) { |
|
181 | - |
|
182 | - if ( is_numeric( $key ) ){ |
|
183 | - $key = 'item'.$key; //dealing with <0/>..<n/> issues |
|
184 | - } |
|
185 | - |
|
186 | - $subnode = $xml->addChild( $key ); |
|
187 | - $this->convert_array_xml( $value, $subnode ); |
|
188 | - |
|
189 | - } else { |
|
190 | - $xml->addChild( $key, htmlspecialchars( $value ) ); |
|
191 | - } |
|
192 | - |
|
193 | - } |
|
15 | + /** |
|
16 | + * @var GetPaid_Reports_Report |
|
17 | + */ |
|
18 | + public $handler; |
|
19 | + |
|
20 | + /** |
|
21 | + * Class constructor. |
|
22 | + * |
|
23 | + */ |
|
24 | + public function __construct() { |
|
25 | + $this->handler = new GetPaid_Reports_Report(); |
|
26 | + } |
|
27 | + |
|
28 | + /** |
|
29 | + * Prepares the datastore handler. |
|
30 | + * |
|
31 | + * @return GetPaid_Reports_Report_Items|GetPaid_Reports_Report_Gateways|GetPaid_Reports_Report_Discounts |
|
32 | + */ |
|
33 | + public function prepare_handler( $graph ) { |
|
34 | + |
|
35 | + if ( empty( $this->handler->views[ $graph ] ) ) { |
|
36 | + wp_die( __( 'Invalid Graph', 'invoicing' ), 400 ); |
|
37 | + } |
|
38 | + |
|
39 | + return new $this->handler->views[ $graph ]['class'](); |
|
40 | + |
|
41 | + } |
|
42 | + |
|
43 | + /** |
|
44 | + * Prepares the output stream. |
|
45 | + * |
|
46 | + * @return resource |
|
47 | + */ |
|
48 | + public function prepare_output() { |
|
49 | + |
|
50 | + $output = fopen( 'php://output', 'w' ); |
|
51 | + |
|
52 | + if ( false === $output ) { |
|
53 | + wp_die( __( 'Unsupported server', 'invoicing' ), 500 ); |
|
54 | + } |
|
55 | + |
|
56 | + return $output; |
|
57 | + } |
|
58 | + |
|
59 | + /** |
|
60 | + * Prepares the file type. |
|
61 | + * |
|
62 | + * @return string |
|
63 | + */ |
|
64 | + public function prepare_file_type( $graph ) { |
|
65 | + |
|
66 | + $file_type = empty( $_REQUEST['file_type'] ) ? 'csv' : sanitize_text_field( $_REQUEST['file_type'] ); |
|
67 | + $file_name = wpinv_sanitize_key( "getpaid-$graph-" . current_time( 'Y-m-d' ) ); |
|
68 | + |
|
69 | + header( "Content-Type:application/$file_type" ); |
|
70 | + header( "Content-Disposition:attachment;filename=$file_name.$file_type" ); |
|
71 | + |
|
72 | + return $file_type; |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * Handles the actual download. |
|
77 | + * |
|
78 | + */ |
|
79 | + public function download( $graph ) { |
|
80 | + global $wpdb; |
|
81 | + |
|
82 | + $handler = $this->prepare_handler( $graph ); |
|
83 | + $stream = $this->prepare_output(); |
|
84 | + $stats = $wpdb->get_results( $handler->get_sql( $handler->get_range() ) ); |
|
85 | + $headers = array( $handler->field, 'total', 'total_raw' ); |
|
86 | + $file_type = $this->prepare_file_type( $graph ); |
|
87 | + |
|
88 | + if ( 'csv' == $file_type ) { |
|
89 | + $this->download_csv( $stats, $stream, $headers ); |
|
90 | + } else if( 'xml' == $file_type ) { |
|
91 | + $this->download_xml( $stats, $stream, $headers ); |
|
92 | + } else { |
|
93 | + $this->download_json( $stats, $stream, $headers ); |
|
94 | + } |
|
95 | + |
|
96 | + fclose( $stream ); |
|
97 | + exit; |
|
98 | + } |
|
99 | + |
|
100 | + /** |
|
101 | + * Downloads graph as csv |
|
102 | + * |
|
103 | + * @param array $stats The stats being downloaded. |
|
104 | + * @param resource $stream The stream to output to. |
|
105 | + * @param array $headers The fields to stream. |
|
106 | + * @since 1.0.19 |
|
107 | + */ |
|
108 | + public function download_csv( $stats, $stream, $headers ) { |
|
109 | + |
|
110 | + // Output the csv column headers. |
|
111 | + fputcsv( $stream, $headers ); |
|
112 | + |
|
113 | + // Loop through |
|
114 | + foreach ( $stats as $stat ) { |
|
115 | + $row = array_values( $this->prepare_row( $stat, $headers ) ); |
|
116 | + $row = array_map( 'maybe_serialize', $row ); |
|
117 | + fputcsv( $stream, $row ); |
|
118 | + } |
|
119 | + |
|
120 | + } |
|
121 | + |
|
122 | + /** |
|
123 | + * Downloads graph as json |
|
124 | + * |
|
125 | + * @param array $stats The stats being downloaded. |
|
126 | + * @param resource $stream The stream to output to. |
|
127 | + * @param array $headers The fields to stream. |
|
128 | + * @since 1.0.19 |
|
129 | + */ |
|
130 | + public function download_json( $stats, $stream, $headers ) { |
|
131 | + |
|
132 | + $prepared = array(); |
|
133 | + |
|
134 | + // Loop through |
|
135 | + foreach ( $stats as $stat ) { |
|
136 | + $prepared[] = $this->prepare_row( $stat, $headers ); |
|
137 | + } |
|
138 | + |
|
139 | + fwrite( $stream, wp_json_encode( $prepared ) ); |
|
140 | + |
|
141 | + } |
|
142 | + |
|
143 | + /** |
|
144 | + * Downloads graph as xml |
|
145 | + * |
|
146 | + * @param array $stats The stats being downloaded. |
|
147 | + * @param resource $stream The stream to output to. |
|
148 | + * @param array $headers The fields to stream. |
|
149 | + * @since 1.0.19 |
|
150 | + */ |
|
151 | + public function download_xml( $stats, $stream, $headers ) { |
|
152 | + |
|
153 | + $prepared = array(); |
|
154 | + |
|
155 | + // Loop through |
|
156 | + foreach ( $stats as $stat ) { |
|
157 | + $prepared[] = $this->prepare_row( $stat, $headers ); |
|
158 | + } |
|
159 | + |
|
160 | + $xml = new SimpleXMLElement('<?xml version="1.0"?><data></data>'); |
|
161 | + $this->convert_array_xml( $prepared, $xml ); |
|
162 | + |
|
163 | + fwrite( $stream, $xml->asXML() ); |
|
164 | + |
|
165 | + } |
|
166 | + |
|
167 | + /** |
|
168 | + * Converts stats array to xml |
|
169 | + * |
|
170 | + * @access public |
|
171 | + * @since 1.0.19 |
|
172 | + */ |
|
173 | + public function convert_array_xml( $data, $xml ) { |
|
174 | + |
|
175 | + // Loop through |
|
176 | + foreach ( $data as $key => $value ) { |
|
177 | + |
|
178 | + $key = preg_replace( "/[^A-Za-z0-9_\-]/", '', $key ); |
|
179 | + |
|
180 | + if ( is_array( $value ) ) { |
|
181 | + |
|
182 | + if ( is_numeric( $key ) ){ |
|
183 | + $key = 'item'.$key; //dealing with <0/>..<n/> issues |
|
184 | + } |
|
185 | + |
|
186 | + $subnode = $xml->addChild( $key ); |
|
187 | + $this->convert_array_xml( $value, $subnode ); |
|
188 | + |
|
189 | + } else { |
|
190 | + $xml->addChild( $key, htmlspecialchars( $value ) ); |
|
191 | + } |
|
192 | + |
|
193 | + } |
|
194 | 194 | |
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * Prepares a single row for download. |
|
199 | - * |
|
200 | - * @param stdClass|array $row The row to prepare.. |
|
201 | - * @param array $fields The fields to stream. |
|
202 | - * @since 1.0.19 |
|
203 | - * @return array |
|
204 | - */ |
|
205 | - public function prepare_row( $row, $fields ) { |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * Prepares a single row for download. |
|
199 | + * |
|
200 | + * @param stdClass|array $row The row to prepare.. |
|
201 | + * @param array $fields The fields to stream. |
|
202 | + * @since 1.0.19 |
|
203 | + * @return array |
|
204 | + */ |
|
205 | + public function prepare_row( $row, $fields ) { |
|
206 | 206 | |
207 | - $prepared = array(); |
|
208 | - $row = (array) $row; |
|
207 | + $prepared = array(); |
|
208 | + $row = (array) $row; |
|
209 | 209 | |
210 | - foreach ( $fields as $field ) { |
|
210 | + foreach ( $fields as $field ) { |
|
211 | 211 | |
212 | - if ( $field === 'total' ) { |
|
213 | - $prepared[ $field ] = html_entity_decode( strip_tags( wpinv_price( $row['total'] ) ), ENT_QUOTES ); |
|
214 | - continue; |
|
215 | - } |
|
212 | + if ( $field === 'total' ) { |
|
213 | + $prepared[ $field ] = html_entity_decode( strip_tags( wpinv_price( $row['total'] ) ), ENT_QUOTES ); |
|
214 | + continue; |
|
215 | + } |
|
216 | 216 | |
217 | - if ( $field === 'total_raw' ) { |
|
218 | - $prepared[ $field ] = wpinv_round_amount( wpinv_sanitize_amount( $row['total'] ) ); |
|
219 | - continue; |
|
220 | - } |
|
217 | + if ( $field === 'total_raw' ) { |
|
218 | + $prepared[ $field ] = wpinv_round_amount( wpinv_sanitize_amount( $row['total'] ) ); |
|
219 | + continue; |
|
220 | + } |
|
221 | 221 | |
222 | - $prepared[ $field ] = strip_tags( $row[ $field ] ); |
|
222 | + $prepared[ $field ] = strip_tags( $row[ $field ] ); |
|
223 | 223 | |
224 | - } |
|
224 | + } |
|
225 | 225 | |
226 | - return $prepared; |
|
227 | - } |
|
226 | + return $prepared; |
|
227 | + } |
|
228 | 228 | |
229 | 229 | |
230 | 230 | } |
@@ -12,194 +12,194 @@ |
||
12 | 12 | */ |
13 | 13 | class GetPaid_Invoice_Exporter extends GetPaid_Graph_Downloader { |
14 | 14 | |
15 | - /** |
|
16 | - * Retrieves invoices query args. |
|
17 | - * |
|
18 | - * @param string $post_type post type to retrieve. |
|
19 | - * @param array $args Args to search for. |
|
20 | - * @return array |
|
21 | - */ |
|
22 | - public function get_invoice_query_args( $post_type, $args ) { |
|
23 | - |
|
24 | - $query_args = array( |
|
25 | - 'post_type' => $post_type, |
|
26 | - 'post_status' => array_keys( wpinv_get_invoice_statuses( true, false, $post_type ) ), |
|
27 | - 'posts_per_page' => -1, |
|
28 | - 'no_found_rows' => true, |
|
29 | - 'update_post_term_cache' => false, |
|
30 | - 'fields' => 'ids', |
|
31 | - ); |
|
32 | - |
|
33 | - if ( ! empty( $args['status'] ) && in_array( $args['status'], $query_args['post_status'], true ) ) { |
|
34 | - $query_args['post_status'] = wpinv_clean( wpinv_parse_list( $args['status'] ) ); |
|
35 | - } |
|
36 | - |
|
37 | - $date_query = array(); |
|
38 | - if ( ! empty( $args['to_date'] ) ) { |
|
39 | - $date_query['before'] = wpinv_clean( $args['to_date'] ); |
|
40 | - } |
|
41 | - |
|
42 | - if ( ! empty( $args['from_date'] ) ) { |
|
43 | - $date_query['after'] = wpinv_clean( $args['from_date'] ); |
|
44 | - } |
|
45 | - |
|
46 | - if ( ! empty( $date_query ) ) { |
|
47 | - $date_query['inclusive'] = true; |
|
48 | - $query_args['date_query'] = array( $date_query ); |
|
49 | - } |
|
50 | - |
|
51 | - return $query_args; |
|
52 | - } |
|
53 | - |
|
54 | - /** |
|
55 | - * Retrieves invoices. |
|
56 | - * |
|
57 | - * @param array $query_args WP_Query args. |
|
58 | - * @return WPInv_Invoice[] |
|
59 | - */ |
|
60 | - public function get_invoices( $query_args ) { |
|
61 | - |
|
62 | - // Get invoices. |
|
63 | - $invoices = new WP_Query( $query_args ); |
|
64 | - |
|
65 | - // Prepare the results. |
|
66 | - return array_map( 'wpinv_get_invoice', $invoices->posts ); |
|
67 | - |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * Handles the actual download. |
|
72 | - * |
|
73 | - */ |
|
74 | - public function export( $post_type, $args ) { |
|
75 | - |
|
76 | - $invoices = $this->get_invoices( $this->get_invoice_query_args( $post_type, $args ) ); |
|
77 | - $stream = $this->prepare_output(); |
|
78 | - $headers = $this->get_export_fields( $post_type ); |
|
79 | - $file_type = $this->prepare_file_type( strtolower( getpaid_get_post_type_label( $post_type ) ) ); |
|
80 | - |
|
81 | - if ( 'csv' == $file_type ) { |
|
82 | - $this->download_csv( $invoices, $stream, $headers ); |
|
83 | - } else if( 'xml' == $file_type ) { |
|
84 | - $this->download_xml( $invoices, $stream, $headers ); |
|
85 | - } else { |
|
86 | - $this->download_json( $invoices, $stream, $headers ); |
|
87 | - } |
|
88 | - |
|
89 | - fclose( $stream ); |
|
90 | - exit; |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Prepares a single invoice for download. |
|
95 | - * |
|
96 | - * @param WPInv_Invoice $invoice The invoice to prepare.. |
|
97 | - * @param array $fields The fields to stream. |
|
98 | - * @since 1.0.19 |
|
99 | - * @return array |
|
100 | - */ |
|
101 | - public function prepare_row( $invoice, $fields ) { |
|
102 | - |
|
103 | - $prepared = array(); |
|
104 | - $amount_fields = $this->get_amount_fields( $invoice->get_post_type() ); |
|
105 | - |
|
106 | - foreach ( $fields as $field ) { |
|
107 | - |
|
108 | - $value = ''; |
|
109 | - $method = "get_$field"; |
|
110 | - |
|
111 | - if ( method_exists( $invoice, $method ) ) { |
|
112 | - $value = $invoice->$method(); |
|
113 | - } |
|
114 | - |
|
115 | - if ( in_array( $field, $amount_fields ) ) { |
|
116 | - $value = wpinv_round_amount( wpinv_sanitize_amount( $value ) ); |
|
117 | - } |
|
118 | - |
|
119 | - $prepared[ $field ] = wpinv_clean( $value ); |
|
120 | - |
|
121 | - } |
|
122 | - |
|
123 | - return $prepared; |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * Retrieves export fields. |
|
128 | - * |
|
129 | - * @param string $post_type |
|
130 | - * @since 1.0.19 |
|
131 | - * @return array |
|
132 | - */ |
|
133 | - public function get_export_fields( $post_type ) { |
|
134 | - |
|
135 | - $fields = array( |
|
136 | - 'id', |
|
137 | - 'parent_id', |
|
138 | - 'status', |
|
139 | - 'date_created', |
|
140 | - 'date_modified', |
|
141 | - 'date_due', |
|
142 | - 'date_completed', |
|
143 | - 'number', |
|
144 | - 'key', |
|
145 | - 'description', |
|
146 | - 'post_type', |
|
147 | - 'mode', |
|
148 | - 'customer_id', |
|
149 | - 'customer_first_name', |
|
150 | - 'customer_last_name', |
|
151 | - 'customer_phone', |
|
152 | - 'customer_email', |
|
153 | - 'customer_country', |
|
154 | - 'customer_city', |
|
155 | - 'customer_state', |
|
156 | - 'customer_zip', |
|
157 | - 'customer_company', |
|
158 | - 'customer_vat_number', |
|
159 | - 'customer_address', |
|
160 | - 'subtotal', |
|
161 | - 'total_discount', |
|
162 | - 'total_tax', |
|
163 | - 'total_fees', |
|
164 | - 'fees', |
|
165 | - 'discounts', |
|
166 | - 'taxes', |
|
167 | - 'cart_details', |
|
168 | - 'item_ids', |
|
169 | - 'payment_form', |
|
170 | - 'discount_code', |
|
171 | - 'gateway', |
|
172 | - 'transaction_id', |
|
173 | - 'currency', |
|
174 | - 'disable_taxes', |
|
175 | - 'subscription_id', |
|
176 | - 'remote_subscription_id', |
|
177 | - 'is_viewed', |
|
178 | - 'email_cc', |
|
179 | - 'template', |
|
180 | - 'created_via' |
|
181 | - ); |
|
182 | - |
|
183 | - return apply_filters( 'getpaid_invoice_exporter_get_fields', $fields, $post_type ); |
|
184 | - } |
|
185 | - |
|
186 | - /** |
|
187 | - * Retrieves amount fields. |
|
188 | - * |
|
189 | - * @param string $post_type |
|
190 | - * @since 1.0.19 |
|
191 | - * @return array |
|
192 | - */ |
|
193 | - public function get_amount_fields( $post_type ) { |
|
194 | - |
|
195 | - $fields = array( |
|
196 | - 'subtotal', |
|
197 | - 'total_discount', |
|
198 | - 'total_tax', |
|
199 | - 'total_fees' |
|
200 | - ); |
|
201 | - |
|
202 | - return apply_filters( 'getpaid_invoice_exporter_get_amount_fields', $fields, $post_type ); |
|
203 | - } |
|
15 | + /** |
|
16 | + * Retrieves invoices query args. |
|
17 | + * |
|
18 | + * @param string $post_type post type to retrieve. |
|
19 | + * @param array $args Args to search for. |
|
20 | + * @return array |
|
21 | + */ |
|
22 | + public function get_invoice_query_args( $post_type, $args ) { |
|
23 | + |
|
24 | + $query_args = array( |
|
25 | + 'post_type' => $post_type, |
|
26 | + 'post_status' => array_keys( wpinv_get_invoice_statuses( true, false, $post_type ) ), |
|
27 | + 'posts_per_page' => -1, |
|
28 | + 'no_found_rows' => true, |
|
29 | + 'update_post_term_cache' => false, |
|
30 | + 'fields' => 'ids', |
|
31 | + ); |
|
32 | + |
|
33 | + if ( ! empty( $args['status'] ) && in_array( $args['status'], $query_args['post_status'], true ) ) { |
|
34 | + $query_args['post_status'] = wpinv_clean( wpinv_parse_list( $args['status'] ) ); |
|
35 | + } |
|
36 | + |
|
37 | + $date_query = array(); |
|
38 | + if ( ! empty( $args['to_date'] ) ) { |
|
39 | + $date_query['before'] = wpinv_clean( $args['to_date'] ); |
|
40 | + } |
|
41 | + |
|
42 | + if ( ! empty( $args['from_date'] ) ) { |
|
43 | + $date_query['after'] = wpinv_clean( $args['from_date'] ); |
|
44 | + } |
|
45 | + |
|
46 | + if ( ! empty( $date_query ) ) { |
|
47 | + $date_query['inclusive'] = true; |
|
48 | + $query_args['date_query'] = array( $date_query ); |
|
49 | + } |
|
50 | + |
|
51 | + return $query_args; |
|
52 | + } |
|
53 | + |
|
54 | + /** |
|
55 | + * Retrieves invoices. |
|
56 | + * |
|
57 | + * @param array $query_args WP_Query args. |
|
58 | + * @return WPInv_Invoice[] |
|
59 | + */ |
|
60 | + public function get_invoices( $query_args ) { |
|
61 | + |
|
62 | + // Get invoices. |
|
63 | + $invoices = new WP_Query( $query_args ); |
|
64 | + |
|
65 | + // Prepare the results. |
|
66 | + return array_map( 'wpinv_get_invoice', $invoices->posts ); |
|
67 | + |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * Handles the actual download. |
|
72 | + * |
|
73 | + */ |
|
74 | + public function export( $post_type, $args ) { |
|
75 | + |
|
76 | + $invoices = $this->get_invoices( $this->get_invoice_query_args( $post_type, $args ) ); |
|
77 | + $stream = $this->prepare_output(); |
|
78 | + $headers = $this->get_export_fields( $post_type ); |
|
79 | + $file_type = $this->prepare_file_type( strtolower( getpaid_get_post_type_label( $post_type ) ) ); |
|
80 | + |
|
81 | + if ( 'csv' == $file_type ) { |
|
82 | + $this->download_csv( $invoices, $stream, $headers ); |
|
83 | + } else if( 'xml' == $file_type ) { |
|
84 | + $this->download_xml( $invoices, $stream, $headers ); |
|
85 | + } else { |
|
86 | + $this->download_json( $invoices, $stream, $headers ); |
|
87 | + } |
|
88 | + |
|
89 | + fclose( $stream ); |
|
90 | + exit; |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Prepares a single invoice for download. |
|
95 | + * |
|
96 | + * @param WPInv_Invoice $invoice The invoice to prepare.. |
|
97 | + * @param array $fields The fields to stream. |
|
98 | + * @since 1.0.19 |
|
99 | + * @return array |
|
100 | + */ |
|
101 | + public function prepare_row( $invoice, $fields ) { |
|
102 | + |
|
103 | + $prepared = array(); |
|
104 | + $amount_fields = $this->get_amount_fields( $invoice->get_post_type() ); |
|
105 | + |
|
106 | + foreach ( $fields as $field ) { |
|
107 | + |
|
108 | + $value = ''; |
|
109 | + $method = "get_$field"; |
|
110 | + |
|
111 | + if ( method_exists( $invoice, $method ) ) { |
|
112 | + $value = $invoice->$method(); |
|
113 | + } |
|
114 | + |
|
115 | + if ( in_array( $field, $amount_fields ) ) { |
|
116 | + $value = wpinv_round_amount( wpinv_sanitize_amount( $value ) ); |
|
117 | + } |
|
118 | + |
|
119 | + $prepared[ $field ] = wpinv_clean( $value ); |
|
120 | + |
|
121 | + } |
|
122 | + |
|
123 | + return $prepared; |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * Retrieves export fields. |
|
128 | + * |
|
129 | + * @param string $post_type |
|
130 | + * @since 1.0.19 |
|
131 | + * @return array |
|
132 | + */ |
|
133 | + public function get_export_fields( $post_type ) { |
|
134 | + |
|
135 | + $fields = array( |
|
136 | + 'id', |
|
137 | + 'parent_id', |
|
138 | + 'status', |
|
139 | + 'date_created', |
|
140 | + 'date_modified', |
|
141 | + 'date_due', |
|
142 | + 'date_completed', |
|
143 | + 'number', |
|
144 | + 'key', |
|
145 | + 'description', |
|
146 | + 'post_type', |
|
147 | + 'mode', |
|
148 | + 'customer_id', |
|
149 | + 'customer_first_name', |
|
150 | + 'customer_last_name', |
|
151 | + 'customer_phone', |
|
152 | + 'customer_email', |
|
153 | + 'customer_country', |
|
154 | + 'customer_city', |
|
155 | + 'customer_state', |
|
156 | + 'customer_zip', |
|
157 | + 'customer_company', |
|
158 | + 'customer_vat_number', |
|
159 | + 'customer_address', |
|
160 | + 'subtotal', |
|
161 | + 'total_discount', |
|
162 | + 'total_tax', |
|
163 | + 'total_fees', |
|
164 | + 'fees', |
|
165 | + 'discounts', |
|
166 | + 'taxes', |
|
167 | + 'cart_details', |
|
168 | + 'item_ids', |
|
169 | + 'payment_form', |
|
170 | + 'discount_code', |
|
171 | + 'gateway', |
|
172 | + 'transaction_id', |
|
173 | + 'currency', |
|
174 | + 'disable_taxes', |
|
175 | + 'subscription_id', |
|
176 | + 'remote_subscription_id', |
|
177 | + 'is_viewed', |
|
178 | + 'email_cc', |
|
179 | + 'template', |
|
180 | + 'created_via' |
|
181 | + ); |
|
182 | + |
|
183 | + return apply_filters( 'getpaid_invoice_exporter_get_fields', $fields, $post_type ); |
|
184 | + } |
|
185 | + |
|
186 | + /** |
|
187 | + * Retrieves amount fields. |
|
188 | + * |
|
189 | + * @param string $post_type |
|
190 | + * @since 1.0.19 |
|
191 | + * @return array |
|
192 | + */ |
|
193 | + public function get_amount_fields( $post_type ) { |
|
194 | + |
|
195 | + $fields = array( |
|
196 | + 'subtotal', |
|
197 | + 'total_discount', |
|
198 | + 'total_tax', |
|
199 | + 'total_fees' |
|
200 | + ); |
|
201 | + |
|
202 | + return apply_filters( 'getpaid_invoice_exporter_get_amount_fields', $fields, $post_type ); |
|
203 | + } |
|
204 | 204 | |
205 | 205 | } |
@@ -215,16 +215,16 @@ discard block |
||
215 | 215 | function getpaid_prepare_item_tax( $item, $tax_name, $tax_amount, $recurring_tax_amount ) { |
216 | 216 | |
217 | 217 | $initial_tax = $tax_amount; |
218 | - $recurring_tax = 0; |
|
218 | + $recurring_tax = 0; |
|
219 | 219 | |
220 | 220 | if ( $item->is_recurring() ) { |
221 | - $recurring_tax = $recurring_tax_amount; |
|
222 | - } |
|
221 | + $recurring_tax = $recurring_tax_amount; |
|
222 | + } |
|
223 | 223 | |
224 | - return array( |
|
225 | - 'name' => sanitize_text_field( $tax_name ), |
|
226 | - 'initial_tax' => $initial_tax, |
|
227 | - 'recurring_tax' => $recurring_tax, |
|
224 | + return array( |
|
225 | + 'name' => sanitize_text_field( $tax_name ), |
|
226 | + 'initial_tax' => $initial_tax, |
|
227 | + 'recurring_tax' => $recurring_tax, |
|
228 | 228 | ); |
229 | 229 | |
230 | 230 | } |
@@ -328,7 +328,7 @@ discard block |
||
328 | 328 | */ |
329 | 329 | function wpinv_should_validate_vat_number() { |
330 | 330 | $validate = wpinv_get_option( 'validate_vat_number' ); |
331 | - return ! empty( $validate ); |
|
331 | + return ! empty( $validate ); |
|
332 | 332 | } |
333 | 333 | |
334 | 334 | function wpinv_sales_tax_for_year( $year = null ) { |
@@ -8,7 +8,7 @@ discard block |
||
8 | 8 | */ |
9 | 9 | |
10 | 10 | if ( ! defined( 'ABSPATH' ) ) { |
11 | - exit; // Exit if accessed directly |
|
11 | + exit; // Exit if accessed directly |
|
12 | 12 | } |
13 | 13 | |
14 | 14 | /** |
@@ -17,10 +17,10 @@ discard block |
||
17 | 17 | class GetPaid_Meta_Box_Item_VAT { |
18 | 18 | |
19 | 19 | /** |
20 | - * Output the metabox. |
|
21 | - * |
|
22 | - * @param WP_Post $post |
|
23 | - */ |
|
20 | + * Output the metabox. |
|
21 | + * |
|
22 | + * @param WP_Post $post |
|
23 | + */ |
|
24 | 24 | public static function output( $post ) { |
25 | 25 | |
26 | 26 | // Prepare the item. |
@@ -46,10 +46,10 @@ discard block |
||
46 | 46 | } |
47 | 47 | |
48 | 48 | /** |
49 | - * Output the VAT rules settings. |
|
50 | - * |
|
51 | - * @param WPInv_Item $item |
|
52 | - */ |
|
49 | + * Output the VAT rules settings. |
|
50 | + * |
|
51 | + * @param WPInv_Item $item |
|
52 | + */ |
|
53 | 53 | public static function output_vat_rules( $item ) { |
54 | 54 | ?> |
55 | 55 | |
@@ -87,10 +87,10 @@ discard block |
||
87 | 87 | } |
88 | 88 | |
89 | 89 | /** |
90 | - * Output the VAT class settings. |
|
91 | - * |
|
92 | - * @param WPInv_Item $item |
|
93 | - */ |
|
90 | + * Output the VAT class settings. |
|
91 | + * |
|
92 | + * @param WPInv_Item $item |
|
93 | + */ |
|
94 | 94 | public static function output_vat_classes( $item ) { |
95 | 95 | ?> |
96 | 96 |
@@ -55,27 +55,27 @@ |
||
55 | 55 | public static function vat_rates_settings() {} |
56 | 56 | |
57 | 57 | /** |
58 | - * |
|
59 | - * @deprecated |
|
60 | - */ |
|
58 | + * |
|
59 | + * @deprecated |
|
60 | + */ |
|
61 | 61 | public static function vat_settings() {} |
62 | 62 | |
63 | 63 | /** |
64 | - * |
|
65 | - * @deprecated |
|
66 | - */ |
|
64 | + * |
|
65 | + * @deprecated |
|
66 | + */ |
|
67 | 67 | public static function maxmind_folder() {} |
68 | 68 | |
69 | 69 | /** |
70 | - * |
|
71 | - * @deprecated |
|
72 | - */ |
|
70 | + * |
|
71 | + * @deprecated |
|
72 | + */ |
|
73 | 73 | public static function geoip2_download_database() {} |
74 | 74 | |
75 | 75 | /** |
76 | - * |
|
77 | - * @deprecated |
|
78 | - */ |
|
76 | + * |
|
77 | + * @deprecated |
|
78 | + */ |
|
79 | 79 | public static function geoip2_download_file() {} |
80 | 80 | |
81 | 81 | /** |
@@ -13,233 +13,233 @@ |
||
13 | 13 | |
14 | 14 | return array( |
15 | 15 | |
16 | - 'id' => array( |
|
17 | - 'description' => __( 'Unique identifier for the item.', 'invoicing' ), |
|
18 | - 'type' => 'integer', |
|
19 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
20 | - 'readonly' => true, |
|
21 | - ), |
|
22 | - |
|
23 | - 'parent_id' => array( |
|
24 | - 'description' => __( 'Parent item ID.', 'invoicing' ), |
|
25 | - 'type' => 'integer', |
|
26 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
27 | - 'default' => 0, |
|
28 | - ), |
|
29 | - |
|
30 | - 'status' => array( |
|
31 | - 'description' => __( 'A named status for the item.', 'invoicing' ), |
|
32 | - 'type' => 'string', |
|
33 | - 'enum' => array( 'draft', 'pending', 'publish' ), |
|
34 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
35 | - 'default' => 'draft', |
|
36 | - ), |
|
37 | - |
|
38 | - 'version' => array( |
|
39 | - 'description' => __( 'Plugin version when the item was created.', 'invoicing' ), |
|
40 | - 'type' => 'string', |
|
41 | - 'context' => array( 'view', 'edit' ), |
|
42 | - 'readonly' => true, |
|
43 | - ), |
|
44 | - |
|
45 | - 'date_created' => array( |
|
46 | - 'description' => __( "The date the item was created, in the site's timezone.", 'invoicing' ), |
|
47 | - 'type' => 'string', |
|
48 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
49 | - ), |
|
50 | - |
|
51 | - 'date_created_gmt' => array( |
|
52 | - 'description' => __( 'The GMT date the item was created.', 'invoicing' ), |
|
53 | - 'type' => 'string', |
|
54 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
55 | - 'readonly' => true, |
|
56 | - ), |
|
57 | - |
|
58 | - 'date_modified' => array( |
|
59 | - 'description' => __( "The date the item was last modified, in the site's timezone.", 'invoicing' ), |
|
60 | - 'type' => 'string', |
|
61 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
62 | - 'readonly' => true, |
|
63 | - ), |
|
64 | - |
|
65 | - 'date_modified_gmt' => array( |
|
66 | - 'description' => __( 'The GMT date the item was last modified.', 'invoicing' ), |
|
67 | - 'type' => 'string', |
|
68 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
69 | - 'readonly' => true, |
|
70 | - ), |
|
71 | - |
|
72 | - 'name' => array( |
|
73 | - 'description' => __( "The item's name.", 'invoicing' ), |
|
74 | - 'type' => 'string', |
|
75 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
76 | - 'required' => true, |
|
77 | - ), |
|
78 | - |
|
79 | - 'description' => array( |
|
80 | - 'description' => __( "The item's description.", 'invoicing' ), |
|
81 | - 'type' => 'string', |
|
82 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
83 | - ), |
|
84 | - |
|
85 | - 'owner' => array( |
|
86 | - 'description' => __( 'The owner of the item (user id).', 'invoicing' ), |
|
87 | - 'type' => 'integer', |
|
88 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
89 | - ), |
|
90 | - |
|
91 | - 'price' => array( |
|
92 | - 'description' => __( 'The price of the item.', 'invoicing' ), |
|
93 | - 'type' => 'number', |
|
94 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
95 | - 'required' => true, |
|
96 | - ), |
|
97 | - |
|
98 | - 'the_price' => array( |
|
99 | - 'description' => __( 'The formatted price of the item.', 'invoicing' ), |
|
100 | - 'type' => 'string', |
|
101 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
102 | - 'readonly' => true, |
|
103 | - ), |
|
104 | - |
|
105 | - 'type' => array( |
|
106 | - 'description' => __( 'The item type.', 'invoicing' ), |
|
107 | - 'type' => 'string', |
|
108 | - 'enum' => wpinv_item_types(), |
|
109 | - 'default' => 'custom', |
|
110 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
111 | - ), |
|
112 | - |
|
113 | - 'vat_rule' => array( |
|
114 | - 'description' => __( 'VAT rule applied to the item.', 'invoicing' ), |
|
115 | - 'type' => 'string', |
|
116 | - 'enum' => array_keys( getpaid_get_tax_rules() ), |
|
117 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
118 | - ), |
|
119 | - |
|
120 | - 'vat_class' => array( |
|
121 | - 'description' => __( 'VAT class for the item.', 'invoicing' ), |
|
122 | - 'type' => 'string', |
|
123 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
124 | - 'enum' => array_keys( getpaid_get_tax_classes() ), |
|
125 | - ), |
|
126 | - |
|
127 | - 'custom_id' => array( |
|
128 | - 'description' => __( 'Custom id for the item.', 'invoicing' ), |
|
129 | - 'type' => 'string', |
|
130 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
131 | - ), |
|
16 | + 'id' => array( |
|
17 | + 'description' => __( 'Unique identifier for the item.', 'invoicing' ), |
|
18 | + 'type' => 'integer', |
|
19 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
20 | + 'readonly' => true, |
|
21 | + ), |
|
22 | + |
|
23 | + 'parent_id' => array( |
|
24 | + 'description' => __( 'Parent item ID.', 'invoicing' ), |
|
25 | + 'type' => 'integer', |
|
26 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
27 | + 'default' => 0, |
|
28 | + ), |
|
29 | + |
|
30 | + 'status' => array( |
|
31 | + 'description' => __( 'A named status for the item.', 'invoicing' ), |
|
32 | + 'type' => 'string', |
|
33 | + 'enum' => array( 'draft', 'pending', 'publish' ), |
|
34 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
35 | + 'default' => 'draft', |
|
36 | + ), |
|
37 | + |
|
38 | + 'version' => array( |
|
39 | + 'description' => __( 'Plugin version when the item was created.', 'invoicing' ), |
|
40 | + 'type' => 'string', |
|
41 | + 'context' => array( 'view', 'edit' ), |
|
42 | + 'readonly' => true, |
|
43 | + ), |
|
44 | + |
|
45 | + 'date_created' => array( |
|
46 | + 'description' => __( "The date the item was created, in the site's timezone.", 'invoicing' ), |
|
47 | + 'type' => 'string', |
|
48 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
49 | + ), |
|
50 | + |
|
51 | + 'date_created_gmt' => array( |
|
52 | + 'description' => __( 'The GMT date the item was created.', 'invoicing' ), |
|
53 | + 'type' => 'string', |
|
54 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
55 | + 'readonly' => true, |
|
56 | + ), |
|
57 | + |
|
58 | + 'date_modified' => array( |
|
59 | + 'description' => __( "The date the item was last modified, in the site's timezone.", 'invoicing' ), |
|
60 | + 'type' => 'string', |
|
61 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
62 | + 'readonly' => true, |
|
63 | + ), |
|
64 | + |
|
65 | + 'date_modified_gmt' => array( |
|
66 | + 'description' => __( 'The GMT date the item was last modified.', 'invoicing' ), |
|
67 | + 'type' => 'string', |
|
68 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
69 | + 'readonly' => true, |
|
70 | + ), |
|
71 | + |
|
72 | + 'name' => array( |
|
73 | + 'description' => __( "The item's name.", 'invoicing' ), |
|
74 | + 'type' => 'string', |
|
75 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
76 | + 'required' => true, |
|
77 | + ), |
|
78 | + |
|
79 | + 'description' => array( |
|
80 | + 'description' => __( "The item's description.", 'invoicing' ), |
|
81 | + 'type' => 'string', |
|
82 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
83 | + ), |
|
84 | + |
|
85 | + 'owner' => array( |
|
86 | + 'description' => __( 'The owner of the item (user id).', 'invoicing' ), |
|
87 | + 'type' => 'integer', |
|
88 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
89 | + ), |
|
90 | + |
|
91 | + 'price' => array( |
|
92 | + 'description' => __( 'The price of the item.', 'invoicing' ), |
|
93 | + 'type' => 'number', |
|
94 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
95 | + 'required' => true, |
|
96 | + ), |
|
97 | + |
|
98 | + 'the_price' => array( |
|
99 | + 'description' => __( 'The formatted price of the item.', 'invoicing' ), |
|
100 | + 'type' => 'string', |
|
101 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
102 | + 'readonly' => true, |
|
103 | + ), |
|
104 | + |
|
105 | + 'type' => array( |
|
106 | + 'description' => __( 'The item type.', 'invoicing' ), |
|
107 | + 'type' => 'string', |
|
108 | + 'enum' => wpinv_item_types(), |
|
109 | + 'default' => 'custom', |
|
110 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
111 | + ), |
|
112 | + |
|
113 | + 'vat_rule' => array( |
|
114 | + 'description' => __( 'VAT rule applied to the item.', 'invoicing' ), |
|
115 | + 'type' => 'string', |
|
116 | + 'enum' => array_keys( getpaid_get_tax_rules() ), |
|
117 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
118 | + ), |
|
119 | + |
|
120 | + 'vat_class' => array( |
|
121 | + 'description' => __( 'VAT class for the item.', 'invoicing' ), |
|
122 | + 'type' => 'string', |
|
123 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
124 | + 'enum' => array_keys( getpaid_get_tax_classes() ), |
|
125 | + ), |
|
126 | + |
|
127 | + 'custom_id' => array( |
|
128 | + 'description' => __( 'Custom id for the item.', 'invoicing' ), |
|
129 | + 'type' => 'string', |
|
130 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
131 | + ), |
|
132 | 132 | |
133 | - 'custom_name' => array( |
|
134 | - 'description' => __( 'Custom name for the item.', 'invoicing' ), |
|
135 | - 'type' => 'string', |
|
136 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
137 | - ), |
|
138 | - |
|
139 | - 'custom_singular_name' => array( |
|
140 | - 'description' => __( 'Custom singular name for the item.', 'invoicing' ), |
|
141 | - 'type' => 'string', |
|
142 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
143 | - ), |
|
144 | - |
|
145 | - 'is_dynamic_pricing' => array( |
|
146 | - 'description' => __( 'Whether or not customers can enter their own prices when checking out.', 'invoicing' ), |
|
147 | - 'type' => 'integer', |
|
148 | - 'enum' => array( 0, 1 ), |
|
149 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
150 | - ), |
|
151 | - |
|
152 | - 'minimum_price' => array( |
|
153 | - 'description' => __( 'For dynamic prices, this is the minimum price that a user can set.', 'invoicing' ), |
|
154 | - 'type' => 'number', |
|
155 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
156 | - ), |
|
157 | - |
|
158 | - 'is_recurring' => array( |
|
159 | - 'description' => __( 'Whether or not this is a subscription item.', 'invoicing' ), |
|
160 | - 'type' => 'integer', |
|
161 | - 'enum' => array( 0, 1 ), |
|
162 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
163 | - ), |
|
164 | - |
|
165 | - 'initial_price' => array( |
|
166 | - 'description' => __( 'The initial price of the item.', 'invoicing' ), |
|
167 | - 'type' => 'number', |
|
168 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
169 | - 'readonly' => true, |
|
170 | - ), |
|
171 | - |
|
172 | - 'the_initial_price' => array( |
|
173 | - 'description' => __( 'The formatted initial price of the item.', 'invoicing' ), |
|
174 | - 'type' => 'string', |
|
175 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
176 | - 'readonly' => true, |
|
177 | - ), |
|
178 | - |
|
179 | - 'recurring_price' => array( |
|
180 | - 'description' => __( 'The recurring price of the item.', 'invoicing' ), |
|
181 | - 'type' => 'number', |
|
182 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
183 | - 'readonly' => true, |
|
184 | - ), |
|
185 | - |
|
186 | - 'the_recurring_price' => array( |
|
187 | - 'description' => __( 'The formatted recurring price of the item.', 'invoicing' ), |
|
188 | - 'type' => 'string', |
|
189 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
190 | - 'readonly' => true, |
|
191 | - ), |
|
192 | - |
|
193 | - 'recurring_period' => array( |
|
194 | - 'description' => __( 'The recurring period for a recurring item.', 'invoicing' ), |
|
195 | - 'type' => 'string', |
|
196 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
197 | - 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
198 | - ), |
|
199 | - |
|
200 | - 'recurring_interval' => array( |
|
201 | - 'description' => __( 'The recurring interval for a subscription item.', 'invoicing' ), |
|
202 | - 'type' => 'integer', |
|
203 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
204 | - ), |
|
205 | - |
|
206 | - 'recurring_limit' => array( |
|
207 | - 'description' => __( 'The maximum number of renewals for a subscription item.', 'invoicing' ), |
|
208 | - 'type' => 'integer', |
|
209 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
210 | - ), |
|
211 | - |
|
212 | - 'is_free_trial' => array( |
|
213 | - 'description' => __( 'Whether the item has a free trial period.', 'invoicing' ), |
|
214 | - 'type' => 'integer', |
|
215 | - 'enum' => array( 0, 1 ), |
|
216 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
217 | - ), |
|
218 | - |
|
219 | - 'trial_period' => array( |
|
220 | - 'description' => __( 'The trial period.', 'invoicing' ), |
|
221 | - 'type' => 'string', |
|
222 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
223 | - 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
224 | - ), |
|
225 | - |
|
226 | - 'trial_interval' => array( |
|
227 | - 'description' => __( 'The trial interval.', 'invoicing' ), |
|
228 | - 'type' => 'integer', |
|
229 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
230 | - ), |
|
231 | - |
|
232 | - 'first_renewal_date' => array( |
|
233 | - 'description' => __( 'The first renewal date in case the item was to be bought today.', 'invoicing' ), |
|
234 | - 'type' => 'string', |
|
235 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
236 | - 'readonly' => true, |
|
237 | - ), |
|
238 | - |
|
239 | - 'edit_url' => array( |
|
240 | - 'description' => __( 'The URL to edit an item.', 'invoicing' ), |
|
241 | - 'type' => 'string', |
|
242 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
243 | - 'readonly' => true, |
|
244 | - ), |
|
133 | + 'custom_name' => array( |
|
134 | + 'description' => __( 'Custom name for the item.', 'invoicing' ), |
|
135 | + 'type' => 'string', |
|
136 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
137 | + ), |
|
138 | + |
|
139 | + 'custom_singular_name' => array( |
|
140 | + 'description' => __( 'Custom singular name for the item.', 'invoicing' ), |
|
141 | + 'type' => 'string', |
|
142 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
143 | + ), |
|
144 | + |
|
145 | + 'is_dynamic_pricing' => array( |
|
146 | + 'description' => __( 'Whether or not customers can enter their own prices when checking out.', 'invoicing' ), |
|
147 | + 'type' => 'integer', |
|
148 | + 'enum' => array( 0, 1 ), |
|
149 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
150 | + ), |
|
151 | + |
|
152 | + 'minimum_price' => array( |
|
153 | + 'description' => __( 'For dynamic prices, this is the minimum price that a user can set.', 'invoicing' ), |
|
154 | + 'type' => 'number', |
|
155 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
156 | + ), |
|
157 | + |
|
158 | + 'is_recurring' => array( |
|
159 | + 'description' => __( 'Whether or not this is a subscription item.', 'invoicing' ), |
|
160 | + 'type' => 'integer', |
|
161 | + 'enum' => array( 0, 1 ), |
|
162 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
163 | + ), |
|
164 | + |
|
165 | + 'initial_price' => array( |
|
166 | + 'description' => __( 'The initial price of the item.', 'invoicing' ), |
|
167 | + 'type' => 'number', |
|
168 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
169 | + 'readonly' => true, |
|
170 | + ), |
|
171 | + |
|
172 | + 'the_initial_price' => array( |
|
173 | + 'description' => __( 'The formatted initial price of the item.', 'invoicing' ), |
|
174 | + 'type' => 'string', |
|
175 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
176 | + 'readonly' => true, |
|
177 | + ), |
|
178 | + |
|
179 | + 'recurring_price' => array( |
|
180 | + 'description' => __( 'The recurring price of the item.', 'invoicing' ), |
|
181 | + 'type' => 'number', |
|
182 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
183 | + 'readonly' => true, |
|
184 | + ), |
|
185 | + |
|
186 | + 'the_recurring_price' => array( |
|
187 | + 'description' => __( 'The formatted recurring price of the item.', 'invoicing' ), |
|
188 | + 'type' => 'string', |
|
189 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
190 | + 'readonly' => true, |
|
191 | + ), |
|
192 | + |
|
193 | + 'recurring_period' => array( |
|
194 | + 'description' => __( 'The recurring period for a recurring item.', 'invoicing' ), |
|
195 | + 'type' => 'string', |
|
196 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
197 | + 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
198 | + ), |
|
199 | + |
|
200 | + 'recurring_interval' => array( |
|
201 | + 'description' => __( 'The recurring interval for a subscription item.', 'invoicing' ), |
|
202 | + 'type' => 'integer', |
|
203 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
204 | + ), |
|
205 | + |
|
206 | + 'recurring_limit' => array( |
|
207 | + 'description' => __( 'The maximum number of renewals for a subscription item.', 'invoicing' ), |
|
208 | + 'type' => 'integer', |
|
209 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
210 | + ), |
|
211 | + |
|
212 | + 'is_free_trial' => array( |
|
213 | + 'description' => __( 'Whether the item has a free trial period.', 'invoicing' ), |
|
214 | + 'type' => 'integer', |
|
215 | + 'enum' => array( 0, 1 ), |
|
216 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
217 | + ), |
|
218 | + |
|
219 | + 'trial_period' => array( |
|
220 | + 'description' => __( 'The trial period.', 'invoicing' ), |
|
221 | + 'type' => 'string', |
|
222 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
223 | + 'enum' => array( 'D', 'W', 'M', 'Y' ), |
|
224 | + ), |
|
225 | + |
|
226 | + 'trial_interval' => array( |
|
227 | + 'description' => __( 'The trial interval.', 'invoicing' ), |
|
228 | + 'type' => 'integer', |
|
229 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
230 | + ), |
|
231 | + |
|
232 | + 'first_renewal_date' => array( |
|
233 | + 'description' => __( 'The first renewal date in case the item was to be bought today.', 'invoicing' ), |
|
234 | + 'type' => 'string', |
|
235 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
236 | + 'readonly' => true, |
|
237 | + ), |
|
238 | + |
|
239 | + 'edit_url' => array( |
|
240 | + 'description' => __( 'The URL to edit an item.', 'invoicing' ), |
|
241 | + 'type' => 'string', |
|
242 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
243 | + 'readonly' => true, |
|
244 | + ), |
|
245 | 245 | ); |
@@ -36,36 +36,36 @@ discard block |
||
36 | 36 | 'desc_tip' => true, |
37 | 37 | 'default' => '', |
38 | 38 | 'advanced' => false |
39 | - ), |
|
39 | + ), |
|
40 | 40 | |
41 | 41 | 'form' => array( |
42 | - 'title' => __( 'Form', 'invoicing' ), |
|
43 | - 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
44 | - 'type' => 'text', |
|
45 | - 'desc_tip' => true, |
|
46 | - 'default' => '', |
|
47 | - 'placeholder' => __('1','invoicing'), |
|
48 | - 'advanced' => false |
|
49 | - ), |
|
50 | - |
|
51 | - 'item' => array( |
|
52 | - 'title' => __( 'Items', 'invoicing' ), |
|
53 | - 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
54 | - 'type' => 'text', |
|
55 | - 'desc_tip' => true, |
|
56 | - 'default' => '', |
|
57 | - 'placeholder' => __('1','invoicing'), |
|
58 | - 'advanced' => false |
|
59 | - ), |
|
42 | + 'title' => __( 'Form', 'invoicing' ), |
|
43 | + 'desc' => __( 'Enter a form id in case you want to display a specific payment form', 'invoicing' ), |
|
44 | + 'type' => 'text', |
|
45 | + 'desc_tip' => true, |
|
46 | + 'default' => '', |
|
47 | + 'placeholder' => __('1','invoicing'), |
|
48 | + 'advanced' => false |
|
49 | + ), |
|
50 | + |
|
51 | + 'item' => array( |
|
52 | + 'title' => __( 'Items', 'invoicing' ), |
|
53 | + 'desc' => __( 'Enter comma separated list of invoicing item id and quantity (item_id|quantity). Ex. 101|2. This will be ignored in case you specify a form above. Enter 0 as the quantity to let users select their own quantities', 'invoicing' ), |
|
54 | + 'type' => 'text', |
|
55 | + 'desc_tip' => true, |
|
56 | + 'default' => '', |
|
57 | + 'placeholder' => __('1','invoicing'), |
|
58 | + 'advanced' => false |
|
59 | + ), |
|
60 | 60 | |
61 | 61 | 'button' => array( |
62 | - 'title' => __( 'Button', 'invoicing' ), |
|
63 | - 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
64 | - 'type' => 'text', |
|
65 | - 'desc_tip' => true, |
|
66 | - 'default' => '', |
|
67 | - 'advanced' => false |
|
68 | - ) |
|
62 | + 'title' => __( 'Button', 'invoicing' ), |
|
63 | + 'desc' => __( 'Enter button label in case you would like to display the forms in a popup.', 'invoicing' ), |
|
64 | + 'type' => 'text', |
|
65 | + 'desc_tip' => true, |
|
66 | + 'default' => '', |
|
67 | + 'advanced' => false |
|
68 | + ) |
|
69 | 69 | |
70 | 70 | ) |
71 | 71 | |
@@ -75,96 +75,96 @@ discard block |
||
75 | 75 | parent::__construct( $options ); |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * The Super block output function. |
|
80 | - * |
|
81 | - * @param array $args |
|
82 | - * @param array $widget_args |
|
83 | - * @param string $content |
|
84 | - * |
|
85 | - * @return string |
|
86 | - */ |
|
78 | + /** |
|
79 | + * The Super block output function. |
|
80 | + * |
|
81 | + * @param array $args |
|
82 | + * @param array $widget_args |
|
83 | + * @param string $content |
|
84 | + * |
|
85 | + * @return string |
|
86 | + */ |
|
87 | 87 | public function output( $args = array(), $widget_args = array(), $content = '' ) { |
88 | 88 | |
89 | - // Is the shortcode set up correctly? |
|
90 | - if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
91 | - return aui()->alert( |
|
92 | - array( |
|
93 | - 'type' => 'warning', |
|
94 | - 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
95 | - ) |
|
96 | - ); |
|
97 | - } |
|
98 | - |
|
99 | - // Payment form or button? |
|
100 | - if ( ! empty( $args['form'] ) ) { |
|
101 | - return $this->handle_payment_form( $args ); |
|
102 | - } else { |
|
103 | - return $this->handle_buy_item( $args ); |
|
104 | - } |
|
105 | - |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Displaying a payment form |
|
110 | - * |
|
111 | - * @return string |
|
112 | - */ |
|
89 | + // Is the shortcode set up correctly? |
|
90 | + if ( empty( $args['form'] ) && empty( $args['item'] ) ) { |
|
91 | + return aui()->alert( |
|
92 | + array( |
|
93 | + 'type' => 'warning', |
|
94 | + 'content' => __( 'No payment form or item selected', 'invoicing' ), |
|
95 | + ) |
|
96 | + ); |
|
97 | + } |
|
98 | + |
|
99 | + // Payment form or button? |
|
100 | + if ( ! empty( $args['form'] ) ) { |
|
101 | + return $this->handle_payment_form( $args ); |
|
102 | + } else { |
|
103 | + return $this->handle_buy_item( $args ); |
|
104 | + } |
|
105 | + |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Displaying a payment form |
|
110 | + * |
|
111 | + * @return string |
|
112 | + */ |
|
113 | 113 | protected function handle_payment_form( $args = array() ) { |
114 | 114 | |
115 | - if ( empty( $args['button'] ) ) { |
|
116 | - ob_start(); |
|
117 | - getpaid_display_payment_form( $args['form'] ); |
|
118 | - return ob_get_clean(); |
|
119 | - } |
|
115 | + if ( empty( $args['button'] ) ) { |
|
116 | + ob_start(); |
|
117 | + getpaid_display_payment_form( $args['form'] ); |
|
118 | + return ob_get_clean(); |
|
119 | + } |
|
120 | 120 | |
121 | - return $this->payment_form_button( $args['form'], $args['button'] ); |
|
122 | - } |
|
121 | + return $this->payment_form_button( $args['form'], $args['button'] ); |
|
122 | + } |
|
123 | 123 | |
124 | - /** |
|
125 | - * Displays a payment form button. |
|
126 | - * |
|
127 | - * @return string |
|
128 | - */ |
|
124 | + /** |
|
125 | + * Displays a payment form button. |
|
126 | + * |
|
127 | + * @return string |
|
128 | + */ |
|
129 | 129 | protected function payment_form_button( $form, $button ) { |
130 | - return getpaid_get_payment_button( $button, $form ); |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * Selling an item |
|
135 | - * |
|
136 | - * @return string |
|
137 | - */ |
|
130 | + return getpaid_get_payment_button( $button, $form ); |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * Selling an item |
|
135 | + * |
|
136 | + * @return string |
|
137 | + */ |
|
138 | 138 | protected function handle_buy_item( $args = array() ) { |
139 | 139 | |
140 | - if ( empty( $args['button'] ) ) { |
|
141 | - return $this->buy_item_form( $args['item'] ); |
|
142 | - } |
|
140 | + if ( empty( $args['button'] ) ) { |
|
141 | + return $this->buy_item_form( $args['item'] ); |
|
142 | + } |
|
143 | 143 | |
144 | - return $this->buy_item_button( $args['item'], $args['button'] ); |
|
144 | + return $this->buy_item_button( $args['item'], $args['button'] ); |
|
145 | 145 | |
146 | - } |
|
146 | + } |
|
147 | 147 | |
148 | - /** |
|
149 | - * Displays a buy item form. |
|
150 | - * |
|
151 | - * @return string |
|
152 | - */ |
|
148 | + /** |
|
149 | + * Displays a buy item form. |
|
150 | + * |
|
151 | + * @return string |
|
152 | + */ |
|
153 | 153 | protected function buy_item_form( $item ) { |
154 | - $items = getpaid_convert_items_to_array( $item ); |
|
155 | - ob_start(); |
|
156 | - getpaid_display_item_payment_form( $items ); |
|
157 | - return ob_get_clean(); |
|
158 | - } |
|
159 | - |
|
160 | - /** |
|
161 | - * Displays a buy item button. |
|
162 | - * |
|
163 | - * @return string |
|
164 | - */ |
|
154 | + $items = getpaid_convert_items_to_array( $item ); |
|
155 | + ob_start(); |
|
156 | + getpaid_display_item_payment_form( $items ); |
|
157 | + return ob_get_clean(); |
|
158 | + } |
|
159 | + |
|
160 | + /** |
|
161 | + * Displays a buy item button. |
|
162 | + * |
|
163 | + * @return string |
|
164 | + */ |
|
165 | 165 | protected function buy_item_button( $item, $button ) { |
166 | - $button = getpaid_get_payment_button( $button, null, $item ); |
|
167 | - return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
166 | + $button = getpaid_get_payment_button( $button, null, $item ); |
|
167 | + return apply_filters( 'getpaid_buy_item_button_widget', $button, $item ); |
|
168 | 168 | } |
169 | 169 | |
170 | 170 | } |
@@ -18,758 +18,758 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Settings_Controller extends GetPaid_REST_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * An array of available settings. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $settings; |
|
27 | - |
|
28 | - /** |
|
29 | - * Route base. |
|
30 | - * |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $rest_base = 'settings'; |
|
34 | - |
|
35 | - /** |
|
36 | - * Registers the routes for the objects of the controller. |
|
37 | - * |
|
38 | - * @since 2.0.0 |
|
39 | - * |
|
40 | - * @see register_rest_route() |
|
41 | - */ |
|
42 | - public function register_namespace_routes( $namespace ) { |
|
43 | - |
|
44 | - // List all registered tabs. |
|
45 | - register_rest_route( |
|
46 | - $namespace, |
|
47 | - $this->rest_base, |
|
48 | - array( |
|
49 | - array( |
|
50 | - 'methods' => WP_REST_Server::READABLE, |
|
51 | - 'callback' => array( $this, 'get_tabs' ), |
|
52 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | - ), |
|
54 | - 'schema' => '__return_empty_array', |
|
55 | - ) |
|
56 | - ); |
|
57 | - |
|
58 | - // View/Update a single setting. |
|
59 | - register_rest_route( |
|
60 | - $namespace, |
|
61 | - $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | - array( |
|
63 | - 'args' => array( |
|
64 | - 'id' => array( |
|
65 | - 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | - 'type' => 'string', |
|
67 | - 'required' => true, |
|
68 | - ), |
|
69 | - ), |
|
70 | - array( |
|
71 | - 'methods' => WP_REST_Server::READABLE, |
|
72 | - 'callback' => array( $this, 'get_item' ), |
|
73 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | - ), |
|
75 | - array( |
|
76 | - 'methods' => WP_REST_Server::EDITABLE, |
|
77 | - 'callback' => array( $this, 'update_item' ), |
|
78 | - 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | - ), |
|
81 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | - ) |
|
83 | - ); |
|
84 | - |
|
85 | - // List registered sections for a given tab. |
|
86 | - register_rest_route( |
|
87 | - $namespace, |
|
88 | - $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | - array( |
|
90 | - 'args' => array( |
|
91 | - 'tab' => array( |
|
92 | - 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | - 'type' => 'string', |
|
94 | - 'required' => true, |
|
95 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | - ), |
|
97 | - ), |
|
98 | - array( |
|
99 | - 'methods' => WP_REST_Server::READABLE, |
|
100 | - 'callback' => array( $this, 'get_sections' ), |
|
101 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | - ), |
|
103 | - 'schema' => '__return_empty_array', |
|
104 | - ) |
|
105 | - ); |
|
106 | - |
|
107 | - // List all registered settings for a given tab. |
|
108 | - register_rest_route( |
|
109 | - $namespace, |
|
110 | - $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | - array( |
|
112 | - 'args' => array( |
|
113 | - 'tab' => array( |
|
114 | - 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | - 'type' => 'string', |
|
116 | - 'required' => true, |
|
117 | - 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | - ), |
|
119 | - 'section' => array( |
|
120 | - 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | - 'type' => 'string', |
|
122 | - 'required' => true, |
|
123 | - ), |
|
124 | - ), |
|
125 | - array( |
|
126 | - 'methods' => WP_REST_Server::READABLE, |
|
127 | - 'callback' => array( $this, 'get_items' ), |
|
128 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | - ), |
|
130 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | - ) |
|
132 | - ); |
|
133 | - |
|
134 | - register_rest_route( |
|
135 | - $namespace, |
|
136 | - '/' . $this->rest_base . '/batch', |
|
137 | - array( |
|
138 | - 'args' => array( |
|
139 | - 'id' => array( |
|
140 | - 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | - 'type' => 'string', |
|
142 | - ), |
|
143 | - ), |
|
144 | - array( |
|
145 | - 'methods' => WP_REST_Server::EDITABLE, |
|
146 | - 'callback' => array( $this, 'batch_items' ), |
|
147 | - 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | - 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | - ), |
|
150 | - 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | - ) |
|
152 | - ); |
|
153 | - |
|
154 | - } |
|
21 | + /** |
|
22 | + * An array of available settings. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $settings; |
|
27 | + |
|
28 | + /** |
|
29 | + * Route base. |
|
30 | + * |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $rest_base = 'settings'; |
|
34 | + |
|
35 | + /** |
|
36 | + * Registers the routes for the objects of the controller. |
|
37 | + * |
|
38 | + * @since 2.0.0 |
|
39 | + * |
|
40 | + * @see register_rest_route() |
|
41 | + */ |
|
42 | + public function register_namespace_routes( $namespace ) { |
|
43 | + |
|
44 | + // List all registered tabs. |
|
45 | + register_rest_route( |
|
46 | + $namespace, |
|
47 | + $this->rest_base, |
|
48 | + array( |
|
49 | + array( |
|
50 | + 'methods' => WP_REST_Server::READABLE, |
|
51 | + 'callback' => array( $this, 'get_tabs' ), |
|
52 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
53 | + ), |
|
54 | + 'schema' => '__return_empty_array', |
|
55 | + ) |
|
56 | + ); |
|
57 | + |
|
58 | + // View/Update a single setting. |
|
59 | + register_rest_route( |
|
60 | + $namespace, |
|
61 | + $this->rest_base . '/setting/(?P<id>[\w-]+)', |
|
62 | + array( |
|
63 | + 'args' => array( |
|
64 | + 'id' => array( |
|
65 | + 'description' => __( 'Unique identifier for the setting.', 'invoicing' ), |
|
66 | + 'type' => 'string', |
|
67 | + 'required' => true, |
|
68 | + ), |
|
69 | + ), |
|
70 | + array( |
|
71 | + 'methods' => WP_REST_Server::READABLE, |
|
72 | + 'callback' => array( $this, 'get_item' ), |
|
73 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
74 | + ), |
|
75 | + array( |
|
76 | + 'methods' => WP_REST_Server::EDITABLE, |
|
77 | + 'callback' => array( $this, 'update_item' ), |
|
78 | + 'permission_callback' => array( $this, 'update_items_permissions_check' ), |
|
79 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
80 | + ), |
|
81 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
82 | + ) |
|
83 | + ); |
|
84 | + |
|
85 | + // List registered sections for a given tab. |
|
86 | + register_rest_route( |
|
87 | + $namespace, |
|
88 | + $this->rest_base . '/(?P<tab>[\w-]+)', |
|
89 | + array( |
|
90 | + 'args' => array( |
|
91 | + 'tab' => array( |
|
92 | + 'description' => __( 'Unique identifier for the tab whose sections should be retrieved.', 'invoicing' ), |
|
93 | + 'type' => 'string', |
|
94 | + 'required' => true, |
|
95 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
96 | + ), |
|
97 | + ), |
|
98 | + array( |
|
99 | + 'methods' => WP_REST_Server::READABLE, |
|
100 | + 'callback' => array( $this, 'get_sections' ), |
|
101 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
102 | + ), |
|
103 | + 'schema' => '__return_empty_array', |
|
104 | + ) |
|
105 | + ); |
|
106 | + |
|
107 | + // List all registered settings for a given tab. |
|
108 | + register_rest_route( |
|
109 | + $namespace, |
|
110 | + $this->rest_base . '/(?P<tab>[\w-]+)/(?P<section>[\w-]+)', |
|
111 | + array( |
|
112 | + 'args' => array( |
|
113 | + 'tab' => array( |
|
114 | + 'description' => __( 'Unique identifier for the tab whose settings should be retrieved.', 'invoicing' ), |
|
115 | + 'type' => 'string', |
|
116 | + 'required' => true, |
|
117 | + 'enum' => array_keys( wpinv_get_settings_tabs() ), |
|
118 | + ), |
|
119 | + 'section' => array( |
|
120 | + 'description' => __( 'The section in the tab whose settings should be retrieved.', 'invoicing' ), |
|
121 | + 'type' => 'string', |
|
122 | + 'required' => true, |
|
123 | + ), |
|
124 | + ), |
|
125 | + array( |
|
126 | + 'methods' => WP_REST_Server::READABLE, |
|
127 | + 'callback' => array( $this, 'get_items' ), |
|
128 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
129 | + ), |
|
130 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
131 | + ) |
|
132 | + ); |
|
133 | + |
|
134 | + register_rest_route( |
|
135 | + $namespace, |
|
136 | + '/' . $this->rest_base . '/batch', |
|
137 | + array( |
|
138 | + 'args' => array( |
|
139 | + 'id' => array( |
|
140 | + 'description' => __( 'Setting ID.', 'invoicing' ), |
|
141 | + 'type' => 'string', |
|
142 | + ), |
|
143 | + ), |
|
144 | + array( |
|
145 | + 'methods' => WP_REST_Server::EDITABLE, |
|
146 | + 'callback' => array( $this, 'batch_items' ), |
|
147 | + 'permission_callback' => array( $this, 'batch_items_permissions_check' ), |
|
148 | + 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ), |
|
149 | + ), |
|
150 | + 'schema' => array( $this, 'get_public_batch_schema' ), |
|
151 | + ) |
|
152 | + ); |
|
153 | + |
|
154 | + } |
|
155 | 155 | |
156 | - /** |
|
157 | - * Return all settings. |
|
158 | - * |
|
159 | - * @since 2.0.0 |
|
160 | - * @param WP_REST_Request $request Request data. |
|
161 | - * @return WP_Error|WP_REST_Response |
|
162 | - */ |
|
163 | - public function get_items( $request ) { |
|
164 | - |
|
165 | - $settings = $this->get_settings(); |
|
166 | - |
|
167 | - if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | - return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | - } |
|
170 | - |
|
171 | - if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | - return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | - } |
|
174 | - |
|
175 | - $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | - $prepared = array(); |
|
177 | - |
|
178 | - foreach ( $settings as $setting ) { |
|
179 | - |
|
180 | - $setting = $this->sanitize_setting( $setting ); |
|
181 | - $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | - $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | - |
|
184 | - if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | - $prepared[] = $setting_data; |
|
186 | - } |
|
187 | - |
|
188 | - } |
|
189 | - |
|
190 | - return rest_ensure_response( $prepared ); |
|
191 | - } |
|
192 | - |
|
193 | - /** |
|
194 | - * Return a single setting. |
|
195 | - * |
|
196 | - * @since 2.0.0 |
|
197 | - * @param WP_REST_Request $request Request data. |
|
198 | - * @return WP_Error|WP_REST_Response |
|
199 | - */ |
|
200 | - public function get_item( $request ) { |
|
201 | - $setting = $this->get_setting( $request['id'] ); |
|
202 | - |
|
203 | - if ( is_wp_error( $setting ) ) { |
|
204 | - return $setting; |
|
205 | - } |
|
206 | - |
|
207 | - $setting = $this->sanitize_setting( $setting ); |
|
208 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
209 | - return rest_ensure_response( $response ); |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Update a single setting. |
|
214 | - * |
|
215 | - * @since 2.0.0 |
|
216 | - * @param WP_REST_Request $request Request data. |
|
217 | - * @return WP_Error|WP_REST_Response |
|
218 | - */ |
|
219 | - public function update_item( $request ) { |
|
220 | - $setting = $this->get_setting( $request['id'] ); |
|
221 | - |
|
222 | - if ( is_wp_error( $setting ) ) { |
|
223 | - return $setting; |
|
224 | - } |
|
225 | - |
|
226 | - if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
227 | - $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
228 | - } else { |
|
229 | - $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
230 | - } |
|
231 | - |
|
232 | - if ( is_wp_error( $value ) ) { |
|
233 | - return $value; |
|
234 | - } |
|
235 | - |
|
236 | - wpinv_update_option( $request['id'], $value ); |
|
237 | - $setting['value'] = $value; |
|
238 | - $setting = $this->sanitize_setting( $setting ); |
|
239 | - $response = $this->prepare_item_for_response( $setting, $request ); |
|
240 | - |
|
241 | - return rest_ensure_response( $response ); |
|
242 | - } |
|
243 | - |
|
244 | - /** |
|
245 | - * Makes sure the current user has access to READ the settings APIs. |
|
246 | - * |
|
247 | - * @since 2.0.0 |
|
248 | - * @param WP_REST_Request $request Full data about the request. |
|
249 | - * @return WP_Error|boolean |
|
250 | - */ |
|
251 | - public function get_items_permissions_check( $request ) { |
|
252 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
253 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
254 | - } |
|
255 | - |
|
256 | - return true; |
|
257 | - } |
|
258 | - |
|
259 | - /** |
|
260 | - * Makes sure the current user has access to WRITE the settings APIs. |
|
261 | - * |
|
262 | - * @since 2.0.0 |
|
263 | - * @param WP_REST_Request $request Full data about the request. |
|
264 | - * @return WP_Error|boolean |
|
265 | - */ |
|
266 | - public function update_items_permissions_check( $request ) { |
|
267 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
268 | - return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
269 | - } |
|
270 | - |
|
271 | - return true; |
|
272 | - } |
|
273 | - |
|
274 | - /** |
|
275 | - * Check if a given request has access batch create, update and delete items. |
|
276 | - * |
|
277 | - * @param WP_REST_Request $request Full details about the request. |
|
278 | - * |
|
279 | - * @return boolean|WP_Error |
|
280 | - */ |
|
281 | - public function batch_items_permissions_check( $request ) { |
|
282 | - return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * Prepare links for the request. |
|
287 | - * |
|
288 | - * @param string $setting_id Setting ID. |
|
289 | - * @return array Links for the given setting. |
|
290 | - */ |
|
291 | - protected function prepare_links( $setting_id ) { |
|
292 | - |
|
293 | - $links = array( |
|
294 | - 'self' => array( |
|
295 | - 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
296 | - ), |
|
297 | - 'collection' => array( |
|
298 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
299 | - ), |
|
300 | - ); |
|
301 | - |
|
302 | - return $links; |
|
303 | - } |
|
304 | - |
|
305 | - /** |
|
306 | - * Prepare a settings object for serialization. |
|
307 | - * |
|
308 | - * @since 2.0.0 |
|
309 | - * @param array $item Setting object. |
|
310 | - * @param WP_REST_Request $request Request object. |
|
311 | - * @return WP_REST_Response $response Response data. |
|
312 | - */ |
|
313 | - public function prepare_item_for_response( $item, $request ) { |
|
314 | - $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
315 | - $data = $this->add_additional_fields_to_object( $item, $request ); |
|
316 | - $data = $this->filter_response_by_context( $data, $context ); |
|
317 | - |
|
318 | - $response = rest_ensure_response( $data ); |
|
319 | - |
|
320 | - $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
321 | - |
|
322 | - return $response; |
|
323 | - } |
|
324 | - |
|
325 | - /** |
|
326 | - * Filters out bad values from the settings array/filter so we |
|
327 | - * only return known values via the API. |
|
328 | - * |
|
329 | - * @since 2.0.0 |
|
330 | - * @param array $setting Setting. |
|
331 | - * @return array |
|
332 | - */ |
|
333 | - public function filter_setting( $setting ) { |
|
334 | - return array_intersect_key( |
|
335 | - $setting, |
|
336 | - array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
337 | - ); |
|
338 | - } |
|
339 | - |
|
340 | - /** |
|
341 | - * Callback for allowed keys for each setting response. |
|
342 | - * |
|
343 | - * @param string $key Key to check. |
|
344 | - * @return boolean |
|
345 | - */ |
|
346 | - public function allowed_setting_keys( $key ) { |
|
347 | - return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
348 | - } |
|
349 | - |
|
350 | - /** |
|
351 | - * Returns default options for a setting. null means the field is required. |
|
352 | - * |
|
353 | - * @since 2.0.0 |
|
354 | - * @return array |
|
355 | - */ |
|
356 | - protected function setting_defaults() { |
|
357 | - return array( |
|
358 | - 'id' => null, |
|
359 | - 'name' => null, |
|
360 | - 'desc' => '', |
|
361 | - 'options' => array(), |
|
362 | - 'std' => false, |
|
363 | - 'value' => false, |
|
364 | - 'placeholder' => '', |
|
365 | - 'readonly' => false, |
|
366 | - 'faux' => false, |
|
367 | - 'section' => 'main', |
|
368 | - 'tab' => 'general', |
|
369 | - 'type' => 'text', |
|
370 | - ); |
|
371 | - } |
|
372 | - |
|
373 | - /** |
|
374 | - * Sanitizes a setting's field. |
|
375 | - * |
|
376 | - * @param array $setting The setting to sanitize. |
|
377 | - * @return array |
|
378 | - */ |
|
379 | - public function sanitize_setting( $setting ) { |
|
156 | + /** |
|
157 | + * Return all settings. |
|
158 | + * |
|
159 | + * @since 2.0.0 |
|
160 | + * @param WP_REST_Request $request Request data. |
|
161 | + * @return WP_Error|WP_REST_Response |
|
162 | + */ |
|
163 | + public function get_items( $request ) { |
|
164 | + |
|
165 | + $settings = $this->get_settings(); |
|
166 | + |
|
167 | + if ( ! isset( $settings[ $request['tab'] ] ) ) { |
|
168 | + return new WP_Error( 'rest_invalid_tab', __( 'Invalid tab.', 'invoicing' ), array( 'status' => 400 ) ); |
|
169 | + } |
|
170 | + |
|
171 | + if ( ! isset( $settings[ $request['tab'] ][ $request['section'] ] ) ) { |
|
172 | + return new WP_Error( 'rest_invalid_section', __( 'Invalid section.', 'invoicing' ), array( 'status' => 400 ) ); |
|
173 | + } |
|
174 | + |
|
175 | + $settings = $settings[ $request['tab'] ][ $request['section'] ]; |
|
176 | + $prepared = array(); |
|
177 | + |
|
178 | + foreach ( $settings as $setting ) { |
|
179 | + |
|
180 | + $setting = $this->sanitize_setting( $setting ); |
|
181 | + $setting_data = $this->prepare_item_for_response( $setting, $request ); |
|
182 | + $setting_data = $this->prepare_response_for_collection( $setting_data ); |
|
183 | + |
|
184 | + if ( $this->is_setting_type_valid( $setting['type'] ) ) { |
|
185 | + $prepared[] = $setting_data; |
|
186 | + } |
|
187 | + |
|
188 | + } |
|
189 | + |
|
190 | + return rest_ensure_response( $prepared ); |
|
191 | + } |
|
192 | + |
|
193 | + /** |
|
194 | + * Return a single setting. |
|
195 | + * |
|
196 | + * @since 2.0.0 |
|
197 | + * @param WP_REST_Request $request Request data. |
|
198 | + * @return WP_Error|WP_REST_Response |
|
199 | + */ |
|
200 | + public function get_item( $request ) { |
|
201 | + $setting = $this->get_setting( $request['id'] ); |
|
202 | + |
|
203 | + if ( is_wp_error( $setting ) ) { |
|
204 | + return $setting; |
|
205 | + } |
|
206 | + |
|
207 | + $setting = $this->sanitize_setting( $setting ); |
|
208 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
209 | + return rest_ensure_response( $response ); |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Update a single setting. |
|
214 | + * |
|
215 | + * @since 2.0.0 |
|
216 | + * @param WP_REST_Request $request Request data. |
|
217 | + * @return WP_Error|WP_REST_Response |
|
218 | + */ |
|
219 | + public function update_item( $request ) { |
|
220 | + $setting = $this->get_setting( $request['id'] ); |
|
221 | + |
|
222 | + if ( is_wp_error( $setting ) ) { |
|
223 | + return $setting; |
|
224 | + } |
|
225 | + |
|
226 | + if ( is_callable( array( $this, 'validate_setting_' . $setting['type'] . '_field' ) ) ) { |
|
227 | + $value = $this->{'validate_setting_' . $setting['type'] . '_field'}( $request['value'], $setting ); |
|
228 | + } else { |
|
229 | + $value = $this->validate_setting_text_field( $request['value'], $setting ); |
|
230 | + } |
|
231 | + |
|
232 | + if ( is_wp_error( $value ) ) { |
|
233 | + return $value; |
|
234 | + } |
|
235 | + |
|
236 | + wpinv_update_option( $request['id'], $value ); |
|
237 | + $setting['value'] = $value; |
|
238 | + $setting = $this->sanitize_setting( $setting ); |
|
239 | + $response = $this->prepare_item_for_response( $setting, $request ); |
|
240 | + |
|
241 | + return rest_ensure_response( $response ); |
|
242 | + } |
|
243 | + |
|
244 | + /** |
|
245 | + * Makes sure the current user has access to READ the settings APIs. |
|
246 | + * |
|
247 | + * @since 2.0.0 |
|
248 | + * @param WP_REST_Request $request Full data about the request. |
|
249 | + * @return WP_Error|boolean |
|
250 | + */ |
|
251 | + public function get_items_permissions_check( $request ) { |
|
252 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
253 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
254 | + } |
|
255 | + |
|
256 | + return true; |
|
257 | + } |
|
258 | + |
|
259 | + /** |
|
260 | + * Makes sure the current user has access to WRITE the settings APIs. |
|
261 | + * |
|
262 | + * @since 2.0.0 |
|
263 | + * @param WP_REST_Request $request Full data about the request. |
|
264 | + * @return WP_Error|boolean |
|
265 | + */ |
|
266 | + public function update_items_permissions_check( $request ) { |
|
267 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
268 | + return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
269 | + } |
|
270 | + |
|
271 | + return true; |
|
272 | + } |
|
273 | + |
|
274 | + /** |
|
275 | + * Check if a given request has access batch create, update and delete items. |
|
276 | + * |
|
277 | + * @param WP_REST_Request $request Full details about the request. |
|
278 | + * |
|
279 | + * @return boolean|WP_Error |
|
280 | + */ |
|
281 | + public function batch_items_permissions_check( $request ) { |
|
282 | + return wpinv_current_user_can_manage_invoicing() ? true : new WP_Error( 'rest_cannot_batch', __( 'Sorry, you are not allowed to batch manipulate this resource.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * Prepare links for the request. |
|
287 | + * |
|
288 | + * @param string $setting_id Setting ID. |
|
289 | + * @return array Links for the given setting. |
|
290 | + */ |
|
291 | + protected function prepare_links( $setting_id ) { |
|
292 | + |
|
293 | + $links = array( |
|
294 | + 'self' => array( |
|
295 | + 'href' => rest_url( sprintf( '/%s/%s/setting/%s', $this->namespace, $this->rest_base, $setting_id ) ), |
|
296 | + ), |
|
297 | + 'collection' => array( |
|
298 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
299 | + ), |
|
300 | + ); |
|
301 | + |
|
302 | + return $links; |
|
303 | + } |
|
304 | + |
|
305 | + /** |
|
306 | + * Prepare a settings object for serialization. |
|
307 | + * |
|
308 | + * @since 2.0.0 |
|
309 | + * @param array $item Setting object. |
|
310 | + * @param WP_REST_Request $request Request object. |
|
311 | + * @return WP_REST_Response $response Response data. |
|
312 | + */ |
|
313 | + public function prepare_item_for_response( $item, $request ) { |
|
314 | + $context = empty( $request['context'] ) ? 'view' : $request['context']; |
|
315 | + $data = $this->add_additional_fields_to_object( $item, $request ); |
|
316 | + $data = $this->filter_response_by_context( $data, $context ); |
|
317 | + |
|
318 | + $response = rest_ensure_response( $data ); |
|
319 | + |
|
320 | + $response->add_links( $this->prepare_links( $item['id'] ) ); |
|
321 | + |
|
322 | + return $response; |
|
323 | + } |
|
324 | + |
|
325 | + /** |
|
326 | + * Filters out bad values from the settings array/filter so we |
|
327 | + * only return known values via the API. |
|
328 | + * |
|
329 | + * @since 2.0.0 |
|
330 | + * @param array $setting Setting. |
|
331 | + * @return array |
|
332 | + */ |
|
333 | + public function filter_setting( $setting ) { |
|
334 | + return array_intersect_key( |
|
335 | + $setting, |
|
336 | + array_flip( array_filter( array_keys( $setting ), array( $this, 'allowed_setting_keys' ) ) ) |
|
337 | + ); |
|
338 | + } |
|
339 | + |
|
340 | + /** |
|
341 | + * Callback for allowed keys for each setting response. |
|
342 | + * |
|
343 | + * @param string $key Key to check. |
|
344 | + * @return boolean |
|
345 | + */ |
|
346 | + public function allowed_setting_keys( $key ) { |
|
347 | + return in_array( $key, array_keys( $this->setting_defaults() ), true ); |
|
348 | + } |
|
349 | + |
|
350 | + /** |
|
351 | + * Returns default options for a setting. null means the field is required. |
|
352 | + * |
|
353 | + * @since 2.0.0 |
|
354 | + * @return array |
|
355 | + */ |
|
356 | + protected function setting_defaults() { |
|
357 | + return array( |
|
358 | + 'id' => null, |
|
359 | + 'name' => null, |
|
360 | + 'desc' => '', |
|
361 | + 'options' => array(), |
|
362 | + 'std' => false, |
|
363 | + 'value' => false, |
|
364 | + 'placeholder' => '', |
|
365 | + 'readonly' => false, |
|
366 | + 'faux' => false, |
|
367 | + 'section' => 'main', |
|
368 | + 'tab' => 'general', |
|
369 | + 'type' => 'text', |
|
370 | + ); |
|
371 | + } |
|
372 | + |
|
373 | + /** |
|
374 | + * Sanitizes a setting's field. |
|
375 | + * |
|
376 | + * @param array $setting The setting to sanitize. |
|
377 | + * @return array |
|
378 | + */ |
|
379 | + public function sanitize_setting( $setting ) { |
|
380 | 380 | |
381 | - $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
382 | - $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
383 | - return $this->filter_setting( $setting ); |
|
384 | - |
|
385 | - } |
|
386 | - |
|
387 | - /** |
|
388 | - * Get setting data. |
|
389 | - * |
|
390 | - * @since 2.0.0 |
|
391 | - * @param string $setting_id Setting ID. |
|
392 | - * @return array|WP_Error |
|
393 | - */ |
|
394 | - public function get_setting( $setting_id ) { |
|
395 | - |
|
396 | - if ( empty( $setting_id ) ) { |
|
397 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
398 | - } |
|
399 | - |
|
400 | - $settings = $this->get_settings(); |
|
401 | - |
|
402 | - foreach ( $settings as $tabs ) { |
|
403 | - |
|
404 | - foreach ( $tabs as $sections ) { |
|
405 | - |
|
406 | - if ( isset( $sections[ $setting_id ] ) ) { |
|
407 | - if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
408 | - return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
409 | - } |
|
410 | - |
|
411 | - return $sections[ $setting_id ]; |
|
412 | - } |
|
413 | - |
|
414 | - } |
|
415 | - |
|
416 | - } |
|
417 | - |
|
418 | - return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
419 | - } |
|
420 | - |
|
421 | - /** |
|
422 | - * Get all tabs. |
|
423 | - * |
|
424 | - * @param WP_REST_Request $request Request data. |
|
425 | - * @return array |
|
426 | - */ |
|
427 | - public function get_tabs( $request ) { |
|
428 | - $tabs = wpinv_get_settings_tabs(); |
|
429 | - $prepared = array(); |
|
430 | - |
|
431 | - foreach ( $tabs as $id => $tab ) { |
|
432 | - |
|
433 | - $_request = $request; |
|
434 | - $_request['tab'] = sanitize_title( $id ); |
|
435 | - $data = array( |
|
436 | - 'id' => sanitize_title( $id ), |
|
437 | - 'label' => sanitize_text_field( $tab ), |
|
438 | - 'sections' => $this->get_sections( $_request ), |
|
439 | - ); |
|
440 | - |
|
441 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
442 | - $response = rest_ensure_response( $data ); |
|
443 | - |
|
444 | - if ( ! is_wp_error( $response ) ) { |
|
445 | - $links = array( |
|
446 | - 'sections' => array( |
|
447 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
448 | - ), |
|
449 | - 'collection' => array( |
|
450 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
451 | - ), |
|
452 | - ); |
|
453 | - $response->add_links( $links ); |
|
454 | - $response = $this->prepare_response_for_collection( $response ); |
|
455 | - } |
|
456 | - |
|
457 | - $prepared[] = $response; |
|
458 | - |
|
459 | - } |
|
460 | - |
|
461 | - return rest_ensure_response( $prepared ); |
|
462 | - } |
|
463 | - |
|
464 | - /** |
|
465 | - * Get all sections. |
|
466 | - * |
|
467 | - * @param WP_REST_Request $request Request data. |
|
468 | - * @return array |
|
469 | - */ |
|
470 | - public function get_sections( $request ) { |
|
471 | - |
|
472 | - $tab = sanitize_title( $request['tab'] ); |
|
473 | - $sections = wpinv_get_settings_tab_sections( $tab ); |
|
474 | - $prepared = array(); |
|
475 | - |
|
476 | - foreach ( $sections as $id => $section ) { |
|
477 | - |
|
478 | - $data = array( |
|
479 | - 'id' => sanitize_title( $id ), |
|
480 | - 'label' => sanitize_text_field( $section ), |
|
481 | - ); |
|
482 | - |
|
483 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
484 | - $response = rest_ensure_response( $data ); |
|
485 | - |
|
486 | - if ( ! is_wp_error( $response ) ) { |
|
487 | - $links = array( |
|
488 | - 'settings' => array( |
|
489 | - 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
490 | - ), |
|
491 | - 'collection' => array( |
|
492 | - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
493 | - ), |
|
494 | - 'tabs' => array( |
|
495 | - 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
496 | - ), |
|
497 | - ); |
|
498 | - $response->add_links( $links ); |
|
499 | - $response = $this->prepare_response_for_collection( $response ); |
|
500 | - } |
|
501 | - |
|
502 | - $prepared[] = $response; |
|
503 | - |
|
504 | - } |
|
505 | - |
|
506 | - return rest_ensure_response( $prepared ); |
|
507 | - } |
|
508 | - |
|
509 | - /** |
|
510 | - * Get all settings. |
|
511 | - * |
|
512 | - * @return array |
|
513 | - */ |
|
514 | - public function get_settings() { |
|
515 | - |
|
516 | - if ( empty( $this->settings ) ) { |
|
517 | - $this->settings = wpinv_get_registered_settings(); |
|
518 | - } |
|
519 | - |
|
520 | - return $this->settings; |
|
521 | - |
|
522 | - } |
|
523 | - |
|
524 | - /** |
|
525 | - * Boolean for if a setting type is a valid supported setting type. |
|
526 | - * |
|
527 | - * @since 2.0.0 |
|
528 | - * @param string $type Type. |
|
529 | - * @return bool |
|
530 | - */ |
|
531 | - public function is_setting_type_valid( $type ) { |
|
532 | - |
|
533 | - return in_array( |
|
534 | - $type, array( |
|
535 | - 'text', // Validates with validate_setting_text_field. |
|
536 | - 'email', // Validates with validate_setting_text_field. |
|
537 | - 'number', // Validates with validate_setting_text_field. |
|
538 | - 'color', // Validates with validate_setting_text_field. |
|
539 | - 'password', // Validates with validate_setting_text_field. |
|
540 | - 'textarea', // Validates with validate_setting_textarea_field. |
|
541 | - 'select', // Validates with validate_setting_select_field. |
|
542 | - 'multiselect', // Validates with validate_setting_multiselect_field. |
|
543 | - 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
544 | - 'checkbox', // Validates with validate_setting_checkbox_field. |
|
545 | - 'header', // Validates with validate_setting_text_field. |
|
546 | - ) |
|
547 | - ); |
|
548 | - |
|
549 | - } |
|
550 | - |
|
551 | - /** |
|
552 | - * Get the settings schema, conforming to JSON Schema. |
|
553 | - * |
|
554 | - * @return array |
|
555 | - */ |
|
556 | - public function get_item_schema() { |
|
557 | - |
|
558 | - // Maybe retrieve the schema from cache. |
|
559 | - if ( ! empty( $this->schema ) ) { |
|
560 | - return $this->add_additional_fields_schema( $this->schema ); |
|
561 | - } |
|
562 | - |
|
563 | - $schema = array( |
|
564 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
565 | - 'title' => 'setting', |
|
566 | - 'type' => 'object', |
|
567 | - 'properties' => array( |
|
568 | - 'id' => array( |
|
569 | - 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
570 | - 'type' => 'string', |
|
571 | - 'arg_options' => array( |
|
572 | - 'sanitize_callback' => 'sanitize_title', |
|
573 | - ), |
|
574 | - 'context' => array( 'view', 'edit' ), |
|
575 | - 'readonly' => true, |
|
576 | - ), |
|
577 | - 'tab' => array( |
|
578 | - 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
579 | - 'type' => 'string', |
|
580 | - 'arg_options' => array( |
|
581 | - 'sanitize_callback' => 'sanitize_title', |
|
582 | - ), |
|
583 | - 'context' => array( 'view', 'edit' ), |
|
584 | - 'readonly' => true, |
|
585 | - ), |
|
586 | - 'section' => array( |
|
587 | - 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
588 | - 'type' => 'string', |
|
589 | - 'arg_options' => array( |
|
590 | - 'sanitize_callback' => 'sanitize_title', |
|
591 | - ), |
|
592 | - 'context' => array( 'view', 'edit' ), |
|
593 | - 'readonly' => true, |
|
594 | - ), |
|
595 | - 'name' => array( |
|
596 | - 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
597 | - 'type' => 'string', |
|
598 | - 'arg_options' => array( |
|
599 | - 'sanitize_callback' => 'sanitize_text_field', |
|
600 | - ), |
|
601 | - 'context' => array( 'view', 'edit' ), |
|
602 | - 'readonly' => true, |
|
603 | - ), |
|
604 | - 'desc' => array( |
|
605 | - 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
606 | - 'type' => 'string', |
|
607 | - 'context' => array( 'view', 'edit' ), |
|
608 | - 'readonly' => true, |
|
609 | - ), |
|
610 | - 'value' => array( |
|
611 | - 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
612 | - 'type' => 'mixed', |
|
613 | - 'context' => array( 'view', 'edit' ), |
|
614 | - ), |
|
615 | - 'default' => array( |
|
616 | - 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
617 | - 'type' => 'mixed', |
|
618 | - 'context' => array( 'view', 'edit' ), |
|
619 | - 'readonly' => true, |
|
620 | - ), |
|
621 | - 'placeholder' => array( |
|
622 | - 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
623 | - 'type' => 'string', |
|
624 | - 'arg_options' => array( |
|
625 | - 'sanitize_callback' => 'sanitize_text_field', |
|
626 | - ), |
|
627 | - 'context' => array( 'view', 'edit' ), |
|
628 | - 'readonly' => true, |
|
629 | - ), |
|
630 | - 'type' => array( |
|
631 | - 'description' => __( 'Type of setting.', 'invoicing' ), |
|
632 | - 'type' => 'string', |
|
633 | - 'arg_options' => array( |
|
634 | - 'sanitize_callback' => 'sanitize_text_field', |
|
635 | - ), |
|
636 | - 'context' => array( 'view', 'edit' ), |
|
637 | - 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
638 | - 'readonly' => true, |
|
639 | - ), |
|
640 | - 'options' => array( |
|
641 | - 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
642 | - 'type' => 'object', |
|
643 | - 'context' => array( 'view', 'edit' ), |
|
644 | - 'readonly' => true, |
|
645 | - ), |
|
646 | - 'readonly' => array( |
|
647 | - 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
648 | - 'type' => 'string', |
|
649 | - 'context' => array( 'view' ), |
|
650 | - 'readonly' => true, |
|
651 | - ), |
|
652 | - 'faux' => array( |
|
653 | - 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
654 | - 'type' => 'string', |
|
655 | - 'context' => array( 'view' ), |
|
656 | - 'readonly' => true, |
|
657 | - ), |
|
658 | - ), |
|
659 | - ); |
|
660 | - |
|
661 | - // Filters the settings schema for the REST API. |
|
381 | + $setting = wp_parse_args( $setting, $this->setting_defaults() ); |
|
382 | + $setting['value'] = wpinv_get_option( $setting['id'], $setting['std'] ); |
|
383 | + return $this->filter_setting( $setting ); |
|
384 | + |
|
385 | + } |
|
386 | + |
|
387 | + /** |
|
388 | + * Get setting data. |
|
389 | + * |
|
390 | + * @since 2.0.0 |
|
391 | + * @param string $setting_id Setting ID. |
|
392 | + * @return array|WP_Error |
|
393 | + */ |
|
394 | + public function get_setting( $setting_id ) { |
|
395 | + |
|
396 | + if ( empty( $setting_id ) ) { |
|
397 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
398 | + } |
|
399 | + |
|
400 | + $settings = $this->get_settings(); |
|
401 | + |
|
402 | + foreach ( $settings as $tabs ) { |
|
403 | + |
|
404 | + foreach ( $tabs as $sections ) { |
|
405 | + |
|
406 | + if ( isset( $sections[ $setting_id ] ) ) { |
|
407 | + if ( ! $this->is_setting_type_valid( $sections[ $setting_id ]['type'] ) ) { |
|
408 | + return new WP_Error( 'rest_setting_setting_type_invalid', __( 'Invalid setting type.', 'invoicing' ), array( 'status' => 404 ) ); |
|
409 | + } |
|
410 | + |
|
411 | + return $sections[ $setting_id ]; |
|
412 | + } |
|
413 | + |
|
414 | + } |
|
415 | + |
|
416 | + } |
|
417 | + |
|
418 | + return new WP_Error( 'rest_setting_setting_invalid', __( 'Invalid setting.', 'invoicing' ), array( 'status' => 404 ) ); |
|
419 | + } |
|
420 | + |
|
421 | + /** |
|
422 | + * Get all tabs. |
|
423 | + * |
|
424 | + * @param WP_REST_Request $request Request data. |
|
425 | + * @return array |
|
426 | + */ |
|
427 | + public function get_tabs( $request ) { |
|
428 | + $tabs = wpinv_get_settings_tabs(); |
|
429 | + $prepared = array(); |
|
430 | + |
|
431 | + foreach ( $tabs as $id => $tab ) { |
|
432 | + |
|
433 | + $_request = $request; |
|
434 | + $_request['tab'] = sanitize_title( $id ); |
|
435 | + $data = array( |
|
436 | + 'id' => sanitize_title( $id ), |
|
437 | + 'label' => sanitize_text_field( $tab ), |
|
438 | + 'sections' => $this->get_sections( $_request ), |
|
439 | + ); |
|
440 | + |
|
441 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
442 | + $response = rest_ensure_response( $data ); |
|
443 | + |
|
444 | + if ( ! is_wp_error( $response ) ) { |
|
445 | + $links = array( |
|
446 | + 'sections' => array( |
|
447 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $id ) ), |
|
448 | + ), |
|
449 | + 'collection' => array( |
|
450 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
451 | + ), |
|
452 | + ); |
|
453 | + $response->add_links( $links ); |
|
454 | + $response = $this->prepare_response_for_collection( $response ); |
|
455 | + } |
|
456 | + |
|
457 | + $prepared[] = $response; |
|
458 | + |
|
459 | + } |
|
460 | + |
|
461 | + return rest_ensure_response( $prepared ); |
|
462 | + } |
|
463 | + |
|
464 | + /** |
|
465 | + * Get all sections. |
|
466 | + * |
|
467 | + * @param WP_REST_Request $request Request data. |
|
468 | + * @return array |
|
469 | + */ |
|
470 | + public function get_sections( $request ) { |
|
471 | + |
|
472 | + $tab = sanitize_title( $request['tab'] ); |
|
473 | + $sections = wpinv_get_settings_tab_sections( $tab ); |
|
474 | + $prepared = array(); |
|
475 | + |
|
476 | + foreach ( $sections as $id => $section ) { |
|
477 | + |
|
478 | + $data = array( |
|
479 | + 'id' => sanitize_title( $id ), |
|
480 | + 'label' => sanitize_text_field( $section ), |
|
481 | + ); |
|
482 | + |
|
483 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
484 | + $response = rest_ensure_response( $data ); |
|
485 | + |
|
486 | + if ( ! is_wp_error( $response ) ) { |
|
487 | + $links = array( |
|
488 | + 'settings' => array( |
|
489 | + 'href' => rest_url( sprintf( '/%s/%s/%s/%s', $this->namespace, $this->rest_base, $tab, $id ) ), |
|
490 | + ), |
|
491 | + 'collection' => array( |
|
492 | + 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $tab ) ), |
|
493 | + ), |
|
494 | + 'tabs' => array( |
|
495 | + 'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ), |
|
496 | + ), |
|
497 | + ); |
|
498 | + $response->add_links( $links ); |
|
499 | + $response = $this->prepare_response_for_collection( $response ); |
|
500 | + } |
|
501 | + |
|
502 | + $prepared[] = $response; |
|
503 | + |
|
504 | + } |
|
505 | + |
|
506 | + return rest_ensure_response( $prepared ); |
|
507 | + } |
|
508 | + |
|
509 | + /** |
|
510 | + * Get all settings. |
|
511 | + * |
|
512 | + * @return array |
|
513 | + */ |
|
514 | + public function get_settings() { |
|
515 | + |
|
516 | + if ( empty( $this->settings ) ) { |
|
517 | + $this->settings = wpinv_get_registered_settings(); |
|
518 | + } |
|
519 | + |
|
520 | + return $this->settings; |
|
521 | + |
|
522 | + } |
|
523 | + |
|
524 | + /** |
|
525 | + * Boolean for if a setting type is a valid supported setting type. |
|
526 | + * |
|
527 | + * @since 2.0.0 |
|
528 | + * @param string $type Type. |
|
529 | + * @return bool |
|
530 | + */ |
|
531 | + public function is_setting_type_valid( $type ) { |
|
532 | + |
|
533 | + return in_array( |
|
534 | + $type, array( |
|
535 | + 'text', // Validates with validate_setting_text_field. |
|
536 | + 'email', // Validates with validate_setting_text_field. |
|
537 | + 'number', // Validates with validate_setting_text_field. |
|
538 | + 'color', // Validates with validate_setting_text_field. |
|
539 | + 'password', // Validates with validate_setting_text_field. |
|
540 | + 'textarea', // Validates with validate_setting_textarea_field. |
|
541 | + 'select', // Validates with validate_setting_select_field. |
|
542 | + 'multiselect', // Validates with validate_setting_multiselect_field. |
|
543 | + 'radio', // Validates with validate_setting_radio_field (-> validate_setting_select_field). |
|
544 | + 'checkbox', // Validates with validate_setting_checkbox_field. |
|
545 | + 'header', // Validates with validate_setting_text_field. |
|
546 | + ) |
|
547 | + ); |
|
548 | + |
|
549 | + } |
|
550 | + |
|
551 | + /** |
|
552 | + * Get the settings schema, conforming to JSON Schema. |
|
553 | + * |
|
554 | + * @return array |
|
555 | + */ |
|
556 | + public function get_item_schema() { |
|
557 | + |
|
558 | + // Maybe retrieve the schema from cache. |
|
559 | + if ( ! empty( $this->schema ) ) { |
|
560 | + return $this->add_additional_fields_schema( $this->schema ); |
|
561 | + } |
|
562 | + |
|
563 | + $schema = array( |
|
564 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
565 | + 'title' => 'setting', |
|
566 | + 'type' => 'object', |
|
567 | + 'properties' => array( |
|
568 | + 'id' => array( |
|
569 | + 'description' => __( 'A unique identifier for the setting.', 'invoicing' ), |
|
570 | + 'type' => 'string', |
|
571 | + 'arg_options' => array( |
|
572 | + 'sanitize_callback' => 'sanitize_title', |
|
573 | + ), |
|
574 | + 'context' => array( 'view', 'edit' ), |
|
575 | + 'readonly' => true, |
|
576 | + ), |
|
577 | + 'tab' => array( |
|
578 | + 'description' => __( 'An identifier for the tab this setting belongs to.', 'invoicing' ), |
|
579 | + 'type' => 'string', |
|
580 | + 'arg_options' => array( |
|
581 | + 'sanitize_callback' => 'sanitize_title', |
|
582 | + ), |
|
583 | + 'context' => array( 'view', 'edit' ), |
|
584 | + 'readonly' => true, |
|
585 | + ), |
|
586 | + 'section' => array( |
|
587 | + 'description' => __( 'An identifier for the section this setting belongs to.', 'invoicing' ), |
|
588 | + 'type' => 'string', |
|
589 | + 'arg_options' => array( |
|
590 | + 'sanitize_callback' => 'sanitize_title', |
|
591 | + ), |
|
592 | + 'context' => array( 'view', 'edit' ), |
|
593 | + 'readonly' => true, |
|
594 | + ), |
|
595 | + 'name' => array( |
|
596 | + 'description' => __( 'A human readable label for the setting used in interfaces.', 'invoicing' ), |
|
597 | + 'type' => 'string', |
|
598 | + 'arg_options' => array( |
|
599 | + 'sanitize_callback' => 'sanitize_text_field', |
|
600 | + ), |
|
601 | + 'context' => array( 'view', 'edit' ), |
|
602 | + 'readonly' => true, |
|
603 | + ), |
|
604 | + 'desc' => array( |
|
605 | + 'description' => __( 'A human readable description for the setting used in interfaces.', 'invoicing' ), |
|
606 | + 'type' => 'string', |
|
607 | + 'context' => array( 'view', 'edit' ), |
|
608 | + 'readonly' => true, |
|
609 | + ), |
|
610 | + 'value' => array( |
|
611 | + 'description' => __( 'The current value of this setting.', 'invoicing' ), |
|
612 | + 'type' => 'mixed', |
|
613 | + 'context' => array( 'view', 'edit' ), |
|
614 | + ), |
|
615 | + 'default' => array( |
|
616 | + 'description' => __( 'Default value for the setting.', 'invoicing' ), |
|
617 | + 'type' => 'mixed', |
|
618 | + 'context' => array( 'view', 'edit' ), |
|
619 | + 'readonly' => true, |
|
620 | + ), |
|
621 | + 'placeholder' => array( |
|
622 | + 'description' => __( 'Placeholder text to be displayed in text inputs.', 'invoicing' ), |
|
623 | + 'type' => 'string', |
|
624 | + 'arg_options' => array( |
|
625 | + 'sanitize_callback' => 'sanitize_text_field', |
|
626 | + ), |
|
627 | + 'context' => array( 'view', 'edit' ), |
|
628 | + 'readonly' => true, |
|
629 | + ), |
|
630 | + 'type' => array( |
|
631 | + 'description' => __( 'Type of setting.', 'invoicing' ), |
|
632 | + 'type' => 'string', |
|
633 | + 'arg_options' => array( |
|
634 | + 'sanitize_callback' => 'sanitize_text_field', |
|
635 | + ), |
|
636 | + 'context' => array( 'view', 'edit' ), |
|
637 | + 'enum' => array( 'text', 'email', 'number', 'color', 'password', 'textarea', 'select', 'multiselect', 'radio', 'image_width', 'checkbox', 'raw_html' ), |
|
638 | + 'readonly' => true, |
|
639 | + ), |
|
640 | + 'options' => array( |
|
641 | + 'description' => __( 'Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons.', 'invoicing' ), |
|
642 | + 'type' => 'object', |
|
643 | + 'context' => array( 'view', 'edit' ), |
|
644 | + 'readonly' => true, |
|
645 | + ), |
|
646 | + 'readonly' => array( |
|
647 | + 'description' => __( 'Whether or not this setting is readonly', 'invoicing' ), |
|
648 | + 'type' => 'string', |
|
649 | + 'context' => array( 'view' ), |
|
650 | + 'readonly' => true, |
|
651 | + ), |
|
652 | + 'faux' => array( |
|
653 | + 'description' => __( 'Whether or not this setting is readonly/faux', 'invoicing' ), |
|
654 | + 'type' => 'string', |
|
655 | + 'context' => array( 'view' ), |
|
656 | + 'readonly' => true, |
|
657 | + ), |
|
658 | + ), |
|
659 | + ); |
|
660 | + |
|
661 | + // Filters the settings schema for the REST API. |
|
662 | 662 | $schema = apply_filters( 'getpaid_rest_settings_schema', $schema ); |
663 | 663 | |
664 | - // Cache the settings schema. |
|
665 | - $this->schema = $schema; |
|
666 | - |
|
667 | - return $this->add_additional_fields_schema( $this->schema ); |
|
668 | - |
|
669 | - } |
|
670 | - |
|
671 | - /** |
|
672 | - * Validate a text value for a text based setting. |
|
673 | - * |
|
674 | - * @since 2.0.0 |
|
675 | - * @param string $value Value. |
|
676 | - * @param array $setting Setting. |
|
677 | - * @return string |
|
678 | - */ |
|
679 | - public function validate_setting_text_field( $value ) { |
|
680 | - $value = is_null( $value ) ? '' : $value; |
|
681 | - return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
682 | - } |
|
683 | - |
|
684 | - /** |
|
685 | - * Validate select based settings. |
|
686 | - * |
|
687 | - * @since 2.0.0 |
|
688 | - * @param string $value Value. |
|
689 | - * @param array $setting Setting. |
|
690 | - * @return string|WP_Error |
|
691 | - */ |
|
692 | - public function validate_setting_select_field( $value, $setting ) { |
|
693 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
694 | - return $value; |
|
695 | - } else { |
|
696 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
697 | - } |
|
698 | - } |
|
699 | - |
|
700 | - /** |
|
701 | - * Validate multiselect based settings. |
|
702 | - * |
|
703 | - * @since 2.0.0 |
|
704 | - * @param array $values Values. |
|
705 | - * @param array $setting Setting. |
|
706 | - * @return array|WP_Error |
|
707 | - */ |
|
708 | - public function validate_setting_multiselect_field( $values, $setting ) { |
|
709 | - if ( empty( $values ) ) { |
|
710 | - return array(); |
|
711 | - } |
|
712 | - |
|
713 | - if ( ! is_array( $values ) ) { |
|
714 | - return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
715 | - } |
|
716 | - |
|
717 | - $final_values = array(); |
|
718 | - foreach ( $values as $value ) { |
|
719 | - if ( array_key_exists( $value, $setting['options'] ) ) { |
|
720 | - $final_values[] = $value; |
|
721 | - } |
|
722 | - } |
|
723 | - |
|
724 | - return $final_values; |
|
725 | - } |
|
726 | - |
|
727 | - /** |
|
728 | - * Validate radio based settings. |
|
729 | - * |
|
730 | - * @since 2.0.0 |
|
731 | - * @param string $value Value. |
|
732 | - * @param array $setting Setting. |
|
733 | - * @return string|WP_Error |
|
734 | - */ |
|
735 | - public function validate_setting_radio_field( $value, $setting ) { |
|
736 | - return $this->validate_setting_select_field( $value, $setting ); |
|
737 | - } |
|
738 | - |
|
739 | - /** |
|
740 | - * Validate checkbox based settings. |
|
741 | - * |
|
742 | - * @since 2.0.0 |
|
743 | - * @param string $value Value. |
|
744 | - * @return int |
|
745 | - */ |
|
746 | - public function validate_setting_checkbox_field( $value ) { |
|
747 | - return (int) ! empty( $value ); |
|
748 | - } |
|
749 | - |
|
750 | - /** |
|
751 | - * Validate textarea based settings. |
|
752 | - * |
|
753 | - * @since 2.0.0 |
|
754 | - * @param string $value Value. |
|
755 | - * @return string |
|
756 | - */ |
|
757 | - public function validate_setting_textarea_field( $value ) { |
|
758 | - $value = is_null( $value ) ? '' : $value; |
|
759 | - return wp_kses( |
|
760 | - trim( stripslashes( $value ) ), |
|
761 | - array_merge( |
|
762 | - array( |
|
763 | - 'iframe' => array( |
|
764 | - 'src' => true, |
|
765 | - 'style' => true, |
|
766 | - 'id' => true, |
|
767 | - 'class' => true, |
|
768 | - ), |
|
769 | - ), |
|
770 | - wp_kses_allowed_html( 'post' ) |
|
771 | - ) |
|
772 | - ); |
|
773 | - } |
|
664 | + // Cache the settings schema. |
|
665 | + $this->schema = $schema; |
|
666 | + |
|
667 | + return $this->add_additional_fields_schema( $this->schema ); |
|
668 | + |
|
669 | + } |
|
670 | + |
|
671 | + /** |
|
672 | + * Validate a text value for a text based setting. |
|
673 | + * |
|
674 | + * @since 2.0.0 |
|
675 | + * @param string $value Value. |
|
676 | + * @param array $setting Setting. |
|
677 | + * @return string |
|
678 | + */ |
|
679 | + public function validate_setting_text_field( $value ) { |
|
680 | + $value = is_null( $value ) ? '' : $value; |
|
681 | + return wp_kses_post( trim( stripslashes( $value ) ) ); |
|
682 | + } |
|
683 | + |
|
684 | + /** |
|
685 | + * Validate select based settings. |
|
686 | + * |
|
687 | + * @since 2.0.0 |
|
688 | + * @param string $value Value. |
|
689 | + * @param array $setting Setting. |
|
690 | + * @return string|WP_Error |
|
691 | + */ |
|
692 | + public function validate_setting_select_field( $value, $setting ) { |
|
693 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
694 | + return $value; |
|
695 | + } else { |
|
696 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
697 | + } |
|
698 | + } |
|
699 | + |
|
700 | + /** |
|
701 | + * Validate multiselect based settings. |
|
702 | + * |
|
703 | + * @since 2.0.0 |
|
704 | + * @param array $values Values. |
|
705 | + * @param array $setting Setting. |
|
706 | + * @return array|WP_Error |
|
707 | + */ |
|
708 | + public function validate_setting_multiselect_field( $values, $setting ) { |
|
709 | + if ( empty( $values ) ) { |
|
710 | + return array(); |
|
711 | + } |
|
712 | + |
|
713 | + if ( ! is_array( $values ) ) { |
|
714 | + return new WP_Error( 'rest_setting_value_invalid', __( 'An invalid setting value was passed.', 'invoicing' ), array( 'status' => 400 ) ); |
|
715 | + } |
|
716 | + |
|
717 | + $final_values = array(); |
|
718 | + foreach ( $values as $value ) { |
|
719 | + if ( array_key_exists( $value, $setting['options'] ) ) { |
|
720 | + $final_values[] = $value; |
|
721 | + } |
|
722 | + } |
|
723 | + |
|
724 | + return $final_values; |
|
725 | + } |
|
726 | + |
|
727 | + /** |
|
728 | + * Validate radio based settings. |
|
729 | + * |
|
730 | + * @since 2.0.0 |
|
731 | + * @param string $value Value. |
|
732 | + * @param array $setting Setting. |
|
733 | + * @return string|WP_Error |
|
734 | + */ |
|
735 | + public function validate_setting_radio_field( $value, $setting ) { |
|
736 | + return $this->validate_setting_select_field( $value, $setting ); |
|
737 | + } |
|
738 | + |
|
739 | + /** |
|
740 | + * Validate checkbox based settings. |
|
741 | + * |
|
742 | + * @since 2.0.0 |
|
743 | + * @param string $value Value. |
|
744 | + * @return int |
|
745 | + */ |
|
746 | + public function validate_setting_checkbox_field( $value ) { |
|
747 | + return (int) ! empty( $value ); |
|
748 | + } |
|
749 | + |
|
750 | + /** |
|
751 | + * Validate textarea based settings. |
|
752 | + * |
|
753 | + * @since 2.0.0 |
|
754 | + * @param string $value Value. |
|
755 | + * @return string |
|
756 | + */ |
|
757 | + public function validate_setting_textarea_field( $value ) { |
|
758 | + $value = is_null( $value ) ? '' : $value; |
|
759 | + return wp_kses( |
|
760 | + trim( stripslashes( $value ) ), |
|
761 | + array_merge( |
|
762 | + array( |
|
763 | + 'iframe' => array( |
|
764 | + 'src' => true, |
|
765 | + 'style' => true, |
|
766 | + 'id' => true, |
|
767 | + 'class' => true, |
|
768 | + ), |
|
769 | + ), |
|
770 | + wp_kses_allowed_html( 'post' ) |
|
771 | + ) |
|
772 | + ); |
|
773 | + } |
|
774 | 774 | |
775 | 775 | } |
@@ -18,50 +18,50 @@ |
||
18 | 18 | */ |
19 | 19 | class GetPaid_REST_Report_Top_Earners_Controller extends GetPaid_REST_Report_Top_Sellers_Controller { |
20 | 20 | |
21 | - /** |
|
22 | - * Route base. |
|
23 | - * |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $rest_base = 'reports/top_earners'; |
|
21 | + /** |
|
22 | + * Route base. |
|
23 | + * |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $rest_base = 'reports/top_earners'; |
|
27 | 27 | |
28 | - /** |
|
29 | - * Get all data needed for this report and store in the class. |
|
30 | - */ |
|
31 | - protected function query_report_data() { |
|
28 | + /** |
|
29 | + * Get all data needed for this report and store in the class. |
|
30 | + */ |
|
31 | + protected function query_report_data() { |
|
32 | 32 | |
33 | - $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
34 | - array( |
|
35 | - 'data' => array( |
|
36 | - 'quantity' => array( |
|
37 | - 'type' => 'invoice_item', |
|
38 | - 'function' => 'SUM', |
|
39 | - 'name' => 'invoice_item_qty', |
|
40 | - ), |
|
41 | - 'item_id' => array( |
|
42 | - 'type' => 'invoice_item', |
|
43 | - 'function' => '', |
|
44 | - 'name' => 'invoice_item_id', |
|
45 | - ), |
|
46 | - 'item_name' => array( |
|
47 | - 'type' => 'invoice_item', |
|
48 | - 'function' => '', |
|
49 | - 'name' => 'invoice_item_name', |
|
50 | - ), |
|
51 | - 'price' => array( |
|
52 | - 'type' => 'invoice_item', |
|
53 | - 'function' => 'SUM', |
|
54 | - 'name' => 'invoice_item_price', |
|
55 | - ), |
|
56 | - ), |
|
57 | - 'group_by' => 'invoice_item_id', |
|
58 | - 'order_by' => 'invoice_item_price DESC', |
|
59 | - 'query_type' => 'get_results', |
|
60 | - 'limit' => 10, |
|
61 | - 'filter_range' => $this->report_range, |
|
62 | - ) |
|
63 | - ); |
|
33 | + $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
34 | + array( |
|
35 | + 'data' => array( |
|
36 | + 'quantity' => array( |
|
37 | + 'type' => 'invoice_item', |
|
38 | + 'function' => 'SUM', |
|
39 | + 'name' => 'invoice_item_qty', |
|
40 | + ), |
|
41 | + 'item_id' => array( |
|
42 | + 'type' => 'invoice_item', |
|
43 | + 'function' => '', |
|
44 | + 'name' => 'invoice_item_id', |
|
45 | + ), |
|
46 | + 'item_name' => array( |
|
47 | + 'type' => 'invoice_item', |
|
48 | + 'function' => '', |
|
49 | + 'name' => 'invoice_item_name', |
|
50 | + ), |
|
51 | + 'price' => array( |
|
52 | + 'type' => 'invoice_item', |
|
53 | + 'function' => 'SUM', |
|
54 | + 'name' => 'invoice_item_price', |
|
55 | + ), |
|
56 | + ), |
|
57 | + 'group_by' => 'invoice_item_id', |
|
58 | + 'order_by' => 'invoice_item_price DESC', |
|
59 | + 'query_type' => 'get_results', |
|
60 | + 'limit' => 10, |
|
61 | + 'filter_range' => $this->report_range, |
|
62 | + ) |
|
63 | + ); |
|
64 | 64 | |
65 | - } |
|
65 | + } |
|
66 | 66 | |
67 | 67 | } |