<?php
class Tribe__Events__Featured_Events {
	const FEATURED_EVENT_KEY = '_tribe_featured';

	/**
	 * Marks an event as featured.
	 *
	 * @param int|WP_Post $event
	 *
	 * @return bool
	 */
	public function feature( $event = null ) {
		$event_id = Tribe__Main::post_id_helper( $event );

		if ( ! $event_id ) {
			return false;
		}

		return (bool) update_post_meta( $event_id, self::FEATURED_EVENT_KEY, true );
	}

	/**
	 * Clears the featured status of an event.
	 *
	 * @param int|WP_Post $event
	 *
	 * @return bool
	 */
	public function unfeature( $event= null ) {
		$event_id = Tribe__Main::post_id_helper( $event );

		if ( ! $event_id ) {
			return false;
		}

		return (bool) delete_post_meta( $event_id, self::FEATURED_EVENT_KEY );
	}

	/**
	 * Confirms if an event is featured.
	 * @param int|WP_Post $event
	 *
	 * @return bool
	 */
	public function is_featured( $event = null ) {
		$event_id = Tribe__Main::post_id_helper( $event );

		if ( ! $event_id ) {
			return false;
		}

		return (bool) get_post_meta( $event_id, self::FEATURED_EVENT_KEY, true );
	}

	/**
	 * Indicates is the specified query (or the current global WP_Query object if not
	 * specified) relates to featured events.
	 *
	 * @param WP_Query|null $query
	 *
	 * @return bool
	 */
	public function is_featured_query( WP_Query $query = null ) {
		if ( null === $query ) {
			$query = $GLOBALS['wp_query'];
		}

		return (bool) $query->get( 'featured' );
	}

	/**
	 * Indicates if 'featured' is set to a positive value either in the URL query
	 * or the posted data (if any).
	 *
	 * @return bool
	 */
	public function featured_events_requested() {
		return tribe_is_truthy( tribe_get_request_var( 'featured', false ) );
	}
}