PHP Classes

File: src/Interfaces/IterableParameterInterface.php

Recommend this page to a friend!
  Classes of Rodolfo Berrios Arce   Parameter   src/Interfaces/IterableParameterInterface.php   Download  
File: src/Interfaces/IterableParameterInterface.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Parameter
Validate function parameters with PHP attributes
Author: By
Last change:
Date: 15 days ago
Size: 1,119 bytes
 

Contents

Class file image Download
<?php

/*
 * This file is part of Chevere.
 *
 * (c) Rodolfo Berrios <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace
Chevere\Parameter\Interfaces;

/**
 * Describes the component in charge of defining a parameter of type iterable.
 */
interface IterableParameterInterface extends ParameterInterface, ParametersAccessInterface
{
   
/**
     * Asserts the given `$value` is valid.
     * @phpstan-ignore-next-line
     */
   
public function __invoke(iterable $value): iterable;

    public function
key(): ParameterInterface;

    public function
value(): ParameterInterface;

    public function
assertCompatible(self $parameter): void;

   
/**
     * @param iterable<mixed, mixed> $default
     */
   
public function withDefault(iterable $default): self;

   
/**
     * @return iterable<mixed, mixed>
     */
   
public function default(): ?iterable;

    public function
typeSchema(): string;

    public function
isList(): bool;

    public function
isMap(): bool;
}