# StringParameterInterface

Chevere\Interfaces\Parameter\StringParameterInterface

view source (opens new window)

# Extends

# Description

Describes the component in charge of defining a parameter of type string.

# Methods

# regex

Provides access to the regex instance.

Return

RegexInterface

# withRegex

Return an instance with the specified $regex.

Parameters

regex: RegexInterface

Throws

BadFunctionCallException

Return

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $regex.

# withDefault

Return an instance with the specified $default value.

Parameters

value: string

Throws

InvalidArgumentException

Return

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $default value.

# default

Provides access to the default value.

Return

string

# type

Provides access to the type instance.

Return

TypeInterface

# withDescription

Parameters

description: string

Return

static

# withAddedAttribute

Return an instance with the specified $attributes added.

Parameters

...attributes: string

Throws

OverflowException

Return

static

This method MUST retain the state of the current instance, and return an instance that contains the specified $attributes added.

# withoutAttribute

Return an instance with the specified $attributes removed.

Parameters

...attributes: string

Throws

OutOfBoundsException

Return

static

This method MUST retain the state of the current instance, and return an instance that contains the specified $attributes removed.

# hasAttribute

Indicates whether the instance has the given $attributes.

Parameters

...attributes: string

Return

bool

# attributes

Provides access to the attributes instance.

Return

Ds\Set (opens new window)

# description

Provides access to the description.

Return

string

# getDescription

Defines the description.

Return

string