2fe8155127d44b76826b64de283421636bd98817-PR-250

Build # 2fe8155127d44b76826b64de283421636bd98817-PR-250

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/wp-graphql/wp-graphql-acf/commit/<a class=hub.com/wp-graphql/wp-graphql-acf/commit/2fe8155127d44b76826b64de283421636bd98817">2fe815512<a href="https://github.com/wp-graphql/wp-graphql-acf/commit/2fe8155127d44b76826b64de283421636bd98817">">Merge </a><a class="double-link" href="https://github.com/wp-graphql/wp-graphql-acf/commit/<a class="double-link" href="https://github.com/wp-graphql/wp-graphql-acf/commit/1bad7d6d5214448f8d27bbcd908b24d6552667cb">1bad7d6d5</a>">1bad7d6d5</a><a href="https://github.com/wp-graphql/wp-graphql-acf/commit/2fe8155127d44b76826b64de283421636bd98817"> into 2545c2f32">2545c2f32</a>

Pull Request Pull Request #250: Release/v0.5.0

Run Details

565 of 565 new or added lines in 4 files covered. (100.0%)

516 of 1069 relevant lines covered (48.27%)

13.48 hits per line

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

0.0

/src/class-acfsettings.php

<?php
/**
 * ACF extension for WP-GraphQL
 *
 * @package wp-graphql-acf
 */

namespace WPGraphQL\ACF;

/**
 * Class ACF_Settings
 *
 * @package WPGraphQL\ACF
 */
class ACF_Settings {

        /**
         * Initialize ACF Settings for the plugin
         */
        public function init() {

                /**
                 * Add settings to individual fields to allow each field granular control
                 * over how it's shown in the GraphQL Schema
                 */
                add_action( 'acf/render_field_settings', [ $this, 'add_field_settings' ], 10, 1 );

                /**
                 * Enqueue scripts to enhance the UI of the ACF Field Group Settings
                 */
                add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_graphql_acf_scripts' ], 10, 1 );

                /**
                 * Register meta boxes for the ACF Field Group Settings
                 */
                add_action( 'add_meta_boxes', [ $this, 'register_meta_boxes' ] );

                /**
                 * Register an AJAX action and callback for converting ACF Location rules to GraphQL Types
                 */
                add_action( 'wp_ajax_get_acf_field_group_graphql_types', [ $this, 'ajax_callback' ] );

        }

        /**
         * Handle the AJAX callback for converting ACF Location settings to GraphQL Types
         *
         * @return void
         */
        public function ajax_callback() {

                if ( isset( $_POST['data'] ) ) {

                        $form_data = [];

                        parse_str( $_POST['data'], $form_data );

                        if ( empty( $form_data ) || ! isset( $form_data['acf_field_group'] ) ) {
                                wp_send_json( __( 'No form data.', 'wp-graphql-acf' ) );
                        }

                        $field_group = isset( $form_data['acf_field_group'] ) ? $form_data['acf_field_group'] : [];
                        $rules       = new LocationRules( [ $field_group ] );
                        $rules->determine_location_rules();

                        $group_name = isset( $field_group['graphql_field_name'] ) ? $field_group['graphql_field_name'] : $field_group['title'];
                        $group_name = $rules->format_field_name( $group_name );

                        $all_rules = $rules->get_rules();
                        if ( isset( $all_rules[ $group_name ] ) ) {
                                wp_send_json( [ 'graphql_types' => $all_rules[ $group_name ] ] );
                        }
                        wp_send_json( [ 'graphql_types' => null ] );
                }

                echo __( 'No location rules were found', 'wp-graphql-acf' );
                wp_die();
        }

        /**
         * Register the GraphQL Settings metabox for the ACF Field Group post type
         *
         * @return void
         */
        public function register_meta_boxes() {
                add_meta_box( 'wpgraphql-acf-meta-box', __( 'GraphQL', 'wp-graphql-acf' ), [
                        $this,
                        'display_metabox'
                ], [ 'acf-field-group' ] );
        }

        /**
         * Display the GraphQL Settings Metabox on the Field Group admin page
         *
         * @param $field_group_post_object
         */
        public function display_metabox( $field_group_post_object ) {

                global $field_group;

                /**
                 * Render a field in the Field Group settings to allow for a Field Group to be shown in GraphQL.
                 */
                acf_render_field_wrap(
                        [
                                'label'        => __( 'Show in GraphQL', 'acf' ),
                                'instructions' => __( 'If the field group is active, and this is set to show, the fields in this group will be available in the WPGraphQL Schema based on the respective Location rules.' ),
                                'type'         => 'true_false',
                                'name'         => 'show_in_graphql',
                                'prefix'       => 'acf_field_group',
                                'value'        => isset( $field_group['show_in_graphql'] ) ? (bool) $field_group['show_in_graphql'] : false,
                                'ui'           => 1,
                        ]
                );

                /**
                 * Render a field in the Field Group settings to set the GraphQL field name for the field group.
                 */
                acf_render_field_wrap(
                        [
                                'label'        => __( 'GraphQL Field Name', 'acf' ),
                                'instructions' => __( 'The name of the field group in the GraphQL Schema. Names should not include spaces or special characters. Best practice is to use "camelCase".', 'wp-graphql-acf' ),
                                'type'         => 'text',
                                'prefix'       => 'acf_field_group',
                                'name'         => 'graphql_field_name',
                                'required'     => isset( $field_group['show_in_graphql'] ) ? (bool) $field_group['show_in_graphql'] : false,
                                'placeholder'  => ! empty( $field_group['graphql_field_name'] ) ? $field_group['graphql_field_name'] : null,
                                'value'        => ! empty( $field_group['graphql_field_name'] ) ? $field_group['graphql_field_name'] : null,
                        ]
                );

                acf_render_field_wrap(
                        [
                                'label'        => __( 'Manually Set GraphQL Types for Field Group', 'acf' ),
                                'instructions' => __( 'By default, ACF Field groups are added to the GraphQL Schema based on the field group\'s location rules. Checking this box will let you manually control the GraphQL Types the field group should be shown on in the GraphQL Schema using the checkboxes below, and the Location Rules will no longer effect the GraphQL Types.', 'wp-graphql-acf' ),
                                'type'         => 'true_false',
                                'name'         => 'map_graphql_types_from_location_rules',
                                'prefix'       => 'acf_field_group',
                                'value'        => isset( $field_group['map_graphql_types_from_location_rules'] ) ? (bool) $field_group['map_graphql_types_from_location_rules'] : false,
                                'ui'           => 1,
                        ]
                );

                $choices = Config::get_all_graphql_types();
                acf_render_field_wrap(
                        [
                                'label'        => __( 'GraphQL Types to Show the Field Group On', 'wp-graphql-acf' ),
                                'instructions' => __( 'Select the Types in the WPGraphQL Schema to show the fields in this field group on', 'wp-graphql-acf' ),
                                'type'         => 'checkbox',
                                'prefix'       => 'acf_field_group',
                                'name'         => 'graphql_types',
                                'value'        => ! empty( $field_group['graphql_types'] ) ? $field_group['graphql_types'] : [],
                                'toggle'       => true,
                                'choices'      => $choices,
                        ]
                );

                ?>
                <div class="acf-hidden">
                        <input type="hidden" name="acf_field_group[key]"
                                   value="<?php echo $field_group['key']; ?>"/>
                </div>
                <script type="text/javascript">
                        if (typeof acf !== 'undefined') {
                                acf.newPostbox({
                                        'id': 'wpgraphql-acf-meta-box',
                                        'label': 'left'
                                });
                        }
                </script>
                <?php

        }

        /**
         * Add settings to each field to show in GraphQL
         *
         * @param array $field The field to add the setting to.
         */
        public function add_field_settings( array $field ) {

                $supported_fields = Config::get_supported_fields();

                /**
                 * If there are no supported fields, or the field is not supported, don't add a setting field.
                 */
                if ( empty( $supported_fields ) || ! is_array( $supported_fields ) || ! in_array( $field['type'], $supported_fields, true ) ) {
                        return;
                }

                /**
                 * Render the "show_in_graphql" setting for the field.
                 */
                acf_render_field_setting(
                        $field,
                        [
                                'label'         => __( 'Show in GraphQL', 'wp-graphql-acf' ),
                                'instructions'  => __( 'Whether the field should be queryable via GraphQL', 'wp-graphql-acf' ),
                                'name'          => 'show_in_graphql',
                                'type'          => 'true_false',
                                'ui'            => 1,
                                'default_value' => 1,
                                'value'         => isset( $field['show_in_graphql'] ) ? (bool) $field['show_in_graphql'] : true,
                        ],
                        true
                );

        }

        /**
         * This enqueues admin script.
         *
         * @param string $screen The screen that scripts are being enqueued to
         *
         * @return void
         */
        public function enqueue_graphql_acf_scripts( string $screen ) {
                global $post;

                if ( $screen == 'post-new.php' || $screen == 'post.php' ) {
                        if ( 'acf-field-group' === $post->post_type ) {
                                wp_enqueue_script( 'graphql-acf', plugins_url( 'src/js/main.js', dirname( __FILE__ ) ), array(
                                        'jquery',
                                        'acf-input',
                                        'acf-field-group'
                                ) );
                        }
                }
        }

}

1	<?php
2	/**
3	* ACF extension for WP-GraphQL
4	*
5	* @package wp-graphql-acf
6	*/
7
8	namespace WPGraphQL\ACF;
9
10	/**
11	* Class ACF_Settings
12	*
13	* @package WPGraphQL\ACF
14	*/
15	class ACF_Settings {
16
17	/**
18	* Initialize ACF Settings for the plugin
19	*/
20	public function init() {
21
22	/**
23	* Add settings to individual fields to allow each field granular control
24	* over how it's shown in the GraphQL Schema
25	*/
26	add_action( 'acf/render_field_settings', [ $this, 'add_field_settings' ], 10, 1 );	×
27
28	/**
29	* Enqueue scripts to enhance the UI of the ACF Field Group Settings
30	*/
31	add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_graphql_acf_scripts' ], 10, 1 );	×
32
33	/**
34	* Register meta boxes for the ACF Field Group Settings
35	*/
36	add_action( 'add_meta_boxes', [ $this, 'register_meta_boxes' ] );	×
37
38	/**
39	* Register an AJAX action and callback for converting ACF Location rules to GraphQL Types
40	*/
41	add_action( 'wp_ajax_get_acf_field_group_graphql_types', [ $this, 'ajax_callback' ] );	×
42
43	}	×
44
45	/**
46	* Handle the AJAX callback for converting ACF Location settings to GraphQL Types
47	*
48	* @return void
49	*/
50	public function ajax_callback() {
51
52	if ( isset( $_POST['data'] ) ) {	×
53
54	$form_data = [];	×
55
56	parse_str( $_POST['data'], $form_data );	×
57
58	if ( empty( $form_data ) \|\| ! isset( $form_data['acf_field_group'] ) ) {	×
59	wp_send_json( __( 'No form data.', 'wp-graphql-acf' ) );	×
60	}
61
62	$field_group = isset( $form_data['acf_field_group'] ) ? $form_data['acf_field_group'] : [];	×
63	$rules = new LocationRules( [ $field_group ] );	×
64	$rules->determine_location_rules();	×
65
66	$group_name = isset( $field_group['graphql_field_name'] ) ? $field_group['graphql_field_name'] : $field_group['title'];	×
67	$group_name = $rules->format_field_name( $group_name );	×
68
69	$all_rules = $rules->get_rules();	×
70	if ( isset( $all_rules[ $group_name ] ) ) {	×
71	wp_send_json( [ 'graphql_types' => $all_rules[ $group_name ] ] );	×
72	}
73	wp_send_json( [ 'graphql_types' => null ] );	×
74	}
75
76	echo __( 'No location rules were found', 'wp-graphql-acf' );	×
77	wp_die();	×
78	}	×
79
80	/**
81	* Register the GraphQL Settings metabox for the ACF Field Group post type
82	*
83	* @return void
84	*/
85	public function register_meta_boxes() {
86	add_meta_box( 'wpgraphql-acf-meta-box', __( 'GraphQL', 'wp-graphql-acf' ), [	×
87	$this,	×
88	'display_metabox'	×
89	], [ 'acf-field-group' ] );	×
90	}	×
91
92	/**
93	* Display the GraphQL Settings Metabox on the Field Group admin page
94	*
95	* @param $field_group_post_object
96	*/
97	public function display_metabox( $field_group_post_object ) {
98
99	global $field_group;	×
100
101	/**
102	* Render a field in the Field Group settings to allow for a Field Group to be shown in GraphQL.
103	*/
104	acf_render_field_wrap(	×
105	[
106	'label' => __( 'Show in GraphQL', 'acf' ),	×
107	'instructions' => __( 'If the field group is active, and this is set to show, the fields in this group will be available in the WPGraphQL Schema based on the respective Location rules.' ),	×
108	'type' => 'true_false',	×
109	'name' => 'show_in_graphql',	×
110	'prefix' => 'acf_field_group',	×
111	'value' => isset( $field_group['show_in_graphql'] ) ? (bool) $field_group['show_in_graphql'] : false,	×
112	'ui' => 1,	×
113	]
114	);
115
116	/**
117	* Render a field in the Field Group settings to set the GraphQL field name for the field group.
118	*/
119	acf_render_field_wrap(	×
120	[
121	'label' => __( 'GraphQL Field Name', 'acf' ),	×
122	'instructions' => __( 'The name of the field group in the GraphQL Schema. Names should not include spaces or special characters. Best practice is to use "camelCase".', 'wp-graphql-acf' ),	×
123	'type' => 'text',	×
124	'prefix' => 'acf_field_group',	×
125	'name' => 'graphql_field_name',	×
126	'required' => isset( $field_group['show_in_graphql'] ) ? (bool) $field_group['show_in_graphql'] : false,	×
127	'placeholder' => ! empty( $field_group['graphql_field_name'] ) ? $field_group['graphql_field_name'] : null,	×
128	'value' => ! empty( $field_group['graphql_field_name'] ) ? $field_group['graphql_field_name'] : null,	×
129	]
130	);
131
132	acf_render_field_wrap(	×
133	[
134	'label' => __( 'Manually Set GraphQL Types for Field Group', 'acf' ),	×
135	'instructions' => __( 'By default, ACF Field groups are added to the GraphQL Schema based on the field group\'s location rules. Checking this box will let you manually control the GraphQL Types the field group should be shown on in the GraphQL Schema using the checkboxes below, and the Location Rules will no longer effect the GraphQL Types.', 'wp-graphql-acf' ),	×
136	'type' => 'true_false',	×
137	'name' => 'map_graphql_types_from_location_rules',	×
138	'prefix' => 'acf_field_group',	×
139	'value' => isset( $field_group['map_graphql_types_from_location_rules'] ) ? (bool) $field_group['map_graphql_types_from_location_rules'] : false,	×
140	'ui' => 1,	×
141	]
142	);
143
144	$choices = Config::get_all_graphql_types();	×
145	acf_render_field_wrap(	×
146	[
147	'label' => __( 'GraphQL Types to Show the Field Group On', 'wp-graphql-acf' ),	×
148	'instructions' => __( 'Select the Types in the WPGraphQL Schema to show the fields in this field group on', 'wp-graphql-acf' ),	×
149	'type' => 'checkbox',	×
150	'prefix' => 'acf_field_group',	×
151	'name' => 'graphql_types',	×
152	'value' => ! empty( $field_group['graphql_types'] ) ? $field_group['graphql_types'] : [],	×
153	'toggle' => true,
154	'choices' => $choices,	×
155	]
156	);
157
158	?>
159	<div class="acf-hidden">	×
160	<input type="hidden" name="acf_field_group[key]"
161	value="<?php echo $field_group['key']; ?>"/>	×
162	</div>
163	<script type="text/javascript">
164	if (typeof acf !== 'undefined') {
165	acf.newPostbox({
166	'id': 'wpgraphql-acf-meta-box',
167	'label': 'left'
168	});
169	}
170	</script>
171	<?php
172
173	}	×
174
175	/**
176	* Add settings to each field to show in GraphQL
177	*
178	* @param array $field The field to add the setting to.
179	*/
180	public function add_field_settings( array $field ) {
181
182	$supported_fields = Config::get_supported_fields();	×
183
184	/**
185	* If there are no supported fields, or the field is not supported, don't add a setting field.
186	*/
187	if ( empty( $supported_fields ) \|\| ! is_array( $supported_fields ) \|\| ! in_array( $field['type'], $supported_fields, true ) ) {	×
188	return;	×
189	}
190
191	/**
192	* Render the "show_in_graphql" setting for the field.
193	*/
194	acf_render_field_setting(	×
195	$field,	×
196	[
197	'label' => __( 'Show in GraphQL', 'wp-graphql-acf' ),	×
198	'instructions' => __( 'Whether the field should be queryable via GraphQL', 'wp-graphql-acf' ),	×
199	'name' => 'show_in_graphql',	×
200	'type' => 'true_false',	×
201	'ui' => 1,	×
202	'default_value' => 1,	×
203	'value' => isset( $field['show_in_graphql'] ) ? (bool) $field['show_in_graphql'] : true,	×
204	],
205	true	×
206	);
207
208	}	×
209
210	/**
211	* This enqueues admin script.
212	*
213	* @param string $screen The screen that scripts are being enqueued to
214	*
215	* @return void
216	*/
217	public function enqueue_graphql_acf_scripts( string $screen ) {
218	global $post;	×
219
220	if ( $screen == 'post-new.php' \|\| $screen == 'post.php' ) {	×
221	if ( 'acf-field-group' === $post->post_type ) {	×
222	wp_enqueue_script( 'graphql-acf', plugins_url( 'src/js/main.js', dirname( __FILE__ ) ), array(	×
223	'jquery',	×
224	'acf-input',
225	'acf-field-group'
226	) );
227	}
228	}
229	}	×
230
231	}

wp-graphql / wp-graphql-acf / 2fe8155127d44b76826b64de283421636bd98817-PR-250

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