<?php
/**
 * Result of building one advert: the listing plus errors (block publishing) and warnings.
 *
 * @package Tidelist
 */

namespace Tidelist\Build;

use Tidelist\Channel\Listing;

/**
 * Advert build result.
 */
final class BuildResult {

	/**
	 * The advert, independent of the marketplace's own format (null until built).
	 *
	 * @var Listing|null
	 */
	public $listing = null;

	/**
	 * Errors: list of [code, text].
	 *
	 * @var array<int, array{code:string, text:string, args?:array}>
	 */
	public $errors = array();

	/**
	 * Warnings: list of [code, text].
	 *
	 * @var array<int, array{code:string, text:string, args?:array}>
	 */
	public $warnings = array();

	/**
	 * Human-readable details (category name, colour, size, brand).
	 *
	 * @var array<string, string>
	 */
	public $info = array();

	/**
	 * Adds an error.
	 *
	 * @param string $code Code.
	 * @param string $text English text.
	 * @param array  $args Values the text is about (for example the field name), for the translated message.
	 */
	public function error( string $code, string $text, array $args = array() ): void {
		$this->errors[] = array(
			'code' => $code,
			'text' => $text,
		) + ( $args ? array( 'args' => $args ) : array() );
	}

	/**
	 * Adds a warning.
	 *
	 * @param string $code Code.
	 * @param string $text English text.
	 * @param array  $args Values the text is about (for example the field name), for the translated message.
	 */
	public function warn( string $code, string $text, array $args = array() ): void {
		$this->warnings[] = array(
			'code' => $code,
			'text' => $text,
		) + ( $args ? array( 'args' => $args ) : array() );
	}

	/**
	 * Whether the advert may be published.
	 */
	public function is_ready(): bool {
		return ! $this->errors;
	}

	/**
	 * Fingerprint of the advert (to detect changes after publishing).
	 */
	public function hash(): string {
		return null === $this->listing ? '' : $this->listing->hash();
	}
}