DescriptorHelper
extends Helper
in package
This class adds helper method to describe objects in various formats.
Tags
Table of Contents
Properties
- $helperSet : HelperSet|null
Methods
- __construct() : mixed
- describe() : void
- Describes an object if supported.
- formatMemory() : string
- formatTime() : string
- getFormats() : array<string|int, mixed>
- getHelperSet() : HelperSet|null
- Gets the helper set associated with this helper.
- getName() : string
- Returns the canonical name of this helper.
- length() : int
- Returns the length of a string, using mb_strlen if it is available.
- register() : $this
- Registers a descriptor.
- removeDecoration() : string
- setHelperSet() : void
- Sets the helper set associated with this helper.
- 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
HelperSet|null
$helperSet
= null
Methods
__construct()
public
__construct() : mixed
describe()
Describes an object if supported.
public
describe(OutputInterface $output, object|null $object[, array<string|int, mixed> $options = [] ]) : void
Available options are:
- format: string, the output format name
- raw_text: boolean, sets output type as raw
Parameters
- $output : OutputInterface
- $object : object|null
- $options : array<string|int, mixed> = []
Tags
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
stringgetFormats()
public
getFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>getHelperSet()
Gets the helper set associated with this helper.
public
getHelperSet() : HelperSet|null
Return values
HelperSet|nullgetName()
Returns the canonical name of this helper.
public
getName() : string
Return values
stringlength()
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
intregister()
Registers a descriptor.
public
register(string $format, DescriptorInterface $descriptor) : $this
Parameters
- $format : string
- $descriptor : DescriptorInterface
Return values
$thisremoveDecoration()
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) : void
Parameters
- $helperSet : HelperSet|null
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