InputAwareHelper
extends Helper
in package
implements
InputAwareInterface
AbstractYes
An implementation of InputAwareInterface for Helpers.
Tags
Table of Contents
Interfaces
- InputAwareInterface
- InputAwareInterface should be implemented by classes that depends on the Console Input.
Properties
- $helperSet : mixed
- $input : mixed
Methods
- formatMemory() : string
- formatTime() : string
- getHelperSet() : HelperSet|null
- Gets the helper set associated with this helper.
- length() : int
- Returns the length of a string, using mb_strlen if it is available.
- removeDecoration() : string
- setHelperSet() : void
- Sets the helper set associated with this helper.
- setInput() : void
- Sets the Console Input.
- substr() : string
- Returns the subset of a string, using mb_substr if it is available.
- width() : int
- Returns the width of a string, using mb_strwidth if it is available.
Properties
$helperSet
protected
mixed
$helperSet
$input
protected
mixed
$input
Methods
formatMemory()
public
static formatMemory(int $memory) : string
Parameters
- $memory : int
Return values
stringformatTime()
public
static formatTime(int|float $secs[, int $precision = 1 ]) : string
Parameters
- $secs : int|float
- $precision : int = 1
Return values
stringgetHelperSet()
Gets the helper set associated with this helper.
public
getHelperSet() : HelperSet|null
Return values
HelperSet|nulllength()
Returns the length of a string, using mb_strlen if it is available.
public
static length(string|null $string) : int
The length is related to how many bytes the string will use.
Parameters
- $string : string|null
Return values
intremoveDecoration()
public
static removeDecoration(OutputFormatterInterface $formatter, string|null $string) : string
Parameters
- $formatter : OutputFormatterInterface
- $string : string|null
Return values
stringsetHelperSet()
Sets the helper set associated with this helper.
public
setHelperSet([HelperSet|null $helperSet = null ]) : void
Parameters
- $helperSet : HelperSet|null = null
setInput()
Sets the Console Input.
public
setInput(InputInterface $input) : void
Parameters
- $input : InputInterface
substr()
Returns the subset of a string, using mb_substr if it is available.
public
static substr(string|null $string, int $from[, int|null $length = null ]) : string
Parameters
- $string : string|null
- $from : int
- $length : int|null = null
Return values
stringwidth()
Returns the width of a string, using mb_strwidth if it is available.
public
static width(string|null $string) : int
The width is how many characters positions the string will use.
Parameters
- $string : string|null