jarednova / timber

lib/image/timber-image-operation-resize.php

Doc Comments +5 added lines, -1 removed lines

@@ -41,6 +41,10 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param string $load_filename
+	 * @param string $save_filename
+	 */
 	protected function run_animated_gif( $load_filename, $save_filename ) {
 		$image = wp_get_image_editor( $load_filename );
 		$current_size = $image->get_size();
@@ -130,7 +134,7 @@ 
 	 *                               (ex: /src/var/www/wp-content/uploads/my-pic.jpg)
 	 * @param  string $save_filename filepath (not URL) where result file should be saved
 	 *                               (ex: /src/var/www/wp-content/uploads/my-pic-300x200-c-default.jpg)
-	 * @return bool                  true if everything went fine, false otherwise
+	 * @return boolean|null                  true if everything went fine, false otherwise
 	 */
 	public function run($load_filename, $save_filename) {
 		//should be resized by gif resizer

lib/image/timber-image-operation-tojpg.php

Doc Comments +1 added lines

@@ -48,6 +48,7 @@
 	}
 
 	/**
+	 * @param string $filename
 	 * @return resource an image identifier representing the image obtained from the given filename
 	 *                  will return the same data type regardless of whether the source is gif or png
 	 */

lib/timber-comment.php

Doc Comments -2 removed lines

@@ -240,8 +240,6 @@
 	 * Enqueue the WP threaded comments javascript,
 	 * and fetch the reply link for various comments.
 	 * @api
-	 * @param int $comment_id
-	 * @param int $post_id
 	 * @return string
 	 */
 	public function reply_link( $reply_text = 'Reply' ) {

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());

Indentation +2 added lines, -2 removed lines

@@ -373,8 +373,8 @@
 	 * @api
 	 * @example
 	 * ```twig
- 	 * <h1>{{post.title}}</h1>
- 	 * <img src="{{post.thumbnail.src}}" />
+	 * <h1>{{post.title}}</h1>
+	 * <img src="{{post.thumbnail.src}}" />
 	 * ```
 	 * ```html
 	 * <img src="http://example.org/wp-content/uploads/2015/08/pic.jpg" />

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();

Indentation +24 added lines, -24 removed lines

@@ -736,33 +736,33 @@
 			$overridden_cpage = true;
 		}
 
-    foreach($comments as $key => &$comment) {
-      $timber_comment = new $CommentClass($comment);
-      $timber_comment->reply_link = $this->TimberComment_reply_link($comment->comment_ID, $this->ID);
-      $timber_comments[$timber_comment->id] = $timber_comment;
-    }
+	foreach($comments as $key => &$comment) {
+	  $timber_comment = new $CommentClass($comment);
+	  $timber_comment->reply_link = $this->TimberComment_reply_link($comment->comment_ID, $this->ID);
+	  $timber_comments[$timber_comment->id] = $timber_comment;
+	}
 
 		// Build a flattened (depth=1) comment tree
 		$comments_tree = array();
-    foreach( $timber_comments as $key => $comment ) {
-      if ( ! $comment->is_child() ) {
-         continue;
-      }
-
-      $tree_element = $comment;
-      do {
-        $tree_element = $timber_comments[$tree_element->comment_parent];
-      } while($tree_element->is_child());
-      $comments_tree[$tree_element->id][] = $comment->id;
-    }
-
-    // Add child comments to the relative "super parents"
-    foreach($comments_tree as $comment_parent => $comment_children) {
-      foreach($comment_children as $comment_child) {
-        $timber_comments[$comment_parent]->children[] = $timber_comments[$comment_child];
-        unset($timber_comments[$comment_child]);
-      }
-    }
+	foreach( $timber_comments as $key => $comment ) {
+	  if ( ! $comment->is_child() ) {
+		 continue;
+	  }
+
+	  $tree_element = $comment;
+	  do {
+		$tree_element = $timber_comments[$tree_element->comment_parent];
+	  } while($tree_element->is_child());
+	  $comments_tree[$tree_element->id][] = $comment->id;
+	}
+
+	// Add child comments to the relative "super parents"
+	foreach($comments_tree as $comment_parent => $comment_children) {
+	  foreach($comment_children as $comment_child) {
+		$timber_comments[$comment_parent]->children[] = $timber_comments[$comment_child];
+		unset($timber_comments[$comment_child]);
+	  }
+	}
 
 		$timber_comments = array_values($timber_comments);