<?php
/**
 * Canonical form field model.
 *
 * @package ModelGainWebmcpForms
 */

namespace ModelGain\WordPress\WebmcpForms;

/**
 * Provider-independent field contract.
 */
final class Field {
	/**
	 * Property value.
	 *
	 * @var string
	 */
	private $name;
	/**
	 * Property value.
	 *
	 * @var string
	 */
	private $type;
	/**
	 * Property value.
	 *
	 * @var string
	 */
	private $label;
	/**
	 * Property value.
	 *
	 * @var bool
	 */
	private $required;
	/**
	 * Property value.
	 *
	 * @var string[]
	 */
	private $options;
	/**
	 * Property value.
	 *
	 * @var string
	 */
	private $provider_type;

	/**
	 * Perform the documented operation.
	 *
	 * @param string   $name Provider field name.
	 * @param string   $type Canonical type.
	 * @param string   $label Human-readable label.
	 * @param bool     $required Whether the field is required.
	 * @param string[] $options Enumerated values.
	 * @param string   $provider_type Original provider type.
	 */
	public function __construct( $name, $type, $label, $required, array $options = array(), $provider_type = '' ) {
		$this->name          = (string) $name;
		$this->type          = (string) $type;
		$this->label         = (string) $label;
		$this->required      = (bool) $required;
		$this->options       = array_values( array_unique( array_map( 'strval', $options ) ) );
		$this->provider_type = (string) $provider_type;
	}

	/**
	 * Return the field name.
	 *
	 * @return string
	 */
	public function name() {
		return $this->name;
	}
	/**
	 * Return the canonical type.
	 *
	 * @return string
	 */
	public function type() {
		return $this->type;
	}
	/**
	 * Return the field label.
	 *
	 * @return string
	 */
	public function label() {
		return $this->label;
	}
	/**
	 * Return whether the field is required.
	 *
	 * @return bool
	 */
	public function required() {
		return $this->required;
	}
	/**
	 * Return enumerated values.
	 *
	 * @return string[]
	 */
	public function options() {
		return $this->options;
	}
	/**
	 * Return the provider type.
	 *
	 * @return string
	 */
	public function provider_type() {
		return $this->provider_type;
	}

	/**
	 * Perform the documented operation.
	 *
	 * @return array<string,mixed>
	 */
	public function to_array() {
		return array(
			'name'          => $this->name,
			'type'          => $this->type,
			'label'         => $this->label,
			'required'      => $this->required,
			'options'       => $this->options,
			'provider_type' => $this->provider_type,
		);
	}
}