Cheetah
Public Member Functions | Public Attributes | List of all members
Intervention\Image\Commands\Argument Class Reference

Public Member Functions

 __construct (AbstractCommand $command, $key=0)
 
 getCommandName ()
 
 value ($default=null)
 
 required ()
 
 type ($type)
 
 between ($x, $y)
 
 min ($value)
 
 max ($value)
 

Public Attributes

 $command
 
 $key
 

Detailed Description

Definition at line 5 of file Argument.php.

Constructor & Destructor Documentation

◆ __construct()

Intervention\Image\Commands\Argument::__construct ( AbstractCommand  $command,
  $key = 0 
)

Creates new instance from given command and key

Parameters
AbstractCommand$command
integer$key

Definition at line 27 of file Argument.php.

Member Function Documentation

◆ between()

Intervention\Image\Commands\Argument::between (   $x,
  $y 
)

Determines that current argument value must be numeric between given values

Returns
\Intervention\Image\Commands\Argument

Definition at line 151 of file Argument.php.

◆ getCommandName()

Intervention\Image\Commands\Argument::getCommandName ( )

Returns name of current arguments command

Returns
string

Definition at line 38 of file Argument.php.

◆ max()

Intervention\Image\Commands\Argument::max (   $value)

Determines that current argument must be under a maxiumum value

Returns
\Intervention\Image\Commands\Argument

Definition at line 198 of file Argument.php.

◆ min()

Intervention\Image\Commands\Argument::min (   $value)

Determines that current argument must be over a minimum value

Returns
\Intervention\Image\Commands\Argument

Definition at line 176 of file Argument.php.

◆ required()

Intervention\Image\Commands\Argument::required ( )

Defines current argument as required

Returns
\Intervention\Image\Commands\Argument

Definition at line 66 of file Argument.php.

◆ type()

Intervention\Image\Commands\Argument::type (   $type)

Determines that current argument must be of given type

Returns
\Intervention\Image\Commands\Argument

Definition at line 82 of file Argument.php.

◆ value()

Intervention\Image\Commands\Argument::value (   $default = null)

Returns value of current argument

Parameters
mixed$default
Returns
mixed

Definition at line 50 of file Argument.php.

Member Data Documentation

◆ $command

Intervention\Image\Commands\Argument::$command

Definition at line 12 of file Argument.php.

◆ $key

Intervention\Image\Commands\Argument::$key

Definition at line 19 of file Argument.php.


The documentation for this class was generated from the following file: