<?php
/**
 * The Choices helpers.
 *
 * @since      0.9.0
 * @package    RankMath
 * @subpackage RankMath\Helpers
 * @author     Rank Math <support@rankmath.com>
 */

namespace RankMath\Helpers;

use RankMath\Helper;
use RankMath\Admin\Admin_Helper;

defined( 'ABSPATH' ) || exit;

/**
 * Choices class.
 */
trait Choices {

	/**
	 * Gets list of overlay images for social thumbnail.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param  string $output Output type.
	 * @return array
	 */
	public static function choices_overlay_images( $output = 'object' ) {
		$uri = rank_math()->plugin_url() . 'assets/admin/img/';
		$dir = rank_math()->plugin_dir() . 'assets/admin/img/';

		$list = apply_filters(
			'rank_math/social/overlay_images',
			[
				'play' => [
					'name' => esc_html__( 'Play icon', 'rank-math' ),
					'url'  => $uri . 'icon-play.png',
					'path' => $dir . 'icon-play.png',
				],
				'gif'  => [
					'name' => esc_html__( 'GIF icon', 'rank-math' ),
					'url'  => $uri . 'icon-gif.png',
					'path' => $dir . 'icon-gif.png',
				],
			]
		);

		return 'names' === $output ? wp_list_pluck( $list, 'name' ) : $list;
	}

	/**
	 * Get robot choices.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_robots() {
		return [
			'noindex'      => esc_html__( 'No Index', 'rank-math' ) . Admin_Helper::get_tooltip( esc_html__( 'Prevents pages from being indexed and displayed in search engine result pages', 'rank-math' ) ),
			'nofollow'     => esc_html__( 'No Follow', 'rank-math' ) . Admin_Helper::get_tooltip( esc_html__( 'Prevents search engines from following links on the pages', 'rank-math' ) ),
			'noarchive'    => esc_html__( 'No Archive', 'rank-math' ) . Admin_Helper::get_tooltip( esc_html__( 'Prevents search engines from showing Cached links for pages', 'rank-math' ) ),
			'noimageindex' => esc_html__( 'No Image Index', 'rank-math' ) . Admin_Helper::get_tooltip( esc_html__( 'Lets you specify that you do not want your pages to appear as the referring page for images that appear in image search results', 'rank-math' ) ),
			'nosnippet'    => esc_html__( 'No Snippet', 'rank-math' ) . Admin_Helper::get_tooltip( esc_html__( 'Prevents a snippet from being shown in the search results', 'rank-math' ) ),
		];
	}

	/**
	 * Get separator choices.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param  string $current Current saved separator if any.
	 * @return array
	 */
	public static function choices_separator( $current = '' ) {
		$defaults = [ '-', '&ndash;', '&mdash;', '&raquo;', '|', '&bull;' ];
		if ( ! $current || in_array( $current, $defaults, true ) ) {
			$current = '';
		}

		return [
			'-'       => '-',
			'&ndash;' => '&ndash;',
			'&mdash;' => '&mdash;',
			'&raquo;' => '&raquo;',
			'|'       => '|',
			'&bull;'  => '&bull;',
			$current  => '<span class="custom-sep" contenteditable>' . $current . '</span>',
		];
	}

	/**
	 * Get public post type as choices.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_post_types() {
		static $choices_post_types;

		if ( ! isset( $choices_post_types ) ) {
			$choices_post_types = Helper::get_accessible_post_types();
			$choices_post_types = \array_map( function( $post_type ) {
				$object = get_post_type_object( $post_type );
				return $object->label;
			}, $choices_post_types );
		}

		return $choices_post_types;
	}

	/**
	 * Get post types.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_any_post_types() {

		$post_types = self::choices_post_types();
		unset( $post_types['attachment'] );

		return [ 'any' => esc_html__( 'Any', 'rank-math' ) ] + $post_types + [ 'comments' => esc_html( translate( 'Comments' ) ) ]; // phpcs:ignore
	}

	/**
	 * Get business type as choices.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param  bool $none Add none option to list.
	 * @return array
	 */
	public static function choices_business_types( $none = false ) {
		$data = apply_filters(
			'rank_math/json_ld/business_types',
			[
				[ 'label' => 'Airport' ],
				[ 'label' => 'Animal Shelter' ],
				[ 'label' => 'Aquarium' ],
				[
					'label' => 'Automotive Business',
					'child' => [
						[ 'label' => 'Auto Body Shop' ],
						[ 'label' => 'Auto Dealer' ],
						[ 'label' => 'Auto Parts Store' ],
						[ 'label' => 'Auto Rental' ],
						[ 'label' => 'Auto Repair' ],
						[ 'label' => 'Auto Wash' ],
						[ 'label' => 'Gas Station' ],
						[ 'label' => 'Motorcycle Dealer' ],
						[ 'label' => 'Motorcycle Repair' ],
					],
				],
				[ 'label' => 'Beach' ],
				[ 'label' => 'Bus Station' ],
				[ 'label' => 'BusStop' ],
				[ 'label' => 'Campground' ],
				[ 'label' => 'Cemetery' ],
				[ 'label' => 'Child Care' ],
				[ 'label' => 'Corporation' ],
				[ 'label' => 'Crematorium' ],
				[ 'label' => 'Dry Cleaning or Laundry' ],
				[
					'label' => 'Educational Organization',
					'child' => [
						[ 'label' => 'College or University' ],
						[ 'label' => 'Elementary School' ],
						[ 'label' => 'High School' ],
						[ 'label' => 'Middle School' ],
						[ 'label' => 'Preschool' ],
						[ 'label' => 'School' ],
					],
				],
				[
					'label' => 'Emergency Service',
					'child' => [
						[ 'label' => 'Fire Station' ],
						[ 'label' => 'Hospital' ],
						[ 'label' => 'Police Station' ],
					],
				],
				[ 'label' => 'Employment Agency' ],
				[
					'label' => 'Entertainment Business',
					'child' => [
						[ 'label' => 'Adult Entertainment' ],
						[ 'label' => 'Amusement Park' ],
						[ 'label' => 'Art Gallery' ],
						[ 'label' => 'Casino' ],
						[ 'label' => 'Comedy Club' ],
						[ 'label' => 'Movie Theater' ],
						[ 'label' => 'Night Club' ],
					],
				],
				[ 'label' => 'Event Venue' ],
				[
					'label' => 'Financial Service',
					'child' => [
						[ 'label' => 'Accounting Service' ],
						[ 'label' => 'Automated Teller' ],
						[ 'label' => 'Bank or Credit Union' ],
						[ 'label' => 'Insurance Agency' ],
					],
				],
				[ 'label' => 'Fire Station' ],
				[
					'label' => 'Food Establishment',
					'child' => [
						[ 'label' => 'Bakery' ],
						[ 'label' => 'Bar or Pub' ],
						[ 'label' => 'Brewery' ],
						[ 'label' => 'Cafe or Coffee Shop' ],
						[ 'label' => 'Fast Food Restaurant' ],
						[ 'label' => 'Ice Cream Shop' ],
						[ 'label' => 'Restaurant' ],
						[ 'label' => 'Winery' ],
					],
				],
				[
					'label' => 'Government Building',
					'child' => [
						[ 'label' => 'City Hall' ],
						[ 'label' => 'Courthouse' ],
						[ 'label' => 'Defence Establishment' ],
						[ 'label' => 'Embassy' ],
						[ 'label' => 'Legislative Building' ],
					],
				],
				[
					'label' => 'Government Office',
					'child' => [
						[ 'label' => 'Post Office' ],
					],
				],
				[ 'label' => 'Government Organization' ],
				[
					'label' => 'Health And Beauty Business',
					'child' => [
						[ 'label' => 'Beauty Salon' ],
						[ 'label' => 'Day Spa' ],
						[ 'label' => 'Hair Salon' ],
						[ 'label' => 'Health Club' ],
						[ 'label' => 'Nail Salon' ],
						[ 'label' => 'Tattoo Parlor' ],
					],
				],
				[
					'label' => 'Home And Construction Business',
					'child' => [
						[ 'label' => 'Electrician' ],
						[ 'label' => 'General Contractor' ],
						[ 'label' => 'HVAC Business' ],
						[ 'label' => 'House Painter' ],
						[ 'label' => 'Locksmith' ],
						[ 'label' => 'Moving Company' ],
						[ 'label' => 'Plumber' ],
						[ 'label' => 'Roofing Contractor' ],
					],
				],
				[ 'label' => 'Hospital' ],
				[ 'label' => 'Internet Cafe' ],
				[ 'label' => 'Library' ],
				[ 'label' => 'Local Business' ],
				[
					'label' => 'Lodging Business',
					'child' => [
						[ 'label' => 'Bed And Breakfast' ],
						[ 'label' => 'Hostel' ],
						[ 'label' => 'Hotel' ],
						[ 'label' => 'Motel' ],
					],
				],
				[
					'label' => 'Medical Organization',
					'child' => [
						[ 'label' => 'Dentist' ],
						[ 'label' => 'Diagnostic Lab' ],
						[ 'label' => 'Hospital' ],
						[ 'label' => 'Medical Clinic' ],
						[ 'label' => 'Optician' ],
						[ 'label' => 'Pharmacy' ],
						[ 'label' => 'Physician' ],
						[ 'label' => 'Veterinary Care' ],
					],
				],
				[ 'label' => 'Movie Theater' ],
				[ 'label' => 'Museum' ],
				[ 'label' => 'Music Venue' ],
				[ 'label' => 'NGO' ],
				[ 'label' => 'Organization' ],
				[ 'label' => 'Park' ],
				[ 'label' => 'Parking Facility' ],
				[ 'label' => 'Performing Arts Theater' ],
				[
					'label' => 'Performing Group',
					'child' => [
						[ 'label' => 'Dance Group' ],
						[ 'label' => 'Music Group' ],
						[ 'label' => 'Theater Group' ],
					],
				],
				[
					'label' => 'Place Of Worship',
					'child' => [
						[ 'label' => 'Buddhist Temple' ],
						[ 'label' => 'Catholic Church' ],
						[ 'label' => 'Church' ],
						[ 'label' => 'Hindu Temple' ],
						[ 'label' => 'Mosque' ],
						[ 'label' => 'Synagogue' ],
					],
				],
				[ 'label' => 'Playground' ],
				[ 'label' => 'PoliceStation' ],
				[
					'label' => 'Professional Service',
					'child' => [
						[ 'label' => 'Accounting Service' ],
						[ 'label' => 'Legal Service' ],
						[ 'label' => 'Dentist' ],
						[ 'label' => 'Electrician' ],
						[ 'label' => 'General Contractor' ],
						[ 'label' => 'House Painter' ],
						[ 'label' => 'Locksmith' ],
						[ 'label' => 'Notary' ],
						[ 'label' => 'Plumber' ],
						[ 'label' => 'Roofing Contractor' ],
					],
				],
				[ 'label' => 'Radio Station' ],
				[ 'label' => 'Real Estate Agent' ],
				[ 'label' => 'Recycling Center' ],
				[
					'label' => 'Residence',
					'child' => [
						[ 'label' => 'Apartment Complex' ],
						[ 'label' => 'Gated Residence Community' ],
						[ 'label' => 'Single Family Residence' ],
					],
				],
				[ 'label' => 'RV Park' ],
				[ 'label' => 'Self Storage' ],
				[ 'label' => 'Shopping Center' ],
				[
					'label' => 'Sports Activity Location',
					'child' => [
						[ 'label' => 'Bowling Alley' ],
						[ 'label' => 'Exercise Gym' ],
						[ 'label' => 'Golf Course' ],
						[ 'label' => 'Health Club' ],
						[ 'label' => 'Public Swimming Pool' ],
						[ 'label' => 'Ski Resort' ],
						[ 'label' => 'Sports Club' ],
						[ 'label' => 'Stadium or Arena' ],
						[ 'label' => 'Tennis Complex' ],
					],
				],
				[ 'label' => 'Sports Team' ],
				[ 'label' => 'Stadium Or Arena' ],
				[
					'label' => 'Store',
					'child' => [
						[ 'label' => 'Auto Parts Store' ],
						[ 'label' => 'Bike Store' ],
						[ 'label' => 'Book Store' ],
						[ 'label' => 'Clothing Store' ],
						[ 'label' => 'Computer Store' ],
						[ 'label' => 'Convenience Store' ],
						[ 'label' => 'Department Store' ],
						[ 'label' => 'Electronics Store' ],
						[ 'label' => 'Florist' ],
						[ 'label' => 'Furniture Store' ],
						[ 'label' => 'Garden Store' ],
						[ 'label' => 'Grocery Store' ],
						[ 'label' => 'Hardware Store' ],
						[ 'label' => 'Hobby Shop' ],
						[ 'label' => 'HomeGoods Store' ],
						[ 'label' => 'Jewelry Store' ],
						[ 'label' => 'Liquor Store' ],
						[ 'label' => 'Mens Clothing Store' ],
						[ 'label' => 'Mobile Phone Store' ],
						[ 'label' => 'Movie Rental Store' ],
						[ 'label' => 'Music Store' ],
						[ 'label' => 'Office Equipment Store' ],
						[ 'label' => 'Outlet Store' ],
						[ 'label' => 'Pawn Shop' ],
						[ 'label' => 'Pet Store' ],
						[ 'label' => 'Shoe Store' ],
						[ 'label' => 'Sporting Goods Store' ],
						[ 'label' => 'Tire Shop' ],
						[ 'label' => 'Toy Store' ],
						[ 'label' => 'Wholesale Store' ],
					],
				],
				[ 'label' => 'Subway Station' ],
				[ 'label' => 'Television Station' ],
				[ 'label' => 'Tourist Information Center' ],
				[ 'label' => 'Train Station' ],
				[ 'label' => 'Travel Agency' ],
				[ 'label' => 'Taxi Stand' ],
				[ 'label' => 'Website' ],
				[ 'label' => 'Graphic Novel' ],
				[ 'label' => 'Zoo' ],
			]
		);

		$business = [];
		if ( $none ) {
			$business['off'] = 'None';
		}

		foreach ( $data as $item ) {
			$business[ str_replace( ' ', '', $item['label'] ) ] = $item['label'];

			if ( isset( $item['child'] ) ) {
				foreach ( $item['child'] as $child ) {
					$business[ str_replace( ' ', '', $child['label'] ) ] = '&mdash; ' . $child['label'];
				}
			}
		}

		return $business;
	}

	/**
	 * Gets rich snippet types as choices.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param  bool $none Add none option to the list.
	 * @return array
	 */
	public static function choices_rich_snippet_types( $none = false ) {
		$types = [
			'article'    => esc_html__( 'Article', 'rank-math' ),
			'book'       => esc_html__( 'Book', 'rank-math' ),
			'course'     => esc_html__( 'Course', 'rank-math' ),
			'event'      => esc_html__( 'Event', 'rank-math' ),
			'jobposting' => esc_html__( 'Job Posting', 'rank-math' ),
			'music'      => esc_html__( 'Music', 'rank-math' ),
			'product'    => esc_html__( 'Product', 'rank-math' ),
			'recipe'     => esc_html__( 'Recipe', 'rank-math' ),
			'restaurant' => esc_html__( 'Restaurant', 'rank-math' ),
			'video'      => esc_html__( 'Video', 'rank-math' ),
			'person'     => esc_html__( 'Person', 'rank-math' ),
			'review'     => esc_html__( 'Review', 'rank-math' ),
			'service'    => esc_html__( 'Service', 'rank-math' ),
			'software'   => esc_html__( 'Software Application', 'rank-math' ),
		];

		if ( is_string( $none ) ) {
			$types = [ 'off' => $none ] + $types;
		}

		return apply_filters( 'rank_math/settings/snippet/types', $types );
	}

	/**
	 * Gets redirection types.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_redirection_types() {
		return [
			'301' => esc_html__( '301 Permanent Move', 'rank-math' ),
			'302' => esc_html__( '302 Temporary Move', 'rank-math' ),
			'307' => esc_html__( '307 Temporary Redirect', 'rank-math' ),
			'410' => esc_html__( '410 Content Deleted', 'rank-math' ),
			'451' => esc_html__( '451 Content Unavailable for Legal Reasons', 'rank-math' ),
		];
	}

	/**
	 * Get comparison types.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_comparison_types() {
		return [
			'exact'    => esc_html__( 'Exact', 'rank-math' ),
			'contains' => esc_html__( 'Contains', 'rank-math' ),
			'start'    => esc_html__( 'Starts With', 'rank-math' ),
			'end'      => esc_html__( 'End With', 'rank-math' ),
			'regex'    => esc_html__( 'Regex', 'rank-math' ),
		];
	}

	/**
	 * Get Post type icons.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_post_type_icons() {
		/**
		 * Allow developer to change post types icons.
		 *
		 * @param array $icons Array of available icons.
		 */
		return apply_filters(
			'rank_math/post_type_icons',
			[
				'default'    => 'dashicons dashicons-admin-post',
				'post'       => 'dashicons dashicons-admin-post',
				'page'       => 'dashicons dashicons-admin-page',
				'attachment' => 'dashicons dashicons-admin-media',
				'product'    => 'fa fa-shopping-cart',
			]
		);
	}

	/**
	 * Get Taxonomy icons.
	 *
	 * @codeCoverageIgnore
	 *
	 * @return array
	 */
	public static function choices_taxonomy_icons() {
		/**
		 * Allow developer to change taxonomies icons.
		 *
		 * @param array $icons Array of available icons.
		 */
		return apply_filters(
			'rank_math/taxonomy_icons',
			[
				'default'     => 'dashicons dashicons-tag',
				'category'    => 'dashicons dashicons-category',
				'post_tag'    => 'dashicons dashicons-tag',
				'product_cat' => 'dashicons dashicons-category',
				'product_tag' => 'dashicons dashicons-tag',
				'post_format' => 'dashicons dashicons-format-image',
			]
		);
	}
}
