class-acf-field-svg-icon-picker.php

<?php

/**
 * Field class for the SVG Icon Picker field.
 *
 * @package Advanced Custom Fields: SVG Icon Picker
 */

namespace SmithfieldStudio\AcfSvgIconPicker;

if (! defined('ABSPATH')) {
	exit;
}

/**
 * Field class for the SVG Icon Picker field.
 */
class ACF_Field_Svg_Icon_Picker extends \acf_field
{
	/**
	 * Controls field type visibility in REST requests.
	 *
	 * @var bool
	 */
	public $show_in_rest = true;

	/**
	 * Stores the path suffix to the icons.
	 *
	 * @var strin $path_suffix The path suffix to the icons.
	 */
	private string $path_suffix;

	/**
	 * Stores the path to the icons.
	 *
	 * @var string $path The path to the icons.
	 */
	private string $path;

	/**
	 * Stores the url to the icons.
	 *
	 * @var string $url The url to the icons.
	 */
	private string $url;

	/**
	 * Stores the icons.
	 *
	 * @var array $svgs The icons, stored as an array.
	 */
	public array $svgs = [];

	/**
	 * Constructor.
	 *
	 * We set the field name, label, category, defaults and l10n.
	 */
	public function __construct()
	{
		$this->name        = 'svg_icon_picker';
		$this->label       = __('SVG Icon Picker', 'acf-svg-icon-picker');
		$this->category    = 'content';
		$this->defaults    = [
			'initial_value' => '',
			'return_format' => 'value',
		];
		$this->l10n        = ['error' => __('Error!', 'acf-svg-icon-picker')];
		$this->url         = get_stylesheet_directory_uri();
		$this->path_suffix = apply_filters('acf_svg_icon_picker_folder', 'icons/');
		$this->path_suffix = apply_filters_deprecated('acf_icon_path_suffix', [$this->path_suffix], '4.0.0', 'acf_svg_icon_picker_folder');

		apply_filters_deprecated('acf_icon_path', [''], '4.0.0', '', 'acf_icon_path filter is no longer in use, please check the docs of ACF SVG Icon Picker Field') . $this->path_suffix;
		apply_filters_deprecated('acf_icon_url', [''], '4.0.0', '', 'acf_icon_url filter is no longer in use, please check the docs of ACF SVG Icon Picker Field') . $this->path_suffix;

		/**
		 * Check if the custom icon location is set by filter and if not, check the theme directories for icons.
		 */
		$svgs       = $this->check_priority_dir();
		$this->svgs = empty($svgs) ? $this->check_theme_dirs() : $svgs;

		parent::__construct();
	}

	/**
	 * Method that checks if the custom icon location is set by filter.
	 * If it is, it sets the path and url to the custom location and collects the icons in that specific location.
	 *
	 * @throws \Exception If the path or url for the custom icon location are not set.
	 * @return array
	 */
	private function check_priority_dir(): array
	{
		$priority_dir_settings = apply_filters('acf_svg_icon_picker_custom_location', false);

		if (false === $priority_dir_settings) {
			return [];
		}

		if (! is_array($priority_dir_settings) || ! isset($priority_dir_settings['path']) || ! isset($priority_dir_settings['url'])) {
			_doing_it_wrong(__FUNCTION__, esc_attr__('The acf_svg_icon_picker_custom_location filter should contain an array with a path and url.', 'acf-svg-icon-picker'), '4.0.0');
			return [];
		}

		$this->path = $priority_dir_settings['path'];
		$this->url  = $priority_dir_settings['url'];

		return $this->svg_collector($this->path, $this->url);
	}

	/**
	 * Method that checks the theme directories for icons.
	 *
	 * @return array
	 */
	private function check_theme_dirs(): array
	{

		$parent_theme_path = get_template_directory() . '/' . $this->path_suffix;
		$child_theme_path  = get_stylesheet_directory() . '/' . $this->path_suffix;
		$parent_theme_url  = get_template_directory_uri() . '/' . $this->path_suffix;
		$child_theme_url   = get_stylesheet_directory_uri() . '/' . $this->path_suffix;

		$svgs = $this->svg_collector($parent_theme_path, $parent_theme_url);

		if ($parent_theme_path !== $child_theme_path) {
			$child_svgs = $this->svg_collector($child_theme_path, $child_theme_url);
			$svgs       = array_merge($svgs, $child_svgs);
			$svgs       = array_unique($svgs, SORT_REGULAR);
		}

		return $svgs;
	}

	/**
	 * Method that renders the field in the admin.
	 *
	 * @param array $field the field array
	 */
	public function render_field($field): void
	{
		$saved_value = '' !== $field['value'] ? $field['value'] : $field['initial_value'];
		$icon        = ! empty($saved_value) ? $this->get_icon_data($saved_value) : null;

		$this->render_view(
			'acf-field',
			[
				'field'       => $field,
				'saved_value' => $saved_value,
				'icon'        => $icon,
			]
		);
	}

	/**
	 * Render_field_settings()
	 *
	 * @param array<string, mixed> $field An array holding all the field's data.
	 */
	public function render_field_settings($field): void
	{
		acf_render_field_setting(
			$field,
			[
				'label'        => __('Return Format', 'acf-svg-icon-picker'),
				'instructions' => '',
				'type'         => 'radio',
				'name'         => 'return_format',
				'layout'       => 'horizontal',
				'choices'      => [
					'value'   => __('Value', 'acf-svg-icon-picker'),
					'icon'    => __('Icon', 'acf-svg-icon-picker'),
				],
			]
		);
	}

	/**
	 * This filter is applied to the $value after it is loaded from the db and before it is returned to the template.
	 *
	 * @param mixed                $value          current value.
	 * @param mixed                $post_id        The post id.
	 * @param array<string, mixed> $field          The field array.
	 * @return mixed                    $value we return.
	 */
	public function format_value(mixed $value, mixed $post_id, $field)
	{
		if ('icon' === $field['return_format'] && ! empty($value)) {
			return get_svg_icon($value);
		}

		return $value;
	}

	/**
	 * Enqueue assets for the field.
	 */
	public function input_admin_enqueue_scripts(): void
	{
		// @phpstan-ignore constant.notFound
		$url = ACF_SVG_ICON_PICKER_URL;
		wp_register_script('acf-input-svg-icon-picker', "{$url}resources/scripts/input.js", ['acf-input'], ACF_SVG_ICON_PICKER_VERSION, true);
		wp_enqueue_script('acf-input-svg-icon-picker');

		wp_localize_script(
			'acf-input-svg-icon-picker',
			'acfSvgIconPicker',
			[
				'svgs'    => $this->svgs,
				'columns' => 4,
				'msgs'    => [
					'title'    => esc_html__('Select an icon', 'acf-svg-icon-picker'),
					'close'    => esc_html__('close', 'acf-svg-icon-picker'),
					'filter'   => esc_html__('Start typing to filter icons', 'acf-svg-icon-picker'),
					// translators: %s: path_suffix
					'no_icons' => sprintf(__('To add icons, add your svg files in the <code>/%s</code> folder in your theme.', 'acf-svg-icon-picker'), esc_attr($this->path_suffix)),
				],
			]
		);

		wp_register_style('acf-input-svg-icon-picker', "{$url}resources/styles/input.css", ['acf-input'], ACF_SVG_ICON_PICKER_VERSION);
		wp_enqueue_style('acf-input-svg-icon-picker');
	}

	/**
	 * Collects the icons from the specified path.
	 *
	 * @param string $path The path to the icons to scan for SVG files.
	 * @param string $url The url to the icons.
	 */
	private function svg_collector(string $path, string $url): array
	{
		$svg_files = [];
		if (! is_dir($path)) {
			return [];
		}

		$found_files = array_filter(
			scandir($path),
			function ($file) {
				return 'svg' === pathinfo($file, PATHINFO_EXTENSION);
			}
		);

		if (empty($found_files)) {
			return [];
		}

		foreach ($found_files as $key => $file) {
			$name       = explode('.', $file)[0];
			$legacy_key = str_replace(['-', '_'], ' ', $name);
			$title      = ucwords($legacy_key);
			$key        = sanitize_key($name);

			$svg_files[$key] = [
				'key'        => $key,
				'legacy_key' => $legacy_key,
				'title'      => $title,
				'url'        => esc_url("{$url}{$file}"),
				'path'       => "{$path}/{$file}",
			];
		}

		return $svg_files;
	}

	/**
	 * Get the icon data.
	 *
	 * @param string $key The icon key.
	 */
	public function get_icon_data(string $key): array
	{
		$icon = ! empty($this->svgs[$key]) ? $this->svgs[$key] : [];

		// if no icon found in array keys, check legacy_key field
		if (empty($icon)) {
			$icon = array_filter(
				$this->svgs,
				function ($svg) use ($key) {
					return $svg['legacy_key'] === $key;
				}
			);

			if (empty($icon)) {
				return [];
			}

			$icon = reset($icon);
		}

		return $icon;
	}

	/**
	 * Render a php/html view.
	 *
	 * @param string $view The view to render.
	 * @param array  $data The data to pass to the view.
	 */
	private function render_view(string $view, array $data)
	{
		// @phpstan-ignore constant.notFound
		$plugin_path = ACF_SVG_ICON_PICKER_PATH;
		$path        = "{$plugin_path}resources/views/{$view}.php";

		if (! file_exists($path)) {
			return;
		}

		extract($data);
		include $path;
	}
}