alex-kalanis / kw_rules

php-src/TRules.php

<?php

namespace kalanis\kw_rules;


use kalanis\kw_rules\Interfaces;
use kalanis\kw_rules\Rules;


/**
 * Trait TRules
 * @package kalanis\kw_rules
 * Main class for processing rules - use it as include for your case
 */
trait TRules
{
    protected ?Interfaces\IRuleFactory $rulesFactory = null;
    /** @var Rules\ARule[]|Rules\File\AFileRule[] */
    protected array $rules = [];

    /**
     * @param string $ruleName
     * @param string $errorText
     * @param mixed ...$args
     */
    public function addRule(string $ruleName, string $errorText, ...$args): void
    {
        $rule = $this->getRulesFactory()->getRule($ruleName);
        $rule->setErrorText($errorText);
        $rule->setAgainstValue(empty($args) ? null : reset($args));
        $this->rules[] = $rule;
    }

    /**
     * @param array<Rules\ARule|Rules\File\AFileRule> $rules
     */
    public function addRules(array $rules = []): void
    {
        foreach ($rules as $rule) {
            if ($rule instanceof Rules\ARule) {
                $this->rules[] = $rule;
            }
            if ($rule instanceof Rules\File\AFileRule) {
                $this->rules[] = $rule;
            }
        }
    }

    /**
     * @return array<Rules\ARule|Rules\File\AFileRule>
     */
    public function getRules(): array
    {
        return $this->rules;
    }

    public function removeRules(): void
    {
        $this->rules = [];
    }

    protected function getRulesFactory(): Interfaces\IRuleFactory
    {
        // @phpstan-ignore-next-line
        if (empty($this->rulesFactory)) {
            $this->rulesFactory = $this->whichRulesFactory();
        }
        return $this->rulesFactory;

The expression return $this->rulesFactory could return the type null which is incompatible with the type-hinted return kalanis\kw_rules\Interfaces\IRuleFactory. Consider adding an additional type-check to rule them out.

    }

    /**
     * Set which factory will be used
     * @return Interfaces\IRuleFactory
     */
    abstract protected function whichRulesFactory(): Interfaces\IRuleFactory;
}