1. class
  2. ExeQue
  3. \
  4. Remix
  5. \
  6. Mutate
  7. \
  8. String
  9. \
  10. Pad

Pad

class Pad extends StringMutator (View source)

Pads a string to a given length with another string with specified direction.

Traits

UsesEncoding
ValidatesEncoding
ResolvesStringInput

Properties

protected $encoding from  UsesEncoding

Methods

__construct(int $length, string $string = ' ', StringDirection $direction = StringDirection::Right, string $encoding = null)

No description

mixed
__invoke(mixed $value)

Mutate the input value.

from  Mutator
static Pad
both(int $length, string $string = ' ', string $encoding = null)

No description

string|null
getEncoding(string $input = null)

No description

from  UsesEncoding
static Pad
left(int $length, string $string = ' ', string $encoding = null)

No description

static Pad
make(int $length, string $string = ' ', StringDirection $direction = StringDirection::Right, string $encoding = null)

No description

mixed
mutate(mixed $value)

Mutate the input value.

from  StringMutator
string
mutateString(string $value)

No description

string
resolveStringInput(mixed $value)

No description

from  ResolvesStringInput
static Pad
right(int $length, string $string = ' ', string $encoding = null)

No description

void
setEncoding(string|null $encoding)

No description

from  UsesEncoding
void
validateEncoding(string|null $encoding)

No description

from  ValidatesEncoding

Details

at line 32
__construct(int $length, string $string = ' ', StringDirection $direction = StringDirection::Right, string $encoding = null)

No description

Parameters

int $length

The length to pad to.
string $string

The string to pad with (default: ' ').
StringDirection $direction

The direction to pad in (default: StringDirection::Right).
string $encoding

The encoding to use (optional).

in Mutator at line 9
final mixed __invoke(mixed $value)

Mutate the input value.

Parameters

mixed $value

Return Value

mixed

at line 79
static Pad both(int $length, string $string = ' ', string $encoding = null)

No description

Parameters

int $length

The length to pad to.
string $string

The string to pad with (default: ' ').
string $encoding

The encoding to use (optional).

Return Value

Pad

in UsesEncoding at line 25
protected string|null getEncoding(string $input = null)

No description

Parameters

string $input

Return Value

string|null

at line 59
static Pad left(int $length, string $string = ' ', string $encoding = null)

No description

Parameters

int $length

The length to pad to.
string $string

The string to pad with (default: ' ').
string $encoding

The encoding to use (optional).

Return Value

Pad

at line 49
static Pad make(int $length, string $string = ' ', StringDirection $direction = StringDirection::Right, string $encoding = null)

No description

Parameters

int $length

The length to pad to.
string $string

The string to pad with (default: ' ').
StringDirection $direction

The direction to pad in (default: StringDirection::Right).
string $encoding

The encoding to use (optional).

Return Value

Pad

in StringMutator at line 14
final mixed mutate(mixed $value)

Mutate the input value.

Parameters

mixed $value

Return Value

mixed

at line 84
protected string mutateString(string $value)

No description

Parameters

string $value

Return Value

string

in ResolvesStringInput at line 13
protected string resolveStringInput(mixed $value)

No description

Parameters

mixed $value

Return Value

string

at line 69
static Pad right(int $length, string $string = ' ', string $encoding = null)

No description

Parameters

int $length

The length to pad to.
string $string

The string to pad with (default: ' ').
string $encoding

The encoding to use (optional).

Return Value

Pad

in UsesEncoding at line 18
protected void setEncoding(string|null $encoding)

No description

Parameters

string|null $encoding

Return Value

void

in ValidatesEncoding at line 14
protected void validateEncoding(string|null $encoding)

No description

Parameters

string|null $encoding

Return Value

void