class-expandable-list.php

<?php
/**
 * Expandable List module class
 *
 * @package Hogan
 */

declare( strict_types = 1 );
namespace Dekode\Hogan;

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

if ( ! class_exists( '\\Dekode\\Hogan\\Expandable_List' ) && class_exists( '\\Dekode\\Hogan\\Module' ) ) {

	/**
	 * Expandable List module class.
	 *
	 * @extends Modules base class.
	 */
	class Expandable_List extends Module {

		/**
		 * List of expandable items.
		 *
		 * @var array $items
		 */
		public $list_items;

		/**
		 * Module index in flexible layout
		 *
		 * @var int $counter
		 */
		public $counter;

		/**
		 * Module constructor.
		 */
		public function __construct() {

			$this->label    = __( 'Expandable List', 'hogan-expandable-list' );
			$this->template = __DIR__ . '/assets/template.php';

			parent::__construct();
		}

		/**
		 * Field definitions for module.
		 *
		 * @return array $fields Fields for this module
		 */
		public function get_fields() : array {

			$fields = [
				[
					'type'         => 'repeater',
					'key'          => $this->field_key . '_list_items',
					'label'        => __( 'List Items', 'hogan-expandable-list' ),
					'name'         => 'list_items',
					'instructions' => __( 'Create a list of expandable items', 'hogan-expandable-list' ),
					'min'          => 1,
					'max'          => 0,
					'layout'       => 'block',
					'button_label' => __( 'Add item', 'hogan-expandable-list' ),
					'sub_fields'   => [
						[
							'type'          => 'image',
							'key'           => $this->field_key . '_item_thumbnail_id',
							'name'          => 'item_thumbnail_id',
							'label'         => __( 'Thumbnail', 'hogan-expandable-list' ),
							'instructions'  => __( 'Add thumbnail next to list item title', 'hogan-expandable-list' ),
							'required'      => false,
							'return_format' => 'id',
							'preview_size'  => 'thumbnail',
							'library'       => 'all',
							'wrapper'       => [
								'width' => '30',
							],
						],
						[
							'type'         => 'text',
							'key'          => $this->field_key . '_item_title',
							'label'        => __( 'Title', 'hogan-expandable-list' ),
							'name'         => 'item_title',
							'required'     => true,
							'instructions' => __( 'Add list item title', 'hogan-expandable-list' ),
							'wrapper'      => [
								'width' => '70',
							],
						],
						[
							'key'          => $this->field_key . '_item_accordion',
							'label'        => '',
							'type'         => 'accordion',
							'instructions' => __( 'Click to open/close item', 'hogan-expandable-list' ),
							'open'         => 1,
							'multi_expand' => 0,
							'endpoint'     => 0,
						],
						[
							'type'         => 'wysiwyg',
							'key'          => $this->field_key . '_item_content',
							'name'         => 'item_content',
							'label'        => __( 'Expandable content', 'hogan-expandable-list' ),
							'instructions' => __( 'Add list item expandable content', 'hogan-expandable-list' ),
							'delay'        => false,
							'required'     => true,
							'tabs'         => apply_filters( 'hogan/module/expandable_list/content/tabs', 'all' ),
							'media_upload' => apply_filters( 'hogan/module/expandable_list/content/media', 0 ),
							'toolbar'      => apply_filters( 'hogan/module/expandable_list/content/toolbar', 'hogan_caption' ),
						],
						[
							'type'         => 'text',
							'key'          => $this->field_key . '_item_id',
							'label'        => __( 'Optional item name', 'hogan-expandable-list' ),
							'name'         => 'item_id',
							'instructions' => __( 'Set a fixed item name so you can link directly to a open item.', 'hogan-expandable-list' ),
						],
					],
				],
			];

			return $fields;
		}

		/**
		 * Enqueue module assets
		 */
		public function enqueue_assets() {

			$_version = defined( 'SCRIPT_DEBUG' ) && true === SCRIPT_DEBUG ? time() : HOGAN_EXPANDABLE_LIST_VERSION;
			if ( true === apply_filters( 'hogan/module/expandable_list/load_styles', true ) ) {
				wp_enqueue_style( 'hogan-expandable-list-styles', plugins_url( '/assets/styles.css', __FILE__ ), [], $_version );
			}

			if ( true === apply_filters( 'hogan/module/expandable_list/load_scripts', true ) ) {
				wp_enqueue_script( 'hogan-expandable-list-scripts', plugins_url( '/assets/scripts.js', __FILE__ ), [], $_version, true );
			}
		}

		/**
		 * Map raw fields from acf to object variable.
		 *
		 * @param array $raw_content Content values.
		 * @param int   $counter Module location in page layout.
		 * @return void
		 */
		public function load_args_from_layout_content( array $raw_content, int $counter = 0 ) {

			$this->list_items = $raw_content['list_items'];
			$this->counter    = $counter;

			parent::load_args_from_layout_content( $raw_content, $counter );
		}

		/**
		 * Validate module content before template is loaded.
		 *
		 * @return bool Whether validation of the module is successful / filled with content.
		 */
		public function validate_args() : bool {
			return ! empty( $this->list_items );
		}
	}
}