jarednova / timber

lib/timber.php

Doc Comments +1 added lines, -1 removed lines

@@ -345,7 +345,7 @@
 	 * Get widgets.
 	 *
 	 * @param int     $widget_id
-	 * @return TimberFunctionWrapper
+	 * @return string
 	 */
 	public static function get_widgets( $widget_id ) {
 		return trim( TimberHelper::function_wrapper( 'dynamic_sidebar', array( $widget_id ), true ) );

Spacing +90 added lines, -90 removed lines

@@ -45,16 +45,16 @@ 
 		if ( is_admin() || $_SERVER['PHP_SELF'] == '/wp-login.php' ) {
 			return;
 		}
-		if ( version_compare( phpversion(), '5.3.0', '<' ) && !is_admin() ) {
-			trigger_error( 'Timber requires PHP 5.3.0 or greater. You have '.phpversion(), E_USER_ERROR );
+		if ( version_compare(phpversion(), '5.3.0', '<') && !is_admin() ) {
+			trigger_error('Timber requires PHP 5.3.0 or greater. You have ' . phpversion(), E_USER_ERROR);
 		}
-		if ( !class_exists( 'Twig_Autoloader' ) ) {
-			trigger_error( 'You have not run "composer install" to download required dependencies for Timber, you can read more on https://github.com/jarednova/timber#installation', E_USER_ERROR );
+		if ( !class_exists('Twig_Autoloader') ) {
+			trigger_error('You have not run "composer install" to download required dependencies for Timber, you can read more on https://github.com/jarednova/timber#installation', E_USER_ERROR);
 		}
 	}
 
 	function init_constants() {
-		defined( "TIMBER_LOC" ) or define( "TIMBER_LOC", realpath( dirname(__DIR__) ) );
+		defined("TIMBER_LOC") or define("TIMBER_LOC", realpath(dirname(__DIR__)));
 	}
 
 	/**
@@ -62,7 +62,7 @@ 
 	 */
 	protected function init() {
 		TimberTwig::init();
-		TimberRoutes::init( $this );
+		TimberRoutes::init($this);
 		TimberImageHelper::init();
 		TimberAdmin::init();
 		TimberIntegrations::init();
@@ -78,8 +78,8 @@ 
 	 * @param string  $PostClass
 	 * @return array|bool|null
 	 */
-	public static function get_post( $query = false, $PostClass = 'TimberPost' ) {
-		return TimberPostGetter::get_post( $query, $PostClass );
+	public static function get_post($query = false, $PostClass = 'TimberPost') {
+		return TimberPostGetter::get_post($query, $PostClass);
 	}
 
 	/**
@@ -89,8 +89,8 @@ 
 	 * @param string  $PostClass
 	 * @return array|bool|null
 	 */
-	public static function get_posts( $query = false, $PostClass = 'TimberPost', $return_collection = false ) {
-		return TimberPostGetter::get_posts( $query, $PostClass, $return_collection );
+	public static function get_posts($query = false, $PostClass = 'TimberPost', $return_collection = false) {
+		return TimberPostGetter::get_posts($query, $PostClass, $return_collection);
 	}
 
 	/**
@@ -100,8 +100,8 @@ 
 	 * @param string  $PostClass
 	 * @return array|bool|null
 	 */
-	public static function query_post( $query = false, $PostClass = 'TimberPost' ) {
-		return TimberPostGetter::query_post( $query, $PostClass );
+	public static function query_post($query = false, $PostClass = 'TimberPost') {
+		return TimberPostGetter::query_post($query, $PostClass);
 	}
 
 	/**
@@ -111,8 +111,8 @@ 
 	 * @param string  $PostClass
 	 * @return array|bool|null
 	 */
-	public static function query_posts( $query = false, $PostClass = 'TimberPost' ) {
-		return TimberPostGetter::query_posts( $query, $PostClass );
+	public static function query_posts($query = false, $PostClass = 'TimberPost') {
+		return TimberPostGetter::query_posts($query, $PostClass);
 	}
 
 	/**
@@ -136,8 +136,8 @@ 
 	 * @param string  $TermClass
 	 * @return mixed
 	 */
-	public static function get_terms( $args = null, $maybe_args = array(), $TermClass = 'TimberTerm' ) {
-		return TimberTermGetter::get_terms( $args, $maybe_args, $TermClass );
+	public static function get_terms($args = null, $maybe_args = array(), $TermClass = 'TimberTerm') {
+		return TimberTermGetter::get_terms($args, $maybe_args, $TermClass);
 	}
 
 	/* Site Retrieval
@@ -149,14 +149,14 @@ 
 	 * @param array|bool $blog_ids
 	 * @return array
 	 */
-	public static function get_sites( $blog_ids = false ) {
-		if ( !is_array( $blog_ids ) ) {
+	public static function get_sites($blog_ids = false) {
+		if ( !is_array($blog_ids) ) {
 			global $wpdb;
-			$blog_ids = $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs ORDER BY blog_id ASC" );
+			$blog_ids = $wpdb->get_col("SELECT blog_id FROM $wpdb->blogs ORDER BY blog_id ASC");
 		}
 		$return = array();
-		foreach ( $blog_ids as $blog_id ) {
-			$return[] = new TimberSite( $blog_id );
+		foreach ($blog_ids as $blog_id) {
+			$return[] = new TimberSite($blog_id);
 		}
 		return $return;
 	}
@@ -174,9 +174,9 @@ 
 		$data = array();
 		$data['http_host'] = 'http://' . TimberURLHelper::get_host();
 		$data['wp_title'] = TimberHelper::get_wp_title();
-		$data['wp_head'] = TimberHelper::function_wrapper( 'wp_head' );
-		$data['wp_footer'] = TimberHelper::function_wrapper( 'wp_footer' );
-		$data['body_class'] = implode( ' ', get_body_class() );
+		$data['wp_head'] = TimberHelper::function_wrapper('wp_head');
+		$data['wp_footer'] = TimberHelper::function_wrapper('wp_footer');
+		$data['body_class'] = implode(' ', get_body_class());
 
 		$data['site'] = new TimberSite();
 		$data['request'] = new TimberRequest();
@@ -184,8 +184,8 @@ 
 
 		$data['posts'] = Timber::query_posts();
 
-		$data = apply_filters( 'timber_context', $data );
-		$data = apply_filters( 'timber/context', $data );
+		$data = apply_filters('timber_context', $data);
+		$data = apply_filters('timber/context', $data);
 		return $data;
 	}
 
@@ -199,27 +199,27 @@ 
 	 * @param bool    $via_render
 	 * @return bool|string
 	 */
-	public static function compile( $filenames, $data = array(), $expires = false, $cache_mode = TimberLoader::CACHE_USE_DEFAULT, $via_render = false ) {
+	public static function compile($filenames, $data = array(), $expires = false, $cache_mode = TimberLoader::CACHE_USE_DEFAULT, $via_render = false) {
 		$caller = self::get_calling_script_dir();
 		$caller_file = self::get_calling_script_file();
-		$caller_file = apply_filters( 'timber_calling_php_file', $caller_file );
-		$loader = new TimberLoader( $caller );
-		$file = $loader->choose_template( $filenames );
+		$caller_file = apply_filters('timber_calling_php_file', $caller_file);
+		$loader = new TimberLoader($caller);
+		$file = $loader->choose_template($filenames);
 		$output = '';
-		if ( is_null( $data ) ) {
+		if ( is_null($data) ) {
 			$data = array();
 		}
-		if ( strlen( $file ) ) {
+		if ( strlen($file) ) {
 			if ( $via_render ) {
-				$file = apply_filters( 'timber_render_file', $file );
-				$data = apply_filters( 'timber_render_data', $data );
+				$file = apply_filters('timber_render_file', $file);
+				$data = apply_filters('timber_render_data', $data);
 			} else {
-				$file = apply_filters( 'timber_compile_file', $file );
-				$data = apply_filters( 'timber_compile_data', $data );
+				$file = apply_filters('timber_compile_file', $file);
+				$data = apply_filters('timber_compile_data', $data);
 			}
-			$output = $loader->render( $file, $data, $expires, $cache_mode );
+			$output = $loader->render($file, $data, $expires, $cache_mode);
 		}
-		do_action( 'timber_compile_done' );
+		do_action('timber_compile_done');
 		return $output;
 	}
 
@@ -230,14 +230,14 @@ 
 	 * @param array   $data   an array with data in it.
 	 * @return  bool|string
 	 */
-	public static function compile_string( $string, $data = array() ) {
+	public static function compile_string($string, $data = array()) {
 		$dummy_loader = new TimberLoader();
 		$dummy_loader->get_twig();
 		$loader = new Twig_Loader_String();
-		$twig = new Twig_Environment( $loader );
-		$twig = apply_filters( 'timber/twig/filters', $twig );
-		$twig = apply_filters( 'twig_apply_filters', $twig );
-		return $twig->render( $string, $data );
+		$twig = new Twig_Environment($loader);
+		$twig = apply_filters('timber/twig/filters', $twig);
+		$twig = apply_filters('twig_apply_filters', $twig);
+		return $twig->render($string, $data);
 	}
 
 	/**
@@ -249,15 +249,15 @@ 
 	 * @param string  $cache_mode
 	 * @return bool|string
 	 */
-	public static function fetch( $filenames, $data = array(), $expires = false, $cache_mode = TimberLoader::CACHE_USE_DEFAULT ) {
+	public static function fetch($filenames, $data = array(), $expires = false, $cache_mode = TimberLoader::CACHE_USE_DEFAULT) {
 		if ( $expires === true ) {
 			//if this is reading as true; the user probably is using the old $echo param
 			//so we should move all vars up by a spot
 			$expires = $cache_mode;
 			$cache_mode = TimberLoader::CACHE_USE_DEFAULT;
 		}
-		$output = self::compile( $filenames, $data, $expires, $cache_mode, true );
-		$output = apply_filters( 'timber_compile_result', $output );
+		$output = self::compile($filenames, $data, $expires, $cache_mode, true);
+		$output = apply_filters('timber_compile_result', $output);
 		return $output;
 	}
 
@@ -270,8 +270,8 @@ 
 	 * @param string  $cache_mode
 	 * @return bool|string
 	 */
-	public static function render( $filenames, $data = array(), $expires = false, $cache_mode = TimberLoader::CACHE_USE_DEFAULT ) {
-		$output = static::fetch( $filenames, $data, $expires, $cache_mode );
+	public static function render($filenames, $data = array(), $expires = false, $cache_mode = TimberLoader::CACHE_USE_DEFAULT) {
+		$output = static::fetch($filenames, $data, $expires, $cache_mode);
 		echo $output;
 		return $output;
 	}
@@ -283,8 +283,8 @@ 
 	 * @param array   $data   an array with data in it.
 	 * @return  bool|string
 	 */
-	public static function render_string( $string, $data = array() ) {
-		$compiled = self::compile_string( $string, $data );
+	public static function render_string($string, $data = array()) {
+		$compiled = self::compile_string($string, $data);
 		echo $compiled;
 		return $compiled;
 	}
@@ -300,14 +300,14 @@ 
 	 * @param array   $data
 	 * @return bool|string
 	 */
-	public static function get_sidebar( $sidebar = '', $data = array() ) {
+	public static function get_sidebar($sidebar = '', $data = array()) {
 		if ( $sidebar == '' ) {
 			$sidebar = 'sidebar.php';
 		}
-		if ( strstr( strtolower( $sidebar ), '.php' ) ) {
-			return self::get_sidebar_from_php( $sidebar, $data );
+		if ( strstr(strtolower($sidebar), '.php') ) {
+			return self::get_sidebar_from_php($sidebar, $data);
 		}
-		return self::compile( $sidebar, $data );
+		return self::compile($sidebar, $data);
 	}
 
 	/**
@@ -317,21 +317,21 @@ 
 	 * @param array   $data
 	 * @return string
 	 */
-	public static function get_sidebar_from_php( $sidebar = '', $data ) {
+	public static function get_sidebar_from_php($sidebar = '', $data) {
 		$caller = self::get_calling_script_dir();
 		$loader = new TimberLoader();
-		$uris = $loader->get_locations( $caller );
+		$uris = $loader->get_locations($caller);
 		ob_start();
 		$found = false;
-		foreach ( $uris as $uri ) {
-			if ( file_exists( trailingslashit( $uri ) . $sidebar ) ) {
-				include trailingslashit( $uri ) . $sidebar;
+		foreach ($uris as $uri) {
+			if ( file_exists(trailingslashit($uri) . $sidebar) ) {
+				include trailingslashit($uri) . $sidebar;
 				$found = true;
 				break;
 			}
 		}
 		if ( !$found ) {
-			TimberHelper::error_log( 'error loading your sidebar, check to make sure the file exists' );
+			TimberHelper::error_log('error loading your sidebar, check to make sure the file exists');
 		}
 		$ret = ob_get_contents();
 		ob_end_clean();
@@ -347,8 +347,8 @@ 
 	 * @param int     $widget_id
 	 * @return TimberFunctionWrapper
 	 */
-	public static function get_widgets( $widget_id ) {
-		return trim( TimberHelper::function_wrapper( 'dynamic_sidebar', array( $widget_id ), true ) );
+	public static function get_widgets($widget_id) {
+		return trim(TimberHelper::function_wrapper('dynamic_sidebar', array($widget_id), true));
 	}
 
 
@@ -363,8 +363,8 @@ 
 	 * @param array   $args
 	 * @deprecated since 0.20.0
 	 */
-	public static function add_route( $route, $callback, $args = array() ) {
-		Routes::map( $route, $callback, $args );
+	public static function add_route($route, $callback, $args = array()) {
+		Routes::map($route, $callback, $args);
 	}
 
 	/**
@@ -372,8 +372,8 @@ 
 	 *
 	 * @deprecated since 0.20.0
 	 */
-	public static function load_template( $template, $query = false, $status_code = 200, $tparams = false ) {
-		return Routes::load( $template, $tparams, $query, $status_code );
+	public static function load_template($template, $query = false, $status_code = 200, $tparams = false) {
+		return Routes::load($template, $tparams, $query, $status_code);
 	}
 
 	/**
@@ -381,8 +381,8 @@ 
 	 *
 	 * @deprecated since 0.20.2
 	 */
-	public static function load_view( $template, $query = false, $status_code = 200, $tparams = false ) {
-		return Routes::load( $template, $tparams, $query, $status_code );
+	public static function load_view($template, $query = false, $status_code = 200, $tparams = false) {
+		return Routes::load($template, $tparams, $query, $status_code);
 	}
 
 
@@ -395,43 +395,43 @@ 
 	 * @param array   $prefs
 	 * @return array mixed
 	 */
-	public static function get_pagination( $prefs = array() ) {
+	public static function get_pagination($prefs = array()) {
 		global $wp_query;
 		global $paged;
 		global $wp_rewrite;
 		$args = array();
-		$args['total'] = ceil( $wp_query->found_posts / $wp_query->query_vars['posts_per_page'] );
+		$args['total'] = ceil($wp_query->found_posts / $wp_query->query_vars['posts_per_page']);
 		if ( $wp_rewrite->using_permalinks() ) {
-			$url = explode( '?', get_pagenum_link( 0 ) );
-			if ( isset( $url[1] ) ) {
-				parse_str( $url[1], $query );
+			$url = explode('?', get_pagenum_link(0));
+			if ( isset($url[1]) ) {
+				parse_str($url[1], $query);
 				$args['add_args'] = $query;
 			}
 			$args['format'] = 'page/%#%';
-			$args['base'] = trailingslashit( $url[0] ).'%_%';
+			$args['base'] = trailingslashit($url[0]) . '%_%';
 		} else {
 			$big = 999999999;
-			$args['base'] = str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) );
+			$args['base'] = str_replace($big, '%#%', esc_url(get_pagenum_link($big)));
 		}
 		$args['type'] = 'array';
-		$args['current'] = max( 1, get_query_var( 'paged' ) );
-		$args['mid_size'] = max( 9 - $args['current'], 3 );
-		if ( is_int( $prefs ) ) {
+		$args['current'] = max(1, get_query_var('paged'));
+		$args['mid_size'] = max(9 - $args['current'], 3);
+		if ( is_int($prefs) ) {
 			$args['mid_size'] = $prefs - 2;
 		} else {
-			$args = array_merge( $args, $prefs );
+			$args = array_merge($args, $prefs);
 		}
 		$data = array();
 		$data['current'] = $args['current'];
 		$data['total'] = $args['total'];
-		$data['pages'] = TimberHelper::paginate_links( $args );
-		$next = get_next_posts_page_link( $args['total'] );
+		$data['pages'] = TimberHelper::paginate_links($args);
+		$next = get_next_posts_page_link($args['total']);
 		if ( $next ) {
-			$data['next'] = array( 'link' => untrailingslashit( $next ), 'class' => 'page-numbers next' );
+			$data['next'] = array('link' => untrailingslashit($next), 'class' => 'page-numbers next');
 		}
-		$prev = previous_posts( false );
+		$prev = previous_posts(false);
 		if ( $prev ) {
-			$data['prev'] = array( 'link' => untrailingslashit( $prev ), 'class' => 'page-numbers prev' );
+			$data['prev'] = array('link' => untrailingslashit($prev), 'class' => 'page-numbers prev');
 		}
 		if ( $paged < 2 ) {
 			$data['prev'] = '';
@@ -447,10 +447,10 @@ 
 	 *
 	 * @return string
 	 */
-	public static function get_calling_script_dir( $offset = 0 ) {
-		$caller = self::get_calling_script_file( $offset );
-		if ( !is_null( $caller ) ) {
-			$pathinfo = pathinfo( $caller );
+	public static function get_calling_script_dir($offset = 0) {
+		$caller = self::get_calling_script_file($offset);
+		if ( !is_null($caller) ) {
+			$pathinfo = pathinfo($caller);
 			$dir = $pathinfo['dirname'];
 			return $dir;
 		}
@@ -463,11 +463,11 @@ 
 	 * @return string|null
 	 * @deprecated since 0.20.0
 	 */
-	public static function get_calling_script_file( $offset = 0 ) {
+	public static function get_calling_script_file($offset = 0) {
 		$caller = null;
 		$backtrace = debug_backtrace();
 		$i = 0;
-		foreach ( $backtrace as $trace ) {
+		foreach ($backtrace as $trace) {
 			if ( array_key_exists('file', $trace) && $trace['file'] != __FILE__ ) {
 				$caller = $trace['file'];
 				break;