Initial commit

Author: Grant Kinney

.gitignore

@@ -0,0 +1,47 @@
+# Always-ignore extensions #
+############################
+*.bak
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.zip
+*.vi
+*~
+*.un~
+*.sass-cache
+
+# OS generated files #
+######################
+*~
+.svn
+.cvs
+.DS_Store*
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db
+.cache
+.project
+.settings
+.tmproj
+*.esproj
+nbproject
+*.sublime*
+
+# Folders to ignore #
+#####################
+.hg
+.svn
+.CVS
+.idea
+node_modules
+dist
+.rvmrc
+.vagrant
+vendor

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Grant Kinney
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,84 @@
+Template Controller for WordPress
+=======================================
+
+This class allows you to abstract the data you need for your theme templates from the  template files, themselves (like `page.php` and `single.php`). Use a controller file to generate the data, and let your template files focus on displaying that data.
+
+Install
+-------
+
+Include the class and a controller file within your theme or plugin
+
+```php
+// Example:
+require_once( get_template_directory() . '/lib/classes/class-template-controller.php' );
+require_once( get_template_directory() . '/controller.php' );
+```
+
+Usage
+-----
+
+Within the controller file, extend the class to create a controller for your theme. Each method within the class should match a body class of a template where you want to display the data. The `common()` method fires for all templates. Don't forget to init the class.
+
+```php
+class My_Controller extends Template_Controller {
+
+	// Generates data for all templates
+	public function common() {
+		$this->add( 'hi', 'I load for every template on the site.' );
+	}
+
+	public function page() {
+		$this->add( 'yo', 'I load for page.php and custom page templates.' );
+
+		// Get recent posts to display on the page
+		$this->add( 'recent_posts', get_posts( array(
+			'post_type' => 'post',
+			'posts_per_page' => 2,
+				)
+			)
+		);
+	}
+}
+
+My_Controller::init();
+```
+
+Within your template files, call the data you've generated.
+
+```php
+// within page.php
+
+// Store the data
+$yo = get_tpl_data( 'yo' );
+
+// Echo out the data
+tpl_data( 'hi' );
+
+// Use data as you normally would in template files
+$recent_posts = tpl_data( 'recent_posts' );
+foreach( $recent_posts as $post ) {
+	echo $post->post_title;
+}
+```
+
+Alternatively, you can call a global to get all of the data available for that template.
+
+```php
+// within page.php
+
+global $template_data;
+extract( $template_data, EXTR_SKIP );
+
+echo $yo;
+
+foreach( $recent_posts as $post ) {
+	echo $post->post_title;
+}
+```
+
+Multiple Controllers
+--------------------
+
+You can create and init as many child classes as you would like. All will follow the same pattern, loading any methods that match any body class on a template. All store data statically in the parent class so that it can be easily called with the tpl_data functions.
+
+Thanks to @DesignPlug for the idea: https://github.com/DesignPlug/wxp-dom-router

class-template-controller.php

@@ -0,0 +1,141 @@
+<?php
+if ( ! class_exists( 'Template_Controller' ) ) {
+	/**
+	 * Parent class for passing data into template files
+	 *
+	 * All properties in this class are declared statically so that all data from child
+	 * classes can be passed back to this parent class and called directly from here.
+	 * (This takes advantage of a PHP quirk that that within child classes, `self` refers
+	 * to the parent class)
+	 *
+	 * @package     WordPress
+	 * @subpackage  Template_Controller
+	 * @author      Grant Kinney
+	 * @license     http://mit-license.org/ MIT
+	 */
+	class Template_Controller {
+
+		/**
+		 * An array of instances used for singleton pattern that stores an instance for this
+		 * parent class and separate instances for each child class
+		 * @var array
+		 */
+		protected static $instances = array();
+
+		/**
+		 * An array of body class for the current template
+		 * @var array
+		 */
+		protected static $classes = array();
+
+		/**
+		 * A key value store for data that is passed into templates
+		 * @var array
+		 */
+		protected static $data = array();
+
+		/**
+		 * Initialize class
+		 * @return void
+		 */
+		public static function init() {
+			self::get_instance();
+		}
+
+		/**
+		 * Singleton pattern: instantiate one and only one instance of this class, and one and
+		 * only one instance of each child class that extends it
+		 *
+		 * @return object instance of class being instantiated
+		 */
+		final public static function get_instance() {
+			// Note, need PHP 5.3 or greater to use `get_called_class()`
+			$class = get_called_class();
+			if ( ! isset( self::$instances[$class] ) ) {
+				self::$instances[$class] = new $class;
+			}
+			return self::$instances[$class];
+		}
+
+		/**
+		 * Hooks for setting up methods within class
+		 */
+		public function __construct() {
+			// Load template data before including template files
+			add_action( 'template_redirect', array( $this, 'load' ) );
+		}
+
+		/**
+		 * Get a value from the template data by name
+		 *
+		 * @param  string $name Name of data stored
+		 * @return mixed        Value of data, if it exists, otherwise false
+		 */
+		public function get( $name ) {
+			return isset( self::$data[$name] ) ? self::$data[$name] : false;
+		}
+
+		/**
+		 * Load template data
+		 *
+		 * Loops through each body class for the current template, checks for a method of
+		 * the same name as the class, and calls that method if it exists
+		 *
+		 * @return void
+		 */
+		public function load() {
+			/**
+			 * Global variable to store template data.
+			 *
+			 * Place the following at the top of your template file as an alternative to calling
+			 * `tpl_data()` or `get_tpl_data()` functions for each individual data key
+			 * `global $template_data;`
+			 * `extract( $template_data, EXTR_SKIP );`
+			 *
+			 * @global array template_data
+			 */
+			global $template_data;
+			// Add `common` to class array so that it loads for every template
+			self::$classes = get_body_class( 'common' );
+			foreach( self::$classes as $class ) {
+				$class = str_replace( '-', '_', $class );
+				if ( method_exists( $this, $class ) ) {
+					call_user_func( array( $this, $class ) );
+				}
+			}
+			// Push template data out to global variable
+			$template_data = self::$data;
+		}
+
+		/**
+		 * Add data by name for use in templates
+		 *
+		 * @param string $name Name of data stored
+		 * @param mixed  $data Value of data
+		 */
+		protected function add( $name, $data ) {
+			self::$data[$name] = $data;
+		}
+
+	} // end class
+} // endif class_exists
+
+/**
+ * Return a template data value from the specified name
+ *
+ * @param  string $name Name of data key to retrieve
+ * @return mixed        Data value for use in template
+ */
+function get_tpl_data( $name ) {
+	return Template_Controller::get_instance()->get($name);
+}
+
+/**
+ * Echo a template data value from the specified name
+ *
+ * @param  string $name Name of data key to retrieve
+ * @return void
+ */
+function tpl_data( $name ) {
+	echo Template_Controller::get_instance()->get($name);
+}

example-controller.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Controller for template data
+ * - Each method in the class that matches a template name will be loaded for that template
+ * - Ex: `single()` will be loaded for single.php. `common()` is called for all templates
+ * - Within each method, use `$this->add( 'name', $data )` for each variable you'd like to pass to a template
+ * - Use `tpl_var('name')` or `get_tpl_var('name')` to call the data from within each template file
+ *
+ * @package    WordPress
+ * @subpackage Template_Controller
+ * @uses       Template_Controller  Parent class for controller
+ */
+class My_Controller extends Template_Controller {
+
+	public function common() {
+		$this->add( 'hi', 'I load for every template on the site.' );
+	}
+
+	public function page() {
+		$this->add( 'yo', 'I load for page.php and custom page templates.' );
+	}
+
+	public function single() {
+		$this->add( 'whazup', 'I load for single.php, for all post types (any template that starts with "single-").' );
+	}
+
+	public function single_post() {
+		$this->add( 'dude', 'I load only for built in single post templates (aka single-post.php)' );
+	}
+
+}
+
+// Initialize controller
+My_Controller::init();