Merge pull request #24 from justcoded/feature/view-extends

Feature/view extends

Author: aprokopenko

framework/Objects/Post_Type.php

@@ -11,6 +11,8 @@
  * https://codex.wordpress.org/Function_Reference/register_post_type
  */
 abstract class Post_Type {
+	use Singleton;
+
 	/**
 	 * Post_Type ID. Used to store it in DB and identify by post_type key
 	 * SHOULD BE OVERWRITTEN IN CHILD CLASS
@@ -231,7 +233,7 @@ abstract class Post_Type {
 	 *
 	 * @throws \Exception Missing $ID property.
 	 */
-	public function __construct() {
+	protected function __construct() {
 		if ( empty( $this::$ID ) ) {
 			throw new \Exception( 'Post Type "' . get_class( $this ) . '" init failed: missing $ID property' );
 		}

framework/Objects/Singleton.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace JustCoded\WP\Framework\Objects;
+
+/**
+ * Class Singleton
+ * Singleton design pattern base class
+ */
+trait Singleton {
+	/**
+	 * Refers to a single instance of this class.
+	 *
+	 * @var self
+	 */
+	protected static $instance = null;
+
+	/**
+	 * Returns the *Singleton* current class.
+	 *
+	 * @return Singleton A single instance of this class.
+	 */
+	public static function instance() {
+		static $instance = null;
+
+		return $instance ?: $instance = new static();
+	}
+
+	/**
+	 * Protected constructor to prevent creating a new instance of the
+	 * *Singleton* via the `new` operator from outside of this class.
+	 */
+	protected function __construct() {
+	}
+
+	/**
+	 * Private clone method to prevent cloning of the instance of the
+	 * *Singleton* instance.
+	 *
+	 * @return void
+	 */
+	final private function __clone() {
+	}
+
+	/**
+	 * Private unserialize method to prevent unserializing of the *Singleton*
+	 * instance.
+	 *
+	 * @return void
+	 */
+	final private function __wakeup() {
+	}
+
+}

framework/Objects/Taxonomy.php

@@ -11,6 +11,8 @@
  * https://codex.wordpress.org/Function_Reference/register_taxonomy
  */
 abstract class Taxonomy {
+	use Singleton;
+
 	/**
 	 * Taxonomy ID. Used to store it in DB and identify by taxonomy key
 	 * SHOULD BE OVERWRITTEN IN CHILD CLASS
@@ -150,7 +152,7 @@ abstract class Taxonomy {
 	 *
 	 * @throws \Exception Taxonomy $ID property not defined.
 	 */
-	public function __construct() {
+	protected function __construct() {
 		if ( empty( $this::$ID ) ) {
 			throw new \Exception( 'Taxonomy "' . get_class( $this ) . '" init failed: missing $ID property' );
 		}

framework/Theme.php

@@ -116,7 +116,7 @@ abstract class Theme {
 	public function __construct() {
 		$this->register_post_types();
 		$this->register_taxonomies();
-		new Template_Hierarchy();
+		$this->init_views_templates();
 
 		/**
 		 * Pretty standard theme hooks
@@ -188,6 +188,14 @@ public function remove_assets_query_string( $src ) {
 		return $src;
 	}
 
+	/**
+	 * Init new Template Hierarchy based on "views" folder and load Views engine.
+	 */
+	public function init_views_templates() {
+		Template_Hierarchy::instance();
+		View::instance();
+	}
+
 	/**
 	 * Called right away after constructor. You can define/call additional actions here
 	 */

framework/Web/Template_Hierarchy.php

@@ -2,14 +2,16 @@
 
 namespace JustCoded\WP\Framework\Web;
 
+use JustCoded\WP\Framework\Objects\Singleton;
 use JustCoded\WP\Framework\Web\View;
-use JustCoded\WP\Framework\Web\Views_Rule;
 
 /**
  * Class Template_Hierarchy
  * Hook get_*_template() functions to add "views" folder everywhere
  */
 class Template_Hierarchy {
+	use Singleton;
+
 	/**
 	 * Standard template types available for rewrite.
 	 *
@@ -49,17 +51,17 @@ class Template_Hierarchy {
 
 	/**
 	 * Template_Hierarchy constructor.
-	 * set wordpress template system hooks
+	 * set WordPress template system hooks
 	 */
-	public function __construct() {
+	protected function __construct() {
+		// patch page/custom post type templates.
+		add_action( 'init', array( $this, 'init_theme_page_template_hooks' ), 1000 );
+
 		// set filter for all query template types.
 		foreach ( $this->template_types as $type ) {
 			add_filter( "{$type}_template_hierarchy", array( $this, "{$type}_template_hierarchy" ) );
 		}
 
-		// patch page/custom post type templates.
-		add_action( 'init', array( $this, 'init_theme_page_template_hooks' ), 1000 );
-
 		// add woocommerce support.
 		add_filter( 'woocommerce_template_path', array( $this, 'woocommerce_template_path' ) );
 

framework/Web/View.php

@@ -1,82 +1,150 @@
 <?php
 namespace JustCoded\WP\Framework\Web;
 
+use JustCoded\WP\Framework\Objects\Singleton;
+
 /**
  * Views base class.
  * Used for layouts and render partials
  */
 class View {
+	use Singleton;
+
+	/**
+	 * Layouts call chain.
+	 *
+	 * @var array
+	 */
+	private $extends = array();
+
 	/**
-	 * Current layout name
+	 * Theme template path to be loaded.
 	 *
 	 * @var string
 	 */
-	private static $_layout;
+	public $template;
 
 	/**
-	 * Layouts call chain
+	 * View constructor.
 	 *
-	 * @var array
+	 * Executed immediately before WordPress includes the predetermined template file
+	 * Override WordPress's default template behavior.
 	 */
-	private static $_processing = array();
+	protected function __construct() {
+		add_filter( 'template_include', array( $this, 'init_template' ), 999999 );
+	}
 
 	/**
-	 * Start recording the content to be passed to the layout template
+	 * Implement template wrappers. For this we need to remember real template to be loaded.
+	 * Then we return the object itself to be able to manipulate the loading process.
 	 *
-	 * @param string $layout Layout name to be rendered after views render.
+	 * @param string $template Template to be included inside theme.
+	 *
+	 * @return $this
 	 */
-	public static function layout_open( $layout = 'main' ) {
-		// WordPress compatibility to still process usual headers.
-		do_action( 'get_header', null );
+	public function init_template( $template ) {
+		$this->template = $template;
 
-		// check that we have required template.
-		$template = static::locate( 'layouts/' . $layout, true );
+		return $this;
+	}
 
-		// memorize the template.
-		static::$_layout = $layout;
-		array_push( static::$_processing, $template );
+	/**
+	 * Convert object to string magic method.
+	 * We replaced string with object inside `template_include` hook, so to support next include statement we need
+	 * to add magic method, which make object to string conversion.
+	 *
+	 * Here we will just return theme index.php file, which will be the entry point of our views engine.
+	 *
+	 * @return string
+	 */
+	public function __toString() {
+		return locate_template( array( 'index.php' ) );
+	}
 
-		// start buffer.
-		ob_start();
-		ob_implicit_flush( false );
+	/**
+	 * Start loading theme template.
+	 */
+	public function include_template() {
+		// add alias.
+		$template = $this->template;
+
+		include $this->template;
+
+		$this->wrap();
 	}
 
 	/**
-	 * Stop recording content part and final render of the layout
+	 * Wrap content with another view or layout
 	 *
-	 * @throws \Exception No layout_open were called before close.
+	 * @return bool
 	 */
-	public static function layout_close() {
-		if ( empty( static::$_processing ) ) {
-			throw new \Exception( 'Unexpected Views::layout_close() method call. Check that you have layout_open() call and not close layout before.' );
+	public function wrap() {
+		if ( empty( $this->extends ) ) {
+			return false;
 		}
 
-		// get content.
-		$content = ob_get_clean();
+		while( ob_get_contents() && $template = array_pop( $this->extends ) ) {
+			$content = ob_get_contents();
+
+			// clean view file buffer.
+			ob_clean();
 
-		// reset query to protect header from unclosed query in the content.
-		wp_reset_postdata();
+			// reset query to protect header from unclosed query in the content.
+			wp_reset_postdata();
+
+			// render under the existing context.
+			include $template;
+		}
+	}
 
-		// render under the existing context.
-		include array_pop( static::$_processing );
+	/**
+	 * Registers parent template.
+	 * Parent template will be rendered just after current template execution.
+	 *
+	 * To use current template generated html use `$content` variable inside the parent view
+	 *
+	 * @param string $layout  View name to register.
+	 *
+	 * @return bool
+	 * @throws \Exception If no parent view template found.
+	 */
+	public function extends( $layout = 'layouts/main' ) {
+		if ( false === $layout ) {
+			return false;
+		}
+
+		// WordPress compatibility to still process usual headers.
+		if ( empty( $this->extends ) ) {
+			do_action( 'get_header', null );
+		}
+
+		// check that we have required template.
+		$template = $this->locate( $layout, true );
+
+		// memorize the template.
+		array_push( $this->extends, $template );
+
+		// start buffer.
+		ob_start();
+		return true;
 	}
 
 	/**
 	 * WordPress compatibility option instead of get_sidebar, to run a sidebar hook
 	 *
 	 * @param string|null $name custom sidebar name.
 	 */
-	public static function sidebar_begin( $name = null ) {
+	public function sidebar_begin( $name = null ) {
 		// WordPress compatibility.
 		do_action( 'get_footer', $name );
 	}
 
 	/**
 	 * WordPress compatibility option intead of get_sidebar
 	 *
-	 * @param string|name $name custom footer name.
+	 * @param string|null $name custom footer name.
 	 */
-	public static function footer_begin( $name = null ) {
+	public function footer_begin( $name = null ) {
 		// WordPress compatibility.
 		do_action( 'get_footer', $name );
 	}
@@ -88,19 +156,20 @@ public static function footer_begin( $name = null ) {
 	 * @param array   $params params to be passed to the view.
 	 * @param boolean $__required print message if views not found.
 	 *
-	 * @return bool|void
+	 * @return bool
 	 */
-	public static function render( $view, $params = array(), $__required = true ) {
-		$__views_path = static::locate( $view, $__required );
-		if ( empty( $__views_path ) ) {
+	public function render( $view, $params = array(), $__required = true ) {
+		$template = $this->locate( $view, $__required );
+		if ( empty( $template ) ) {
 			return false;
 		}
 
 		if ( ! empty( $params ) ) {
 			extract( $params );
 		}
 
-		include $__views_path;
+		include $template;
+		return true;
 	}
 
 	/**
@@ -114,7 +183,7 @@ public static function render( $view, $params = array(), $__required = true ) {
 	 *
 	 * @throws \Exception  Required and not found.
 	 */
-	public static function locate( $view, $required = false ) {
+	public function locate( $view, $required = false ) {
 		$view_file = "views/$view.php";
 		$template  = locate_template( $view_file );
 		if ( $required && ( empty( $template ) || ! is_file( $template ) ) ) {

readme.txt

@@ -91,6 +91,8 @@ To upgrade remove the old plugin folder. After than follow the installation step
 
 == Changelog ==
 
+= Version 2.1.0 - 15 December 2017 =
+	* New: Updated View component and layouts wrapping rendering. Replaced layout_open()/layout_close() methods with extends() method.
 = Version 2.0.1 - 27 November 2017 =
 	* New: Removed theme hooks to patch WordPress-generated .htaccess (moved to starter package)
 = Version 2.0 - 21 November 2017 =

wordpress-theme-framework.php

@@ -4,7 +4,7 @@
 Plugin Name: WordPress Theme Framework
 Description: Lightweight theme framework base with Model-View concept for developers who want to better organize their own custom themes.
 Tags: mvc theme, theme boilerplate, oop theme, mini framework
-Version: 2.0.1
+Version: 2.1.0
 Author: JustCoded / Alex Prokopenko
 Author URI: http://justcoded.com/
 License: GPL3