FileMaster

Edit File: properties.php

<?php
/**
 * Property Registry
 *
 * This file handles all schema property definitions.
 *
 * @package surerank
 * @since 1.6.2
 */

namespace SureRank\Inc\Schema;

/**
 * Property Registry
 * This class manages all schema property definitions.
 *
 * @since 1.6.2
 */
class Properties {

/**
	 * Get property by name
	 *
	 * @param string               $name Property name.
	 * @param array<string, mixed> $args Additional arguments to merge.
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	public static function get( $name, $args = [] ) {
		$definitions = self::get_definitions();
		$property    = $definitions[ $name ] ?? [];

return array_replace_recursive( $property, $args );
	}

/**
	 * Get all property definitions
	 *
	 * @return array<string, array<string, mixed>>
	 * @since 1.6.2
	 */
	private static function get_definitions() {
		return [
			'type'                      => self::get_type_property(),
			'image'                     => self::get_image_property(),
			'product_image'             => self::get_product_image_property(),
			'name'                      => self::get_name_property(),
			'Answer'                    => self::get_answer_property(),
			'dateCreated'               => self::get_date_created_property(),
			'datePublished'             => self::get_date_published_property(),
			'dateModified'              => self::get_date_modified_property(),
			'description'               => self::get_description_property(),
			'url'                       => self::get_url_property(),
			'aggregateRating'           => self::get_aggregate_rating_property(),
			'VideoObject'               => self::get_video_object_property(),
			'address'                   => self::get_address_property(),
			'Person'                    => self::get_person_property(),
			'OpeningHoursSpecification' => self::get_opening_hours_specification_property(),
			'Review'                    => self::get_review_property(),
			'duration'                  => self::get_duration_property(),
			'QuantitativeValue'         => self::get_quantitative_value_property(),
			'mainEntity'                => self::get_main_entity_property(),
			'mainEntityOfPage'          => self::get_main_entity_of_page_property(),
		];
	}

/**
	 * Get type property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_type_property() {
		return [
			'id'       => '@type',
			'type'     => 'Hidden',
			'required' => true,
			'show'     => true,
		];
	}

/**
	 * Get image property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_image_property() {
		return [
			'id'        => 'image',
			'label'     => __( 'Image', 'surerank' ),
			'std'       => [ '%post.thumbnail%' ],
			'type'      => 'Image',
			'cloneable' => true,
			'show'      => true,
			'default'   => true,
		];
	}

/**
	 * Get product image property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_product_image_property() {
		return [
			'id'        => 'image',
			'label'     => __( 'Product Image', 'surerank' ),
			'std'       => [ '%product.image%' ],
			'type'      => 'Image',
			'cloneable' => true,
			'show'      => true,
			'default'   => true,
		];
	}

/**
	 * Get name property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_name_property() {
		return [
			'label'   => __( 'Name', 'surerank' ),
			'id'      => 'name',
			'std'     => '%post.title%',
			'show'    => true,
			'default' => true,
		];
	}

/**
	 * Get Answer property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_answer_property() {
		return [
			'type'   => 'Group',
			'show'   => true,
			'fields' => [
				[
					'id'       => '@type',
					'std'      => 'Answer',
					'type'     => 'Hidden',
					'required' => true,
				],
				[
					'id'       => 'text',
					'label'    => __( 'Text', 'surerank' ),
					'type'     => 'Textarea',
					'tooltip'  => __( 'The full instruction text of this step', 'surerank' ),
					'required' => true,
					'show'     => true,
					'default'  => true,
				],
				[
					'id'      => 'upvoteCount',
					'label'   => __( 'Upvote count', 'surerank' ),
					'tooltip' => __( 'The total number of votes that this question has received. If the page supports upvotes and downvotes, then set the upvoteCount value to a single aggregate value that represents both upvotes and downvotes.', 'surerank' ),
					'show'    => true,
					'default' => true,
				],
				[
					'id'      => 'url',
					'label'   => __( 'URL', 'surerank' ),
					'tooltip' => __( 'A URL that links directly to this answer.', 'surerank' ),
					'show'    => true,
					'default' => true,
				],
			],
		];
	}

/**
	 * Get dateCreated property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_date_created_property() {
		return [
			'id'      => 'dateCreated',
			'label'   => __( 'Created date', 'surerank' ),
			'type'    => 'Date',
			'show'    => true,
			'default' => true,
		];
	}

/**
	 * Get datePublished property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_date_published_property() {
		return [
			'id'      => 'datePublished',
			'label'   => __( 'Published date', 'surerank' ),
			'type'    => 'Date',
			'show'    => true,
			'default' => true,
		];
	}

/**
	 * Get dateModified property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_date_modified_property() {
		return [
			'id'      => 'dateModified',
			'label'   => __( 'Modified date', 'surerank' ),
			'type'    => 'Date',
			'show'    => true,
			'default' => true,
		];
	}

/**
	 * Get description property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_description_property() {
		return [
			'id'      => 'description',
			'label'   => __( 'Description', 'surerank' ),
			'type'    => 'Textarea',
			'std'     => '%post.excerpt%',
			'show'    => true,
			'default' => true,
		];
	}

/**
	 * Get url property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_url_property() {
		return [
			'id'      => 'url',
			'label'   => __( 'URL', 'surerank' ),
			'show'    => true,
			'default' => true,
		];
	}

/**
	 * Get aggregateRating property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_aggregate_rating_property() {
		return [
			'id'           => 'aggregateRating',
			'label'        => __( 'Aggregate rating', 'surerank' ),
			'type'         => 'Group',
			'propertyType' => 'AggregateRating',
			'show'         => true,
			'default'      => true,
			'tooltip'      => __( 'Include an overall rating based on customer reviews. This rating is used in structured data to reflect the product\'s average performance or satisfaction level.', 'surerank' ),
			'fields'       => [
				[
					'id'       => 'ratingValue',
					'label'    => __( 'Value', 'surerank' ),
					'std'      => '%product.rating%',
					'tooltip'  => __( 'Specify the actual score given to the product, such as \'4\', \'60%\', or \'6/10\'. This numeric value contributes to the aggregate rating in structured data.', 'surerank' ),
					'required' => true,
				],
				[
					'id'       => 'reviewCount',
					'label'    => __( 'Review count', 'surerank' ),
					'std'      => '%product.review_count%',
					'tooltip'  => __( 'Enter the total number of reviews the product has received. This helps search engines understand the product\'s popularity and display review count in rich results.', 'surerank' ),
					'required' => true,
				],
			],
		];
	}

/**
	 * Get VideoObject property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_video_object_property() {
		return [
			'id'      => 'video',
			'label'   => __( 'Video', 'surerank' ),
			'type'    => 'Group',
			'show'    => true,
			'default' => true,
			'fields'  => [
				[
					'id'       => '@type',
					'std'      => 'VideoObject',
					'type'     => 'Hidden',
					'required' => true,
				],
				[
					'label'    => __( 'Name', 'surerank' ),
					'id'       => 'name',
					'std'      => '%post.title%',
					'required' => true,
				],
				[
					'id'       => 'description',
					'label'    => __( 'Description', 'surerank' ),
					'type'     => 'Textarea',
					'std'      => '%post.content%',
					'required' => true,
				],
				[
					'id'       => 'thumbnailUrl',
					'label'    => __( 'Thumbnail URL', 'surerank' ),
					'tooltip'  => __( 'A URL pointing to the video thumbnail image file', 'surerank' ),
					'std'      => '%post.thumbnail%',
					'required' => true,
				],
				[
					'id'       => 'uploadDate',
					'label'    => __( 'Upload Date', 'surerank' ),
					'tooltip'  => __( 'The date the video was first published, in ISO 8601 format.', 'surerank' ),
					'type'     => 'Date',
					'std'      => '%post.date%',
					'required' => true,
				],
				[
					'id'      => 'contentURL',
					'label'   => __( 'Content URL', 'surerank' ),
					'tooltip' => __( 'A URL pointing to the actual video media file', 'surerank' ),
					'show'    => true,
				],
				[
					'id'      => 'embedURL',
					'label'   => __( 'Embed URL', 'surerank' ),
					'tooltip' => __( 'A URL pointing to a player for the specific video. Don\'t link to the page where the video lives; this must be the URL of the video player itself. Usually this is the information in the src element of an <embed> tag.', 'surerank' ),
				],
				[
					'id'      => 'duration',
					'label'   => __( 'Duration (min)', 'surerank' ),
					'tooltip' => __( 'The duration of the video in ISO 8601 format. For example, PT00H30M5S represents a duration of "thirty minutes and five seconds".', 'surerank' ),
				],
				[
					'id'      => 'expires',
					'label'   => __( 'Expires', 'surerank' ),
					'tooltip' => __( 'If applicable, the date after which the video will no longer be available, in ISO 8601 format. Don\'t supply this information if your video does not expire.', 'surerank' ),
				],
				[
					'id'               => 'hasPart',
					'label'            => __( 'Has part', 'surerank' ),
					'tooltip'          => __( 'If your video has important segments, specify them here', 'surerank' ),
					'type'             => 'Group',
					'cloneable'        => true,
					'cloneItemHeading' => __( 'Part', 'surerank' ),
					'fields'           => [
						[
							'id'       => '@type',
							'std'      => 'Clip',
							'type'     => 'Hidden',
							'required' => true,
						],
						[
							'label' => __( 'Name', 'surerank' ),
							'id'    => 'name',
							'show'  => true,
						],
						[
							'id'    => 'startOffset',
							'label' => __( 'Start offset', 'surerank' ),
							'show'  => true,
						],
						[
							'label' => __( 'URL', 'surerank' ),
							'id'    => 'url',
							'show'  => true,
						],
					],
				],
				[
					'id'     => 'interactionStatistic',
					'type'   => 'Group',
					'fields' => [
						[
							'id'       => '@type',
							'type'     => 'Hidden',
							'std'      => 'InteractionCounter',
							'required' => true,
						],
						[
							'id'       => 'interactionType',
							'type'     => 'Group',
							'required' => true,
							'fields'   => [
								[
									'id'       => '@type',
									'type'     => 'Hidden',
									'std'      => 'WatchAction',
									'required' => true,
								],
							],
						],
						[
							'id'       => 'userInteractionCount',
							'label'    => __( 'Interaction statistic', 'surerank' ),
							'tooltip'  => __( 'The number of times the video has been watched', 'surerank' ),
							'required' => true,
						],
					],
				],
			],
		];
	}

/**
	 * Get address property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_address_property() {
		return [
			'id'      => 'address',
			'label'   => __( 'Address', 'surerank' ),
			'type'    => 'Group',
			'show'    => true,
			'default' => true,
			'fields'  => [
				[
					'id'   => '@type',
					'std'  => 'PostalAddress',
					'type' => 'Hidden',
					'show' => true,
				],
				[
					'id'      => 'streetAddress',
					'label'   => __( 'Street address', 'surerank' ),
					'tooltip' => __( 'The detailed street address.', 'surerank' ),
					'show'    => true,
				],
				[
					'id'      => 'addressLocality',
					'label'   => __( 'Locality', 'surerank' ),
					'tooltip' => __( 'The locality in which the street address is, and which is in the region.', 'surerank' ),
					'show'    => true,
				],
				[
					'id'      => 'addressRegion',
					'label'   => __( 'Region', 'surerank' ),
					'tooltip' => __( 'The region in which the locality is, and which is in the country.', 'surerank' ),
					'show'    => true,
				],
				[
					'id'      => 'addressCountry',
					'label'   => __( 'Country', 'surerank' ),
					'tooltip' => __( 'The country. You can also provide the two-letter ISO 3166-1 alpha-2 country code.', 'surerank' ),
					'std'     => 'US',
					'show'    => true,
				],
				[
					'id'    => 'postalCode',
					'label' => __( 'Postal code', 'surerank' ),
					'show'  => true,
				],
			],
		];
	}

/**
	 * Get Person property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_person_property() {
		return [
			'type'    => 'Group',
			'show'    => true,
			'default' => true,
			'fields'  => [
				[
					'id'       => '@type',
					'std'      => 'Person',
					'type'     => 'Hidden',
					'required' => true,
				],
				[
					'id'       => 'name',
					'required' => true,
					'std'      => '%author.display_name%',
				],
			],
		];
	}

/**
	 * Get OpeningHoursSpecification property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_opening_hours_specification_property() {
		return [
			'type'      => 'Group',
			'cloneable' => true,
			'show'      => true,
			'default'   => true,
			'fields'    => [
				[
					'id'      => 'dayOfWeek',
					'label'   => __( 'Day of week', 'surerank' ),
					'tooltip' => __( 'The day of the week for which these opening hours are valid', 'surerank' ),
					'show'    => true,
					'type'    => 'Select',
					'options' => [
						'https://schema.org/Monday'    => __( 'Monday', 'surerank' ),
						'https://schema.org/Tuesday'   => __( 'Tuesday', 'surerank' ),
						'https://schema.org/Wednesday' => __( 'Wednesday', 'surerank' ),
						'https://schema.org/Thursday'  => __( 'Thursday', 'surerank' ),
						'https://schema.org/Friday'    => __( 'Friday', 'surerank' ),
						'https://schema.org/Saturday'  => __( 'Saturday', 'surerank' ),
						'https://schema.org/Sunday'    => __( 'Sunday', 'surerank' ),
					],
				],
				[
					'id'      => 'opens',
					'label'   => __( 'Opens', 'surerank' ),
					'tooltip' => __( 'The opening hour of the place or service on the given day(s) of the week, in hh:mm:ss format', 'surerank' ),
					'show'    => true,
					'width'   => '1/2',
				],
				[
					'id'      => 'closes',
					'label'   => __( 'Closes', 'surerank' ),
					'tooltip' => __( 'The closing hour of the place or service on the given day(s) of the week, in hh:mm:ss format', 'surerank' ),
					'show'    => true,
					'width'   => '1/2',
				],
				[
					'id'      => 'validFrom',
					'label'   => __( 'Valid from', 'surerank' ),
					'tooltip' => __( 'The date when the item becomes valid, in YYYY-MM-DD format', 'surerank' ),
					'width'   => '1/2',
				],
				[
					'id'      => 'validThrough',
					'label'   => __( 'Valid through', 'surerank' ),
					'tooltip' => __( 'The date after when the item is not valid, in YYYY-MM-DD format', 'surerank' ),
					'width'   => '1/2',
				],
			],
		];
	}

/**
	 * Get Review property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_review_property() {
		return [
			'id'               => 'review',
			'type'             => 'Group',
			'label'            => __( 'Reviews', 'surerank' ),
			'cloneable'        => true,
			'show'             => true,
			'default'          => true,
			'cloneItemHeading' => __( 'Review', 'surerank' ),
			'tooltip'          => __( 'Reviews of the item', 'surerank' ),
			'fields'           => [
				[
					'id'       => '@type',
					'std'      => 'Review',
					'type'     => 'Hidden',
					'required' => true,
				],
				[
					'id'     => 'author',
					'type'   => 'Group',
					'show'   => true,
					'fields' => [
						[
							'id'       => '@type',
							'std'      => 'Person',
							'type'     => 'Hidden',
							'required' => true,
						],
						[
							'id'       => 'name',
							'label'    => __( 'Author', 'surerank' ),
							'required' => true,
							'std'      => '%author.display_name%',
						],
					],
				],
				[
					'id'     => 'reviewRating',
					'type'   => 'Group',
					'label'  => __( 'Rating', 'surerank' ),
					'show'   => true,
					'fields' => [
						[
							'id'       => '@type',
							'std'      => 'Rating',
							'type'     => 'Hidden',
							'required' => true,
						],
						[
							'id'       => 'ratingValue',
							'label'    => __( 'Rating value', 'surerank' ),
							'required' => true,
							'type'     => 'DataList',
							'std'      => '5',
							'options'  => [
								1 => 1,
								2 => 2,
								3 => 3,
								4 => 4,
								5 => 5,
							],
						],
						[
							'id'      => 'bestRating',
							'label'   => __( 'Best rating', 'surerank' ),
							'type'    => 'DataList',
							'std'     => '5',
							'options' => [
								1 => 1,
								2 => 2,
								3 => 3,
								4 => 4,
								5 => 5,
							],
						],
						[
							'id'      => 'worstRating',
							'label'   => __( 'Worst rating', 'surerank' ),
							'type'    => 'DataList',
							'std'     => '1',
							'options' => [
								1 => 1,
								2 => 2,
								3 => 3,
								4 => 4,
								5 => 5,
							],
						],
					],
				],
				[
					'id'    => 'datePublished',
					'label' => __( 'Date published', 'surerank' ),
					'type'  => 'Date',
				],
			],
		];
	}

/**
	 * Get duration property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_duration_property() {
		return [
			'show'   => true,
			'fields' => [
				[
					'id'       => '@type',
					'std'      => 'QuantitativeValue',
					'type'     => 'Hidden',
					'required' => true,
				],
				[
					'id'    => 'value',
					'label' => __( 'Value', 'surerank' ),
					'show'  => true,
				],
				[
					'id'    => 'minValue',
					'label' => __( 'Min value', 'surerank' ),
				],
				[
					'id'    => 'maxValue',
					'label' => __( 'Max value', 'surerank' ),
				],
				[
					'id'      => 'unitText',
					'label'   => __( 'Unit text', 'surerank' ),
					'type'    => 'Select',
					'std'     => 'MONTH',
					'tooltip' => __( 'A string or text indicating the unit of measurement.', 'surerank' ),
					'options' => [
						'HOUR'  => __( 'Hour', 'surerank' ),
						'DAY'   => __( 'Day', 'surerank' ),
						'WEEK'  => __( 'Week', 'surerank' ),
						'MONTH' => __( 'Month', 'surerank' ),
						'YEAR'  => __( 'Year', 'surerank' ),
					],
				],
			],
		];
	}

/**
	 * Get QuantitativeValue property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_quantitative_value_property() {
		return [
			'show'   => true,
			'fields' => [
				[
					'id'       => '@type',
					'std'      => 'QuantitativeValue',
					'type'     => 'Hidden',
					'required' => true,
				],
				[
					'id'    => 'value',
					'label' => __( 'Value', 'surerank' ),
					'show'  => true,
				],
				[
					'id'    => 'minValue',
					'label' => __( 'Min value', 'surerank' ),
				],
				[
					'id'    => 'maxValue',
					'label' => __( 'Max value', 'surerank' ),
				],
				[
					'id'      => 'unitText',
					'label'   => __( 'Unit text', 'surerank' ),
					'tooltip' => __( 'A string or text indicating the unit of measurement.', 'surerank' ),
					'show'    => true,
				],
			],
		];
	}

/**
	 * Get mainEntity property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_main_entity_property() {
		return [
			'id'          => 'mainEntity',
			'label'       => __( 'Main entity', 'surerank' ),
			'tooltip'     => __( 'Indicates the primary entity described in some page or other CreativeWork.', 'surerank' ),
			'description' => __( 'Please create a schema and link to this property via a dynamic variable', 'surerank' ),
			'show'        => true,
		];
	}

/**
	 * Get mainEntityOfPage property
	 *
	 * @return array<string, mixed>
	 * @since 1.6.2
	 */
	private static function get_main_entity_of_page_property() {
		return [
			'id'      => 'mainEntityOfPage',
			'label'   => __( 'Main entity of page', 'surerank' ),
			'tooltip' => __( 'Identify the main entity being described on the page, such as an article, product, or event. This helps search engines understand the primary focus of the page through structured data.', 'surerank' ),
			'std'     => '%schemas.webpage%',
			'show'    => true,
			'default' => true,
		];
	}
}

Back