class-gv-template-view.php

Go to the documentation of this file.

<?php
namespace GV;

/** If this file is called directly, abort. */
if ( ! defined( 'GRAVITYVIEW_DIR' ) ) {
    die();
}

/**
 * Load up the Gamajo Template Loader.
 *
 * @see https://github.com/GaryJones/Gamajo-Template-Loader
 */
if ( ! class_exists( '\GV\Gamajo_Template_Loader' ) ) {
    require gravityview()->plugin->dir( 'future/lib/class-gamajo-template-loader.php' );
}

/**
 * The View Template class .
 *
 * Renders a \GV\View and a \GV\Entry_Collection via a \GV\View_Renderer.
 */
abstract class View_Template extends Template {
    /**
     * Prefix for filter names.
     * @var string
     */
    protected $filter_prefix = 'gravityview/template/views';

    /**
     * Directory name where custom templates for this plugin should be found in the theme.
     * @var string
     */
    protected $theme_template_directory = 'gravityview/views/';

    /**
     * Directory name where the default templates for this plugin are found.
     * @var string
     */
    protected $plugin_template_directory = 'templates/views/';

    /**
     * @var \GV\View The view connected to this template.
     */
    public $view;

    /**
     * @var \GV\Entry_Collection The entries that need to be rendered.
     */
    public $entries;

    /**
     * @var \GV\Request The request context.
     */
    public $request;

    /**
     * @var string The template slug to be loaded (like "table", "list")
     */
    public static $slug;

    /**
     * Initializer.
     *
     * @param \GV\View $view The View connected to this template.
     * @param \GV\Entry_Collection $entries A collection of entries for this view.
     * @param \GV\Request $request The request context.
     */
    public function __construct( View $view, Entry_Collection $entries, Request $request ) {
        $this->view = $view;
        $this->entries = $entries;
        $this->request = $request;

        /** Add granular overrides. */
        add_filter( $this->filter_prefix . '_get_template_part', array( $this, 'add_id_specific_templates' ), 10, 3 );

        parent::__construct();
    }

    public function __destruct() {
        remove_filter( $this->filter_prefix . '_get_template_part', array( $this, 'add_id_specific_templates' ) );
    }

    /**
     * Enable granular template overrides based on current post, view, form, etc.
     *
     * The loading order is:
     *
     * - post-[ID of post or page where view is embedded]-view-[View ID]-table-footer.php
     * - post-[ID of post or page where view is embedded]-table-footer.php
     * - view-[View ID]-table-footer.php
     * - form-[Form ID]-table-footer.php
     * - table-footer.php
     *
     * @see  Gamajo_Template_Loader::get_template_file_names() Where the filter is
     * @param array $templates Existing list of templates.
     * @param string $slug      Name of the template base, example: `table`, `list`, `datatables`, `map`
     * @param string $name      Name of the template part, example: `body`, `footer`, `head`, `single`
     *
     * @return array $templates Modified template array, merged with existing $templates values
     */
    public function add_id_specific_templates( $templates, $slug, $name ) {

        $specifics = array();

        list( $slug_dir, $slug_name ) = self::split_slug( $slug, $name );

        global $post;

        if ( ! $this->request->is_view( false ) && $post ) {
            $specifics []= sprintf( '%spost-%d-view-%d-%s.php', $slug_dir, $post->ID, $this->view->ID, $slug_name );
            $specifics []= sprintf( '%spost-%d-%s.php', $slug_dir, $post->ID, $slug_name );
        }


        $specifics []= sprintf( '%sview-%d-%s.php', $slug_dir, $this->view->ID, $slug_name );
        $specifics []= sprintf( '%sform-%d-%s.php', $slug_dir, $this->view->form->ID, $slug_name );

        return array_merge( $specifics, $templates );
    }

    /**
     * Output some HTML.
     *
     * @return void
     */
    public function render() {
        $context = Template_Context::from_template( $this );

        /**
         * Make various pieces of data available to the template
         *  under the $gravityview scoped variable.
         *
         * @filter `gravityview/template/view/context`
         * @param \GV\Template_Context $context The context for this template.
         * @param \GV\View_Template $template The current template.
         * @since 2.0
         */
        $this->push_template_data( $context = apply_filters( 'gravityview/template/view/context', $context, $this ), 'gravityview' );

        /**
         * @filter `gravityview/template/view/render` Before rendering.
         * @param \GV\View_Template $template The current template.
         * @since 2.0
         */
        do_action( 'gravityview/template/view/render', $context );

        /** Load the template. */
        $this->get_template_part( static::$slug );
        $this->pop_template_data( 'gravityview' );
    }
}

/** Load implementations. */
require gravityview()->plugin->dir( 'future/includes/class-gv-template-view-table.php' );
require gravityview()->plugin->dir( 'future/includes/class-gv-template-view-list.php' );
require gravityview()->plugin->dir( 'future/includes/class-gv-template-view-legacy.php' );