jarednova / timber

lib/timber-helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -176,7 +176,7 @@ 
 	 *
 	 *
 	 * @param mixed $arg that you want to error_log
-	 * @return void
+	 * @return null|boolean
 	 */
 	public static function error_log( $arg ) {
 		if ( !WP_DEBUG ) {
@@ -208,7 +208,7 @@ 
 	 *
 	 * @param string  $text
 	 * @param int     $num_words
-	 * @param string|null|false  $more text to appear in "Read more...". Null to use default, false to hide
+	 * @param boolean  $more text to appear in "Read more...". Null to use default, false to hide
 	 * @param string  $allowed_tags
 	 * @return string
 	 */

lib/timber-image-helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
 	 * Generates a new image with increased size, for display on Retina screens.
 	 *
 	 * @param string  $src
-	 * @param float   $multiplier
+	 * @param integer   $multiplier
 	 * @param boolean $force
 	 *
 	 * @return string url to the new image
@@ -136,7 +136,7 @@ 
 	 * @param int     $h
 	 * @param string  $color
 	 * @param bool    $force
-	 * @return mixed|null|string
+	 * @return string
 	 */
 	public static function letterbox( $src, $w, $h, $color = '#000000', $force = false ) {
 		$op = new TimberImageOperationLetterbox($w, $h, $color);

Indentation +15 added lines, -15 removed lines

@@ -108,23 +108,23 @@
 		//its a gif so test
 		if(!($fh = @fopen($file, 'rb'))) {
 		  	return false;
-	    }
-	    $count = 0;
-	    //an animated gif contains multiple "frames", with each frame having a
-	    //header made up of:
-	    // * a static 4-byte sequence (\x00\x21\xF9\x04)
-	    // * 4 variable bytes
-	    // * a static 2-byte sequence (\x00\x2C)
+		}
+		$count = 0;
+		//an animated gif contains multiple "frames", with each frame having a
+		//header made up of:
+		// * a static 4-byte sequence (\x00\x21\xF9\x04)
+		// * 4 variable bytes
+		// * a static 2-byte sequence (\x00\x2C)
 
-	    // We read through the file til we reach the end of the file, or we've found
-	    // at least 2 frame headers
-	    while(!feof($fh) && $count < 2) {
-	        $chunk = fread($fh, 1024 * 100); //read 100kb at a time
-	        $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', $chunk, $matches);
-	    }
+		// We read through the file til we reach the end of the file, or we've found
+		// at least 2 frame headers
+		while(!feof($fh) && $count < 2) {
+			$chunk = fread($fh, 1024 * 100); //read 100kb at a time
+			$count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', $chunk, $matches);
+		}
 
-	    fclose($fh);
-	    return $count > 1;
+		fclose($fh);
+		return $count > 1;
 	}
 
 	/**

lib/timber-image.php

Doc Comments +1 added lines, -1 removed lines

@@ -301,7 +301,7 @@
 	 * 	   <img src="{{ post.thumbnail.src|resize(500) }}" alt="A sumo wrestler" />
 	 * {% endif %}
 	 * ```
-	 * @return float
+	 * @return integer
 	 */
 	public function aspect() {
 		$w = intval($this->width());

lib/timber-menu-item.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
 	/**
 	 *
 	 * @internal
-	 * @return bool 
+	 * @return boolean|null 
 	 */
 	function update_child_levels() {
 		if (is_array($this->children)) {

lib/timber-menu.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 	public $title;
 
 	/**
-	 * @param int|string $slug
+	 * @param integer $slug
 	 */
 	function __construct($slug = 0) {
 		$locations = get_nav_menu_locations();

lib/timber-post.php

Doc Comments +6 added lines, -6 removed lines

@@ -225,7 +225,7 @@ 
 	/**
 	 * Initializes a TimberPost
 	 * @internal
-	 * @param int|bool $pid
+	 * @param integer $pid
 	 */
 	protected function init($pid = false) {
 		if ( $pid === false ) {
@@ -272,7 +272,7 @@ 
 	 * takes a mix of integer (post ID), string (post slug),
 	 * or object to return a WordPress post object from WP's built-in get_post() function
 	 * @internal
-	 * @param mixed $pid
+	 * @param integer $pid
 	 * @return WP_Post on success
 	 */
 	protected function prepare_post_info( $pid = 0 ) {
@@ -598,7 +598,7 @@ 
 	 * Gets a User object from the author of the post
 	 * @internal
 	 * @see TimberPost::author
-	 * @return bool|TimberUser
+	 * @return TimberUser|null
 	 */
 	function get_author() {
 		if ( isset($this->post_author) ) {
@@ -608,7 +608,7 @@ 
 
 	/**
 	 * @internal
-	 * @return bool|TimberUser
+	 * @return TimberUser|null
 	 */
 	function get_modified_author() {
 		$user_id = get_post_meta($this->ID, '_edit_last', true);
@@ -1073,7 +1073,7 @@ 
 	 *     <a href="{{post.author.link}}">{{post.author.name}}</a>
 	 * </p>
 	 * ```
-	 * @return TimberUser|bool A TimberUser object if found, false if not
+	 * @return TimberUser|null A TimberUser object if found, false if not
 	 */
 	public function author() {
 		return $this->get_author();
@@ -1088,7 +1088,7 @@ 
 	 * ```html
 	 * Last updated by Harper Lee
 	 * ```
-	 * @return TimberUser|bool A TimberUser object if found, false if not
+	 * @return TimberUser|null A TimberUser object if found, false if not
 	 */
 	public function modified_author() {
 		return $this->get_modified_author();

lib/timber-routes.php

Doc Comments +2 added lines, -1 removed lines

@@ -4,6 +4,7 @@ 
 
 	/**
 	 * @deprecated since 0.21.1 use Upstatement/routes instead
+	 * @param Timber $timber
 	 */
 	public static function init( $timber ) {
 		// Install ourselves in Timber
@@ -24,7 +25,7 @@ 
 	 * @param mixed $query
 	 * @param int $status_code
 	 * @param bool $tparams
-	 * @return bool
+	 * @return boolean|null
 	 * @deprecated since 0.21.1 use Upstatement/routes instead
 	 */
 	public static function load_view($template, $query = false, $status_code = 200, $tparams = false) {

lib/timber-url-helper.php

Doc Comments +7 added lines

@@ -136,6 +136,9 @@ 
 		return $path;
 	}
 
+	/**
+	 * @param string $fs
+	 */
 	public static function file_system_to_url( $fs ) {
 		$relative_path = self::get_rel_path( $fs );
 		$home = home_url( '/'.$relative_path );
@@ -210,6 +213,7 @@ 
 	/**
 	 * This will evaluate wheter a URL is at an aboslute location (like http://example.org/whatever)
 	 *
+	 * @param string $path
 	 * @return boolean true if $path is an absolute url, false if relative.
 	 */
 	public static function is_absolute( $path ) {
@@ -230,6 +234,9 @@ 
 		return $is_external;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	private static function is_internal_content($url) {
 		// using content_url() instead of site_url or home_url is IMPORTANT
 		// otherwise you run into errors with sites that:

lib/image/timber-image-operation.php

Indentation +8 added lines, -8 removed lines

@@ -1,13 +1,13 @@
 <?php
 /**
- * Each image filter is represented by a subclass of this class,m
- * and each filter call is a new instance, with call arguments as properties.
- * 
- * Only 3 methods need to be implemented:
- * - constructor, storing all filter arguments
- * - filename
- * - run
- */
+	 * Each image filter is represented by a subclass of this class,m
+	 * and each filter call is a new instance, with call arguments as properties.
+	 * 
+	 * Only 3 methods need to be implemented:
+	 * - constructor, storing all filter arguments
+	 * - filename
+	 * - run
+	 */
 abstract class TimberImageOperation {
 	/**
 	 * Builds the result filename, based on source filename and extension