# StringParameterInterface

Chevere\Interfaces\Parameter\StringParameterInterface

view source

# Extends

# Description

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

# Methods

# regex()

Provides access to the regex instance.


# withRegex()

Return an instance with the specified $regex.

# Parameters

  1. RegexInterface $regex

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

  1. string $default

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.


# withDescription()

# Parameters

  1. string $description

RETURN

self


# withAddedAttribute()

Return an instance with the specified $attributes added.

# Parameters

  1. string ...$attributes

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

  1. string ...$attributes

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

  1. string ...$attributes

RETURN

bool


# attributes()

Provides access to the attributes instance.

RETURN

Ds\Set


# description()

Provides access to the description.

RETURN

string


# getDescription()

Defines the description.

RETURN

string


Last Updated: 1/16/2021, 9:23:54 PM