RockLobsterInc\Swv\Rules

RequiredRule{} │ final │ CF7 1.0└─ AbstractRule

Хуков нет.

Использование

$RequiredRule = new RequiredRule();
// use class methods

Методы

1. public __construct(array $properties = [])
2. public matches(array $context)
3. public toArray()
4. public validate(FormDataTree $form_data, array $context = [])

Код RequiredRule{} RequiredRule{} ^{CF7 6.2.4.1}

final class RequiredRule extends AbstractRule
{
    const RULE_NAME = "required";

    /**
     * Rule properties.
     */
    public readonly string $field;
    public readonly string $error;

    /**
     * Constructor.
     *
     * @param array $properties Rule properties.
     */
    public function __construct(array $properties = [])
    {
        $this->field = $properties["field"] ?? "";
        $this->error = $properties["error"] ?? "";
    }

    /**
     * Returns true if this rule matches the given context.
     *
     * @param array $context Context.
     */
    public function matches(array $context): bool
    {
        if (false === parent::matches($context)) {
            return false;
        }

        if (empty($context["text"])) {
            return false;
        }

        return true;
    }

    /**
     * Validates the form data according to the logic defined by this rule.
     *
     * @param FormDataTree $form_data Form data.
     * @param array $context Optional context.
     */
    public function validate(FormDataTree $form_data, array $context = [])
    {
        $values = $form_data->getAll($this->field);
        $values = array_flatten($values);

        if (empty($values)) {
            throw new Invalidity($this);
        }

        return true;
    }

    /**
     * Returns an array that represents the rule properties.
     *
     * @return array Array of rule properties.
     */
    public function toArray(): array
    {
        return [
            "rule" => self::RULE_NAME,
            "field" => $this->field,
            "error" => $this->error,
        ];
    }
}