<?php
/**
 * Operation descriptor.
 *
 * @package Recast\WCS
 */

namespace Recast\WCS\Operation;

defined( 'ABSPATH' ) || exit;

/**
 * Static facts about an operation for the UI: label, param schema, flags.
 */
final class OperationDescriptor {


	/**
	 * Operation id.
	 *
	 * @var string
	 */
	public $id;

	/**
	 * Label.
	 *
	 * @var string
	 */
	public $label;

	/**
	 * Description.
	 *
	 * @var string
	 */
	public $description;


	/**
	 * Param schema.
	 *
	 * @var ParamSchema
	 */
	public $schema;

	/**
	 * Whether applied runs can be undone.
	 *
	 * @var bool
	 */
	public $undoable;

	/**
	 * Free-form flags (e.g. 'suppress_emails_default', 'touches_dates', 'touches_money').
	 *
	 * @var string[]
	 */
	public $flags;

	/**
	 * Group for the picker (price|schedule|field|journal|dev).
	 *
	 * @var string
	 */
	public $group;

	/**
	 * Constructor.
	 *
	 * @param string      $id          Id.
	 * @param string      $label       Label.
	 * @param string      $description Description.
	 * @param ParamSchema $schema      Schema.
	 * @param bool        $undoable    Undoable.
	 * @param string[]    $flags       Flags.
	 * @param string      $group       Group.
	 */
	public function __construct( $id, $label, $description, ParamSchema $schema, $undoable = true, array $flags = array(), $group = 'field' ) {
		$this->id          = $id;
		$this->label       = $label;
		$this->description = $description;
		$this->schema      = $schema;
		$this->undoable    = (bool) $undoable;
		$this->flags       = $flags;
		$this->group       = $group;
	}


	/**
	 * REST/UI form.
	 *
	 * @return array<string, mixed>
	 */
	public function to_array() {
		return array(
			'id'           => $this->id,
			'label'        => $this->label,
			'description'  => $this->description,
			'undoable'     => $this->undoable,
			'flags'        => array_values( $this->flags ),
			'group'        => $this->group,
			'param_schema' => $this->schema->to_array(),
		);
	}
}