<?php
/**
 * The SEO Framework data reader.
 *
 * @package OrbitstemSEO
 */

namespace Orbitstem\SEO\Import;

defined( 'ABSPATH' ) || exit;

/**
 * Posts: _genesis_* post meta (shared with the Genesis framework). Terms:
 * one serialized array in the autodescription-term-settings term meta, saved
 * for every term edited even when all values are empty (those are skipped).
 * Robots values: 1 = force on, -1 = force off, 0 = default. No variables.
 * Formats checked against The SEO Framework 5.2.0.
 */
class Tsf extends Source {

	const TERM_KEY = 'autodescription-term-settings';

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

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

	/**
	 * Post meta keys by Orbitstem field.
	 *
	 * @return array<string,string>
	 */
	protected function post_keys() {
		return array(
			'title'       => '_genesis_title',
			'description' => '_genesis_description',
			'canonical'   => '_genesis_canonical_uri',
			'noindex'     => '_genesis_noindex',
			'nofollow'    => '_genesis_nofollow',
		);
	}

	/**
	 * Term IDs with TSF term settings, 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( self::TERM_KEY ), $after, $limit );
	}

	/**
	 * Raw values for one term.
	 *
	 * @param int $term_id Term ID.
	 * @return array
	 */
	protected function read_term_raw( $term_id ) {
		$fields = get_term_meta( $term_id, self::TERM_KEY, true );
		$fields = is_array( $fields ) ? $fields : array();
		return array(
			'title'       => isset( $fields['doctitle'] ) ? $fields['doctitle'] : '',
			'description' => isset( $fields['description'] ) ? $fields['description'] : '',
			'canonical'   => isset( $fields['canonical'] ) ? $fields['canonical'] : '',
			'noindex'     => isset( $fields['noindex'] ) ? $fields['noindex'] : '',
			'nofollow'    => isset( $fields['nofollow'] ) ? $fields['nofollow'] : '',
		);
	}
}