<?php
/**
 * Search Console report.
 *
 * @package TurtleReport
 */

namespace TurtleReport\Reports;

use TurtleReport\Policy\Segments;
use TurtleReport\Profiles\Profile;

defined( 'ABSPATH' ) || exit;

/**
 * Clicks, impressions, CTR and position by one dimension.
 */
final class SearchConsoleReport extends Report {

	/**
	 * {@inheritDoc}
	 *
	 * @return string
	 */
	public function id() {
		return 'search-console';
	}

	/**
	 * {@inheritDoc}
	 *
	 * @return string
	 */
	public function section() {
		return Profile::SECTION_SEARCH;
	}

	/**
	 * {@inheritDoc}
	 *
	 * @return string[]
	 */
	public function segment_types() {
		return array( Segments::TYPE_QUERY, Segments::TYPE_PAGE );
	}

	/**
	 * {@inheritDoc}
	 *
	 * @return array
	 */
	public function args() {
		return array(
			'dimension' => array(
				'type'     => 'string',
				'enum'     => array( 'date', 'page', 'query', 'country', 'device' ),
				'required' => true,
			),
		);
	}

	/**
	 * {@inheritDoc}
	 *
	 * @param Profile $site   Site.
	 * @param array   $params Parameters.
	 * @return array[]
	 */
	public function run( Profile $site, array $params ) {
		$segment = $this->segment( $site, $params );
		return $this->google->for_site( $site, Profile::SOURCE_SEARCH )->search_console()->query(
			$site->gsc_site,
			$params['dimension'],
			$params['start'],
			$params['end'],
			$site->search_type,
			$this->ttl( $params['end'] ),
			$segment ? SegmentFilter::gsc( $segment ) : array()
		);
	}
}