PHP Classes

File: src/Interfaces/IntParameterInterface.php

Recommend this page to a friend!
  Classes of Rodolfo Berrios Arce   Parameter   src/Interfaces/IntParameterInterface.php   Download  
File: src/Interfaces/IntParameterInterface.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Parameter
Validate function parameters with PHP attributes
Author: By
Last change:
Date: 24 days ago
Size: 2,793 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 int.
 */
interface IntParameterInterface extends ParameterInterface
{
    public const
MIN = PHP_INT_MIN;

    public const
MAX = PHP_INT_MAX;

   
/**
     * Asserts the given `$value` is valid.
     */
   
public function __invoke(int $value): int;

   
/**
     * Return an instance with the specified default value.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified default value.
     */
   
public function withDefault(int $value): self;

   
/**
     * Return an instance with the specified minimum value.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified minimum value.
     */
   
public function withMin(int $value): self;

   
/**
     * Return an instance with the specified maximum value.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified maximum value.
     */
   
public function withMax(int $value): self;

   
/**
     * Return an instance with the specified accepted value(s).
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified accepted value(s).
     *
     * When using this method it will nullify the minimum and maximum values.
     */
   
public function withAccept(int ...$value): self;

   
/**
     * Return an instance with the specified rejected value(s).
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified rejected value(s).
     *
     * When using this method it will nullify the minimum and maximum values.
     */
   
public function withReject(int ...$value): self;

   
/**
     * Provides access to the default value (if any).
     */
   
public function default(): ?int;

   
/**
     * Provides access to the minimum value.
     */
   
public function min(): ?int;

   
/**
     * Provides access to the maximum value.
     */
   
public function max(): ?int;

   
/**
     * Provides access to the accepted value(s).
     *
     * @return int[]
     */
   
public function accept(): array;

   
/**
     * Provides access to the rejected value(s).
     *
     * @return int[]
     */
   
public function reject(): array;

    public function
assertCompatible(self $parameter): void;
}