<?php
/**
 * Shared field behaviour.
 *
 * @package WPInterface\ProductReviews
 */

declare( strict_types=1 );

namespace WPInterface\ProductReviews\Collection\Form;

use WPInterface\ProductReviews\Core\Templates;
use WP_Error;

defined( 'ABSPATH' ) || exit;

/**
 * Template rendering and error helpers. Field markup lives in templates/form/, so themes
 * can override any field.
 */
abstract class AbstractField implements FormField {

	/**
	 * Template loader.
	 *
	 * @var Templates
	 */
	protected Templates $templates;

	/**
	 * Constructor.
	 *
	 * @param Templates $templates Template loader.
	 */
	public function __construct( Templates $templates ) {
		$this->templates = $templates;
	}

	/**
	 * {@inheritDoc}
	 */
	public function area(): string {
		return self::AREA_MAIN;
	}

	/**
	 * {@inheritDoc}
	 */
	public function load( int $comment_id ) {
		return null;
	}

	/**
	 * Render templates/form/{name}.php.
	 *
	 * @param string               $name    Template name.
	 * @param FormContext          $context Form context.
	 * @param array<string, mixed> $args    Template data.
	 */
	protected function template( string $name, FormContext $context, array $args = array() ): string {
		return $this->templates->render( 'form/' . $name . '.php', $args + array( 'context' => $context ) );
	}

	/**
	 * Validation error tied to an input name.
	 *
	 * @param string $input   Input name.
	 * @param string $message Message for the reviewer.
	 */
	protected function error( string $input, string $message ): WP_Error {
		return new WP_Error( 'wpipr_field_invalid', $message, array( 'field' => $input ) );
	}

	/**
	 * A scalar input as a string.
	 *
	 * @param array<string, mixed> $input Input.
	 * @param string               $key   Input name.
	 */
	protected static function string( array $input, string $key ): string {
		return isset( $input[ $key ] ) && is_scalar( $input[ $key ] ) ? (string) $input[ $key ] : '';
	}
}