abstract-wc-data.php
5 years ago
abstract-wc-deprecated-hooks.php
6 years ago
abstract-wc-integration.php
5 years ago
abstract-wc-log-handler.php
5 years ago
abstract-wc-object-query.php
5 years ago
abstract-wc-order.php
4 years ago
abstract-wc-payment-gateway.php
5 years ago
abstract-wc-payment-token.php
5 years ago
abstract-wc-privacy.php
5 years ago
abstract-wc-product.php
4 years ago
abstract-wc-session.php
5 years ago
abstract-wc-settings-api.php
5 years ago
abstract-wc-shipping-method.php
5 years ago
abstract-wc-widget.php
4 years ago
class-wc-background-process.php
5 years ago
abstract-wc-object-query.php
96 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Query abstraction layer functionality. |
| 4 | * |
| 5 | * @package WooCommerce\Abstracts |
| 6 | */ |
| 7 | |
| 8 | if ( ! defined( 'ABSPATH' ) ) { |
| 9 | exit; |
| 10 | } |
| 11 | |
| 12 | /** |
| 13 | * Abstract WC Object Query Class |
| 14 | * |
| 15 | * Extended by classes to provide a query abstraction layer for safe object searching. |
| 16 | * |
| 17 | * @version 3.1.0 |
| 18 | * @package WooCommerce\Abstracts |
| 19 | */ |
| 20 | abstract class WC_Object_Query { |
| 21 | |
| 22 | /** |
| 23 | * Stores query data. |
| 24 | * |
| 25 | * @var array |
| 26 | */ |
| 27 | protected $query_vars = array(); |
| 28 | |
| 29 | /** |
| 30 | * Create a new query. |
| 31 | * |
| 32 | * @param array $args Criteria to query on in a format similar to WP_Query. |
| 33 | */ |
| 34 | public function __construct( $args = array() ) { |
| 35 | $this->query_vars = wp_parse_args( $args, $this->get_default_query_vars() ); |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * Get the current query vars. |
| 40 | * |
| 41 | * @return array |
| 42 | */ |
| 43 | public function get_query_vars() { |
| 44 | return $this->query_vars; |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Get the value of a query variable. |
| 49 | * |
| 50 | * @param string $query_var Query variable to get value for. |
| 51 | * @param mixed $default Default value if query variable is not set. |
| 52 | * @return mixed Query variable value if set, otherwise default. |
| 53 | */ |
| 54 | public function get( $query_var, $default = '' ) { |
| 55 | if ( isset( $this->query_vars[ $query_var ] ) ) { |
| 56 | return $this->query_vars[ $query_var ]; |
| 57 | } |
| 58 | return $default; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Set a query variable. |
| 63 | * |
| 64 | * @param string $query_var Query variable to set. |
| 65 | * @param mixed $value Value to set for query variable. |
| 66 | */ |
| 67 | public function set( $query_var, $value ) { |
| 68 | $this->query_vars[ $query_var ] = $value; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Get the default allowed query vars. |
| 73 | * |
| 74 | * @return array |
| 75 | */ |
| 76 | protected function get_default_query_vars() { |
| 77 | |
| 78 | return array( |
| 79 | 'name' => '', |
| 80 | 'parent' => '', |
| 81 | 'parent_exclude' => '', |
| 82 | 'exclude' => '', |
| 83 | |
| 84 | 'limit' => get_option( 'posts_per_page' ), |
| 85 | 'page' => 1, |
| 86 | 'offset' => '', |
| 87 | 'paginate' => false, |
| 88 | |
| 89 | 'order' => 'DESC', |
| 90 | 'orderby' => 'date', |
| 91 | |
| 92 | 'return' => 'objects', |
| 93 | ); |
| 94 | } |
| 95 | } |
| 96 |