- Move GraphQL Field Group Settings into their own box in the ACF Fie…

…ld Group page

- Add Ajax callback for determining rules
- Update Location Rules to check for rule conflicts, and support many edge cases, such as assigning a Field Group to a post_status
- Update JS helpers for the GraphQL Field Group settings. Add conditional logic to the field that allows users to manually chose GraphQL fields or map based on location rules
- Reset location rules when manual graphql type mapping is unchecked.

src/class-acfsettings.php

@@ -19,12 +19,6 @@ class ACF_Settings {
 	 */
 	public function init() {
 
-		/**
-		 * Creates a field group setting to allow a field group to be
-		 * shown in the GraphQL Schema.
-		 */
-		// add_action( 'acf/render_field_group_settings', [ $this, 'add_field_group_settings' ], 10, 1 );
-
 		/**
 		 * Add settings to individual fields to allow each field granular control
 		 * over how it's shown in the GraphQL Schema
@@ -42,15 +36,20 @@ public function init() {
 		add_action( 'add_meta_boxes', [ $this, 'register_meta_boxes' ] );
 
 		/**
-		 * Register an AJAX callback
+		 * 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' ] ) ) {
+		if ( isset( $_POST['data'] ) ) {
 
 			$form_data = [];
 
@@ -61,19 +60,40 @@ public function ajax_callback() {
 			}
 
 			$field_group = isset( $form_data['acf_field_group'] ) ? $form_data['acf_field_group'] : [];
-			$rules = new LocationRules( [ $field_group ] );
+			$rules       = new LocationRules( [ $field_group ] );
 			$rules->determine_location_rules();
-			wp_send_json( $rules->get_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' ] );
+		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;
@@ -111,12 +131,12 @@ public function display_metabox( $field_group_post_object ) {
 
 		acf_render_field_wrap(
 			[
-				'label'        => __( 'Use ACF Location Rules to map to the GraphQL Schema', 'acf' ),
-				'instructions' => __( 'By default, the ACF Field group will be added to the GraphQL Schema based on the field group\'s location rules. Turning this off will allow you to manually select which GraphQL Types the Field Group should show on in the GraphQL Schema.', 'wp-graphql-acf' ),
+				'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'         => 'manual_type_selection',
+				'name'         => 'map_graphql_types_from_location_rules',
 				'prefix'       => 'acf_field_group',
-				'value'        => isset( $field_group['manual_type_selection'] ) ? (bool) $field_group['manual_type_selection'] : true,
+				'value'        => isset( $field_group['map_graphql_types_from_location_rules'] ) ? (bool) $field_group['map_graphql_types_from_location_rules'] : false,
 				'ui'           => 1,
 			]
 		);
@@ -129,18 +149,19 @@ public function display_metabox( $field_group_post_object ) {
 				'type'         => 'checkbox',
 				'prefix'       => 'acf_field_group',
 				'name'         => 'graphql_types',
-				'value'        => ! empty( $field_group['graphql_types'] ) ? $field_group['graphql_types'] : null,
+				'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']; ?>" />
+			<input type="hidden" name="acf_field_group[key]"
+				   value="<?php echo $field_group['key']; ?>"/>
 		</div>
 		<script type="text/javascript">
-			if( typeof acf !== 'undefined' ) {
+			if (typeof acf !== 'undefined') {
 				acf.newPostbox({
 					'id': 'wpgraphql-acf-meta-box',
 					'label': 'left'
@@ -187,70 +208,22 @@ public function add_field_settings( array $field ) {
 	}
 
 	/**
-	 * This adds a setting to the ACF Field groups to activate a field group in GraphQL.
+	 * This enqueues admin script.
 	 *
-	 * If a field group is set to active and is set to "show_in_graphql", the fields in the field
-	 * group will be exposed to the GraphQL Schema based on the matching location rules.
+	 * @param string $screen The screen that scripts are being enqueued to
 	 *
-	 * @param array $field_group The field group to add settings to.
-	 */
-	public function add_field_group_settings( array $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 allow for a Field Group to be shown in GraphQL.
-		 */
-		acf_render_field_wrap(
-			[
-				'label'        => __( 'GraphQL Field Name', 'acf' ),
-				'instructions' => __( 'The name of the field group in the GraphQL Schema.', '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,
-			]
-		);
-
-		$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'] : null,
-				'toggle'       => true,
-				'choices'      => $choices,
-			]
-		);
-	}
-
-	/**
-	 * This enqueues admin script.
+	 * @return void
 	 */
-	public function enqueue_graphql_acf_scripts( $hook ) {
+	public function enqueue_graphql_acf_scripts( string $screen ) {
 		global $post;
 
-		if ( $hook == 'post-new.php' || $hook == 'post.php' ) {
+		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' ) );
+				wp_enqueue_script( 'graphql-acf', plugins_url( 'src/js/main.js', dirname( __FILE__ ) ), array(
+					'jquery',
+					'acf-input',
+					'acf-field-group'
+				) );
 			}
 		}
 	}