Carbon_Breadcrumb_Locator_Date

Complexity

Total Complexity

10

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	is_included()	0	3	1
A	get_items()	0	19	3
A	get_archive_item_details()	0	19	4
A	generate_items()	0	7	2

<?php
/**
 * Date archive breadcrumb item locator
 *
 * @package carbon-breadcrumbs
 */

/**
 * Date archive breadcrumb item locator class.
 *
 * Used to locate the breadcrumb items for date archives.
 */
class Carbon_Breadcrumb_Locator_Date extends Carbon_Breadcrumb_Locator {

	/**
	 * Whether this the items of this locator should be included in the trail.
	 *
	 * @access public
	 *
	 * @return bool $is_included Whether the found items should be included.
	 */
	public function is_included() {
		return is_date();
	}

	/**
	 * Retrieve the items, found by this locator.
	 *
	 * @access public
	 *
	 * @param int $priority The priority of the located items.
	 * @param int $id Not used.
	 * @return array $items The items, found by this locator.
	 */
	public function get_items( $priority = 1000, $id = 0 ) {
		$items = array();

		// Prepare the date archive item details.
		$date_archives = $this->get_archive_item_details();

		// Add the associated date archive breadcrumb items.
		foreach ( $date_archives as $archive_name => $archive_details ) {
			if ( $archive_details['condition'] ) {
				$item = Carbon_Breadcrumb_Item::factory( 'custom', $priority );
				$item->set_title( get_the_time( $archive_details['title_format'] ) );
				$item->set_link( $archive_details['link'] );
				$item->setup();
				$items[] = $item;
			}
		}

		return $items;
	}

	/**
	 * Prepare the date archive conditions, with the corresponding title format and link.
	 *
	 * @access public
	 *
	 * @return array $details Date archive details.
	 */
	public function get_archive_item_details() {
		return array(
			'year'  => array(
				'condition'    => is_year() || is_month() || is_day(),
				'title_format' => 'Y',
				'link'         => get_year_link( get_query_var( 'year' ) ),
			),
			'month' => array(
				'condition'    => is_month() || is_day(),
				'title_format' => 'F',
				'link'         => get_month_link( get_query_var( 'year' ), get_query_var( 'monthnum' ) ),
			),
			'day'   => array(
				'condition'    => is_day(),
				'title_format' => 'd',
				'link'         => get_day_link( get_query_var( 'year' ), get_query_var( 'monthnum' ), get_query_var( 'day' ) ),
			),
		);
	}

	/**
	 * Generate a set of breadcrumb items that found by this locator type and any subtype.
	 * The date archive locator has no subtypes, so this method wraps around get_items().
	 *
	 * @access public
	 *
	 * @return array $items The items, generated by this locator.
	 */
	public function generate_items() {
		if ( ! $this->is_included() ) {
			return array();
		}

		return $this->get_items();
	}

}