Remove Template class

This commit is contained in:
QWp6t
2015-12-27 22:07:25 -08:00
committed by Ben Word
parent 12d6ac3c51
commit 1df3fee010
8 changed files with 120 additions and 193 deletions

View File

@@ -13,26 +13,37 @@ class Wrapper implements WrapperInterface {
protected $template = '';
/** @var string[] Array of template wrappers; e.g., `base-singular.php`, `base-page.php`, `base.php` */
protected $wrappers = [];
protected $wrapper = [];
/** @var string[] Cache template locations */
protected static $locations = [];
/**
* Wrapper constructor
*
* @param string $templateSlug Template slug, typically from Template Heirarchy; e.g., `page`, `single`, `singular`
* @param string $template Template file, as from Template Heirarchy; e.g., `page.php`, `single.php`, `singular.php`
* @param string $base Wrapper's base template, this is what will wrap around $template
*/
public function __construct($templateSlug, $base = 'layouts/base.php') {
public function __construct($template, $base = 'layouts/base.php') {
$this->slug = sanitize_title(basename($base, '.php'));
$this->wrappers = [$base];
$this->template = $templateSlug;
$this->wrapper = [$base];
$this->template = $template;
$str = substr($base, 0, -4);
array_unshift($this->wrappers, sprintf($str . '-%s.php', $templateSlug));
array_unshift($this->wrapper, sprintf($str . '-%s.php', basename($template, '.php')));
}
/**
* @return string
* @see getTemplate
*/
public function __toString() {
return $this->getTemplate();
}
/** {@inheritdoc} */
public function getWrappers() {
$this->wrappers = apply_filters('sage/wrap_' . $this->slug, $this->wrappers) ?: $this->wrappers;
return $this->wrappers;
public function getWrapper() {
$wrappers = apply_filters('sage/wrap_' . $this->slug, $this->wrapper) ?: $this->wrapper;
return locate_template($wrappers);
}
/** {@inheritdoc} */
@@ -42,6 +53,7 @@ class Wrapper implements WrapperInterface {
/** {@inheritdoc} */
public function getTemplate() {
return $this->template;
$template = apply_filters('sage/unwrap_' . $this->slug, $this->template) ?: $this->template;
return locate_template($template);
}
}

View File

@@ -0,0 +1,73 @@
<?php namespace Roots\Sage\Template;
/**
* Class Wrapper
* @package Roots\Sage
* @author QWp6t
*/
class WrapperCollection {
/** @var $this */
protected static $instance;
/** @var WrapperInterface[] $wrappers */
protected $wrappers = [];
/** Singleton */
private function __construct() {}
private function __clone() {}
/**
* @return static
*/
public static function instance() {
isset(self::$instance) || self::$instance = new static;
return self::$instance;
}
/**
* @param WrapperInterface $wrapper
* @param string $slug
* @param bool $overwriteIfExists
* @return $this
* @throws \Exception
*/
public static function add(WrapperInterface $wrapper, $slug = '', $overwriteIfExists = false) {
$slug = $slug ?: $wrapper->getSlug();
if (self::instance()->exists($slug) && !$overwriteIfExists) {
throw new \Exception("Wrapper $slug already exists.");
}
self::instance()->wrappers[$slug] = $wrapper;
return self::instance();
}
/**
* @param string $slug
* @return $this
*/
public static function remove($slug) {
unset(self::instance()->wrappers[$slug]);
return self::instance();
}
/**
* @param string $slug
* @return null|WrapperInterface
*/
public static function get($slug) {
return isset(self::instance()->wrappers[$slug]) ? self::instance()->wrappers[$slug] : null;
}
/**
* @return string[] Slugs of wrappers in collection
*/
public static function wrappers() {
return array_keys(self::instance()->wrappers);
}
/**
* @param $slug
* @return bool
*/
public static function exists($slug) {
return isset(self::instance()->wrappers[$slug]);
}
}

View File

@@ -6,16 +6,16 @@
* @author QWp6t
*/
interface WrapperInterface {
/**
* Get a list of potential wrappers
* Useful for passing to WordPress's locate_template()
*
* @return string[] List of wrappers; e.g., `base-page.php`, `base.php`
*/
public function getWrappers();
/**
* @return string Template file that is being wrapped; e.g., `page.php`, `single.php`, `singular.php`
* Get wrapper template file
*
* @return string Wrapper template (FQPN of, e.g., `base-page.php`, `base.php`)
*/
public function getWrapper();
/**
* @return string Wrapped template (FQPN of, e.g., `page.php`, `single.php`, `singular.php`)
*/
public function getTemplate();