Create a gist now

Instantly share code, notes, and snippets.

@iamntz /Tpl.php Secret
Created Jan 8, 2017

Handlebars Wrapper
<?php
namespace iamntz\utils;
use \Handlebars\Handlebars;
/**
* Template system wrapper
*/
class Tpl {
/**
* Get the Handlebars template engine
*
* @method get_engine
*
* @param array $options override the default template options.
*
* @return Handlebars
*/
public static function get_engine( $options = [] ) {
/**
* Allows you to override the partials subdirectory.
*
* However, this subdirectory should be inside of the views folder.
*
* @var string
*/
$partials_path = apply_filters( 'iamntz/templates/partials_path', 'partials' );
$options = array_merge( self::get_template_options(), $options );
return new Handlebars([
'loader' => new \Handlebars\Loader\FilesystemLoader( self::get_template_paths(), $options ),
'partials_loader' => new \Handlebars\Loader\FilesystemLoader( self::get_template_paths( $partials_path ), $options ),
]);
}
/**
* Gets the directory paths where to look for templates
*
* @method get_paths
*
* @return array the directory paths
*/
public static function get_paths() {
$paths = [
get_template_directory(),
get_stylesheet_directory(),
];
$paths = array_reverse( apply_filters( 'iamntz/template/directories', $paths ) );
return array_map( 'trailingslashit', $paths );
}
/**
* Filter template directories and returns only paths that actually exists.
*
* @method get_template_paths
*
* @param string $subdir additional subdirectory to search into.
*
* @return array filtered array.
*/
public static function get_template_paths( $subdir = '' ) {
$paths = array_map(function( $path ) use ( $subdir ) {
return file_exists( $path . "/views/{$subdir}" ) ? $path . "views/{$subdir}" : null;
}, self::get_paths());
return array_filter( $paths );
}
/**
* Get Template Engine options
*
* @method get_template_options
*
* @return array
*/
public static function get_template_options() {
$options = [
'extension' => '.hbs',
];
return apply_filters( 'iamntz/template/options', $options );
;
}
/**
* Gets the compiled template
*
* @method get
*
* @param string $template the template file name without extension.
* @param array $content the data to be passed to the template.
* @param array $options override the default template options.
* @param \Handlebars\Tokenizer $tokenizer override the default tokenizer.
*
* @return string compiled template
*/
public static function get( $template, $content = [], $options = [], $tokenizer = null ) {
$content = apply_filters( 'iamntz/template/content', $content );
$content['i18n'] = apply_filters( 'iamntz/template/i18n_strings', [] );
$content['home_url'] = esc_url( home_url( '/' ) );
$content['theme_uri'] = get_stylesheet_directory_uri();
$content['parent_theme_uri'] = get_template_directory_uri();
$content['is_child_theme?'] = is_child_theme();
$content['is_home?'] = is_front_page() && is_home();
$content['admin?'] = is_admin();
$engine = self::get_engine( $options );
if ( ! is_null( $tokenizer ) ) {
$engine->setTokenizer( $tokenizer );
}
return $engine->render( $template, self::get_content_with_id( $content ) );
}
/**
* Echoes the template
*
* @method show
*
* @param string $template the template file.
* @param array $content the data to be passed.
* @param array $options override the default template options.
* @param \Handlebars\Tokenizer $tokenizer override the default tokenizer.
*/
public static function show( $template, $content = [], $options = [], $tokenizer = null ) {
// @codingStandardsIgnoreStart
echo self::get( $template, $content, $options, $tokenizer );
// @codingStandardsIgnoreEnd
}
/**
* Automatically add an ID to template data in order to always have an ID available in HTML
*
* @method get_content_with_id
*
* @param array $content the content data.
*
* @return array the content data with IDs added.
*/
public static function get_content_with_id( $content ) {
$hash_algorithm = apply_filters( 'iamntz/template/hash', 'crc32b' );
if ( ! isset( $content['_id'] ) ) {
$content['_id'] = 'id-' . hash( $hash_algorithm, serialize( $content ) );
}
if ( ! isset( $content['_uniqid'] ) ) {
$content['_uniqid'] = chr( rand( 64, 90 ) ) . str_replace( '.', '-', uniqid( '_', true ) );
}
return $content;
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment