<?php
/**
 * Rank Math data reader.
 *
 * @package OrbitstemSEO
 */

namespace Orbitstem\SEO\Import;

defined( 'ABSPATH' ) || exit;

/**
 * Posts and terms both use rank_math_* meta. Robots is an array of
 * directives such as array( 'noindex', 'nofollow' ).
 * Formats checked against Rank Math 1.0.280.
 */
class RankMath extends Source {

	/**
	 * Machine id.
	 *
	 * @return string
	 */
	public function id() {
		return 'rank-math';
	}

	/**
	 * Display name.
	 *
	 * @return string
	 */
	public function name() {
		return 'Rank Math SEO';
	}

	/**
	 * Post (and term) meta keys by Orbitstem field.
	 *
	 * @return array<string,string>
	 */
	protected function post_keys() {
		return array(
			'title'         => 'rank_math_title',
			'description'   => 'rank_math_description',
			'canonical'     => 'rank_math_canonical_url',
			'noindex'       => 'rank_math_robots',
			'nofollow'      => 'rank_math_robots',
			'focus_keyword' => 'rank_math_focus_keyword',
		);
	}

	/**
	 * Rank Math variable names => Orbitstem variables.
	 *
	 * @return array<string,string>
	 */
	protected function variables() {
		return array(
			'title'            => '%title%',
			'excerpt'          => '%excerpt%',
			'excerpt_only'     => '%excerpt%',
			'sitename'         => '%sitename%',
			'sitedesc'         => '%tagline%',
			'sep'              => '%sep%',
			'page'             => '%page%',
			'term'             => '%term%',
			'term_description' => '%term_description%',
			'name'             => '%author%',
			'search_query'     => '%search%',
			'pt_plural'        => '%type%',
		);
	}

	/**
	 * Rank Math variables: %name% or %name(arguments)%, names may contain hyphens.
	 *
	 * @return string
	 */
	protected function token_pattern() {
		return '/%([a-z0-9_-]+)(?:\([^)]*\))?%/i';
	}

	/**
	 * Robots is stored as an array of directives.
	 *
	 * @param string $field Field.
	 * @param mixed  $raw   Stored value.
	 * @return bool
	 */
	protected function robots_flag( $field, $raw ) {
		return is_array( $raw ) && in_array( $field, $raw, true );
	}

	/**
	 * Term IDs with Rank Math term meta, after a cursor.
	 *
	 * @param int $after Last processed ID.
	 * @param int $limit Batch size.
	 * @return int[]
	 */
	protected function candidate_term_ids( $after, $limit ) {
		return $this->term_ids_from_meta( array_values( $this->post_keys() ), $after, $limit );
	}

	/**
	 * Raw values for one term.
	 *
	 * @param int $term_id Term ID.
	 * @return array
	 */
	protected function read_term_raw( $term_id ) {
		$raw = array();
		foreach ( $this->post_keys() as $field => $key ) {
			$raw[ $field ] = get_term_meta( $term_id, $key, true );
		}
		return $raw;
	}
}