File "class-facets.php"

Full path: /home/dora/public_html/wp-content/plugins/wp-grid-builder/frontend/class-facets.php
File size: 4.42 KB
MIME-type: --
Charset: utf-8

<?php
/**
 * Facets
 *
 * @package   WP Grid Builder
 * @author    Loïc Blascos
 * @copyright 2019-2022 Loïc Blascos
 */

namespace WP_Grid_Builder\FrontEnd;

use WP_Grid_Builder\FrontEnd\Facets;
use WP_Grid_Builder\Includes\Helpers;

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

/**
 * Add facets in layout
 *
 * @class WP_Grid_Builder\FrontEnd\Facets
 * @since 1.0.0
 */
final class Facets extends Objects implements Models\Facets_Interface {

	/**
	 * Holds grid settings
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @var object
	 */
	public $settings = [];

	/**
	 * Holds selected facets
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @var array
	 */
	public $selections = [];

	/**
	 * Constructor
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @param object $settings Hold Settings.
	 */
	public function __construct( $settings ) {

		$this->settings = $settings;

	}

	/**
	 * Query and refresh facets
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @param boolean $render Whether to render facet content.
	 * @return array Holds all facets data.
	 */
	public function refresh( $render = true ) {

		return array_map(
			function( $facet ) use ( $render ) {

				$choices = $this->query_facet( $facet );
				$content = $render ? $this->render_facet( $facet, $choices ) : '';

				$this->cache_facet( $facet, $content );
				$this->set_selection( $facet, $choices );

				return apply_filters(
					'wp_grid_builder/facet/response',
					[
						'html'     => $content,
						'name'     => $facet['name'],
						'slug'     => $facet['slug'],
						'type'     => $facet['type'],
						'settings' => $facet['settings'],
						'selected' => $facet['selected'],
					],
					$facet,
					$choices
				);

			},
			wpgb_get_facet_instances( $this->settings['facets'] )
		);

	}

	/**
	 * Search for facet values/names (async method)
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @return array Holds facet value/name.
	 */
	public function search() {

		if (
			empty( $this->settings['search']['facet'] ) ||
			empty( $this->settings['search']['string'] )
		) {
			return [];
		}

		$facet  = $this->settings['search']['facet'];
		$search = $this->settings['search']['string'];
		$facets = wpgb_get_facet_instances( $facet );

		if ( empty( $facets[ $facet ] ) ) {
			return [];
		}

		$choices = ( new Facets\Async() )->query_facet( $facets[ $facet ], $search );

		return apply_filters( 'wp_grid_builder/facet/choices', $choices, $facet );

	}

	/**
	 * Query facet choices
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @param array $facet Hold Facet settings.
	 * @return array
	 */
	public function query_facet( $facet ) {

		if ( ! method_exists( $facet['instance'], 'query_facet' ) ) {
			return [];
		}

		$choices = $facet['instance']->query_facet( $facet );
		$choices = apply_filters( 'wp_grid_builder/facet/choices', $choices, $facet );

		return $choices;

	}

	/**
	 * Render facet content
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @param array $facet   Hold Facet settings.
	 * @param array $choices Hold Facet choices.
	 * @return string
	 */
	public function render_facet( $facet, $choices ) {

		if ( ! method_exists( $facet['instance'], 'render_facet' ) ) {
			return '';
		}

		$content = $facet['instance']->render_facet( $facet, $choices );
		$content = apply_filters( 'wp_grid_builder/facet/html', $content, $facet['id'] );

		ob_start();
		Helpers::get_template( 'layout/facet', [ 'html' => $content ] + $facet );
		return ob_get_clean();

	}

	/**
	 * Set selection from selected facets
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @param array $facet   Hold Facet settings.
	 * @param array $choices Hold Facet choices.
	 */
	public function set_selection( $facet, $choices ) {

		// Only push selection from filter facets.
		if (
			empty( $facet['selected'] ) ||
			empty( $facet['action'] ) ||
			'filter' !== $facet['action']
		) {
			return;
		}

		$this->selections[ $facet['slug'] ] = [ 'choices' => $choices ] + $facet;

	}

	/**
	 * Cache facet output
	 *
	 * @since 1.0.0
	 * @access public
	 *
	 * @param array  $facet   Hold Facet settings.
	 * @param string $content Facet content.
	 */
	public function cache_facet( $facet, $content ) {

		// Only cache unfiltered facets.
		if ( wpgb_has_selected_facets() ) {
			return;
		}

		$transient = WPGB_SLUG . '_G' . $this->settings['id'] . 'F' . $facet['id'] . $this->settings['lang'];

		set_transient( apply_filters( 'wp_grid_builder/facet/transient_name', $transient ), $content );

	}
}