6622

pending completion

Build # 6622

Build Type

Pull #2397

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/timber/timber/commit/<a class=hub.com/timber/timber/commit/<a class="double-link" href="https://git"><a class=hub.com/timber/timber/commit/<a class="double-link" href="https://git"><a class=hub.com/timber/timber/commit/<a class="double-link" href="https://git"><a class=hub.com/timber/timber/commit/eaabb56a77a9bfe9c35a980021ef936f0c4f99dc">eaabb56a7">&lt;a href=&quot;https://github.com/timber/timber/commit/</a><a class="double-link" href="https://github.com/timber/timber/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/timber/timber/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/timber/timber/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/timber/timber/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/timber/timber/commit/eaabb56a77a9bfe9c35a980021ef936f0c4f99dc">eaabb56a7</a><a href="https://github.com/timber/timber/commit/eaabb56a77a9bfe9c35a980021ef936f0c4f99dc">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/timber/timber/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/timber/timber/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/timber/timber/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/timber/timber/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/timber/timber/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/timber/timber/commit/eaabb56a77a9bfe9c35a980021ef936f0c4f99dc&quot;&gt;eaabb56a7&lt;/a&gt;&lt;a href=&quot;https://github.com/timber/timber/commit/eaabb56a77a9bfe9c35a980021ef936f0c4f99dc&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/timber/timber/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/timber/timber/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;htt... (continued)

Pull Request Pull Request #2397: 2.x improve meta field handling

Run Details

139 of 139 new or added lines in 3 files covered. (100.0%)

3189 of 3496 relevant lines covered (91.22%)

90.69 hits per line

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

90.0

/lib/CoreEntity.php

<?php

namespace Timber;

abstract class CoreEntity extends Core implements CoreInterface, MetaInterface {

        /**
         * Gets an object meta value.
         *
         * Returns a meta value or all meta values for all custom fields of an object saved in the
         * meta database table.
         *
         * Fetching all values is only advised during development, because it can have a big performance
         * impact, when all filters are applied.
         *
         * @api
         *
         * @param string $field_name Optional. The field name for which you want to get the value. If
         *                           no field name is provided, this function will fetch values for all
         *                           custom fields. Default empty string.
         * @param array $args An array of arguments for getting the meta value. Third-party integrations
         *                    can use this argument to make their API arguments available in Timber.
         *                    Default empty array.
         * @return mixed The custom field value or an array of custom field values. Null if no value
         *               could be found.
         */
        public function meta( $field_name = '', $args = [] ) {
                return $this->fetch_meta( $field_name, $args );
        }

        /**
         * Gets an object meta value directly from the database.
         *
         * Returns a raw meta value or all raw meta values saved in the meta database table. In
         * comparison to `meta()`, this function will return raw values that are not filtered by third-
         * party plugins.
         *
         * Fetching raw values for all custom fields will not have a big performance impact, because
         * WordPress gets all meta values, when the first meta value is accessed.
         *
         * @api
         * @since 2.0.0
         *
         * @param string $field_name Optional. The field name for which you want to get the value. If
         *                           no field name is provided, this function will fetch values for all
         *                           custom fields. Default empty string.
         *
         * @return null|mixed The meta field value(s). Null if no value could be found, an empty array
         *                    if all fields were requested but no values could be found.
         */
        public function raw_meta( $field_name = '' ) {
                return $this->fetch_meta( $field_name, [], false );
        }

        /**
         * Gets an object meta value.
         *
         * Returns a meta value or all meta values for all custom fields of an object saved in the object
         * meta database table.
         *
         * Fetching all values is only advised during development, because it can have a big performance
         * impact, when all filters are applied.
         *
         * @api
         *
         * @param string $field_name Optional. The field name for which you want to get the value. If
         *                           no field name is provided, this function will fetch values for all
         *                           custom fields. Default empty string.
         * @param array  $args       {
         *      An array of arguments for getting the meta value. Third-party integrations can use this
         *      argument to make their API arguments available in Timber. Default empty array.
         * }
         * @param bool $apply_filters Whether to apply filtering of meta values. You can also use
         *                                               the `raw_meta()` method as a shortcut to apply this argument.
         *                            Default true.
         *
         * @return mixed The custom field value or an array of custom field values. Null if no value
         *               could be found.
         */
        protected function fetch_meta( $field_name = '', $args = [], $apply_filters = true ) {

                /**
                 * Filters whether to transform a meta value.
                 *
                 * If the filter returns `true`, all meta value will be transformed to Timber/standard PHP objects if possible.
                 *
                 * @api
                 * @since 2.0.0
                 * @example
                 * ```php
                 * // Transforms all meta value.
                 * add_filter( 'timber/meta/transform_value', '__return_true' );
                 * ```
                 *
                 * @param bool $transform_value
                 */
                $transform_value = apply_filters('timber/meta/transform_value', false );

                $args = wp_parse_args( $args, [
                        'transform_value' => $transform_value,
                ] );

                $object_meta = null;

                $object_type = $this->get_object_type();

                if ( $apply_filters ) {
                        /**
                         * Filters object meta data before it is fetched from the database.
                         *
                         * @example
                         * ```php
                         * // Disable fetching meta values.
                         * add_filter( 'timber/post/pre_meta', '__return_false' );
                         *
                         * // Add your own meta data.
                         * add_filter( 'timber/post/pre_meta', function( $post_meta, $post_id, $post ) {
                         *     $post_meta = array_merge( $post_meta, [
                         *         'custom_data_1' => 73,
                         *         'custom_data_2' => 274,
                         *     ] );
                         *
                         *     return $post_meta;
                         * }, 10, 3 );
                         * ```
                         *
                         * @since 2.0.0
                         *
                         * @param string       $object_meta  The field value. Default null. Passing a non-null
                         *                                 value will skip fetching the value from the database
                         *                                 and will use the value from the filter instead.
                         * @param int          $post_id    The post ID.
                         * @param string       $field_name The name of the meta field to get the value for.
                         * @param \Timber\{Object} $object       The Timber object.
                         * @param array        $args       An array of arguments.
                         */
                        $object_meta = apply_filters(
                                "timber/{$object_type}/pre_meta",
                                $object_meta,
                                $this->ID,
                                $field_name,
                                $this,
                                $args
                        );

                        // @todo Remove when deprecated filters will be gone
                        if( $object_type !== 'term' ) {
                                /**
                                 * Filters the value for a post meta field before it is fetched from the database.
                                 *
                                 * @deprecated 2.0.0, use `timber/{object_type}/pre_meta`
                                 */
                                $object_meta = apply_filters_deprecated(
                                        "timber_{$object_type}_get_meta_field_pre",
                                        [ $object_meta, $this->ID, $field_name, $this ],
                                        '2.0.0',
                                        "timber/{$object_type}/pre_meta"
                                );

                                /**
                                 * Filters post meta data before it is fetched from the database.
                                 *
                                 * @deprecated 2.0.0, use `timber/{object_type}/pre_meta`
                                 */
                                do_action_deprecated(
                                        "timber_{$object_type}_get_meta_pre",
                                        [ $object_meta, $this->ID, $this ],
                                        '2.0.0',
                                        "timber/{$object_type}/pre_meta"
                                );
                        }
                }

                if ( null === $object_meta ) {
                        // Fetch values. Auto-fetches all values if $field_name is empty.
                        $object_meta = call_user_func_array( "get_{$object_type}_meta", [ $this->ID, $field_name, true ] );

                        // Mimick $single argument when fetching all meta values.
                        if ( empty( $field_name ) && is_array( $object_meta ) && ! empty( $object_meta ) ) {
                                $object_meta = array_map( function( $meta ) {
                                        if ( 1 === count( $meta ) && isset( $meta[0] ) ) {
                                                return $meta[0];
                                        }

                                        return $meta;
                                }, $object_meta );
                        }

                        // Empty result.
                        if ( empty( $object_meta ) ) {
                                $object_meta = empty( $field_name ) ? [] : null;
                        }
                }

                if ( $apply_filters ) {
                        /**
                         * Filters the value for a post meta field.
                         *
                         * This filter is used by the ACF Integration.
                         *
                         * @example
                         * ```php
                         * add_filter( 'timber/post/meta', function( $post_meta, $post_id, $field_name, $post ) {
                         *     if ( 'event' === $post->post_type ) {
                         *         // Do something special.
                         *         $post_meta['foo'] = $post_meta['foo'] . ' bar';
                         *     }
                         *
                         *     return $post_meta;
                         * }, 10, 4 );
                         * ```
                         *
                         * @see   \Timber\Post::meta()
                         * @since 2.0.0
                         *
                         * @param string       $post_meta  The field value.
                         * @param int          $post_id    The post ID.
                         * @param string       $field_name The name of the meta field to get the value for.
                         * @param \Timber\Post $post       The post object.
                         * @param array        $args       An array of arguments.
                         */
                        $object_meta = apply_filters(
                                "timber/{$object_type}/meta",
                                $object_meta,
                                $this->ID,
                                $field_name,
                                $this,
                                $args
                        );

                        // @todo Remove when deprecated filters will be gone
                        if( $object_type === 'term' ) {
                                /**
                                 * Filters the value for a term meta field.
                                 *
                                 * @deprecated 2.0.0, use `timber/term/meta`
                                 */
                                $object_meta = apply_filters_deprecated(
                                        'timber/term/meta/field',
                                        [ $object_meta, $this->ID, $field_name, $this ],
                                        '2.0.0',
                                        'timber/term/meta'
                                );
                        }

                        /**
                         * Filters the value for an object meta field.
                         *
                         * @deprecated 2.0.0, use `timber/{object_type}/meta`
                         */
                        $object_meta = apply_filters_deprecated(
                                "timber_{$object_type}_get_meta_field",
                                [ $object_meta, $this->ID, $field_name, $this ],
                                '2.0.0',
                                "timber/{$object_type}/meta"
                        );

                        /**
                         * Filters object meta data fetched from the database.
                         *
                         * @deprecated 2.0.0, use `timber/{object_type}/meta`
                         */
                        $object_meta = apply_filters_deprecated(
                                "timber_{$object_type}_get_meta",
                                [ $object_meta, $this->ID, $this ],
                                '2.0.0',
                                "timber/{$object_type}/meta"
                        );

                        // Maybe convert values to Timber objects.
                        if ( $args['transform_value'] ) {
                                $object_meta = $this->convert($object_meta);
                        }

                }

                return $object_meta;
        }

        /**
         * Finds any WP_Post objects and converts them to Timber\Posts
         *
         * @api
         * @param array|WP_Post $data
         * @param string $class
         */
        public function convert( $data ) {
                if ( is_object($data) ) {
                        $data = Helper::convert_wp_object($data);
                } else if ( is_array($data) ) {
                        $data = array_map([$this, 'convert'], $data);
                }
                return $data;
        }

        /**
         * Get the base object type
         *
         * @return string
         */
        protected function get_object_type() {
                return $this->object_type;
        }

}

1	<?php
2
3	namespace Timber;
4
5	abstract class CoreEntity extends Core implements CoreInterface, MetaInterface {
6
7	/**
8	* Gets an object meta value.
9	*
10	* Returns a meta value or all meta values for all custom fields of an object saved in the
11	* meta database table.
12	*
13	* Fetching all values is only advised during development, because it can have a big performance
14	* impact, when all filters are applied.
15	*
16	* @api
17	*
18	* @param string $field_name Optional. The field name for which you want to get the value. If
19	* no field name is provided, this function will fetch values for all
20	* custom fields. Default empty string.
21	* @param array $args An array of arguments for getting the meta value. Third-party integrations
22	* can use this argument to make their API arguments available in Timber.
23	* Default empty array.
24	* @return mixed The custom field value or an array of custom field values. Null if no value
25	* could be found.
26	*/
27	public function meta( $field_name = '', $args = [] ) {
28	return $this->fetch_meta( $field_name, $args );	200✔
29	}
30
31	/**
32	* Gets an object meta value directly from the database.
33	*
34	* Returns a raw meta value or all raw meta values saved in the meta database table. In
35	* comparison to `meta()`, this function will return raw values that are not filtered by third-
36	* party plugins.
37	*
38	* Fetching raw values for all custom fields will not have a big performance impact, because
39	* WordPress gets all meta values, when the first meta value is accessed.
40	*
41	* @api
42	* @since 2.0.0
43	*
44	* @param string $field_name Optional. The field name for which you want to get the value. If
45	* no field name is provided, this function will fetch values for all
46	* custom fields. Default empty string.
47	*
48	* @return null\|mixed The meta field value(s). Null if no value could be found, an empty array
49	* if all fields were requested but no values could be found.
50	*/
51	public function raw_meta( $field_name = '' ) {
52	return $this->fetch_meta( $field_name, [], false );	146✔
53	}
54
55	/**
56	* Gets an object meta value.
57	*
58	* Returns a meta value or all meta values for all custom fields of an object saved in the object
59	* meta database table.
60	*
61	* Fetching all values is only advised during development, because it can have a big performance
62	* impact, when all filters are applied.
63	*
64	* @api
65	*
66	* @param string $field_name Optional. The field name for which you want to get the value. If
67	* no field name is provided, this function will fetch values for all
68	* custom fields. Default empty string.
69	* @param array $args {
70	* An array of arguments for getting the meta value. Third-party integrations can use this
71	* argument to make their API arguments available in Timber. Default empty array.
72	* }
73	* @param bool $apply_filters Whether to apply filtering of meta values. You can also use
74	* the `raw_meta()` method as a shortcut to apply this argument.
75	* Default true.
76	*
77	* @return mixed The custom field value or an array of custom field values. Null if no value
78	* could be found.
79	*/
80	protected function fetch_meta( $field_name = '', $args = [], $apply_filters = true ) {
81
82	/**
83	* Filters whether to transform a meta value.
84	*
85	* If the filter returns `true`, all meta value will be transformed to Timber/standard PHP objects if possible.
86	*
87	* @api
88	* @since 2.0.0
89	* @example
90	* ```php
91	* // Transforms all meta value.
92	* add_filter( 'timber/meta/transform_value', '__return_true' );
93	* ```
94	*
95	* @param bool $transform_value
96	*/
97	$transform_value = apply_filters('timber/meta/transform_value', false );	330✔
98
99	$args = wp_parse_args( $args, [	330✔
100	'transform_value' => $transform_value,	330✔
101	] );
102
103	$object_meta = null;	330✔
104
105	$object_type = $this->get_object_type();	330✔
106
107	if ( $apply_filters ) {	330✔
108	/**
109	* Filters object meta data before it is fetched from the database.
110	*
111	* @example
112	* ```php
113	* // Disable fetching meta values.
114	* add_filter( 'timber/post/pre_meta', '__return_false' );
115	*
116	* // Add your own meta data.
117	* add_filter( 'timber/post/pre_meta', function( $post_meta, $post_id, $post ) {
118	* $post_meta = array_merge( $post_meta, [
119	* 'custom_data_1' => 73,
120	* 'custom_data_2' => 274,
121	* ] );
122	*
123	* return $post_meta;
124	* }, 10, 3 );
125	* ```
126	*
127	* @since 2.0.0
128	*
129	* @param string $object_meta The field value. Default null. Passing a non-null
130	* value will skip fetching the value from the database
131	* and will use the value from the filter instead.
132	* @param int $post_id The post ID.
133	* @param string $field_name The name of the meta field to get the value for.
134	* @param \Timber\{Object} $object The Timber object.
135	* @param array $args An array of arguments.
136	*/
137	$object_meta = apply_filters(	200✔
138	"timber/{$object_type}/pre_meta",	200✔
139	$object_meta,
140	$this->ID,	200✔
141	$field_name,
142	$this,
143	$args
144	);
145
146	// @todo Remove when deprecated filters will be gone
147	if( $object_type !== 'term' ) {	200✔
148	/**
149	* Filters the value for a post meta field before it is fetched from the database.
150	*
151	* @deprecated 2.0.0, use `timber/{object_type}/pre_meta`
152	*/
153	$object_meta = apply_filters_deprecated(	172✔
154	"timber_{$object_type}_get_meta_field_pre",	172✔
155	[ $object_meta, $this->ID, $field_name, $this ],	172✔
156	'2.0.0',	172✔
157	"timber/{$object_type}/pre_meta"	172✔
158	);
159
160	/**
161	* Filters post meta data before it is fetched from the database.
162	*
163	* @deprecated 2.0.0, use `timber/{object_type}/pre_meta`
164	*/
165	do_action_deprecated(	172✔
166	"timber_{$object_type}_get_meta_pre",	172✔
167	[ $object_meta, $this->ID, $this ],	172✔
168	'2.0.0',	172✔
169	"timber/{$object_type}/pre_meta"	172✔
170	);
171	}
172	}
173
174	if ( null === $object_meta ) {	330✔
175	// Fetch values. Auto-fetches all values if $field_name is empty.
176	$object_meta = call_user_func_array( "get_{$object_type}_meta", [ $this->ID, $field_name, true ] );	248✔
177
178	// Mimick $single argument when fetching all meta values.
179	if ( empty( $field_name ) && is_array( $object_meta ) && ! empty( $object_meta ) ) {	248✔
180	$object_meta = array_map( function( $meta ) {
181	if ( 1 === count( $meta ) && isset( $meta[0] ) ) {	142✔
182	return $meta[0];	142✔
183	}
184
185	return $meta;	×
186	}, $object_meta );	142✔
187	}
188
189	// Empty result.
190	if ( empty( $object_meta ) ) {	248✔
191	$object_meta = empty( $field_name ) ? [] : null;	62✔
192	}
193	}
194
195	if ( $apply_filters ) {	330✔
196	/**
197	* Filters the value for a post meta field.
198	*
199	* This filter is used by the ACF Integration.
200	*
201	* @example
202	* ```php
203	* add_filter( 'timber/post/meta', function( $post_meta, $post_id, $field_name, $post ) {
204	* if ( 'event' === $post->post_type ) {
205	* // Do something special.
206	* $post_meta['foo'] = $post_meta['foo'] . ' bar';
207	* }
208	*
209	* return $post_meta;
210	* }, 10, 4 );
211	* ```
212	*
213	* @see \Timber\Post::meta()
214	* @since 2.0.0
215	*
216	* @param string $post_meta The field value.
217	* @param int $post_id The post ID.
218	* @param string $field_name The name of the meta field to get the value for.
219	* @param \Timber\Post $post The post object.
220	* @param array $args An array of arguments.
221	*/
222	$object_meta = apply_filters(	200✔
223	"timber/{$object_type}/meta",	200✔
224	$object_meta,
225	$this->ID,	200✔
226	$field_name,
227	$this,
228	$args
229	);
230
231	// @todo Remove when deprecated filters will be gone
232	if( $object_type === 'term' ) {	200✔
233	/**
234	* Filters the value for a term meta field.
235	*
236	* @deprecated 2.0.0, use `timber/term/meta`
237	*/
238	$object_meta = apply_filters_deprecated(	50✔
239	'timber/term/meta/field',	50✔
240	[ $object_meta, $this->ID, $field_name, $this ],	50✔
241	'2.0.0',	50✔
242	'timber/term/meta'	50✔
243	);
244	}
245
246	/**
247	* Filters the value for an object meta field.
248	*
249	* @deprecated 2.0.0, use `timber/{object_type}/meta`
250	*/
251	$object_meta = apply_filters_deprecated(	200✔
252	"timber_{$object_type}_get_meta_field",	200✔
253	[ $object_meta, $this->ID, $field_name, $this ],	200✔
254	'2.0.0',	200✔
255	"timber/{$object_type}/meta"	200✔
256	);
257
258	/**
259	* Filters object meta data fetched from the database.
260	*
261	* @deprecated 2.0.0, use `timber/{object_type}/meta`
262	*/
263	$object_meta = apply_filters_deprecated(	200✔
264	"timber_{$object_type}_get_meta",	200✔
265	[ $object_meta, $this->ID, $this ],	200✔
266	'2.0.0',	200✔
267	"timber/{$object_type}/meta"	200✔
268	);
269
270	// Maybe convert values to Timber objects.
271	if ( $args['transform_value'] ) {	200✔
272	$object_meta = $this->convert($object_meta);	22✔
273	}
274
275	}
276
277	return $object_meta;	330✔
278	}
279
280	/**
281	* Finds any WP_Post objects and converts them to Timber\Posts
282	*
283	* @api
284	* @param array\|WP_Post $data
285	* @param string $class
286	*/
287	public function convert( $data ) {
288	if ( is_object($data) ) {	×
289	$data = Helper::convert_wp_object($data);	×
290	} else if ( is_array($data) ) {	×
291	$data = array_map([$this, 'convert'], $data);	×
292	}
293	return $data;	×
294	}
295
296	/**
297	* Get the base object type
298	*
299	* @return string
300	*/
301	protected function get_object_type() {
302	return $this->object_type;	330✔
303	}
304
305	}

timber / timber / 6622

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