Manager

Back Back Up Advanced Editor

<?php
/* ============================================================================
 * Copyright 2020 Zindex Software
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============================================================================ */

namespace Opis\JsonSchema\Keywords;

use Opis\JsonSchema\{
    ValidationContext,
    Keyword,
    Schema
};
use Opis\JsonSchema\Errors\ValidationError;

class ItemsKeyword implements Keyword
{
    use OfTrait;
    use IterableDataValidationTrait;

/** @var bool|object|Schema|bool[]|object[]|Schema[] */
    protected $value;

protected int $count = -1;
    protected bool $alwaysValid;
    protected string $keyword;
    protected int $startIndex;

/**
     * @param bool|object|Schema|bool[]|object[]|Schema[] $value
     * @param bool $alwaysValid
     * @param string $keyword
     * @param int $startIndex
     */
    public function __construct($value, bool $alwaysValid = false, string $keyword = 'items', int $startIndex = 0)
    {
        $this->value = $value;
        $this->alwaysValid = $alwaysValid;

if (is_array($value)) {
            $this->count = count($value);
        }

$this->keyword = $keyword;
        $this->startIndex = $startIndex;
    }

/**
     * @inheritDoc
     */
    public function validate(ValidationContext $context, Schema $schema): ?ValidationError
    {
        if ($this->alwaysValid || $this->value === true) {
            if ($this->count === -1) {
                $context->markAllAsEvaluatedItems();
            } else {
                $context->markCountAsEvaluatedItems($this->count);
            }
            return null;
        }

$count = count($context->currentData());

if ($this->startIndex >= $count) {
            // Already validated by other keyword
            return null;
        }

if ($this->value === false) {
            if ($count === 0) {
                return null;
            }

return $this->error($schema, $context, $this->keyword, 'Array must be empty');
        }

if ($this->count >= 0) {

$errors = $this->errorContainer($context->maxErrors());
            $max = min($count, $this->count);
            $evaluated = [];

for ($i = $this->startIndex; $i < $max; $i++) {
                if ($this->value[$i] === true) {
                    $evaluated[] = $i;
                    continue;
                }

if ($this->value[$i] === false) {
                    $context->addEvaluatedItems($evaluated);
                    return $this->error($schema, $context, $this->keyword, "Array item at index {index} is not allowed", [
                        'index' => $i,
                    ]);
                }

if (is_object($this->value[$i]) && !($this->value[$i] instanceof Schema)) {
                    $this->value[$i] = $context->loader()->loadObjectSchema($this->value[$i]);
                }

$context->pushDataPath($i);
                $error = $this->value[$i]->validate($context);
                $context->popDataPath();

if ($error) {
                    $errors->add($error);
                    if ($errors->isFull()) {
                        break;
                    }
                } else {
                    $evaluated[] = $i;
                }
            }

$context->addEvaluatedItems($evaluated);

if ($errors->isEmpty()) {
                return null;
            }

return $this->error($schema, $context, $this->keyword, 'Array items must match corresponding schemas', [],
                $errors);
        }

if (is_object($this->value) && !($this->value instanceof Schema)) {
            $this->value = $context->loader()->loadObjectSchema($this->value);
        }

$object = $this->createArrayObject($context);

$error = $this->validateIterableData($schema, $this->value, $context, $this->indexes($this->startIndex, $count),
            $this->keyword, 'All array items must match schema', [], $object);

if ($object && $object->count()) {
            $context->addEvaluatedItems($object->getArrayCopy());
        }

return $error;
    }

/**
     * @param int $start
     * @param int $max
     * @return iterable|int[]
     */
    protected function indexes(int $start, int $max): iterable
    {
        for ($i = $start; $i < $max; $i++) {
            yield $i;
        }
    }
}