code annotations, formatting, better testing, some fixes

Author: mcguffin

include/ACFCustomizer/Compat/ACF/ACF.php

@@ -17,23 +17,26 @@ class ACF extends Core\Singleton implements Core\ComponentInterface {
 	 */
 	protected function __construct() {
 
-		// need to figure out which version ist lowest...
-
-
 		global $wp_customize;
 
 		$core = Core\Core::instance();
 
-		if ( ! is_null( $wp_customize ) ) {
-			// instantinate at 11
-//			add_action( 'plugins_loaded', array('ACFCustomizer\Compat\ACF\Customize','instance'), 11 );
-
-		}
-
 		require_once $core->get_plugin_dir() . '/include/api/acf-functions.php';
 
 		add_action( 'acf/include_location_rules', array( $this, 'load_location_rule' ) );
+		add_filter( 'acf/decode_post_id', [ $this, 'decode_post_id' ], 10, 2 );
+
+	}
 
+	/**
+	 *	@filter acf/decode_post_id
+	 */
+	public function decode_post_id( $decoded_post_id, $post_id ) {
+		if ( 'option' === $decoded_post_id['type'] && ( $storage_type = Customize::instance()->get_storage_type_by_post_id( $post_id ) ) ) {
+			// storage type by post id
+			$decoded_post_id['type'] = $storage_type;
+		}
+		return $decoded_post_id;
 	}
 
 	/**
@@ -51,6 +54,7 @@ public function ensure_field_key( $field, $post_id ) {
 		$local_fields = acf_get_local_store( 'fields' )->query(array(
 			'name' => $field['name']
 		));
+
 		$candidates = array_keys( $local_fields );
 		$candidates = array_merge( $candidates, $wpdb->get_col( $wpdb->prepare(
 			"SELECT post_name FROM $wpdb->posts WHERE post_excerpt = %s",
@@ -78,14 +82,15 @@ public function ensure_field_key( $field, $post_id ) {
 
 	/**
 	 *	returns whether an ACF field is handling data for specified post_id
+	 *
 	 *	@param array $acf_field
 	 *	@param int|string $post_id
 	 *	@return boolean
 	 */
 	public function acf_field_is_handling_post_id( $acf_field, $post_id ) {
 
 		$decoded_post_id = acf_decode_post_id( $post_id );
-		if ( ! in_array( $decoded_post_id['type'], [ 'post', 'term', 'option' ] ) ) {
+		if ( ! in_array( $decoded_post_id['type'], [ 'post', 'term', 'option', 'theme_mod' ] ) ) {
 			return false;
 		}
 

include/ACFCustomizer/Compat/ACF/Customize.php

@@ -101,6 +101,21 @@ public function get_section_id_by_fieldgroup_post_id( $field_group_key, $post_id
 		return false;
 	}
 
+	/**
+	 *	Used by customize preview shortcuts
+	 *
+	 *	@param string $post_id
+	 *	@return boolean|string false on failure storage type otherwise
+	 */
+	public function get_storage_type_by_post_id( $post_id ) {
+		foreach ( $this->sections as $section_id => $section ) {
+			if ( $post_id === $section[ 'post_id' ] ) {
+				return $section['storage_type'];
+			}
+		}
+		return false;
+	}
+
 	/**
 	 *	@action customize_controls_enqueue_scripts
 	 */

include/ACFCustomizer/Compat/ACF/CustomizePreview.php

@@ -38,40 +38,64 @@ protected function __construct() {
 	 *	@action acf_customizer_field
 	 */
 	public function partial_field( $selector, $post_id = null ) {
+		echo $this->get_partial_field( $selector, $post_id ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+	}
+
+	/**
+	 *	@action acf_customizer_row
+	 */
+	public function partial_row( ) {
+		echo $this->partial_row(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+	}
+
+	/**
+	 *	@action acf_customizer_sub_field
+	 */
+	public function partial_subfield( $selector ) {
+		echo $this->get_partial_subfield( $selector ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+	}
+
+	/**
+	 *	@action acf_customizer_field
+	 */
+	public function get_partial_field( $selector, $post_id = null ) {
 		if ( $path = $this->build_path( $selector, $post_id ) ) {
-			echo $this->get_partial_button( $path ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+			return $this->get_partial_button( $path );
 		}
+		return '';
 	}
 
 	/**
 	 *	@action acf_customizer_row
 	 */
-	public function partial_row( ) {
+	public function get_partial_row() {
 		if ( $path = $this->build_path( ) ) {
-			echo $this->get_partial_button( $path ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+			return $this->get_partial_button( $path );
 		}
+		return '';
 	}
 
 
 	/**
 	 *	@action acf_customizer_sub_field
 	 */
-	public function partial_subfield( $selector ) {
+	public function get_partial_subfield( $selector ) {
 		if ( $path = $this->build_path( $selector ) ) {
-			echo $this->get_partial_button( $path ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+			return $this->get_partial_button( $path );
 		}
+		return '';
 	}
 
 	/**
 	 *	Build path from
 	 *
 	 *	@param string $selector If null will build path based on ACF loop hierarchy. If not get path from field hierarchy.
 	 *	@param string|int $post_id If null will guess current post id.
-	 *	@return array
+	 *	@return array Array of field keys
 	 */
 	private function build_path( $selector = null, $post_id = null ) {
 
-		$path = array();
+		$path = [];
 		$section_id = false;
 		$post_id_info = false;
 
@@ -80,21 +104,18 @@ private function build_path( $selector = null, $post_id = null ) {
 
 		$customize = Customize::instance();
 		$acf = ACF::instance();
-
+var_export($is_loop);
 		if ( is_null( $post_id ) ) {
 			if ( $is_loop ) {
 				$post_id = acf_get_loop( 'active', 'post_id' );
 			} else {
 				$post_id = acf_get_valid_post_id();
 			}
-
 		}
 
 		$post_id_info = acf_get_post_id_info( $post_id );
 
-
 		if ( ! is_null( $selector ) ) {
-
 			if ( $is_loop ) {
 				$field = get_sub_field_object( $selector, $post_id );
 			} else {
@@ -104,7 +125,9 @@ private function build_path( $selector = null, $post_id = null ) {
 				$path[] = $field['key'];
 			} else {
 				$field = get_field_object( $acf->ensure_field_key( [ 'name' => $selector ], $post_id ), $post_id );
-				$path[] = $field['key'];
+				if ( is_array( $field ) ) {
+					$path[] = $field['key'];
+				}
 			}
 		}
 
@@ -121,11 +144,7 @@ private function build_path( $selector = null, $post_id = null ) {
 		// } else {
 		// 	$field = acf_get_field( $acf->ensure_field_key( [ 'name' => $selector ], $post_id ), $post_id );
 		}
-if ( ! $field ) {
-	var_dump($loops);
-	var_dump($path);
-	var_dump($acf->ensure_field_key( [ 'name' => $selector ], $post_id ));
-}
+
 		$field_group_key = $field['parent'];
 
 		$path[] = $field_group_key; // field group

include/ACFCustomizer/Compat/ACF/Storage/Storage.php

@@ -49,10 +49,11 @@ protected function __construct() {
 	/**
 	 *	register a post id
 	 *
+	 *	@param string setting_id
 	 *	@param string $post_id
 	 */
-	public function register_setting_id( $setting_id ) {
-		$this->setting_ids[ $setting_id ] = true;
+	public function register_setting_id( $setting_id, $post_id = true ) {
+		$this->setting_ids[ $setting_id ] = $post_id;
 	}
 
 
@@ -64,7 +65,7 @@ public function register_setting_id( $setting_id ) {
 	 */
 	public function has_setting_id( $setting_id ) {
 
-		return isset( $this->setting_ids[ $setting_id ] ) && $this->setting_ids[ $setting_id ];
+		return isset( $this->setting_ids[ $setting_id ] ) && false !== $this->setting_ids[ $setting_id ];
 
 	}
 

include/ACFCustomizer/Core/Core.php

@@ -15,24 +15,28 @@
 
 class Core extends Plugin implements CoreInterface {
 
-
+	/** @var Asset\Asset */
 	public $control_css = null;
 
+	/** @var Asset\Asset */
 	public $control_js = null;
 
+	/** @var Asset\Asset */
 	public $preview_css = null;
 
+	/** @var Asset\Asset */
 	public $preview_js = null;
 
-	private $is_loaded = false; 
+	/** @var boolean */
+	private $is_loaded = false;
 
 	/**
 	 *	@inheritdoc
 	 */
 	protected function __construct() {
-		add_action( 'plugins_loaded' , array( $this , 'init_compat' ), 0 ); // must run before hook acf/include_location_rules (acf as regular plugin)
-		add_action( 'init' , array( $this , 'init_compat' ), 0 ); // must run before hook acf/include_location_rules (acf bundled in theme)
-		add_action( 'init' , array( $this , 'init_assets' ) );
+		add_action( 'plugins_loaded', [ $this , 'init_compat' ], 0 ); // must run before hook acf/include_location_rules (acf as regular plugin)
+		add_action( 'init', [ $this , 'init_compat' ], 0 ); // must run before hook acf/include_location_rules (acf bundled in theme)
+		add_action( 'init', [ $this , 'init_assets' ] );
 
 		$args = func_get_args();
 		parent::__construct( ...$args );

index.php

@@ -7,13 +7,13 @@
 Description: Use ACF Fields in customizer.
 Author: Jörn Lund
 Version: 0.3.1
-Tested up to: 5.5
-Requires PHP: 5.6
+Tested up to: 6.2
+Requires PHP: 7.4
 Author URI: https://github.com/mcguffin
 License: GPL3
 Text Domain: acf-customizer
 Domain Path: /languages/
-Update URI: https://github.com/mcguffin/acf-customizer/raw/main/.wp-release-info.json
+Update URI: https://github.com/mcguffin/acf-customizer/raw/master/.wp-release-info.json
 */
 
 /*  Copyright 2018  Jörn Lund

test/test.php

@@ -7,6 +7,7 @@
 class PluginTest {
 
 	private $current_json_save_path = null;
+	private $customizePreview = null;
 
 	public function __construct() {
 		add_filter( 'acf/settings/load_json', [ $this, 'load_json' ] );
@@ -34,6 +35,8 @@ public function __construct() {
 	}
 
 	public function the_content( $content ) {
+		$this->customizePreview = Compat\ACF\CustomizePreview::instance();
+
 		$content = '';
 
 		$show = [
@@ -72,31 +75,58 @@ public function the_content( $content ) {
 			$content .= "\n";
 		}
 
-		get_template_part('template-parts/acf/repeat-basic');
+		// get_template_part('template-parts/acf/repeat-basic');
 
 		return $content;
 	}
 
-	private function render_field_groups( $field_groups, $post_id = null ) {
-		$customizePreview = Compat\ACF\CustomizePreview::instance();
+	private function render_field_groups( $field_groups, $post_id = null, $get_field_cb = 'get_field' ) {
 		$content = '';
 		foreach ( $field_groups as $group ) {
 			$fields = acf_get_fields( $group );
 
 			$content .= "# Group: ".$group['title']."\n";
 			foreach ( $fields as $field ) {
-				$content .= $customizePreview->get_partial_field( $field['name'], $post_id );
-				$content .= '<pre>';
-				$content .= "Label: ".$field['label']."\n";
-				$content .= "Name: ".$field['name']."\n";
-				$content .= "Value: ".var_export(get_field($field['name'],$post_id),true)."\n"."\n";
-				$content .= '</pre>';
+				if ( in_array( $field['type'], ['flexible_content', 'repeater'] ) ) {
+					$content .= '<pre>';
+					$content .= "Label: ".$field['label']."\n";
+					$content .= "Name: ".$field['name']."\n";
+					$content .= '</pre>';
+					while ( have_rows( $field['name'] ) ) {
+						the_row();
+						$content .= $this->customizePreview->get_partial_row();
+
+						$sub_fields = acf_get_fields( $field );
+						foreach ( $sub_fields as $sub_field ) {
+							$content .= $this->render_field( $sub_field, $post_id, 'get_sub_field' );
+						}
+					}
+				} else {
+					$content .= $this->render_field( $field, $post_id );
+				}
 			}
 			$content .= "\n";
 		}
 		return $content;
 	}
 
+	private function render_field( $field, $post_id, $get_field_cb = 'get_field' ) {
+		$content = '';
+		if ( $get_field_cb === 'get_field' ) {
+			$content .= $this->customizePreview->get_partial_field( $field['name'], $post_id );
+		} else {
+			// $content .= $this->customizePreview->get_partial_subfield( $field['name'] );
+		}
+		$content .= '<pre>';
+		$content .= "Label: ".$field['label']."\n";
+		$content .= "Name: ".$field['name']."\n";
+		$content .= "Value: ".var_export($get_field_cb($field['name'],$post_id),true)."\n"."\n";
+		$content .= '</pre>';
+
+		return $content;
+
+	}
+
 	// public function template_include( $template ) {
 	// 	$file = str_replace( get_stylesheet_directory(), '', $template);
 	// 	$test_template = dirname(__FILE__) . '/templates' . $file;