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
 	 */

Braces +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 	 *                               (ex: /src/var/www/wp-content/uploads/my-pic.png)
 	 * @return bool                  true if everything went fine, false otherwise
 	 */
-	function run($load_filename, $save_filename){
+	function run($load_filename, $save_filename) {
 		$input = self::image_create( $load_filename );
 		list( $width, $height ) = getimagesize( $load_filename );
 		$output = imagecreatetruecolor( $width, $height );

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' ) {

Braces +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
 		$this->init($cid);
 	}
 
-	function __toString(){
+	function __toString() {
 		return $this->content();
 	}
 

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
 	 */

Braces +3 added lines, -2 removed lines

@@ -48,8 +48,9 @@
 
 			// lock timeout shouldn't be higher than 5 seconds, unless
 			// remote calls with high timeouts are made here
-			if ( $enable_transients )
-				self::_lock_transient( $slug, $lock_timeout );
+			if ( $enable_transients ) {
+							self::_lock_transient( $slug, $lock_timeout );
+			}
 
 			$data = $callback();
 

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

Braces +2 added lines, -1 removed lines

@@ -325,7 +325,8 @@
 		);
 		$upload_dir = wp_upload_dir();
 		$tmp = $url;
-		if ( 0 === strpos($tmp, ABSPATH) ) { // we've been given a dir, not an url
+		if ( 0 === strpos($tmp, ABSPATH) ) {
+// we've been given a dir, not an url
 			$result['absolute'] = true;
 			if ( 0 === strpos($tmp, $upload_dir['basedir']) ) {
 				$result['base']= self::BASE_UPLOADS; // upload based

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

Braces +5 added lines, -5 removed lines

@@ -101,7 +101,7 @@ 
 		$menu = wp_get_nav_menu_items($menu_id);
 		if ($menu) {
 			_wp_menu_item_classes_by_context($menu);
-			if (is_array($menu)){
+			if (is_array($menu)) {
 				$menu = self::order_children($menu);
 			}
 			$this->items = $menu;
@@ -123,7 +123,7 @@ 
 				$mi->__title = $mi->post_title;
 			}
 			_wp_menu_item_classes_by_context($menu);
-			if (is_array($menu)){
+			if (is_array($menu)) {
 				$menu = self::order_children($menu);
 			}
 			$this->items = $menu;
@@ -201,13 +201,13 @@ 
 				$item->__title = $item->title;
 				unset($item->title);
 			}
-			if(isset($item->ID)){
-				if (is_object($item) && get_class($item) == 'WP_Post'){
+			if(isset($item->ID)) {
+				if (is_object($item) && get_class($item) == 'WP_Post') {
 					$old_menu_item = $item;
 					$item = new $this->PostClass($item);
 				}
 				$menu_item = new $this->MenuItemClass($item);
-				if (isset($old_menu_item)){
+				if (isset($old_menu_item)) {
 					$menu_item->import_classes($old_menu_item);
 				}
 				$index[$item->ID] = $menu_item;

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

Braces +4 added lines, -4 removed lines

@@ -188,13 +188,13 @@ 
 			&& get_class($wp_query->queried_object) == 'WP_Post'
 			) {
 			$pid = $wp_query->queried_object_id;
-		} else if ( $pid === null && $wp_query->is_home && isset($wp_query->queried_object_id) && $wp_query->queried_object_id )  {
+		} else if ( $pid === null && $wp_query->is_home && isset($wp_query->queried_object_id) && $wp_query->queried_object_id ) {
 			//hack for static page as home page
 			$pid = $wp_query->queried_object_id;
 		} else if ( $pid === null ) {
 			$gtid = false;
 			$maybe_post = get_post();
-			if ( isset($maybe_post->ID) ){
+			if ( isset($maybe_post->ID) ) {
 				$gtid = true;
 			}
 			if ( $gtid ) {
@@ -1028,7 +1028,7 @@ 
 		$post = $this;
 		$class_array = get_post_class($class, $this->ID);
 		$post = $old_global_post;
-		if ( is_array($class_array) ){
+		if ( is_array($class_array) ) {
 			return implode(' ', $class_array);
 		}
 		return $class_array;
@@ -1248,7 +1248,7 @@ 
 	/**
 	 * @return string
 	 */
-	public function name(){
+	public function name() {
 		return $this->title();
 	}