# StringParameterInterface
Chevere\Interfaces\Parameter\StringParameterInterface
# Extends
# Description
Describes the component in charge of defining a parameter of type string.
# Methods
# regex()
Provides access to the regex instance.
RETURN
# withRegex()
Return an instance with the specified $regex
.
# Parameters
- RegexInterface
$regex
THROWS
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
- string
$default
THROWS
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
# withDescription()
# Parameters
- string
$description
RETURN
self
# withAddedAttribute()
Return an instance with the specified $attributes
added.
# Parameters
- string
...$attributes
THROWS
RETURN
self
This method MUST retain the state of the current instance, and return
an instance that contains the specified $attributes
added.
# withRemovedAttribute()
Return an instance with the specified $attributes
removed.
# Parameters
- string
...$attributes
THROWS
RETURN
self
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
- string
...$attributes
RETURN
bool
# attributes()
Provides access to the attributes instance.
RETURN
# description()
Provides access to the description.
RETURN
string
# getDescription()
Defines the description.
RETURN
string