File "Status_Labels.php"

Full Path: /home/romayxjt/public_html/wp-content/plugins/the-events-calendar/src/Tribe/Event_Status/Status_Labels.php
File size: 3.1 KB
MIME-type: text/x-php
Charset: utf-8

<?php
/**
 * The Event Status Labels.
 *
 * @since   5.11.0
 * @package Tribe\Events\Event_Status
 */

namespace Tribe\Events\Event_Status;

/**
 * Class Statuses
 *
 * @since   5.11.0
 *
 * @package Tribe\Events\Event_Status
 */
class Status_Labels {

	/**
	 * Add the event statuses to select for an event.
	 *
	 * @since 5.11.0
	 *
	 * @param array<string|mixed> $statuses       The event status options for an event.
	 * @param string              $current_status The current event status for the event or empty string if none.
	 *
	 * @return array<string|mixed> The event status options for an event.
	 */
	public function filter_event_statuses( $statuses, $current_status ) {
		$default_statuses = [
			[
				'text'     => $this->get_scheduled_label(),
				'id'       => 'scheduled',
				'value'    => 'scheduled',
				'selected' => 'scheduled' === $current_status ? true : false,
			],
			[
				'text'     => $this->get_canceled_label(),
				'id'       => 'canceled',
				'value'    => 'canceled',
				'selected' => 'canceled' === $current_status ? true : false,
			],
			[
				'text'     => $this->get_postponed_label(),
				'id'       => 'postponed',
				'value'    => 'postponed',
				'selected' => 'postponed' === $current_status ? true : false,
			]
		];

		$statuses = array_merge( $statuses, $default_statuses );

		return $statuses;
	}

	/**
	 * Get the event status label.
	 *
	 * @since 5.12.1
	 *
	 * @return string The label for the event status.
	 */
	public function get_event_status_label() {

		/**
		 * Filter the label for event status.
		 *
		 * @since 5.12.1
		 *
		 * @param string The default translated label for the event status.
		 */
		return apply_filters( 'tec_event_status_label', _x( 'Event Status', 'Event status label.', 'the-events-calendar' ) );
	}

	/**
	 * Get the scheduled status label.
	 *
	 * @since 5.11.0
	 *
	 * @return string The label for the scheduled status.
	 */
	public function get_scheduled_label() {

		/**
		 * Filter the scheduled label for event status.
		 *
		 * @since 5.11.0
		 *
		 * @param string The default translated label for the scheduled status.
		 */
		return apply_filters( 'tec_event_status_scheduled_label', _x( 'Scheduled', 'Scheduled label.', 'the-events-calendar' ) );
	}

	/**
	 * Get the canceled status label.
	 *
	 * @since 5.11.0
	 *
	 * @return string The label for the canceled status.
	 */
	public function get_canceled_label() {

		/**
		 * Filter the canceled label for event status.
		 *
		 * @since 5.11.0
		 *
		 * @param string The default translated label for the canceled status.
		 */
		return apply_filters( 'tec_event_status_canceled_label', _x( 'Canceled', 'Canceled label.', 'the-events-calendar' ) );
	}

	/**
	 * Get the postponed status label.
	 *
	 * @since 5.11.0
	 *
	 * @return string The label for the postponed status.
	 */
	public function get_postponed_label() {

		/**
		 * Filter the postponed label for event status.
		 *
		 * @since 5.11.0
		 *
		 * @param string The default translated label for the postponed status.
		 */
		return apply_filters( 'tec_event_status_postponed_label', _x( 'Postponed', 'Postponed label', 'the-events-calendar' ) );
	}
}