TimberPostGetter

Complexity

Total Complexity

36

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	4
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	get_posts()	0	4	1
A	get_post()	0	6	2
A	query_post()	0	6	3
C	query_posts()	0	22	9
A	get_pids()	0	10	3
A	loop_to_id()	0	13	4
A	wp_query_has_posts()	0	4	3
A	is_post_class_or_class_map()	0	10	4
B	get_class_for_use_as_timber_post()	0	15	7

<?php

class TimberPostGetter {

	/**
	 * @param mixed $query
	 * @param string $PostClass
	 * @return array|bool|null
	 */
	static function get_post($query = false, $PostClass = 'TimberPost') {

It is generally recommended to explicitly declare the visibility for methods.

		$posts = self::get_posts( $query, $PostClass );
		if ( $post = reset($posts ) ) {
			return $post;
		}
	}

	static function get_posts( $query = false, $PostClass = 'TimberPost', $return_collection = false ) {

It is generally recommended to explicitly declare the visibility for methods.

		$posts = self::query_posts( $query, $PostClass );
		return apply_filters('timber_post_getter_get_posts', $posts->get_posts( $return_collection ));

The call to TimberPostsCollection::get_posts() has too many arguments starting with $return_collection.

	}

	static function query_post( $query = false, $PostClass = 'TimberPost' ) {

It is generally recommended to explicitly declare the visibility for methods.

		$posts = self::query_posts( $query, $PostClass );
		if ( method_exists($posts, 'current') && $post = $posts->current() ) {

The method current does only exist in TimberQueryIterator, but not in TimberPostsCollection.

			return $post;
		}
	}

	/**
	 * @param mixed $query
	 * @param string $PostClass
	 * @return array|bool|null

Should the return type not be TimberPostsCollection|TimberQueryIterator?

	 */
	static function query_posts($query = false, $PostClass = 'TimberPost' ) {

It is generally recommended to explicitly declare the visibility for methods.

		if ( $type = self::get_class_for_use_as_timber_post($query) ) {
			$PostClass = $type;
			if ( self::is_post_class_or_class_map($query) ) {
				$query = false;
			}
		}

		if (is_object($query) && !is_a($query, 'WP_Query') ){
			// The only object other than a query is a type of post object
			$query = array( $query );
		}

		if ( is_array( $query ) && count( $query ) && isset( $query[0] ) && is_object( $query[0] ) ) {
			// We have an array of post objects that already have data
			return new TimberPostsCollection( $query, $PostClass );

It seems like $PostClass defined by $type on line 36 can also be of type boolean; however, TimberPostsCollection::__construct() does only seem to accept string, maybe add an additional type check?

		} else {
			// We have a query (of sorts) to work with
			$tqi = new TimberQueryIterator( $query, $PostClass );

It seems like $PostClass defined by $type on line 36 can also be of type boolean; however, TimberQueryIterator::__construct() does only seem to accept string, maybe add an additional type check?

			return $tqi;
		}
	}

	static function get_pids($query){

It is generally recommended to explicitly declare the visibility for methods.

		$posts = self::get_posts($query);
		$pids = array();
		foreach($posts as $post){
			if (isset($post->ID)){
				$pids[] = $post->ID;
			}
		}
		return $pids;
	}

	static function loop_to_id() {

It is generally recommended to explicitly declare the visibility for methods.

		if (!self::wp_query_has_posts()) { return false; }

		global $wp_query;
		$post_num = property_exists($wp_query, 'current_post')
				  ? $wp_query->current_post + 1
				  : 0
				  ;

		if (!isset($wp_query->posts[$post_num])) { return false; }

		return $wp_query->posts[$post_num]->ID;
	}

	/**
	 * @return bool
	 */
	static function wp_query_has_posts() {

It is generally recommended to explicitly declare the visibility for methods.

		global $wp_query;
		return ($wp_query && property_exists($wp_query, 'posts') && $wp_query->posts);
	}

	/**
	 * @param string|array $arg
	 * @return bool

Should the return type not be boolean|null?

	 */
	static function is_post_class_or_class_map($arg){

It is generally recommended to explicitly declare the visibility for methods.

		$maybe_type = self::get_class_for_use_as_timber_post( $arg );
		if ( is_array($arg) && isset($arg['post_type'])) {
			//the user has passed a true WP_Query-style query array that needs to be used later, so the $arg is not a class map or post class
			return false;
		}
		if ( $maybe_type ) {
			return true;
		}
	}

	/**
	 * @param string|array $arg
	 * @return string|bool if a $type is found; false if not
	 */
	static function get_class_for_use_as_timber_post($arg) {

It is generally recommended to explicitly declare the visibility for methods.

		$type = false;

		if ( is_string($arg) ) {
			$type = $arg;
		} else if ( is_array($arg) && isset($arg['post_type']) ) {
			$type = $arg['post_type'];
		}

		if(!$type) return false;

		if (class_exists($type) && is_subclass_of($type, 'TimberPost')) {
			return $type;
		}
	}
}