@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
3 | - exit; |
|
3 | + exit; |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | /** |
@@ -10,30 +10,30 @@ discard block |
||
10 | 10 | class WPInv_Item extends GetPaid_Data { |
11 | 11 | |
12 | 12 | /** |
13 | - * Which data store to load. |
|
14 | - * |
|
15 | - * @var string |
|
16 | - */ |
|
13 | + * Which data store to load. |
|
14 | + * |
|
15 | + * @var string |
|
16 | + */ |
|
17 | 17 | protected $data_store_name = 'item'; |
18 | 18 | |
19 | 19 | /** |
20 | - * This is the name of this object type. |
|
21 | - * |
|
22 | - * @var string |
|
23 | - */ |
|
24 | - protected $object_type = 'item'; |
|
20 | + * This is the name of this object type. |
|
21 | + * |
|
22 | + * @var string |
|
23 | + */ |
|
24 | + protected $object_type = 'item'; |
|
25 | 25 | |
26 | 26 | /** |
27 | - * Item Data array. This is the core item data exposed in APIs. |
|
28 | - * |
|
29 | - * @since 1.0.19 |
|
30 | - * @var array |
|
31 | - */ |
|
32 | - protected $data = array( |
|
33 | - 'parent_id' => 0, |
|
34 | - 'status' => 'draft', |
|
35 | - 'version' => '', |
|
36 | - 'date_created' => null, |
|
27 | + * Item Data array. This is the core item data exposed in APIs. |
|
28 | + * |
|
29 | + * @since 1.0.19 |
|
30 | + * @var array |
|
31 | + */ |
|
32 | + protected $data = array( |
|
33 | + 'parent_id' => 0, |
|
34 | + 'status' => 'draft', |
|
35 | + 'version' => '', |
|
36 | + 'date_created' => null, |
|
37 | 37 | 'date_modified' => null, |
38 | 38 | 'name' => '', |
39 | 39 | 'description' => '', |
@@ -58,13 +58,13 @@ discard block |
||
58 | 58 | ); |
59 | 59 | |
60 | 60 | /** |
61 | - * Stores meta in cache for future reads. |
|
62 | - * |
|
63 | - * A group must be set to to enable caching. |
|
64 | - * |
|
65 | - * @var string |
|
66 | - */ |
|
67 | - protected $cache_group = 'getpaid_items'; |
|
61 | + * Stores meta in cache for future reads. |
|
62 | + * |
|
63 | + * A group must be set to to enable caching. |
|
64 | + * |
|
65 | + * @var string |
|
66 | + */ |
|
67 | + protected $cache_group = 'getpaid_items'; |
|
68 | 68 | |
69 | 69 | /** |
70 | 70 | * Stores a reference to the original WP_Post object |
@@ -74,37 +74,37 @@ discard block |
||
74 | 74 | protected $post = null; |
75 | 75 | |
76 | 76 | /** |
77 | - * Get the item if ID is passed, otherwise the item is new and empty. |
|
78 | - * |
|
79 | - * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
80 | - */ |
|
81 | - public function __construct( $item = 0 ) { |
|
82 | - parent::__construct( $item ); |
|
83 | - |
|
84 | - if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
85 | - $this->set_id( $item ); |
|
86 | - } elseif ( $item instanceof self ) { |
|
87 | - $this->set_id( $item->get_id() ); |
|
88 | - } elseif ( ! empty( $item->ID ) ) { |
|
89 | - $this->set_id( $item->ID ); |
|
90 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
91 | - $this->set_id( $item_id ); |
|
92 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
93 | - $this->set_id( $item_id ); |
|
94 | - } else { |
|
95 | - $this->set_object_read( true ); |
|
96 | - } |
|
77 | + * Get the item if ID is passed, otherwise the item is new and empty. |
|
78 | + * |
|
79 | + * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
80 | + */ |
|
81 | + public function __construct( $item = 0 ) { |
|
82 | + parent::__construct( $item ); |
|
83 | + |
|
84 | + if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
85 | + $this->set_id( $item ); |
|
86 | + } elseif ( $item instanceof self ) { |
|
87 | + $this->set_id( $item->get_id() ); |
|
88 | + } elseif ( ! empty( $item->ID ) ) { |
|
89 | + $this->set_id( $item->ID ); |
|
90 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
91 | + $this->set_id( $item_id ); |
|
92 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
93 | + $this->set_id( $item_id ); |
|
94 | + } else { |
|
95 | + $this->set_object_read( true ); |
|
96 | + } |
|
97 | 97 | |
98 | 98 | // Load the datastore. |
99 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
99 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
100 | 100 | |
101 | - if ( $this->get_id() > 0 ) { |
|
101 | + if ( $this->get_id() > 0 ) { |
|
102 | 102 | $this->post = get_post( $this->get_id() ); |
103 | 103 | $this->ID = $this->get_id(); |
104 | - $this->data_store->read( $this ); |
|
104 | + $this->data_store->read( $this ); |
|
105 | 105 | } |
106 | 106 | |
107 | - } |
|
107 | + } |
|
108 | 108 | |
109 | 109 | /* |
110 | 110 | |-------------------------------------------------------------------------- |
@@ -122,401 +122,401 @@ discard block |
||
122 | 122 | */ |
123 | 123 | |
124 | 124 | /** |
125 | - * Get parent item ID. |
|
126 | - * |
|
127 | - * @since 1.0.19 |
|
128 | - * @param string $context View or edit context. |
|
129 | - * @return int |
|
130 | - */ |
|
131 | - public function get_parent_id( $context = 'view' ) { |
|
132 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
125 | + * Get parent item ID. |
|
126 | + * |
|
127 | + * @since 1.0.19 |
|
128 | + * @param string $context View or edit context. |
|
129 | + * @return int |
|
130 | + */ |
|
131 | + public function get_parent_id( $context = 'view' ) { |
|
132 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
133 | 133 | } |
134 | 134 | |
135 | 135 | /** |
136 | - * Get item status. |
|
137 | - * |
|
138 | - * @since 1.0.19 |
|
139 | - * @param string $context View or edit context. |
|
140 | - * @return string |
|
141 | - */ |
|
142 | - public function get_status( $context = 'view' ) { |
|
143 | - return $this->get_prop( 'status', $context ); |
|
136 | + * Get item status. |
|
137 | + * |
|
138 | + * @since 1.0.19 |
|
139 | + * @param string $context View or edit context. |
|
140 | + * @return string |
|
141 | + */ |
|
142 | + public function get_status( $context = 'view' ) { |
|
143 | + return $this->get_prop( 'status', $context ); |
|
144 | 144 | } |
145 | 145 | |
146 | 146 | /** |
147 | - * Get plugin version when the item was created. |
|
148 | - * |
|
149 | - * @since 1.0.19 |
|
150 | - * @param string $context View or edit context. |
|
151 | - * @return string |
|
152 | - */ |
|
153 | - public function get_version( $context = 'view' ) { |
|
154 | - return $this->get_prop( 'version', $context ); |
|
147 | + * Get plugin version when the item was created. |
|
148 | + * |
|
149 | + * @since 1.0.19 |
|
150 | + * @param string $context View or edit context. |
|
151 | + * @return string |
|
152 | + */ |
|
153 | + public function get_version( $context = 'view' ) { |
|
154 | + return $this->get_prop( 'version', $context ); |
|
155 | 155 | } |
156 | 156 | |
157 | 157 | /** |
158 | - * Get date when the item was created. |
|
159 | - * |
|
160 | - * @since 1.0.19 |
|
161 | - * @param string $context View or edit context. |
|
162 | - * @return string |
|
163 | - */ |
|
164 | - public function get_date_created( $context = 'view' ) { |
|
165 | - return $this->get_prop( 'date_created', $context ); |
|
158 | + * Get date when the item was created. |
|
159 | + * |
|
160 | + * @since 1.0.19 |
|
161 | + * @param string $context View or edit context. |
|
162 | + * @return string |
|
163 | + */ |
|
164 | + public function get_date_created( $context = 'view' ) { |
|
165 | + return $this->get_prop( 'date_created', $context ); |
|
166 | 166 | } |
167 | 167 | |
168 | 168 | /** |
169 | - * Get GMT date when the item was created. |
|
170 | - * |
|
171 | - * @since 1.0.19 |
|
172 | - * @param string $context View or edit context. |
|
173 | - * @return string |
|
174 | - */ |
|
175 | - public function get_date_created_gmt( $context = 'view' ) { |
|
169 | + * Get GMT date when the item was created. |
|
170 | + * |
|
171 | + * @since 1.0.19 |
|
172 | + * @param string $context View or edit context. |
|
173 | + * @return string |
|
174 | + */ |
|
175 | + public function get_date_created_gmt( $context = 'view' ) { |
|
176 | 176 | $date = $this->get_date_created( $context ); |
177 | 177 | |
178 | 178 | if ( $date ) { |
179 | 179 | $date = get_gmt_from_date( $date ); |
180 | 180 | } |
181 | - return $date; |
|
181 | + return $date; |
|
182 | 182 | } |
183 | 183 | |
184 | 184 | /** |
185 | - * Get date when the item was last modified. |
|
186 | - * |
|
187 | - * @since 1.0.19 |
|
188 | - * @param string $context View or edit context. |
|
189 | - * @return string |
|
190 | - */ |
|
191 | - public function get_date_modified( $context = 'view' ) { |
|
192 | - return $this->get_prop( 'date_modified', $context ); |
|
185 | + * Get date when the item was last modified. |
|
186 | + * |
|
187 | + * @since 1.0.19 |
|
188 | + * @param string $context View or edit context. |
|
189 | + * @return string |
|
190 | + */ |
|
191 | + public function get_date_modified( $context = 'view' ) { |
|
192 | + return $this->get_prop( 'date_modified', $context ); |
|
193 | 193 | } |
194 | 194 | |
195 | 195 | /** |
196 | - * Get GMT date when the item was last modified. |
|
197 | - * |
|
198 | - * @since 1.0.19 |
|
199 | - * @param string $context View or edit context. |
|
200 | - * @return string |
|
201 | - */ |
|
202 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
196 | + * Get GMT date when the item was last modified. |
|
197 | + * |
|
198 | + * @since 1.0.19 |
|
199 | + * @param string $context View or edit context. |
|
200 | + * @return string |
|
201 | + */ |
|
202 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
203 | 203 | $date = $this->get_date_modified( $context ); |
204 | 204 | |
205 | 205 | if ( $date ) { |
206 | 206 | $date = get_gmt_from_date( $date ); |
207 | 207 | } |
208 | - return $date; |
|
208 | + return $date; |
|
209 | 209 | } |
210 | 210 | |
211 | 211 | /** |
212 | - * Get the item name. |
|
213 | - * |
|
214 | - * @since 1.0.19 |
|
215 | - * @param string $context View or edit context. |
|
216 | - * @return string |
|
217 | - */ |
|
218 | - public function get_name( $context = 'view' ) { |
|
219 | - return $this->get_prop( 'name', $context ); |
|
212 | + * Get the item name. |
|
213 | + * |
|
214 | + * @since 1.0.19 |
|
215 | + * @param string $context View or edit context. |
|
216 | + * @return string |
|
217 | + */ |
|
218 | + public function get_name( $context = 'view' ) { |
|
219 | + return $this->get_prop( 'name', $context ); |
|
220 | 220 | } |
221 | 221 | |
222 | 222 | /** |
223 | - * Alias of self::get_name(). |
|
224 | - * |
|
225 | - * @since 1.0.19 |
|
226 | - * @param string $context View or edit context. |
|
227 | - * @return string |
|
228 | - */ |
|
229 | - public function get_title( $context = 'view' ) { |
|
230 | - return $this->get_name( $context ); |
|
223 | + * Alias of self::get_name(). |
|
224 | + * |
|
225 | + * @since 1.0.19 |
|
226 | + * @param string $context View or edit context. |
|
227 | + * @return string |
|
228 | + */ |
|
229 | + public function get_title( $context = 'view' ) { |
|
230 | + return $this->get_name( $context ); |
|
231 | 231 | } |
232 | 232 | |
233 | 233 | /** |
234 | - * Get the item description. |
|
235 | - * |
|
236 | - * @since 1.0.19 |
|
237 | - * @param string $context View or edit context. |
|
238 | - * @return string |
|
239 | - */ |
|
240 | - public function get_description( $context = 'view' ) { |
|
241 | - return $this->get_prop( 'description', $context ); |
|
234 | + * Get the item description. |
|
235 | + * |
|
236 | + * @since 1.0.19 |
|
237 | + * @param string $context View or edit context. |
|
238 | + * @return string |
|
239 | + */ |
|
240 | + public function get_description( $context = 'view' ) { |
|
241 | + return $this->get_prop( 'description', $context ); |
|
242 | 242 | } |
243 | 243 | |
244 | 244 | /** |
245 | - * Alias of self::get_description(). |
|
246 | - * |
|
247 | - * @since 1.0.19 |
|
248 | - * @param string $context View or edit context. |
|
249 | - * @return string |
|
250 | - */ |
|
251 | - public function get_excerpt( $context = 'view' ) { |
|
252 | - return $this->get_description( $context ); |
|
245 | + * Alias of self::get_description(). |
|
246 | + * |
|
247 | + * @since 1.0.19 |
|
248 | + * @param string $context View or edit context. |
|
249 | + * @return string |
|
250 | + */ |
|
251 | + public function get_excerpt( $context = 'view' ) { |
|
252 | + return $this->get_description( $context ); |
|
253 | 253 | } |
254 | 254 | |
255 | 255 | /** |
256 | - * Alias of self::get_description(). |
|
257 | - * |
|
258 | - * @since 1.0.19 |
|
259 | - * @param string $context View or edit context. |
|
260 | - * @return string |
|
261 | - */ |
|
262 | - public function get_summary( $context = 'view' ) { |
|
263 | - return $this->get_description( $context ); |
|
256 | + * Alias of self::get_description(). |
|
257 | + * |
|
258 | + * @since 1.0.19 |
|
259 | + * @param string $context View or edit context. |
|
260 | + * @return string |
|
261 | + */ |
|
262 | + public function get_summary( $context = 'view' ) { |
|
263 | + return $this->get_description( $context ); |
|
264 | 264 | } |
265 | 265 | |
266 | 266 | /** |
267 | - * Get the owner of the item. |
|
268 | - * |
|
269 | - * @since 1.0.19 |
|
270 | - * @param string $context View or edit context. |
|
271 | - * @return int |
|
272 | - */ |
|
273 | - public function get_author( $context = 'view' ) { |
|
274 | - return (int) $this->get_prop( 'author', $context ); |
|
275 | - } |
|
267 | + * Get the owner of the item. |
|
268 | + * |
|
269 | + * @since 1.0.19 |
|
270 | + * @param string $context View or edit context. |
|
271 | + * @return int |
|
272 | + */ |
|
273 | + public function get_author( $context = 'view' ) { |
|
274 | + return (int) $this->get_prop( 'author', $context ); |
|
275 | + } |
|
276 | 276 | |
277 | - /** |
|
278 | - * Alias of self::get_author(). |
|
279 | - * |
|
280 | - * @since 1.0.19 |
|
281 | - * @param string $context View or edit context. |
|
282 | - * @return int |
|
283 | - */ |
|
284 | - public function get_owner( $context = 'view' ) { |
|
285 | - return $this->get_author( $context ); |
|
286 | - } |
|
287 | - |
|
288 | - /** |
|
289 | - * Get the price of the item. |
|
290 | - * |
|
291 | - * @since 1.0.19 |
|
292 | - * @param string $context View or edit context. |
|
293 | - * @return float |
|
294 | - */ |
|
295 | - public function get_price( $context = 'view' ) { |
|
277 | + /** |
|
278 | + * Alias of self::get_author(). |
|
279 | + * |
|
280 | + * @since 1.0.19 |
|
281 | + * @param string $context View or edit context. |
|
282 | + * @return int |
|
283 | + */ |
|
284 | + public function get_owner( $context = 'view' ) { |
|
285 | + return $this->get_author( $context ); |
|
286 | + } |
|
287 | + |
|
288 | + /** |
|
289 | + * Get the price of the item. |
|
290 | + * |
|
291 | + * @since 1.0.19 |
|
292 | + * @param string $context View or edit context. |
|
293 | + * @return float |
|
294 | + */ |
|
295 | + public function get_price( $context = 'view' ) { |
|
296 | 296 | return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) ); |
297 | - } |
|
297 | + } |
|
298 | 298 | |
299 | - /** |
|
300 | - * Get the inital price of the item. |
|
301 | - * |
|
302 | - * @since 1.0.19 |
|
303 | - * @param string $context View or edit context. |
|
304 | - * @return float |
|
305 | - */ |
|
306 | - public function get_initial_price( $context = 'view' ) { |
|
299 | + /** |
|
300 | + * Get the inital price of the item. |
|
301 | + * |
|
302 | + * @since 1.0.19 |
|
303 | + * @param string $context View or edit context. |
|
304 | + * @return float |
|
305 | + */ |
|
306 | + public function get_initial_price( $context = 'view' ) { |
|
307 | 307 | |
308 | - $price = (float) $this->get_price( $context ); |
|
308 | + $price = (float) $this->get_price( $context ); |
|
309 | 309 | |
310 | - if ( $this->has_free_trial() ) { |
|
311 | - $price = 0; |
|
312 | - } |
|
310 | + if ( $this->has_free_trial() ) { |
|
311 | + $price = 0; |
|
312 | + } |
|
313 | 313 | |
314 | 314 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) ); |
315 | 315 | } |
316 | 316 | |
317 | 317 | /** |
318 | - * Returns a formated price. |
|
319 | - * |
|
320 | - * @since 1.0.19 |
|
321 | - * @param string $context View or edit context. |
|
322 | - * @return string |
|
323 | - */ |
|
318 | + * Returns a formated price. |
|
319 | + * |
|
320 | + * @since 1.0.19 |
|
321 | + * @param string $context View or edit context. |
|
322 | + * @return string |
|
323 | + */ |
|
324 | 324 | public function get_the_price() { |
325 | 325 | return wpinv_price( $this->get_price() ); |
326 | - } |
|
327 | - |
|
328 | - /** |
|
329 | - * Returns the formated initial price. |
|
330 | - * |
|
331 | - * @since 1.0.19 |
|
332 | - * @param string $context View or edit context. |
|
333 | - * @return string |
|
334 | - */ |
|
326 | + } |
|
327 | + |
|
328 | + /** |
|
329 | + * Returns the formated initial price. |
|
330 | + * |
|
331 | + * @since 1.0.19 |
|
332 | + * @param string $context View or edit context. |
|
333 | + * @return string |
|
334 | + */ |
|
335 | 335 | public function get_the_initial_price() { |
336 | 336 | return wpinv_price( $this->get_initial_price() ); |
337 | 337 | } |
338 | 338 | |
339 | 339 | /** |
340 | - * Get the VAT rule of the item. |
|
341 | - * |
|
342 | - * @since 1.0.19 |
|
343 | - * @param string $context View or edit context. |
|
344 | - * @return string |
|
345 | - */ |
|
346 | - public function get_vat_rule( $context = 'view' ) { |
|
340 | + * Get the VAT rule of the item. |
|
341 | + * |
|
342 | + * @since 1.0.19 |
|
343 | + * @param string $context View or edit context. |
|
344 | + * @return string |
|
345 | + */ |
|
346 | + public function get_vat_rule( $context = 'view' ) { |
|
347 | 347 | return $this->get_prop( 'vat_rule', $context ); |
348 | 348 | } |
349 | 349 | |
350 | 350 | /** |
351 | - * Get the VAT class of the item. |
|
352 | - * |
|
353 | - * @since 1.0.19 |
|
354 | - * @param string $context View or edit context. |
|
355 | - * @return string |
|
356 | - */ |
|
357 | - public function get_vat_class( $context = 'view' ) { |
|
351 | + * Get the VAT class of the item. |
|
352 | + * |
|
353 | + * @since 1.0.19 |
|
354 | + * @param string $context View or edit context. |
|
355 | + * @return string |
|
356 | + */ |
|
357 | + public function get_vat_class( $context = 'view' ) { |
|
358 | 358 | return $this->get_prop( 'vat_class', $context ); |
359 | 359 | } |
360 | 360 | |
361 | 361 | /** |
362 | - * Get the type of the item. |
|
363 | - * |
|
364 | - * @since 1.0.19 |
|
365 | - * @param string $context View or edit context. |
|
366 | - * @return string |
|
367 | - */ |
|
368 | - public function get_type( $context = 'view' ) { |
|
362 | + * Get the type of the item. |
|
363 | + * |
|
364 | + * @since 1.0.19 |
|
365 | + * @param string $context View or edit context. |
|
366 | + * @return string |
|
367 | + */ |
|
368 | + public function get_type( $context = 'view' ) { |
|
369 | 369 | return $this->get_prop( 'type', $context ); |
370 | 370 | } |
371 | 371 | |
372 | 372 | /** |
373 | - * Get the custom id of the item. |
|
374 | - * |
|
375 | - * @since 1.0.19 |
|
376 | - * @param string $context View or edit context. |
|
377 | - * @return string |
|
378 | - */ |
|
379 | - public function get_custom_id( $context = 'view' ) { |
|
373 | + * Get the custom id of the item. |
|
374 | + * |
|
375 | + * @since 1.0.19 |
|
376 | + * @param string $context View or edit context. |
|
377 | + * @return string |
|
378 | + */ |
|
379 | + public function get_custom_id( $context = 'view' ) { |
|
380 | 380 | return $this->get_prop( 'custom_id', $context ); |
381 | 381 | } |
382 | 382 | |
383 | 383 | /** |
384 | - * Get the custom name of the item. |
|
385 | - * |
|
386 | - * @since 1.0.19 |
|
387 | - * @param string $context View or edit context. |
|
388 | - * @return string |
|
389 | - */ |
|
390 | - public function get_custom_name( $context = 'view' ) { |
|
384 | + * Get the custom name of the item. |
|
385 | + * |
|
386 | + * @since 1.0.19 |
|
387 | + * @param string $context View or edit context. |
|
388 | + * @return string |
|
389 | + */ |
|
390 | + public function get_custom_name( $context = 'view' ) { |
|
391 | 391 | return $this->get_prop( 'custom_name', $context ); |
392 | 392 | } |
393 | 393 | |
394 | 394 | /** |
395 | - * Get the custom singular name of the item. |
|
396 | - * |
|
397 | - * @since 1.0.19 |
|
398 | - * @param string $context View or edit context. |
|
399 | - * @return string |
|
400 | - */ |
|
401 | - public function get_custom_singular_name( $context = 'view' ) { |
|
395 | + * Get the custom singular name of the item. |
|
396 | + * |
|
397 | + * @since 1.0.19 |
|
398 | + * @param string $context View or edit context. |
|
399 | + * @return string |
|
400 | + */ |
|
401 | + public function get_custom_singular_name( $context = 'view' ) { |
|
402 | 402 | return $this->get_prop( 'custom_singular_name', $context ); |
403 | 403 | } |
404 | 404 | |
405 | 405 | /** |
406 | - * Checks if an item is editable.. |
|
407 | - * |
|
408 | - * @since 1.0.19 |
|
409 | - * @param string $context View or edit context. |
|
410 | - * @return int |
|
411 | - */ |
|
412 | - public function get_is_editable( $context = 'view' ) { |
|
406 | + * Checks if an item is editable.. |
|
407 | + * |
|
408 | + * @since 1.0.19 |
|
409 | + * @param string $context View or edit context. |
|
410 | + * @return int |
|
411 | + */ |
|
412 | + public function get_is_editable( $context = 'view' ) { |
|
413 | 413 | return (int) $this->get_prop( 'is_editable', $context ); |
414 | 414 | } |
415 | 415 | |
416 | 416 | /** |
417 | - * Alias of self::get_is_editable(). |
|
418 | - * |
|
419 | - * @since 1.0.19 |
|
420 | - * @param string $context View or edit context. |
|
421 | - * @return int |
|
422 | - */ |
|
423 | - public function get_editable( $context = 'view' ) { |
|
424 | - return $this->get_is_editable( $context ); |
|
417 | + * Alias of self::get_is_editable(). |
|
418 | + * |
|
419 | + * @since 1.0.19 |
|
420 | + * @param string $context View or edit context. |
|
421 | + * @return int |
|
422 | + */ |
|
423 | + public function get_editable( $context = 'view' ) { |
|
424 | + return $this->get_is_editable( $context ); |
|
425 | 425 | } |
426 | 426 | |
427 | 427 | /** |
428 | - * Checks if dynamic pricing is enabled. |
|
429 | - * |
|
430 | - * @since 1.0.19 |
|
431 | - * @param string $context View or edit context. |
|
432 | - * @return int |
|
433 | - */ |
|
434 | - public function get_is_dynamic_pricing( $context = 'view' ) { |
|
428 | + * Checks if dynamic pricing is enabled. |
|
429 | + * |
|
430 | + * @since 1.0.19 |
|
431 | + * @param string $context View or edit context. |
|
432 | + * @return int |
|
433 | + */ |
|
434 | + public function get_is_dynamic_pricing( $context = 'view' ) { |
|
435 | 435 | return (int) $this->get_prop( 'is_dynamic_pricing', $context ); |
436 | 436 | } |
437 | 437 | |
438 | 438 | /** |
439 | - * Returns the minimum price if dynamic pricing is enabled. |
|
440 | - * |
|
441 | - * @since 1.0.19 |
|
442 | - * @param string $context View or edit context. |
|
443 | - * @return float |
|
444 | - */ |
|
445 | - public function get_minimum_price( $context = 'view' ) { |
|
439 | + * Returns the minimum price if dynamic pricing is enabled. |
|
440 | + * |
|
441 | + * @since 1.0.19 |
|
442 | + * @param string $context View or edit context. |
|
443 | + * @return float |
|
444 | + */ |
|
445 | + public function get_minimum_price( $context = 'view' ) { |
|
446 | 446 | return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) ); |
447 | 447 | } |
448 | 448 | |
449 | 449 | /** |
450 | - * Checks if this is a recurring item. |
|
451 | - * |
|
452 | - * @since 1.0.19 |
|
453 | - * @param string $context View or edit context. |
|
454 | - * @return int |
|
455 | - */ |
|
456 | - public function get_is_recurring( $context = 'view' ) { |
|
450 | + * Checks if this is a recurring item. |
|
451 | + * |
|
452 | + * @since 1.0.19 |
|
453 | + * @param string $context View or edit context. |
|
454 | + * @return int |
|
455 | + */ |
|
456 | + public function get_is_recurring( $context = 'view' ) { |
|
457 | 457 | return (int) $this->get_prop( 'is_recurring', $context ); |
458 | - } |
|
458 | + } |
|
459 | 459 | |
460 | - /** |
|
461 | - * Get the recurring price of the item. |
|
462 | - * |
|
463 | - * @since 1.0.19 |
|
464 | - * @param string $context View or edit context. |
|
465 | - * @return float |
|
466 | - */ |
|
467 | - public function get_recurring_price( $context = 'view' ) { |
|
468 | - $price = $this->get_price( $context ); |
|
460 | + /** |
|
461 | + * Get the recurring price of the item. |
|
462 | + * |
|
463 | + * @since 1.0.19 |
|
464 | + * @param string $context View or edit context. |
|
465 | + * @return float |
|
466 | + */ |
|
467 | + public function get_recurring_price( $context = 'view' ) { |
|
468 | + $price = $this->get_price( $context ); |
|
469 | 469 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) ); |
470 | - } |
|
471 | - |
|
472 | - /** |
|
473 | - * Get the formatted recurring price of the item. |
|
474 | - * |
|
475 | - * @since 1.0.19 |
|
476 | - * @param string $context View or edit context. |
|
477 | - * @return string |
|
478 | - */ |
|
470 | + } |
|
471 | + |
|
472 | + /** |
|
473 | + * Get the formatted recurring price of the item. |
|
474 | + * |
|
475 | + * @since 1.0.19 |
|
476 | + * @param string $context View or edit context. |
|
477 | + * @return string |
|
478 | + */ |
|
479 | 479 | public function get_the_recurring_price() { |
480 | 480 | return wpinv_price( $this->get_recurring_price() ); |
481 | - } |
|
482 | - |
|
483 | - /** |
|
484 | - * Get the first renewal date (in timestamps) of the item. |
|
485 | - * |
|
486 | - * @since 1.0.19 |
|
487 | - * @return int |
|
488 | - */ |
|
489 | - public function get_first_renewal_date() { |
|
490 | - |
|
491 | - $periods = array( |
|
492 | - 'D' => 'days', |
|
493 | - 'W' => 'weeks', |
|
494 | - 'M' => 'months', |
|
495 | - 'Y' => 'years', |
|
496 | - ); |
|
497 | - |
|
498 | - $period = $this->get_recurring_period(); |
|
499 | - $interval = $this->get_recurring_interval(); |
|
500 | - |
|
501 | - if ( $this->has_free_trial() ) { |
|
502 | - $period = $this->get_trial_period(); |
|
503 | - $interval = $this->get_trial_interval(); |
|
504 | - } |
|
505 | - |
|
506 | - $period = $periods[ $period ]; |
|
507 | - $interval = empty( $interval ) ? 1 : $interval; |
|
508 | - $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
481 | + } |
|
482 | + |
|
483 | + /** |
|
484 | + * Get the first renewal date (in timestamps) of the item. |
|
485 | + * |
|
486 | + * @since 1.0.19 |
|
487 | + * @return int |
|
488 | + */ |
|
489 | + public function get_first_renewal_date() { |
|
490 | + |
|
491 | + $periods = array( |
|
492 | + 'D' => 'days', |
|
493 | + 'W' => 'weeks', |
|
494 | + 'M' => 'months', |
|
495 | + 'Y' => 'years', |
|
496 | + ); |
|
497 | + |
|
498 | + $period = $this->get_recurring_period(); |
|
499 | + $interval = $this->get_recurring_interval(); |
|
500 | + |
|
501 | + if ( $this->has_free_trial() ) { |
|
502 | + $period = $this->get_trial_period(); |
|
503 | + $interval = $this->get_trial_interval(); |
|
504 | + } |
|
505 | + |
|
506 | + $period = $periods[ $period ]; |
|
507 | + $interval = empty( $interval ) ? 1 : $interval; |
|
508 | + $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
509 | 509 | return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this ); |
510 | 510 | } |
511 | 511 | |
512 | 512 | /** |
513 | - * Get the recurring period. |
|
514 | - * |
|
515 | - * @since 1.0.19 |
|
516 | - * @param bool $full Return abbreviation or in full. |
|
517 | - * @return string |
|
518 | - */ |
|
519 | - public function get_recurring_period( $full = false ) { |
|
513 | + * Get the recurring period. |
|
514 | + * |
|
515 | + * @since 1.0.19 |
|
516 | + * @param bool $full Return abbreviation or in full. |
|
517 | + * @return string |
|
518 | + */ |
|
519 | + public function get_recurring_period( $full = false ) { |
|
520 | 520 | $period = $this->get_prop( 'recurring_period', 'view' ); |
521 | 521 | |
522 | 522 | if ( $full && ! is_bool( $full ) ) { |
@@ -527,58 +527,58 @@ discard block |
||
527 | 527 | } |
528 | 528 | |
529 | 529 | /** |
530 | - * Get the recurring interval. |
|
531 | - * |
|
532 | - * @since 1.0.19 |
|
533 | - * @param string $context View or edit context. |
|
534 | - * @return int |
|
535 | - */ |
|
536 | - public function get_recurring_interval( $context = 'view' ) { |
|
537 | - $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
538 | - return max( 1, $interval ); |
|
530 | + * Get the recurring interval. |
|
531 | + * |
|
532 | + * @since 1.0.19 |
|
533 | + * @param string $context View or edit context. |
|
534 | + * @return int |
|
535 | + */ |
|
536 | + public function get_recurring_interval( $context = 'view' ) { |
|
537 | + $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
538 | + return max( 1, $interval ); |
|
539 | 539 | } |
540 | 540 | |
541 | 541 | /** |
542 | - * Get the recurring limit. |
|
543 | - * |
|
544 | - * @since 1.0.19 |
|
545 | - * @param string $context View or edit context. |
|
546 | - * @return int |
|
547 | - */ |
|
548 | - public function get_recurring_limit( $context = 'view' ) { |
|
542 | + * Get the recurring limit. |
|
543 | + * |
|
544 | + * @since 1.0.19 |
|
545 | + * @param string $context View or edit context. |
|
546 | + * @return int |
|
547 | + */ |
|
548 | + public function get_recurring_limit( $context = 'view' ) { |
|
549 | 549 | return (int) $this->get_prop( 'recurring_limit', $context ); |
550 | 550 | } |
551 | 551 | |
552 | 552 | /** |
553 | - * Checks if we have a free trial. |
|
554 | - * |
|
555 | - * @since 1.0.19 |
|
556 | - * @param string $context View or edit context. |
|
557 | - * @return int |
|
558 | - */ |
|
559 | - public function get_is_free_trial( $context = 'view' ) { |
|
553 | + * Checks if we have a free trial. |
|
554 | + * |
|
555 | + * @since 1.0.19 |
|
556 | + * @param string $context View or edit context. |
|
557 | + * @return int |
|
558 | + */ |
|
559 | + public function get_is_free_trial( $context = 'view' ) { |
|
560 | 560 | return (int) $this->get_prop( 'is_free_trial', $context ); |
561 | 561 | } |
562 | 562 | |
563 | 563 | /** |
564 | - * Alias for self::get_is_free_trial(). |
|
565 | - * |
|
566 | - * @since 1.0.19 |
|
567 | - * @param string $context View or edit context. |
|
568 | - * @return int |
|
569 | - */ |
|
570 | - public function get_free_trial( $context = 'view' ) { |
|
564 | + * Alias for self::get_is_free_trial(). |
|
565 | + * |
|
566 | + * @since 1.0.19 |
|
567 | + * @param string $context View or edit context. |
|
568 | + * @return int |
|
569 | + */ |
|
570 | + public function get_free_trial( $context = 'view' ) { |
|
571 | 571 | return $this->get_is_free_trial( $context ); |
572 | 572 | } |
573 | 573 | |
574 | 574 | /** |
575 | - * Get the trial period. |
|
576 | - * |
|
577 | - * @since 1.0.19 |
|
578 | - * @param bool $full Return abbreviation or in full. |
|
579 | - * @return string |
|
580 | - */ |
|
581 | - public function get_trial_period( $full = false ) { |
|
575 | + * Get the trial period. |
|
576 | + * |
|
577 | + * @since 1.0.19 |
|
578 | + * @param bool $full Return abbreviation or in full. |
|
579 | + * @return string |
|
580 | + */ |
|
581 | + public function get_trial_period( $full = false ) { |
|
582 | 582 | $period = $this->get_prop( 'trial_period', 'view' ); |
583 | 583 | |
584 | 584 | if ( $full && ! is_bool( $full ) ) { |
@@ -589,104 +589,104 @@ discard block |
||
589 | 589 | } |
590 | 590 | |
591 | 591 | /** |
592 | - * Get the trial interval. |
|
593 | - * |
|
594 | - * @since 1.0.19 |
|
595 | - * @param string $context View or edit context. |
|
596 | - * @return int |
|
597 | - */ |
|
598 | - public function get_trial_interval( $context = 'view' ) { |
|
592 | + * Get the trial interval. |
|
593 | + * |
|
594 | + * @since 1.0.19 |
|
595 | + * @param string $context View or edit context. |
|
596 | + * @return int |
|
597 | + */ |
|
598 | + public function get_trial_interval( $context = 'view' ) { |
|
599 | 599 | return (int) $this->get_prop( 'trial_interval', $context ); |
600 | - } |
|
600 | + } |
|
601 | 601 | |
602 | - /** |
|
603 | - * Get the item's edit url. |
|
604 | - * |
|
605 | - * @since 1.0.19 |
|
606 | - * @return string |
|
607 | - */ |
|
608 | - public function get_edit_url() { |
|
602 | + /** |
|
603 | + * Get the item's edit url. |
|
604 | + * |
|
605 | + * @since 1.0.19 |
|
606 | + * @return string |
|
607 | + */ |
|
608 | + public function get_edit_url() { |
|
609 | 609 | return get_edit_post_link( $this->get_id(), 'edit' ); |
610 | - } |
|
611 | - |
|
612 | - /** |
|
613 | - * Given an item's name/custom id, it returns its id. |
|
614 | - * |
|
615 | - * |
|
616 | - * @static |
|
617 | - * @param string $value The item name or custom id. |
|
618 | - * @param string $field Either name or custom_id. |
|
619 | - * @param string $type in case you need to search for a given type. |
|
620 | - * @since 1.0.15 |
|
621 | - * @return int |
|
622 | - */ |
|
623 | - public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
624 | - |
|
625 | - // Trim the value. |
|
626 | - $value = sanitize_text_field( $value ); |
|
627 | - if ( empty( $value ) ) { |
|
628 | - return 0; |
|
629 | - } |
|
610 | + } |
|
611 | + |
|
612 | + /** |
|
613 | + * Given an item's name/custom id, it returns its id. |
|
614 | + * |
|
615 | + * |
|
616 | + * @static |
|
617 | + * @param string $value The item name or custom id. |
|
618 | + * @param string $field Either name or custom_id. |
|
619 | + * @param string $type in case you need to search for a given type. |
|
620 | + * @since 1.0.15 |
|
621 | + * @return int |
|
622 | + */ |
|
623 | + public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
624 | + |
|
625 | + // Trim the value. |
|
626 | + $value = sanitize_text_field( $value ); |
|
627 | + if ( empty( $value ) ) { |
|
628 | + return 0; |
|
629 | + } |
|
630 | 630 | |
631 | 631 | // Valid fields. |
632 | 632 | $fields = array( 'custom_id', 'name', 'slug' ); |
633 | 633 | |
634 | - // Ensure a field has been passed. |
|
635 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
636 | - return 0; |
|
637 | - } |
|
638 | - |
|
639 | - if ( $field == 'name' ) { |
|
640 | - $field = 'slug'; |
|
641 | - } |
|
642 | - |
|
643 | - // Maybe retrieve from the cache. |
|
644 | - $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
645 | - if ( ! empty( $item_id ) ) { |
|
646 | - return $item_id; |
|
647 | - } |
|
648 | - |
|
649 | - // Fetch from the db. |
|
650 | - $items = array(); |
|
651 | - if ( $field == 'slug' ) { |
|
652 | - $items = get_posts( |
|
653 | - array( |
|
654 | - 'post_type' => 'wpi_item', |
|
655 | - 'name' => $value, |
|
656 | - 'posts_per_page' => 1, |
|
657 | - 'post_status' => 'any', |
|
658 | - ) |
|
659 | - ); |
|
660 | - } |
|
661 | - |
|
662 | - if ( $field =='custom_id' ) { |
|
663 | - $items = get_posts( |
|
664 | - array( |
|
665 | - 'post_type' => 'wpi_item', |
|
666 | - 'posts_per_page' => 1, |
|
667 | - 'post_status' => 'any', |
|
668 | - 'meta_query' => array( |
|
669 | - array( |
|
670 | - 'key' => '_wpinv_type', |
|
671 | - 'value' => $type, |
|
672 | - ), |
|
673 | - array( |
|
674 | - 'key' => '_wpinv_custom_id', |
|
675 | - 'value' => $value, |
|
676 | - ) |
|
677 | - ) |
|
678 | - ) |
|
679 | - ); |
|
680 | - } |
|
681 | - |
|
682 | - if ( empty( $items ) ) { |
|
683 | - return 0; |
|
684 | - } |
|
685 | - |
|
686 | - // Update the cache with our data |
|
687 | - wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
688 | - |
|
689 | - return $items[0]->ID; |
|
634 | + // Ensure a field has been passed. |
|
635 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
636 | + return 0; |
|
637 | + } |
|
638 | + |
|
639 | + if ( $field == 'name' ) { |
|
640 | + $field = 'slug'; |
|
641 | + } |
|
642 | + |
|
643 | + // Maybe retrieve from the cache. |
|
644 | + $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
645 | + if ( ! empty( $item_id ) ) { |
|
646 | + return $item_id; |
|
647 | + } |
|
648 | + |
|
649 | + // Fetch from the db. |
|
650 | + $items = array(); |
|
651 | + if ( $field == 'slug' ) { |
|
652 | + $items = get_posts( |
|
653 | + array( |
|
654 | + 'post_type' => 'wpi_item', |
|
655 | + 'name' => $value, |
|
656 | + 'posts_per_page' => 1, |
|
657 | + 'post_status' => 'any', |
|
658 | + ) |
|
659 | + ); |
|
660 | + } |
|
661 | + |
|
662 | + if ( $field =='custom_id' ) { |
|
663 | + $items = get_posts( |
|
664 | + array( |
|
665 | + 'post_type' => 'wpi_item', |
|
666 | + 'posts_per_page' => 1, |
|
667 | + 'post_status' => 'any', |
|
668 | + 'meta_query' => array( |
|
669 | + array( |
|
670 | + 'key' => '_wpinv_type', |
|
671 | + 'value' => $type, |
|
672 | + ), |
|
673 | + array( |
|
674 | + 'key' => '_wpinv_custom_id', |
|
675 | + 'value' => $value, |
|
676 | + ) |
|
677 | + ) |
|
678 | + ) |
|
679 | + ); |
|
680 | + } |
|
681 | + |
|
682 | + if ( empty( $items ) ) { |
|
683 | + return 0; |
|
684 | + } |
|
685 | + |
|
686 | + // Update the cache with our data |
|
687 | + wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
688 | + |
|
689 | + return $items[0]->ID; |
|
690 | 690 | } |
691 | 691 | |
692 | 692 | /** |
@@ -719,52 +719,52 @@ discard block |
||
719 | 719 | */ |
720 | 720 | |
721 | 721 | /** |
722 | - * Set parent order ID. |
|
723 | - * |
|
724 | - * @since 1.0.19 |
|
725 | - */ |
|
726 | - public function set_parent_id( $value ) { |
|
727 | - if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
728 | - return; |
|
729 | - } |
|
730 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
731 | - } |
|
732 | - |
|
733 | - /** |
|
734 | - * Sets item status. |
|
735 | - * |
|
736 | - * @since 1.0.19 |
|
737 | - * @param string $status New status. |
|
738 | - * @return array details of change. |
|
739 | - */ |
|
740 | - public function set_status( $status ) { |
|
722 | + * Set parent order ID. |
|
723 | + * |
|
724 | + * @since 1.0.19 |
|
725 | + */ |
|
726 | + public function set_parent_id( $value ) { |
|
727 | + if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
728 | + return; |
|
729 | + } |
|
730 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
731 | + } |
|
732 | + |
|
733 | + /** |
|
734 | + * Sets item status. |
|
735 | + * |
|
736 | + * @since 1.0.19 |
|
737 | + * @param string $status New status. |
|
738 | + * @return array details of change. |
|
739 | + */ |
|
740 | + public function set_status( $status ) { |
|
741 | 741 | $old_status = $this->get_status(); |
742 | 742 | |
743 | 743 | $this->set_prop( 'status', $status ); |
744 | 744 | |
745 | - return array( |
|
746 | - 'from' => $old_status, |
|
747 | - 'to' => $status, |
|
748 | - ); |
|
745 | + return array( |
|
746 | + 'from' => $old_status, |
|
747 | + 'to' => $status, |
|
748 | + ); |
|
749 | 749 | } |
750 | 750 | |
751 | 751 | /** |
752 | - * Set plugin version when the item was created. |
|
753 | - * |
|
754 | - * @since 1.0.19 |
|
755 | - */ |
|
756 | - public function set_version( $value ) { |
|
757 | - $this->set_prop( 'version', $value ); |
|
752 | + * Set plugin version when the item was created. |
|
753 | + * |
|
754 | + * @since 1.0.19 |
|
755 | + */ |
|
756 | + public function set_version( $value ) { |
|
757 | + $this->set_prop( 'version', $value ); |
|
758 | 758 | } |
759 | 759 | |
760 | 760 | /** |
761 | - * Set date when the item was created. |
|
762 | - * |
|
763 | - * @since 1.0.19 |
|
764 | - * @param string $value Value to set. |
|
761 | + * Set date when the item was created. |
|
762 | + * |
|
763 | + * @since 1.0.19 |
|
764 | + * @param string $value Value to set. |
|
765 | 765 | * @return bool Whether or not the date was set. |
766 | - */ |
|
767 | - public function set_date_created( $value ) { |
|
766 | + */ |
|
767 | + public function set_date_created( $value ) { |
|
768 | 768 | $date = strtotime( $value ); |
769 | 769 | |
770 | 770 | if ( $date ) { |
@@ -777,13 +777,13 @@ discard block |
||
777 | 777 | } |
778 | 778 | |
779 | 779 | /** |
780 | - * Set date when the item was last modified. |
|
781 | - * |
|
782 | - * @since 1.0.19 |
|
783 | - * @param string $value Value to set. |
|
780 | + * Set date when the item was last modified. |
|
781 | + * |
|
782 | + * @since 1.0.19 |
|
783 | + * @param string $value Value to set. |
|
784 | 784 | * @return bool Whether or not the date was set. |
785 | - */ |
|
786 | - public function set_date_modified( $value ) { |
|
785 | + */ |
|
786 | + public function set_date_modified( $value ) { |
|
787 | 787 | $date = strtotime( $value ); |
788 | 788 | |
789 | 789 | if ( $date ) { |
@@ -796,115 +796,115 @@ discard block |
||
796 | 796 | } |
797 | 797 | |
798 | 798 | /** |
799 | - * Set the item name. |
|
800 | - * |
|
801 | - * @since 1.0.19 |
|
802 | - * @param string $value New name. |
|
803 | - */ |
|
804 | - public function set_name( $value ) { |
|
799 | + * Set the item name. |
|
800 | + * |
|
801 | + * @since 1.0.19 |
|
802 | + * @param string $value New name. |
|
803 | + */ |
|
804 | + public function set_name( $value ) { |
|
805 | 805 | $name = sanitize_text_field( $value ); |
806 | - $this->set_prop( 'name', $name ); |
|
806 | + $this->set_prop( 'name', $name ); |
|
807 | 807 | } |
808 | 808 | |
809 | 809 | /** |
810 | - * Alias of self::set_name(). |
|
811 | - * |
|
812 | - * @since 1.0.19 |
|
813 | - * @param string $value New name. |
|
814 | - */ |
|
815 | - public function set_title( $value ) { |
|
816 | - $this->set_name( $value ); |
|
810 | + * Alias of self::set_name(). |
|
811 | + * |
|
812 | + * @since 1.0.19 |
|
813 | + * @param string $value New name. |
|
814 | + */ |
|
815 | + public function set_title( $value ) { |
|
816 | + $this->set_name( $value ); |
|
817 | 817 | } |
818 | 818 | |
819 | 819 | /** |
820 | - * Set the item description. |
|
821 | - * |
|
822 | - * @since 1.0.19 |
|
823 | - * @param string $value New description. |
|
824 | - */ |
|
825 | - public function set_description( $value ) { |
|
826 | - $description = wp_kses_post( wp_unslash( $value ) ); |
|
827 | - return $this->set_prop( 'description', $description ); |
|
820 | + * Set the item description. |
|
821 | + * |
|
822 | + * @since 1.0.19 |
|
823 | + * @param string $value New description. |
|
824 | + */ |
|
825 | + public function set_description( $value ) { |
|
826 | + $description = wp_kses_post( wp_unslash( $value ) ); |
|
827 | + return $this->set_prop( 'description', $description ); |
|
828 | 828 | } |
829 | 829 | |
830 | 830 | /** |
831 | - * Alias of self::set_description(). |
|
832 | - * |
|
833 | - * @since 1.0.19 |
|
834 | - * @param string $value New description. |
|
835 | - */ |
|
836 | - public function set_excerpt( $value ) { |
|
837 | - $this->set_description( $value ); |
|
831 | + * Alias of self::set_description(). |
|
832 | + * |
|
833 | + * @since 1.0.19 |
|
834 | + * @param string $value New description. |
|
835 | + */ |
|
836 | + public function set_excerpt( $value ) { |
|
837 | + $this->set_description( $value ); |
|
838 | 838 | } |
839 | 839 | |
840 | 840 | /** |
841 | - * Alias of self::set_description(). |
|
842 | - * |
|
843 | - * @since 1.0.19 |
|
844 | - * @param string $value New description. |
|
845 | - */ |
|
846 | - public function set_summary( $value ) { |
|
847 | - $this->set_description( $value ); |
|
841 | + * Alias of self::set_description(). |
|
842 | + * |
|
843 | + * @since 1.0.19 |
|
844 | + * @param string $value New description. |
|
845 | + */ |
|
846 | + public function set_summary( $value ) { |
|
847 | + $this->set_description( $value ); |
|
848 | 848 | } |
849 | 849 | |
850 | 850 | /** |
851 | - * Set the owner of the item. |
|
852 | - * |
|
853 | - * @since 1.0.19 |
|
854 | - * @param int $value New author. |
|
855 | - */ |
|
856 | - public function set_author( $value ) { |
|
857 | - $this->set_prop( 'author', (int) $value ); |
|
858 | - } |
|
851 | + * Set the owner of the item. |
|
852 | + * |
|
853 | + * @since 1.0.19 |
|
854 | + * @param int $value New author. |
|
855 | + */ |
|
856 | + public function set_author( $value ) { |
|
857 | + $this->set_prop( 'author', (int) $value ); |
|
858 | + } |
|
859 | 859 | |
860 | - /** |
|
861 | - * Alias of self::set_author(). |
|
862 | - * |
|
863 | - * @since 1.0.19 |
|
864 | - * @param int $value New author. |
|
865 | - */ |
|
866 | - public function set_owner( $value ) { |
|
867 | - $this->set_author( $value ); |
|
868 | - } |
|
869 | - |
|
870 | - /** |
|
871 | - * Set the price of the item. |
|
872 | - * |
|
873 | - * @since 1.0.19 |
|
874 | - * @param float $value New price. |
|
875 | - */ |
|
876 | - public function set_price( $value ) { |
|
860 | + /** |
|
861 | + * Alias of self::set_author(). |
|
862 | + * |
|
863 | + * @since 1.0.19 |
|
864 | + * @param int $value New author. |
|
865 | + */ |
|
866 | + public function set_owner( $value ) { |
|
867 | + $this->set_author( $value ); |
|
868 | + } |
|
869 | + |
|
870 | + /** |
|
871 | + * Set the price of the item. |
|
872 | + * |
|
873 | + * @since 1.0.19 |
|
874 | + * @param float $value New price. |
|
875 | + */ |
|
876 | + public function set_price( $value ) { |
|
877 | 877 | $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) ); |
878 | 878 | } |
879 | 879 | |
880 | 880 | /** |
881 | - * Set the VAT rule of the item. |
|
882 | - * |
|
883 | - * @since 1.0.19 |
|
884 | - * @param string $value new rule. |
|
885 | - */ |
|
886 | - public function set_vat_rule( $value ) { |
|
881 | + * Set the VAT rule of the item. |
|
882 | + * |
|
883 | + * @since 1.0.19 |
|
884 | + * @param string $value new rule. |
|
885 | + */ |
|
886 | + public function set_vat_rule( $value ) { |
|
887 | 887 | $this->set_prop( 'vat_rule', $value ); |
888 | 888 | } |
889 | 889 | |
890 | 890 | /** |
891 | - * Set the VAT class of the item. |
|
892 | - * |
|
893 | - * @since 1.0.19 |
|
894 | - * @param string $value new class. |
|
895 | - */ |
|
896 | - public function set_vat_class( $value ) { |
|
891 | + * Set the VAT class of the item. |
|
892 | + * |
|
893 | + * @since 1.0.19 |
|
894 | + * @param string $value new class. |
|
895 | + */ |
|
896 | + public function set_vat_class( $value ) { |
|
897 | 897 | $this->set_prop( 'vat_class', $value ); |
898 | 898 | } |
899 | 899 | |
900 | 900 | /** |
901 | - * Set the type of the item. |
|
902 | - * |
|
903 | - * @since 1.0.19 |
|
904 | - * @param string $value new item type. |
|
905 | - * @return string |
|
906 | - */ |
|
907 | - public function set_type( $value ) { |
|
901 | + * Set the type of the item. |
|
902 | + * |
|
903 | + * @since 1.0.19 |
|
904 | + * @param string $value new item type. |
|
905 | + * @return string |
|
906 | + */ |
|
907 | + public function set_type( $value ) { |
|
908 | 908 | |
909 | 909 | if ( empty( $value ) ) { |
910 | 910 | $value = 'custom'; |
@@ -914,132 +914,132 @@ discard block |
||
914 | 914 | } |
915 | 915 | |
916 | 916 | /** |
917 | - * Set the custom id of the item. |
|
918 | - * |
|
919 | - * @since 1.0.19 |
|
920 | - * @param string $value new custom id. |
|
921 | - */ |
|
922 | - public function set_custom_id( $value ) { |
|
917 | + * Set the custom id of the item. |
|
918 | + * |
|
919 | + * @since 1.0.19 |
|
920 | + * @param string $value new custom id. |
|
921 | + */ |
|
922 | + public function set_custom_id( $value ) { |
|
923 | 923 | $this->set_prop( 'custom_id', $value ); |
924 | 924 | } |
925 | 925 | |
926 | 926 | /** |
927 | - * Set the custom name of the item. |
|
928 | - * |
|
929 | - * @since 1.0.19 |
|
930 | - * @param string $value new custom name. |
|
931 | - */ |
|
932 | - public function set_custom_name( $value ) { |
|
927 | + * Set the custom name of the item. |
|
928 | + * |
|
929 | + * @since 1.0.19 |
|
930 | + * @param string $value new custom name. |
|
931 | + */ |
|
932 | + public function set_custom_name( $value ) { |
|
933 | 933 | $this->set_prop( 'custom_name', $value ); |
934 | 934 | } |
935 | 935 | |
936 | 936 | /** |
937 | - * Set the custom singular name of the item. |
|
938 | - * |
|
939 | - * @since 1.0.19 |
|
940 | - * @param string $value new custom singular name. |
|
941 | - */ |
|
942 | - public function set_custom_singular_name( $value ) { |
|
937 | + * Set the custom singular name of the item. |
|
938 | + * |
|
939 | + * @since 1.0.19 |
|
940 | + * @param string $value new custom singular name. |
|
941 | + */ |
|
942 | + public function set_custom_singular_name( $value ) { |
|
943 | 943 | $this->set_prop( 'custom_singular_name', $value ); |
944 | 944 | } |
945 | 945 | |
946 | 946 | /** |
947 | - * Sets if an item is editable.. |
|
948 | - * |
|
949 | - * @since 1.0.19 |
|
950 | - * @param int|bool $value whether or not the item is editable. |
|
951 | - */ |
|
952 | - public function set_is_editable( $value ) { |
|
953 | - $this->set_prop( 'is_editable', (int) $value ); |
|
947 | + * Sets if an item is editable.. |
|
948 | + * |
|
949 | + * @since 1.0.19 |
|
950 | + * @param int|bool $value whether or not the item is editable. |
|
951 | + */ |
|
952 | + public function set_is_editable( $value ) { |
|
953 | + $this->set_prop( 'is_editable', (int) $value ); |
|
954 | 954 | } |
955 | 955 | |
956 | 956 | /** |
957 | - * Sets if dynamic pricing is enabled. |
|
958 | - * |
|
959 | - * @since 1.0.19 |
|
960 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
961 | - */ |
|
962 | - public function set_is_dynamic_pricing( $value ) { |
|
957 | + * Sets if dynamic pricing is enabled. |
|
958 | + * |
|
959 | + * @since 1.0.19 |
|
960 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
961 | + */ |
|
962 | + public function set_is_dynamic_pricing( $value ) { |
|
963 | 963 | $this->set_prop( 'is_dynamic_pricing', (int) $value ); |
964 | 964 | } |
965 | 965 | |
966 | 966 | /** |
967 | - * Sets the minimum price if dynamic pricing is enabled. |
|
968 | - * |
|
969 | - * @since 1.0.19 |
|
970 | - * @param float $value minimum price. |
|
971 | - */ |
|
972 | - public function set_minimum_price( $value ) { |
|
967 | + * Sets the minimum price if dynamic pricing is enabled. |
|
968 | + * |
|
969 | + * @since 1.0.19 |
|
970 | + * @param float $value minimum price. |
|
971 | + */ |
|
972 | + public function set_minimum_price( $value ) { |
|
973 | 973 | $this->set_prop( 'minimum_price', (float) wpinv_sanitize_amount( $value ) ); |
974 | 974 | } |
975 | 975 | |
976 | 976 | /** |
977 | - * Sets if this is a recurring item. |
|
978 | - * |
|
979 | - * @since 1.0.19 |
|
980 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
981 | - */ |
|
982 | - public function set_is_recurring( $value ) { |
|
977 | + * Sets if this is a recurring item. |
|
978 | + * |
|
979 | + * @since 1.0.19 |
|
980 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
981 | + */ |
|
982 | + public function set_is_recurring( $value ) { |
|
983 | 983 | $this->set_prop( 'is_recurring', (int) $value ); |
984 | 984 | } |
985 | 985 | |
986 | 986 | /** |
987 | - * Set the recurring period. |
|
988 | - * |
|
989 | - * @since 1.0.19 |
|
990 | - * @param string $value new period. |
|
991 | - */ |
|
992 | - public function set_recurring_period( $value ) { |
|
987 | + * Set the recurring period. |
|
988 | + * |
|
989 | + * @since 1.0.19 |
|
990 | + * @param string $value new period. |
|
991 | + */ |
|
992 | + public function set_recurring_period( $value ) { |
|
993 | 993 | $this->set_prop( 'recurring_period', $value ); |
994 | 994 | } |
995 | 995 | |
996 | 996 | /** |
997 | - * Set the recurring interval. |
|
998 | - * |
|
999 | - * @since 1.0.19 |
|
1000 | - * @param int $value recurring interval. |
|
1001 | - */ |
|
1002 | - public function set_recurring_interval( $value ) { |
|
997 | + * Set the recurring interval. |
|
998 | + * |
|
999 | + * @since 1.0.19 |
|
1000 | + * @param int $value recurring interval. |
|
1001 | + */ |
|
1002 | + public function set_recurring_interval( $value ) { |
|
1003 | 1003 | return $this->set_prop( 'recurring_interval', (int) $value ); |
1004 | 1004 | } |
1005 | 1005 | |
1006 | 1006 | /** |
1007 | - * Get the recurring limit. |
|
1008 | - * @since 1.0.19 |
|
1009 | - * @param int $value The recurring limit. |
|
1010 | - * @return int |
|
1011 | - */ |
|
1012 | - public function set_recurring_limit( $value ) { |
|
1007 | + * Get the recurring limit. |
|
1008 | + * @since 1.0.19 |
|
1009 | + * @param int $value The recurring limit. |
|
1010 | + * @return int |
|
1011 | + */ |
|
1012 | + public function set_recurring_limit( $value ) { |
|
1013 | 1013 | $this->set_prop( 'recurring_limit', (int) $value ); |
1014 | 1014 | } |
1015 | 1015 | |
1016 | 1016 | /** |
1017 | - * Checks if we have a free trial. |
|
1018 | - * |
|
1019 | - * @since 1.0.19 |
|
1020 | - * @param int|bool $value whether or not it has a free trial. |
|
1021 | - */ |
|
1022 | - public function set_is_free_trial( $value ) { |
|
1017 | + * Checks if we have a free trial. |
|
1018 | + * |
|
1019 | + * @since 1.0.19 |
|
1020 | + * @param int|bool $value whether or not it has a free trial. |
|
1021 | + */ |
|
1022 | + public function set_is_free_trial( $value ) { |
|
1023 | 1023 | $this->set_prop( 'is_free_trial', (int) $value ); |
1024 | 1024 | } |
1025 | 1025 | |
1026 | 1026 | /** |
1027 | - * Set the trial period. |
|
1028 | - * |
|
1029 | - * @since 1.0.19 |
|
1030 | - * @param string $value trial period. |
|
1031 | - */ |
|
1032 | - public function set_trial_period( $value ) { |
|
1027 | + * Set the trial period. |
|
1028 | + * |
|
1029 | + * @since 1.0.19 |
|
1030 | + * @param string $value trial period. |
|
1031 | + */ |
|
1032 | + public function set_trial_period( $value ) { |
|
1033 | 1033 | $this->set_prop( 'trial_period', $value ); |
1034 | 1034 | } |
1035 | 1035 | |
1036 | 1036 | /** |
1037 | - * Set the trial interval. |
|
1038 | - * |
|
1039 | - * @since 1.0.19 |
|
1040 | - * @param int $value trial interval. |
|
1041 | - */ |
|
1042 | - public function set_trial_interval( $value ) { |
|
1037 | + * Set the trial interval. |
|
1038 | + * |
|
1039 | + * @since 1.0.19 |
|
1040 | + * @param int $value trial interval. |
|
1041 | + */ |
|
1042 | + public function set_trial_interval( $value ) { |
|
1043 | 1043 | $this->set_prop( 'trial_interval', $value ); |
1044 | 1044 | } |
1045 | 1045 | |
@@ -1047,17 +1047,17 @@ discard block |
||
1047 | 1047 | * Create an item. For backwards compatibilty. |
1048 | 1048 | * |
1049 | 1049 | * @deprecated |
1050 | - * @return int item id |
|
1050 | + * @return int item id |
|
1051 | 1051 | */ |
1052 | 1052 | public function create( $data = array() ) { |
1053 | 1053 | |
1054 | - // Set the properties. |
|
1055 | - if ( is_array( $data ) ) { |
|
1056 | - $this->set_props( $data ); |
|
1057 | - } |
|
1054 | + // Set the properties. |
|
1055 | + if ( is_array( $data ) ) { |
|
1056 | + $this->set_props( $data ); |
|
1057 | + } |
|
1058 | 1058 | |
1059 | - // Save the item. |
|
1060 | - return $this->save(); |
|
1059 | + // Save the item. |
|
1060 | + return $this->save(); |
|
1061 | 1061 | |
1062 | 1062 | } |
1063 | 1063 | |
@@ -1065,7 +1065,7 @@ discard block |
||
1065 | 1065 | * Updates an item. For backwards compatibilty. |
1066 | 1066 | * |
1067 | 1067 | * @deprecated |
1068 | - * @return int item id |
|
1068 | + * @return int item id |
|
1069 | 1069 | */ |
1070 | 1070 | public function update( $data = array() ) { |
1071 | 1071 | return $this->create( $data ); |
@@ -1081,93 +1081,93 @@ discard block |
||
1081 | 1081 | */ |
1082 | 1082 | |
1083 | 1083 | /** |
1084 | - * Checks whether the item has enabled dynamic pricing. |
|
1085 | - * |
|
1086 | - * @since 1.0.19 |
|
1087 | - * @return bool |
|
1088 | - */ |
|
1089 | - public function user_can_set_their_price() { |
|
1084 | + * Checks whether the item has enabled dynamic pricing. |
|
1085 | + * |
|
1086 | + * @since 1.0.19 |
|
1087 | + * @return bool |
|
1088 | + */ |
|
1089 | + public function user_can_set_their_price() { |
|
1090 | 1090 | return (bool) $this->get_is_dynamic_pricing(); |
1091 | - } |
|
1091 | + } |
|
1092 | 1092 | |
1093 | - /** |
|
1094 | - * Checks whether the item is recurring. |
|
1095 | - * |
|
1096 | - * @since 1.0.19 |
|
1097 | - * @return bool |
|
1098 | - */ |
|
1099 | - public function is_recurring() { |
|
1093 | + /** |
|
1094 | + * Checks whether the item is recurring. |
|
1095 | + * |
|
1096 | + * @since 1.0.19 |
|
1097 | + * @return bool |
|
1098 | + */ |
|
1099 | + public function is_recurring() { |
|
1100 | 1100 | return (bool) $this->get_is_recurring(); |
1101 | 1101 | } |
1102 | 1102 | |
1103 | 1103 | /** |
1104 | - * Checks whether the item has a free trial. |
|
1105 | - * |
|
1106 | - * @since 1.0.19 |
|
1107 | - * @return bool |
|
1108 | - */ |
|
1104 | + * Checks whether the item has a free trial. |
|
1105 | + * |
|
1106 | + * @since 1.0.19 |
|
1107 | + * @return bool |
|
1108 | + */ |
|
1109 | 1109 | public function has_free_trial() { |
1110 | 1110 | $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false; |
1111 | 1111 | return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this ); |
1112 | 1112 | } |
1113 | 1113 | |
1114 | 1114 | /** |
1115 | - * Checks whether the item is free. |
|
1116 | - * |
|
1117 | - * @since 1.0.19 |
|
1118 | - * @return bool |
|
1119 | - */ |
|
1115 | + * Checks whether the item is free. |
|
1116 | + * |
|
1117 | + * @since 1.0.19 |
|
1118 | + * @return bool |
|
1119 | + */ |
|
1120 | 1120 | public function is_free() { |
1121 | 1121 | $is_free = $this->get_price() == 0; |
1122 | 1122 | return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this ); |
1123 | 1123 | } |
1124 | 1124 | |
1125 | 1125 | /** |
1126 | - * Checks the item status against a passed in status. |
|
1127 | - * |
|
1128 | - * @param array|string $status Status to check. |
|
1129 | - * @return bool |
|
1130 | - */ |
|
1131 | - public function has_status( $status ) { |
|
1132 | - $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
1133 | - return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
1126 | + * Checks the item status against a passed in status. |
|
1127 | + * |
|
1128 | + * @param array|string $status Status to check. |
|
1129 | + * @return bool |
|
1130 | + */ |
|
1131 | + public function has_status( $status ) { |
|
1132 | + $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
1133 | + return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
1134 | 1134 | } |
1135 | 1135 | |
1136 | 1136 | /** |
1137 | - * Checks the item type against a passed in types. |
|
1138 | - * |
|
1139 | - * @param array|string $type Type to check. |
|
1140 | - * @return bool |
|
1141 | - */ |
|
1142 | - public function is_type( $type ) { |
|
1143 | - $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
1144 | - return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
1145 | - } |
|
1137 | + * Checks the item type against a passed in types. |
|
1138 | + * |
|
1139 | + * @param array|string $type Type to check. |
|
1140 | + * @return bool |
|
1141 | + */ |
|
1142 | + public function is_type( $type ) { |
|
1143 | + $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
1144 | + return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
1145 | + } |
|
1146 | 1146 | |
1147 | 1147 | /** |
1148 | - * Checks whether the item is editable. |
|
1149 | - * |
|
1150 | - * @since 1.0.19 |
|
1151 | - * @return bool |
|
1152 | - */ |
|
1148 | + * Checks whether the item is editable. |
|
1149 | + * |
|
1150 | + * @since 1.0.19 |
|
1151 | + * @return bool |
|
1152 | + */ |
|
1153 | 1153 | public function is_editable() { |
1154 | 1154 | $is_editable = $this->get_is_editable(); |
1155 | 1155 | return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this ); |
1156 | - } |
|
1156 | + } |
|
1157 | 1157 | |
1158 | - /** |
|
1159 | - * Returns an array of cart fees. |
|
1160 | - */ |
|
1161 | - public function get_fees() { |
|
1158 | + /** |
|
1159 | + * Returns an array of cart fees. |
|
1160 | + */ |
|
1161 | + public function get_fees() { |
|
1162 | 1162 | return array(); |
1163 | 1163 | } |
1164 | 1164 | |
1165 | 1165 | /** |
1166 | - * Checks whether the item is purchasable. |
|
1167 | - * |
|
1168 | - * @since 1.0.19 |
|
1169 | - * @return bool |
|
1170 | - */ |
|
1166 | + * Checks whether the item is purchasable. |
|
1167 | + * |
|
1168 | + * @since 1.0.19 |
|
1169 | + * @return bool |
|
1170 | + */ |
|
1171 | 1171 | public function can_purchase() { |
1172 | 1172 | $can_purchase = $this->exists(); |
1173 | 1173 | |
@@ -1179,11 +1179,11 @@ discard block |
||
1179 | 1179 | } |
1180 | 1180 | |
1181 | 1181 | /** |
1182 | - * Checks whether the item supports dynamic pricing. |
|
1183 | - * |
|
1184 | - * @since 1.0.19 |
|
1185 | - * @return bool |
|
1186 | - */ |
|
1182 | + * Checks whether the item supports dynamic pricing. |
|
1183 | + * |
|
1184 | + * @since 1.0.19 |
|
1185 | + * @return bool |
|
1186 | + */ |
|
1187 | 1187 | public function supports_dynamic_pricing() { |
1188 | 1188 | return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this ); |
1189 | 1189 | } |