Restructure theme, use autoloader

roots · Mar 11, 2016 · 3f9b112 · 3f9b112 · LeoColomb · Mar 13, 2016
1 parent 463d6bc
commit 3f9b112
Show file tree

Hide file tree

Showing 13 changed files with 608 additions and 6 deletions.
diff --git a/app/admin.php b/app/admin.php
@@ -0,0 +1,15 @@
+<?php namespace App;
+
+/**
+ * Add postMessage support
+ */
+add_action('customize_register', function (\WP_Customize_Manager $wp_customize) {
+  $wp_customize->get_setting('blogname')->transport = 'postMessage';
+});
+
+/**
+ * Customizer JS
+ */
+add_action('customize_preview_init', function () {
+  wp_enqueue_script('sage/customizer', asset_path('scripts/customizer.js'), ['customize-preview'], null, true);
+});
diff --git a/app/filters.php b/app/filters.php
@@ -0,0 +1,55 @@
+<?php namespace App;
+
+use Roots\Sage\Template;
+use Roots\Sage\Template\Wrapper;
+
+/**
+ * Determine which pages should NOT display the sidebar
+ * @link https://codex.wordpress.org/Conditional_Tags
+ */
+add_filter('sage/display_sidebar', function ($display) {
+  /** The sidebar will NOT be displayed if ANY of the following return true. */
+  return $display ? !in_array(true, [
+    is_404(),
+    is_front_page(),
+    is_page_template('template-custom.php'),
+  ]) : $display;
+});
+
+/**
+ * Add <body> classes
+ */
+add_filter('body_class', function (array $classes) {
+  // Add page slug if it doesn't exist
+  if (is_single() || is_page() && !is_front_page()) {
+    if (!in_array(basename(get_permalink()), $classes)) {
+      $classes[] = basename(get_permalink());
+    }
+  }
+
+  // Add class if sidebar is active
+  if (display_sidebar()) {
+    $classes[] = 'sidebar-primary';
+  }
+
+  return $classes;
+});
+
+/**
+ * Clean up the_excerpt()
+ */
+add_filter('excerpt_more', function () {
+  return ' &hellip; <a href="' . get_permalink() . '">' . __('Continued', 'sage') . '</a>';
+});
+
+
+/**
+ * Use Wrapper by default
+ */
+add_filter('template_include', function ($main) {
+  if (!is_string($main) || !(string) $main) {
+    return $main;
+  }
+  $main = basename($main, '.php');
+  return Template::wrap(new Wrapper($main, 'layouts/base.php'))->locate();
+}, 109);
diff --git a/app/helpers.php b/app/helpers.php
@@ -0,0 +1,77 @@
+<?php namespace App;
+
+use Roots\Sage\Asset;
+use Roots\Sage\Assets\JsonManifest;
+use Roots\Sage\Template;
+
+/**
+ * @param string $slug
+ * @param array $context
+ */
+function template_unwrap($slug = '', $context = []) {
+  if ($file = Template::unwrap($slug, $context)->locate()) {
+    /** @noinspection PhpIncludeInspection */
+    include $file;
+  }
+}
+
+/**
+ * @param array $context
+ */
+function template_sidebar($context = []) {
+  template_part('sidebar', $context);
+}
+
+/**
+ * @param $template
+ * @param array $context
+ */
+function template_part($template, $context = []) {
+  if ($file = (new Template($template, $context))->locate()) {
+    /** @noinspection PhpIncludeInspection */
+    include $file;
+  }
+}
+
+/**
+ * @param $filename
+ * @return string
+ */
+function asset_path($filename) {
+  static $manifest;
+  isset($manifest) || $manifest = new JsonManifest(get_template_directory() . '/' . Asset::$dist . '/assets.json');
+  return (string) new Asset($filename, $manifest);
+}
+
+/**
+ * Determine whether to show the sidebar
+ * @return bool
+ */
+function display_sidebar() {
+  static $display;
+  isset($display) || $display = apply_filters('sage/display_sidebar', true);
+  return $display;
+}
+
+/**
+ * Page titles
+ * @return string
+ */
+function title() {
+  if (is_home()) {
+    if ($home = get_option('page_for_posts', true)) {
+      return get_the_title($home);
+    }
+    return __('Latest Posts', 'sage');
+  }
+  if (is_archive()) {
+    return get_the_archive_title();
+  }
+  if (is_search()) {
+    return sprintf(__('Search Results for %s', 'sage'), get_search_query());
+  }
+  if (is_404()) {
+    return __('Not Found', 'sage');
+  }
+  return get_the_title();
+}
diff --git a/app/lib/Sage/Asset.php b/app/lib/Sage/Asset.php
@@ -0,0 +1,35 @@
+<?php namespace Roots\Sage;
+
+use Roots\Sage\Assets\IManifest;
+
+/**
+ * Class Template
+ * @package Roots\Sage
+ * @author QWp6t
+ */
+class Asset {
+
+  public static $dist = '/dist';
+
+  /** @var IManifest Currently used manifest */
+  protected $manifest;
+
+  protected $asset;
+
+  protected $dir;
+
+  public function __construct($file, IManifest $manifest = null) {
+    $this->manifest = $manifest;
+    $this->asset = basename($file);
+    $this->dir = dirname($file) != '.' ? dirname($file) : '';
+  }
+
+  public function __toString() {
+    return $this->getUri();
+  }
+
+  public function getUri() {
+    $file = self::$dist . '/' . $this->dir . '/' . ($this->manifest ? $this->manifest->get($this->asset) : $this->asset);
+    return get_template_directory_uri() . $file;
+  }
+}
diff --git a/app/lib/Sage/Assets/IManifest.php b/app/lib/Sage/Assets/IManifest.php
@@ -0,0 +1,26 @@
+<?php namespace Roots\Sage\Assets;
+
+/**
+ * Interface IManifest
+ * @package Roots\Sage
+ * @author QWp6t
+ */
+interface IManifest {
+
+  /**
+   * Get the cache-busted filename
+   *
+   * If the manifest does not have an entry for $file, then return $file
+   *
+   * @param string $file The original name of the file before cache-busting
+   * @return string
+   */
+  public function get($file);
+
+  /**
+   * Get the asset manifest
+   *
+   * @return array
+   */
+  public function getAll();
+}
diff --git a/app/lib/Sage/Assets/JsonManifest.php b/app/lib/Sage/Assets/JsonManifest.php
@@ -0,0 +1,29 @@
+<?php namespace Roots\Sage\Assets;
+
+/**
+ * Class JsonManifest
+ * @package Roots\Sage
+ * @author QWp6t
+ */
+class JsonManifest implements IManifest {
+  /** @var array */
+  protected $manifest = [];
+
+  /**
+   * JsonManifest constructor
+   * @param string $manifestPath Local filesystem path to JSON-encoded manifest
+   */
+  public function __construct($manifestPath) {
+    $this->manifest = file_exists($manifestPath) ? json_decode(file_get_contents($manifestPath), true) : [];
+  }
+
+  /** @inheritdoc */
+  public function get($file) {
+    return isset($this->manifest[$file]) ? $this->manifest[$file] : $file;
+  }
+
+  /** @inheritdoc */
+  public function getAll() {
+    return $this->manifest;
+  }
+}
diff --git a/app/lib/Sage/Template.php b/app/lib/Sage/Template.php
@@ -0,0 +1,151 @@
+<?php namespace Roots\Sage;
+
+use Roots\Sage\Template\IWrapper;
+
+/**
+ * Class Template
+ * @package Roots\Sage
+ * @author QWp6t
+ */
+class Template {
+  protected static $root = 'templates/';
+
+  /** @var IWrapper[] */
+  protected static $wrappers = [];
+
+  protected $templates = [];
+
+  protected $context = [];
+
+  protected $html = '';
+
+  /**
+   * @param IWrapper $wrapper
+   * @param array $context Variables to pass to wrapper
+   * @return static Template instance of wrapper
+   */
+  public static function wrap(IWrapper $wrapper, $context = []) {
+    self::$wrappers[$wrapper->getSlug()] = $wrapper;
+    return new static($wrapper->getWrappers(), $context);
+  }
+
+  /**
+   * @param string $slug
+   * @param array $context
+   * @return static
+   */
+  public static function unwrap($slug = '', $context = []) {
+    if (!$slug) {
+      // If no slug is specified, we grab the most recently wrapped item
+      end(self::$wrappers);
+      $slug = key(self::$wrappers);
+    }
+    return new static(self::$wrappers[$slug]->getTemplate(), $context);
+  }
+
+  /**
+   * Converts a delimeted template file into an array of parts
+   *
+   * Example:
+   *   Template::getConvertedTemplateParts('content-single-audio.php');
+   *   => ['content-single-audio.php', 'content-single.php', 'content.php']
+   *
+   * The returned value can then be passed to WordPress's locate_template.
+   *
+   * @param string $template
+   * @param string $delimeter
+   * @return array
+   */
+  public static function convertParts($template, $delimeter = '-') {
+    $templateParts = explode($delimeter, str_replace('.php', '', (string) $template));
+    $templates[] = array_shift($templateParts);
+    foreach ($templateParts as $i => $templatePart) {
+      $templates[] = $templates[$i] . $delimeter . $templatePart;
+    }
+    return array_reverse($templates);
+  }
+
+  /**
+   * Template constructor
+   * @param string|string[] $template
+   * @param array $context
+   */
+  public function __construct($template, array $context = []) {
+    $this->set($template);
+    $this->context = $context;
+  }
+
+  /**
+   * @return string HTML
+   * @see get
+   */
+  public function __toString() {
+    return $this->get();
+  }
+
+  /**
+   * Echoes the output HTML
+   * @see get
+   */
+  public function render() {
+    echo $this->get();
+  }
+
+  /**
+   * @return string HTML
+   * @SuppressWarnings(PHPMD.UnusedLocalVariable)
+   */
+  public function get() {
+    /** @noinspection PhpUnusedLocalVariableInspection $context is passed to the included template */
+    $context = $this->context;
+    extract($this->context);
+    ob_start();
+    if ($template = $this->locate()) {
+      /** @noinspection PhpIncludeInspection */
+      include $template;
+    }
+    $this->html = ob_get_clean() ?: '';
+    return $this->html;
+  }
+
+  /**
+   * @param string[]|string $template
+   */
+  public function set($template) {
+    if (is_array($template)) {
+      $this->templates = self::format($template);
+      return;
+    }
+    if (!is_string($template) || !(string) $template) {
+      return;
+    }
+    // At this point, we assume it's something like `content-single.php` or `content-single-audio.php`
+    $this->templates = self::format(self::convertParts($template));
+  }
+
+  /**
+   * Ensures that each template in $this->templates is appended with `.php`
+   * @param $templates
+   * @return array
+   */
+  protected static function format($templates) {
+    return array_map(function ($template) {
+      if (substr($template, -4, 4) === '.php') {
+        return $template;
+      }
+      return $template . '.php';
+    }, $templates);
+  }
+
+  /**
+   * @param string $templateDir Specify a template directory relative to your theme directory; e.g., `templates/`, `templates/partials/`, `woocommerce/`
+   * @return string Filename
+   */
+  public function locate($templateDir = '') {
+    $templates = array_map(function ($template) use ($templateDir) {
+      return ($templateDir ?: self::$root) . $template;
+    }, $this->templates);
+    $template = locate_template($templates);
+    return apply_filters('sage/locate_template', $template, $templates) ?: $template;
+  }
+}