<?php
/**
 * @since 3.0.0
 */

namespace GravityKit\GravityView\Search\Fields;

use \Gravity_Flow_API;
use \Gravity_Flow_Step;
use \GravityView_Field_Workflow_Step;
use GV\View;

/**
 * A search field for Gravity Flow Step fields.
 *
 * @since 2.42
 * @since 3.0.0 Migrated to PSR-4 namespace.
 */
final class SearchFieldGravityFlowStatusStep extends \GV\Search\Fields\Search_Field_Choices {
	/**
	 * The unique type for workflow fields.
	 *
	 * @since 2.42
	 *
	 * @var string
	 */
	protected static string $type = 'workflow_step_status';

	/**
	 * The inner step.
	 *
	 * @since 2.42
	 *
	 * @var \Gravity_Flow_Step|null
	 */
	private ?Gravity_Flow_Step $step = null;

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	protected static string $field_type = 'select';

	/**
	 * @inheritDoc
	 *
	 * Make only allow named constructors for this field, due to the dependencies.
	 *
	 * @since 2.42
	 */
	protected function __construct( ?string $label = null, array $data = [] ) {
		// Do not initialize here, it will be called on the named constructors to parse dependencies.
		parent::__construct( $label, $data, false );
	}

	/**
	 * Creates an instance from a Gravity Flow step.
	 *
	 * @since 2.42
	 *
	 * @param \Gravity_Flow_Step $step The step.
	 *
	 * @return self|null
	 */
	public static function from_step( Gravity_Flow_Step $step ): self {
		$label = sprintf(
			/* translators: %s: the Gravity Flow workflow step name. */
			_x( 'Status: %s', 'Gravity Flow Workflow Step Status', 'gk-gravityview' ),
			$step->get_name()
		);

		$instance       = new self( $label );
		$instance->step = $step;

		$instance->id         = $instance->get_type();
		$instance->item['id'] = $instance->id;
		$instance->form_id    = $step->get_form_id();

		$instance->init();

		return $instance;
	}

	/**
	 * Retrieves the step ID from the field ID.
	 *
	 * @since 2.42
	 *
	 * @return int|null
	 */
	private function get_step_id(): ?int {
		if ( $this->step ) {
			return $this->step->get_id();
		}

		$regex   = sprintf( '/%s_(\d+)/is', preg_quote( self::$type, '/' ) );
		$step_id = preg_match( $regex, $this->id, $matches ) ? (int) $matches[1] : null;

		return $step_id ?? null;
	}

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	public static function from_configuration(
		array $data,
		?View $view = null,
		array $additional_context = []
	): ?\GV\Search\Fields\Search_Field {
		$instance = parent::from_configuration( $data, $view, $additional_context );
		if ( ! $instance ) {
			return null;
		}

		// Retrieve the step field for this search field.
		$gravity_flow_api = new Gravity_Flow_API( $instance->form_id );
		$step             = $gravity_flow_api->get_step( $instance->get_step_id() );

		$instance->step = $step ? $step : null;

		return $instance;
	}

	/**
	 * Returns the workflow step ID.
	 *
	 * @since 2.42
	 *
	 * @return string|null The workflow step ID.
	 */
	private function step_status_id(): ?string {
		if ( ! $this->step ) {
			return null;
		}

		return sprintf( self::$type . '_%d', $this->step->get_id() );
	}

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	public function get_type(): string {
		if ( ! $this->step ) {
			return parent::get_type();
		}

		return sprintf( '%d::%s', $this->step->get_form_id(), $this->step_status_id() );
	}

	/**
	 * Returns the icon for the field.
	 *
	 * @since 2.42
	 *
	 * @return string
	 */
	protected function get_icon(): string {
		return ( new GravityView_Field_Workflow_Step() )->get_icon();
	}

	/**
	 * Returns the description for this field.
	 *
	 * @since 2.42
	 */
	public function get_description(): string {
		return esc_html__( 'Gravity Flow Step Status', 'gk-gravityview' );
	}

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	public function is_of_type( string $type ): bool {
		$test = sprintf( '%s_%d', self::$type, $this->get_step_id() );

		return strpos( $type, $test ) !== false;
	}

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	protected function get_key(): string {
		$field_id = $this->step_status_id();

		return $field_id ?? parent::get_key();
	}

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	public function satisfies( array $configuration ): bool {
		if ( $this->is_of_type( $configuration['id'] ?? '' ) ) {
			return true;
		}

		return parent::satisfies( $configuration );
	}

	/**
	 * @inheritDoc
	 * @since 2.42
	 */
	protected function get_choices(): array {
		if (
			! $this->step
			|| null === $this->step_status_id()
		) {
			return [];
		}

		$entry_meta = gravity_flow()->get_entry_meta( [], $this->step->get_form_id() );

		return (array) \GV\Utils::get( $entry_meta, $this->step_status_id() . '/filter/choices' );
	}
}
