JezK

Edit File: ValidationRule.php

<?php

/**
 * Validation rule class.
 *
 * @package    Framework
 * @subpackage Validation
 * @since      1.0.0
 */
namespace Kirki\Framework\Validation;

use Closure;
use Kirki\Framework\Filesystem\File;
use Kirki\Framework\Supports\Arr;
use Kirki\Framework\Supports\Fluent;
use function Kirki\Framework\message;
\defined('ABSPATH') || exit;
abstract class ValidationRule extends Fluent
{
    /**
     * The data to validate.
     *
     * @var array
     *
     * @since 1.0.0
     */
    protected $data = [];
    /**
     * The value to validate.
     *
     * @var mixed
     *
     * @since 1.0.0
     */
    protected $value;
    /**
     * The name of the field where the validation rule is applied.
     *
     * @var string
     *
     * @since 1.0.0
     */
    protected string $name = '';
    /**
     * The name of the validation rule.
     *
     * @var string
     *
     * @since 1.0.0
     */
    protected string $rule = '';
    /**
     * The arguments to validate.
     *
     * @var array
     *
     * @since 1.0.0
     */
    protected $args;
    /**
     * Whether the rule is an implicit rule.
     *
     * @var bool
     *
     * @since 1.0.0
     */
    public bool $is_implicit = \false;
    /**
     * The messages to return.
     *
     * @var array
     *
     * @since 1.0.0
     */
    protected array $messages = [];
    /**
     * The default messages to return.
     *
     * @var array
     *
     * @since 1.0.0
     */
    protected array $default_messages = [];
    /**
     * The custom user defined messages to return.
     *
     * @var array
     *
     * @since 1.0.0
     */
    protected array $custom_messages = [];
    /**
     * Whether to stop on first failure.
     *
     * @var bool
     *
     * @since 1.0.0
     */
    protected $should_stop_on_first_failure = \false;
    /**
     * The constraints to validate.
     *
     * @var array
     *
     * @since 1.0.0
     */
    protected array $constraints = [];
    /**
     * Create a new rule instance.
     *
     * @param array|null $args The additional arguments to validate.
     *
     * @return void
     * 
     * @since 1.0.0
     */
    public function __construct($args = null)
    {
        $this->args = $args;
        $this->process_default_messages($this->constraints);
    }
    /**
     * Get the rule name.
     *
     * @return string
     *
     * @since 1.0.0
     */
    public function get_rule_name()
    {
        return $this->rule;
    }
    /**
     * Set whether to stop on first failure.
     *
     * @param bool $should_stop_on_first_failure Whether to stop on first failure.
     *
     * @return $this
     * 
     * @since 1.0.0
     */
    public function should_stop_on_first_failure(bool $should_stop_on_first_failure)
    {
        $this->should_stop_on_first_failure = $should_stop_on_first_failure;
        return $this;
    }
    /**
     * Set the value to validate.
     *
     * @param mixed $value The value to validate.
     *
     * @return $this
     * 
     * @since 1.0.0
     */
    public function with_value($value)
    {
        $this->value = $value;
        return $this;
    }
    /**
     * Set the data to validate.
     *
     * @param array $data The data to validate.
     *
     * @return $this
     * 
     * @since 1.0.0
     */
    public function with_data(array $data)
    {
        $this->data = $data;
        return $this;
    }
    /**
     * Set the name of the field where the validation rule is applied.
     *
     * @param string $name The name of the field where the validation rule is applied.
     *
     * @return $this
     * 
     * @since 1.0.0
     */
    public function with_name(string $name)
    {
        $this->name = $name;
        return $this;
    }
    /**
     * Run the applied constraints against the value.
     *
     * @param callable $callback The callback to call when a constraint fails.
     *
     * @return bool
     * 
     * @since 1.0.0
     */
    protected function validate_constraints(callable $callback)
    {
        $constraints = \array_intersect($this->keys(), $this->constraints);
        $passed = \true;
        foreach ($constraints as $constraint) {
            $method = 'validate_' . \strtolower($constraint);
            if (!\method_exists($this, $method)) {
                continue;
            }
            if (!$this->{$method}($this->value)) {
                $passed = \false;
                $callback($passed, $constraint);
                if ($this->should_stop_on_first_failure) {
                    return \false;
                }
            }
        }
        return $passed;
    }
    /**
     * Check if the rule has a constraint.
     *
     * @param string $constraint The constraint to check.
     *
     * @return bool
     * 
     * @since 1.0.0
     */
    public function has_constraint(string $constraint)
    {
        return \in_array($constraint, $this->constraints, \true);
    }
    /**
     * Validate the rule.
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public abstract function validate() : bool;
    /**
     * Get the error message.
     *
     * @return string
     *
     * @since 1.0.0
     */
    public abstract function messages();
    /**
     * Check if the rule passed.
     *
     * @return bool
     * 
     * @since 1.0.0
     */
    public function passed()
    {
        return $this->validate();
    }
    /**
     * Reset the messages to an empty array.
     *
     * @return $this
     * 
     * @since 1.0.0
     */
    public function clear_error_messages()
    {
        $this->messages = [];
        return $this;
    }
    /** 
     * Set the custom messages to return.
     *
     * @param array $messages The custom messages to return.
     *
     * @return $this
     * 
     * @since 1.0.0
     */
    public function sync_custom_messages(array $messages)
    {
        $this->custom_messages = $messages;
        $this->sync_default_messages_with_custom_messages();
        return $this;
    }
    /**
     * Sync the default messages with the custom messages.
     *
     * @return void
     * 
     * @since 1.0.0
     */
    protected function sync_default_messages_with_custom_messages()
    {
        $this->process_default_messages($this->constraints);
    }
    /**
     * Check if the value is null, an empty string, or an empty countable.
     *
     * @param mixed $value The value to check.
     *
     * @return bool
     * 
     * @since 1.0.0
     */
    public static function is_nullish($value)
    {
        if (\is_null($value)) {
            return \true;
        }
        if (\is_string($value) && \trim($value) === '') {
            return \true;
        }
        if (\is_countable($value) && \count($value) < 1) {
            return \true;
        }
        if ($value instanceof File) {
            return (string) $value->getPath() === '';
        }
        return \false;
    }
    /**
     * Add a message to the validation errors.
     *
     * @param string $message The message to add.
     * @param array $placeholders The placeholders to replace.
     *
     * @return bool
     * 
     * @since 1.0.0
     */
    protected function fails(string $message, array $placeholders = [])
    {
        $message = $this->replace_message_placeholders($message, $placeholders);
        $this->messages = \array_merge($this->messages, Arr::wrap($message));
        return \false;
    }
    /**
     * Replace the message placeholders.
     *
     * @param string $message The message to replace the placeholders in.
     * @param array $placeholders The placeholders to replace.
     *
     * @return string
     * 
     * @since 1.0.0
     */
    protected function replace_message_placeholders(string $message, array $placeholders = [])
    {
        $placeholders = \array_merge(['name' => $this->name, 'args' => \is_array($this->args) ? Arr::join(Arr::reject($this->args, fn($arg) => !\is_string($arg) && !\is_numeric($arg)), ', ') : (string) $this->args], $placeholders);
        $placeholders = Arr::map($placeholders, fn($placeholder) => \is_array($placeholder) ? \implode(', ', $placeholder) : $placeholder);
        foreach ($placeholders as $key => $value) {
            $placeholder = '{' . $key . '}';
            $message = \str_replace($placeholder, $value, $message);
        }
        return $message;
    }
    /**
     * Process the messages.
     *
     * @param array $messages The messages to process.
     *
     * @return array
     * 
     * @since 1.0.0
     */
    protected function process_messages(array $messages)
    {
        foreach ($messages as $key => $message) {
            $messages[$key] = $this->replace_message_placeholders($message);
        }
        return $messages;
    }
    /**
     * Get the default messages.
     *
     * @param array $keys The keys to get the default messages for.
     *
     * @return array
     * 
     * @since 1.0.0
     */
    protected function process_default_messages(array $keys)
    {
        $keys = \array_merge(['default'], $keys);
        $messages = [];
        foreach ($keys as $key) {
            $messages[$key] = $this->get_custom_message($key) ?? $this->get_default_message($key);
        }
        return $this->default_messages = $messages;
    }
    /**
     * Get the default message.
     *
     * @param string $key The key to get the default message for.
     *
     * @return string
     * 
     * @since 1.0.0
     */
    protected function get_default_message(string $key)
    {
        return message($this->build_message_key($key)) ?? '';
    }
    /**
     * Get the custom message.
     *
     * @param string $key The key to get the custom message for.
     *
     * @return string|null
     * 
     * @since 1.0.0
     */
    protected function get_custom_message(string $key)
    {
        if ($key === 'default') {
            $key = $this->rule;
        }
        $custom_message_key = $this->name . '.' . $key;
        $message = Arr::get($this->custom_messages, $custom_message_key);
        if ($message instanceof Closure) {
            return $message($this->name, $this->value, $this->data);
        }
        return $message;
    }
    /**
     * Build the message key.
     *
     * @param string $key The key to build the message key for.
     *
     * @return string
     * 
     * @since 1.0.0
     */
    protected function build_message_key(string $key)
    {
        return 'validator.' . $this->rule . '.' . $key;
    }
}

Maremoto Productions

WELCOME TO MAREMOTO

SANTIAGO, CHILE | TORONTO, CANADA

ABOUT MAREMOTO

ABOUT US

Maremoto is a production company founded by Chilean-Canadian filmmaker Maria Teresa Larrain in 2008.

OUR TEAM

Chilean-Canadian filmmaker Maria Teresa Larrain is a graduate of the Radio and Television Arts Program at Ryerson University in Toronto.

SELECTED WORKS

In the midst of a deep social conflict exacerbated by a devastating pandemic, a Canadian filmmaker….

LAST NEWS

FOLLOW US

CONTACT

?> ?>