14716683875

Committed 28 Apr 2025 07:58PM UTC coverage: 84.287% (+1.6%) from 82.648%

Build # 14716683875

Build Type

push

github

Committed by

actions-user

Commit Message

release: merge develop into master for v2.3.0

Run Details

15905 of 18870 relevant lines covered (84.29%)

257.23 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

53.03

/src/Data/Cursor/TermObjectCursor.php

<?php
namespace WPGraphQL\Data\Cursor;

use WP_Term;

class TermObjectCursor extends AbstractCursor {

        /**
         * @var ?\WP_Term ;
         */
        public $cursor_node;

        /**
         * Counter for meta value joins
         *
         * @var int
         */
        public $meta_join_alias = 0;

        /**
         * {@inheritDoc}
         *
         * @var string
         */
        protected $id_key = 't.term_id';

        /**
         * Deprecated in favor of get_query_var()
         *
         * @param string $name The name of the query var to get
         *
         * @deprecated 1.9.0
         *
         * @return mixed|null
         */
        public function get_query_arg( string $name ) {
                _deprecated_function( __METHOD__, '1.9.0', self::class . '::get_query_var()' );

                return $this->get_query_var( $name );
        }

        /**
         * {@inheritDoc}
         *
         * @return ?\WP_Term ;
         */
        public function get_cursor_node() {
                // Bail if no offset.
                if ( ! $this->cursor_offset ) {
                        return null;
                }

                /**
                 * If pre-hooked, return filtered node.
                 *
                 * @param \WP_Term|null                           $pre_term The pre-filtered term node.
                 * @param int                                     $offset   The cursor offset.
                 * @param \WPGraphQL\Data\Cursor\TermObjectCursor $node     The cursor instance.
                 *
                 * @return \WP_Term|null
                 */
                $pre_term = apply_filters( 'graphql_pre_term_cursor_node', null, $this->cursor_offset, $this );
                if ( null !== $pre_term ) {
                        return $pre_term;
                }

                // Get cursor node.
                $term = WP_Term::get_instance( $this->cursor_offset );

                return $term instanceof WP_Term ? $term : null;
        }

        /**
         * Deprecated in favor of get_cursor_node().
         *
         * @return ?\WP_Term
         * @deprecated 1.9.0
         */
        public function get_cursor_term() {
                _deprecated_function( __METHOD__, '1.9.0', self::class . '::get_cursor_node()' );

                return $this->cursor_node;
        }

        /**
         * {@inheritDoc}
         *
         * @param array<array<string,mixed>>[]|null $fields The fields from the CursorBuilder to convert to SQL.
         */
        public function to_sql( $fields = null ) {
                $sql = $this->builder->to_sql( $fields );
                if ( empty( $sql ) ) {
                        return '';
                }
                return ' AND ' . $sql;
        }

        /**
         * {@inheritDoc}
         */
        public function get_where() {
                // If we have a bad cursor, just skip.
                if ( ! $this->is_valid_offset_and_node() ) {
                        return '';
                }

                $orderby = $this->get_query_var( 'orderby' );
                $order   = $this->get_query_var( 'order' );

                if ( 'name' === $orderby ) {
                        if ( '>' === $this->compare ) {
                                $order         = 'DESC';
                                $this->compare = '<';
                        } elseif ( '<' === $this->compare ) {
                                $this->compare = '>';
                                $order         = 'ASC';
                        }
                }

                /**
                 * If $orderby is just a string just compare with it directly as DESC
                 */
                if ( ! empty( $orderby ) && is_string( $orderby ) ) {
                        $this->compare_with( $orderby, $order );
                }

                /**
                 * If there's no orderby specified yet, compare with the following fields.
                 */
                if ( ! $this->builder->has_fields() ) {
                        $this->compare_with_cursor_fields();
                }

                /**
                 * Stabilize cursor by consistently comparing with the ID.
                 */
                $this->compare_with_id_field();

                return $this->to_sql();
        }

        /**
         * Get AND operator for given order by key
         *
         * @param string $by    The order by key
         * @param string $order The order direction ASC or DESC
         */
        private function compare_with( string $by, string $order ): void {

                // Bail early, if "key" and "value" provided in query_vars.
                $key   = $this->get_query_var( "graphql_cursor_compare_by_{$by}_key" );
                $value = $this->get_query_var( "graphql_cursor_compare_by_{$by}_value" );
                if ( ! empty( $key ) && ! empty( $value ) ) {
                        $this->builder->add_field( $key, $value, null, $order );
                        return;
                }

                // Set "key" as term table column and get "value" from cursor node.
                $key   = "t.{$by}";
                $value = $this->cursor_node->{$by};

                /**
                 * If key or value are null, check whether this is a meta key based ordering before bailing.
                 */
                if ( null === $value ) {
                        $meta_key = $this->get_meta_key( $by );
                        if ( $meta_key ) {
                                $this->compare_with_meta_field( $meta_key, $order );
                        }
                        return;
                }

                $this->builder->add_field( $key, $value, null, $order );
        }

        /**
         * Compare with meta key field
         *
         * @param string $meta_key meta key
         * @param string $order    The comparison string
         */
        private function compare_with_meta_field( string $meta_key, string $order ): void {
                $meta_type  = $this->get_query_var( 'meta_type' );
                $meta_value = get_term_meta( $this->cursor_offset, $meta_key, true );

                $key = "{$this->wpdb->termmeta}.meta_value";

                /**
                 * WP uses mt1, mt2 etc. style aliases for additional meta value joins.
                 */
                if ( 0 !== $this->meta_join_alias ) {
                        $key = "mt{$this->meta_join_alias}.meta_value";
                }

                ++$this->meta_join_alias;

                $this->builder->add_field( $key, $meta_value, $meta_type, $order, $this );
        }

        /**
         * Get the actual meta key if any
         *
         * @param string $by The order by key
         *
         * @return string|null
         */
        private function get_meta_key( string $by ) {
                if ( 'meta_value' === $by || 'meta_value_num' === $by ) {
                        return $this->get_query_var( 'meta_key' );
                }

                /**
                 * Check for the WP 4.2+ style meta clauses
                 * https://make.wordpress.org/core/2015/03/30/query-improvements-in-wp-4-2-orderby-and-meta_query/
                 */
                if ( ! isset( $this->query_vars['meta_query'][ $by ] ) ) {
                        return null;
                }

                $clause = $this->query_vars['meta_query'][ $by ];

                return empty( $clause['key'] ) ? null : $clause['key'];
        }
}

1	<?php
2	namespace WPGraphQL\Data\Cursor;
3
4	use WP_Term;
5
6	class TermObjectCursor extends AbstractCursor {
7
8	/**
9	* @var ?\WP_Term ;
10	*/
11	public $cursor_node;
12
13	/**
14	* Counter for meta value joins
15	*
16	* @var int
17	*/
18	public $meta_join_alias = 0;
19
20	/**
21	* {@inheritDoc}
22	*
23	* @var string
24	*/
25	protected $id_key = 't.term_id';
26
27	/**
28	* Deprecated in favor of get_query_var()
29	*
30	* @param string $name The name of the query var to get
31	*
32	* @deprecated 1.9.0
33	*
34	* @return mixed\|null
35	*/
36	public function get_query_arg( string $name ) {	×
37	_deprecated_function( __METHOD__, '1.9.0', self::class . '::get_query_var()' );	×
38
39	return $this->get_query_var( $name );	×
40	}
41
42	/**
43	* {@inheritDoc}
44	*
45	* @return ?\WP_Term ;
46	*/
47	public function get_cursor_node() {	60✔
48	// Bail if no offset.
49	if ( ! $this->cursor_offset ) {	60✔
50	return null;	60✔
51	}
52
53	/**
54	* If pre-hooked, return filtered node.
55	*
56	* @param \WP_Term\|null $pre_term The pre-filtered term node.
57	* @param int $offset The cursor offset.
58	* @param \WPGraphQL\Data\Cursor\TermObjectCursor $node The cursor instance.
59	*
60	* @return \WP_Term\|null
61	*/
62	$pre_term = apply_filters( 'graphql_pre_term_cursor_node', null, $this->cursor_offset, $this );	9✔
63	if ( null !== $pre_term ) {	9✔
64	return $pre_term;	×
65	}
66
67	// Get cursor node.
68	$term = WP_Term::get_instance( $this->cursor_offset );	9✔
69
70	return $term instanceof WP_Term ? $term : null;	9✔
71	}
72
73	/**
74	* Deprecated in favor of get_cursor_node().
75	*
76	* @return ?\WP_Term
77	* @deprecated 1.9.0
78	*/
79	public function get_cursor_term() {	×
80	_deprecated_function( __METHOD__, '1.9.0', self::class . '::get_cursor_node()' );	×
81
82	return $this->cursor_node;	×
83	}
84
85	/**
86	* {@inheritDoc}
87	*
88	* @param array<array<string,mixed>>[]\|null $fields The fields from the CursorBuilder to convert to SQL.
89	*/
90	public function to_sql( $fields = null ) {	9✔
91	$sql = $this->builder->to_sql( $fields );	9✔
92	if ( empty( $sql ) ) {	9✔
93	return '';	×
94	}
95	return ' AND ' . $sql;	9✔
96	}
97
98	/**
99	* {@inheritDoc}
100	*/
101	public function get_where() {	9✔
102	// If we have a bad cursor, just skip.
103	if ( ! $this->is_valid_offset_and_node() ) {	9✔
104	return '';	×
105	}
106
107	$orderby = $this->get_query_var( 'orderby' );	9✔
108	$order = $this->get_query_var( 'order' );	9✔
109
110	if ( 'name' === $orderby ) {	9✔
111	if ( '>' === $this->compare ) {	8✔
112	$order = 'DESC';	6✔
113	$this->compare = '<';	6✔
114	} elseif ( '<' === $this->compare ) {	6✔
115	$this->compare = '>';	6✔
116	$order = 'ASC';	6✔
117	}
118	}
119
120	/**
121	* If $orderby is just a string just compare with it directly as DESC
122	*/
123	if ( ! empty( $orderby ) && is_string( $orderby ) ) {	9✔
124	$this->compare_with( $orderby, $order );	9✔
125	}
126
127	/**
128	* If there's no orderby specified yet, compare with the following fields.
129	*/
130	if ( ! $this->builder->has_fields() ) {	9✔
131	$this->compare_with_cursor_fields();	×
132	}
133
134	/**
135	* Stabilize cursor by consistently comparing with the ID.
136	*/
137	$this->compare_with_id_field();	9✔
138
139	return $this->to_sql();	9✔
140	}
141
142	/**
143	* Get AND operator for given order by key
144	*
145	* @param string $by The order by key
146	* @param string $order The order direction ASC or DESC
147	*/
148	private function compare_with( string $by, string $order ): void {	9✔
149
150	// Bail early, if "key" and "value" provided in query_vars.
151	$key = $this->get_query_var( "graphql_cursor_compare_by_{$by}_key" );	9✔
152	$value = $this->get_query_var( "graphql_cursor_compare_by_{$by}_value" );	9✔
153	if ( ! empty( $key ) && ! empty( $value ) ) {	9✔
154	$this->builder->add_field( $key, $value, null, $order );	×
155	return;	×
156	}
157
158	// Set "key" as term table column and get "value" from cursor node.
159	$key = "t.{$by}";	9✔
160	$value = $this->cursor_node->{$by};	9✔
161
162	/**
163	* If key or value are null, check whether this is a meta key based ordering before bailing.
164	*/
165	if ( null === $value ) {	9✔
166	$meta_key = $this->get_meta_key( $by );	×
167	if ( $meta_key ) {	×
168	$this->compare_with_meta_field( $meta_key, $order );	×
169	}
170	return;	×
171	}
172
173	$this->builder->add_field( $key, $value, null, $order );	9✔
174	}
175
176	/**
177	* Compare with meta key field
178	*
179	* @param string $meta_key meta key
180	* @param string $order The comparison string
181	*/
182	private function compare_with_meta_field( string $meta_key, string $order ): void {	×
183	$meta_type = $this->get_query_var( 'meta_type' );	×
184	$meta_value = get_term_meta( $this->cursor_offset, $meta_key, true );	×
185
186	$key = "{$this->wpdb->termmeta}.meta_value";	×
187
188	/**
189	* WP uses mt1, mt2 etc. style aliases for additional meta value joins.
190	*/
191	if ( 0 !== $this->meta_join_alias ) {	×
192	$key = "mt{$this->meta_join_alias}.meta_value";	×
193	}
194
195	++$this->meta_join_alias;	×
196
197	$this->builder->add_field( $key, $meta_value, $meta_type, $order, $this );	×
198	}
199
200	/**
201	* Get the actual meta key if any
202	*
203	* @param string $by The order by key
204	*
205	* @return string\|null
206	*/
207	private function get_meta_key( string $by ) {	×
208	if ( 'meta_value' === $by \|\| 'meta_value_num' === $by ) {	×
209	return $this->get_query_var( 'meta_key' );	×
210	}
211
212	/**
213	* Check for the WP 4.2+ style meta clauses
214	* https://make.wordpress.org/core/2015/03/30/query-improvements-in-wp-4-2-orderby-and-meta_query/
215	*/
216	if ( ! isset( $this->query_vars['meta_query'][ $by ] ) ) {	×
217	return null;	×
218	}
219
220	$clause = $this->query_vars['meta_query'][ $by ];	×
221
222	return empty( $clause['key'] ) ? null : $clause['key'];	×
223	}
224	}

wp-graphql / wp-graphql / 14716683875

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous