WC_Object_Query & WC_Order_Query #14733

claudiulodro · 2017-04-26T18:31:44Z

Relates to #13646.

This is the implementation of WC_Object_Query and WC_Order_Query. The next PR will integrate these into WC_Order_Data_Store_CPT::get_orders and wc_get_orders.

Functions like `wc_get_orders` are almost certainly used widely and in a million different ways, so I think we should take a conservative approach to releasing the query helpers: Have them just hanging out and available for developers to use in 3.1 to iron out any problems or things we didn't think of. In 3.2, we can update existing code like `wc_get_orders` to use the query objects knowing that many developers will have switched over to the query objects and the query objects are bug-free. This is similar to how WP stretched out releasing term meta over a few releases. Thoughts?

Never mind. Overthought this ^.

mikejolley

Functions like wc_get_orders are almost certainly used widely and in a million different ways, so I think we should take a conservative approach to releasing the query helpers

Why are you concerned with this? wc_get_orders only has a handful of props which I imagine will be included in this helper?

All the function would need to keep is the backwards compatibility handling, with which it would convert the old props to the new props for the helper.

These helpers should act as a way to get objects or ids for WC core objects. I don't think they need to match WP_Query exactly, simply because it does a lot of bloated unnecessary things we shouldn't have to worry about.

Search Helper is the layer devs work with. Search Helper then has an internal layer to translate the supported args -> WP_Query (or if we ever had custom tables, our own queries instead).

Does that make sense?

mikejolley · 2017-04-27T14:27:50Z

includes/abstracts/abstract-wc-object-query.php

+	protected function get_default_query_vars() {
+
+		return array(
+			'tax_query'      => array(),


Do args like this feel too deeply coupled to WP_Query? The whole idea of meta_query/tax_query even things like meta_key and meta_value - these don't feel like things we should be carrying over to an abstract search helper.

I feel we should start small, support core props and some more advanced searches, like date ranges, but handle the translation between this and WP_Query internally, behind the scenes...

mikejolley · 2017-04-27T14:28:09Z

includes/abstracts/abstract-wc-object-query.php

+	 * @param mixed $value Value to set for query variable.
+	 */
+	public function set( $query_var, $value ) {
+		$this->query_vars[$query_var] = $value;


Spaces around [ ]

mikejolley · 2017-04-27T14:28:41Z

includes/abstracts/abstract-wc-object-query.php

+			'exact'          => '',
+			'sentence'       => '',
+
+			'fields'         => '',


this too. We should support ids and objects. These follow out CRUD more closely.

mikejolley · 2017-04-27T16:05:43Z

includes/abstracts/abstract-wc-object-query.php

+	 * Stores query data.
+	 * @var array
+	 */
+	public $query_vars = array();


I think we should keep this protected and have a getter.

Yeah. I think I was trying to make this too similar to WP_Query. I'll try and steer away from that from now on. :)

mikejolley · 2017-04-27T16:07:16Z

includes/abstracts/abstract-wc-object-query.php

+			'in'             => array(),
+			'not_in'         => array(),
+
+			'status'         => array( 'publish', 'pending', 'draft', 'future', 'private', 'inherit' ),


Should we leave this out and let the sub-classes deal with it? They may not match WP 1:1

mikejolley · 2017-04-27T16:08:10Z

includes/abstracts/abstract-wc-object-query.php

+			'parent__in'     => array(),
+			'parent__not_in' => array(),
+			'in'             => array(),
+			'not_in'         => array(),


in and not_in seem less useful to me - that kind of inclusion/exclusion would be easy to handle externally.

Just noticed wc_get_orders has exclude. Maybe that is ok to use? in though... not sure why you'd need to search if you have the ids already?

not_in/exclude comes in handy a lot. e.g. if you want to get products that aren't the current product. in isn't very useful. I'll change not_in to exclude and ditch in.

mikejolley · 2017-04-27T16:09:15Z

includes/abstracts/abstract-wc-object-query.php

+
+			'status'         => array( 'publish', 'pending', 'draft', 'future', 'private', 'inherit' ),
+
+			'per_page'       => -1,


wc_get_orders has page, limit, offset. Personally prefer that over per_page.

Also has paginate which returns some extra page args if used which is handy I guess. Maybe good to factor in to the return values?

mikejolley · 2017-04-27T16:12:01Z

includes/abstracts/abstract-wc-object-query.php

+			'order'          => 'DESC',
+			'orderby'        => 'date',
+
+		    'date_before'    => '',


I think we should leave this one to subclasses and make it more prop based. e.g. orders have date_paid, date_completed, date_created and so on which could benefit from these type of query.

And yes that may make the later queries harder to map/generate, but I think it's more useful.

mikejolley · 2017-04-27T16:12:58Z

includes/data-stores/class-wc-data-store-wp.php

+	 * @param array $query_vars query vars from a WC_Object_Query
+	 * @return array
+	 */
+	public function get_wp_query_args( $query_vars ) {


Why public?

claudiulodro · 2017-04-28T02:22:28Z

@mikejolley I've implemented your requested changes. I think this will be easier to maintain and migrate to custom tables now. 👍

mikejolley

Just some timezone questions to resolve.

Is this all we need for v1? Provide some examples/what is supported?

mikejolley · 2017-04-28T11:39:40Z

includes/abstracts/abstract-wc-object-query.php

+		$this->query_vars = wp_parse_args( $args, $this->get_default_query_vars() );
+	}
+
+	public function get_query_vars() {


mikejolley · 2017-04-28T11:45:35Z

includes/data-stores/class-wc-order-data-store-cpt.php

+
+		if ( isset( $query_vars[ 'date_created_after'] ) && '' !== $query_vars[ 'date_created_after' ] ) {
+			$wp_query_args['date_query'][] = array(
+				'column' => 'post_date',


Should we work with GMT or store timezone here or support both?

mikejolley · 2017-04-28T11:46:00Z

includes/data-stores/class-wc-order-data-store-cpt.php

+		if ( isset( $query_vars[ 'date_completed_before' ] ) && '' !== $query_vars[ 'date_completed_before' ] && strtotime( $query_vars[ 'date_completed_before' ] ) ) {
+			$wp_query_args['meta_query'][] = array(
+				'key'     => '_date_completed',
+				'value'   => strtotime( $query_vars[ 'date_completed_before' ] ),


This may also be confusing when you think about timezones.

mikejolley · 2017-04-28T11:47:32Z

includes/data-stores/class-wc-order-data-store-cpt.php

+			return $query->posts;
+		}
+
+		$orders = array_map( 'wc_get_order', $query->posts );


Filter out bad results with array_filter

claudiulodro · 2017-04-28T21:25:30Z

I'm going to make a wiki for the object query args, similar to the WP_Query docs. You can query for any combination of the props in WC_Object_Query::get_default_query_vars and WC_Order_Query::get_default_query_vars. There's a few examples in the unit tests at tests/unit-tests/order/query.php.

I'm going to make a ticket for integrating WC_Order_Query into wc_get_orders and other similar situations for the next sprint. The 3.0.5 release took up my morning. :)

mikejolley · 2017-05-07T13:23:40Z

@claudiulodro This looks good to go so #14795 can proceed. I do have one more idea which could be implemented to change the date queries, but I'll note it in #13646 for feedback.

claudiulodro added 7 commits April 24, 2017 11:33

WC_Object_Query

29fa59a

WC_Order_Query

553a122

Formatting

3d5dabc

Basic working order queries

efa1dbb

Polish and cleanup

9f0f0cd

Better comments

2fad122

Add filters

1647e25

claudiulodro added this to the 3.1.0 milestone Apr 26, 2017

claudiulodro added the Status: Needs Review label Apr 26, 2017

claudiulodro modified the milestones: ⚡ 3.1.0 - Sprint 1, 3.1.0 Apr 26, 2017

Line up array

020e242

mikejolley reviewed Apr 27, 2017

View reviewed changes

Reduce scope

6aecb15

mikejolley reviewed Apr 27, 2017

View reviewed changes

claudiulodro added 6 commits April 27, 2017 11:07

Tweaks from feedback

db3de73

Offload more to subclasses

4eb1396

Missed a spot

059389c

Update tests

11c7722

Add paginate

0721354

Handle paginate

30d2332

mikejolley reviewed Apr 28, 2017

View reviewed changes

mikejolley added needs: author feedback The issue/PR needs a response from any of the parties involved in the issue. and removed Status: Needs Review labels Apr 28, 2017

claudiulodro added 3 commits April 28, 2017 09:55

Docblock

c93c45b

Array filter results

1bb46ad

Better time handling

7c393a4

claudiulodro added Status: Needs Review and removed needs: author feedback The issue/PR needs a response from any of the parties involved in the issue. labels Apr 28, 2017

claudiulodro mentioned this pull request Apr 28, 2017

Integrate WC_Order_Query #14795

Closed

mikejolley modified the milestones: ⚡ 3.1.0 - Sprint 1, ⚡ 3.1.0 - Sprint 3 May 7, 2017

mikejolley merged commit dd3be12 into master May 7, 2017

mikejolley deleted the feature/13646 branch May 7, 2017 13:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WC_Object_Query & WC_Order_Query #14733

WC_Object_Query & WC_Order_Query #14733

claudiulodro commented Apr 26, 2017 •

edited

mikejolley left a comment

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

claudiulodro Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

claudiulodro Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

mikejolley Apr 27, 2017

claudiulodro commented Apr 28, 2017

mikejolley left a comment

mikejolley Apr 28, 2017

mikejolley Apr 28, 2017

mikejolley Apr 28, 2017

mikejolley Apr 28, 2017

claudiulodro commented Apr 28, 2017

mikejolley commented May 7, 2017


		'status' => array( 'publish', 'pending', 'draft', 'future', 'private', 'inherit' ),

		'per_page' => -1,

WC_Object_Query & WC_Order_Query #14733

WC_Object_Query & WC_Order_Query #14733

Conversation

claudiulodro commented Apr 26, 2017 • edited

mikejolley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

claudiulodro commented Apr 28, 2017

mikejolley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

claudiulodro commented Apr 28, 2017

mikejolley commented May 7, 2017

claudiulodro commented Apr 26, 2017 •

edited