Skip to content

Latest commit

 

History

History
456 lines (186 loc) · 5.56 KB

DebugFormatterHelper.md

File metadata and controls

456 lines (186 loc) · 5.56 KB

DebugFormatterHelper

Helps outputting debug information when running an external program from a command.

An external program can be a Process, an HTTP request, or anything else.

Constants

Constant Visibility Type Value
COLORS private ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'default']

Properties

started

private $started

count

private $count

Methods

start

Starts a debug formatting session.

public start(string $id, string $message, string $prefix = 'RUN'): string

Parameters:

Parameter Type Description
$id string
$message string
$prefix string

progress

Adds progress to a formatting session.

public progress(string $id, string $buffer, bool $error = false, string $prefix = 'OUT', string $errorPrefix = 'ERR'): string

Parameters:

Parameter Type Description
$id string
$buffer string
$error bool
$prefix string
$errorPrefix string

stop

Stops a formatting session.

public stop(string $id, string $message, bool $successful, string $prefix = 'RES'): string

Parameters:

Parameter Type Description
$id string
$message string
$successful bool
$prefix string

getBorder

private getBorder(string $id): string

Parameters:

Parameter Type Description
$id string

getName

{@inheritdoc}

public getName(): mixed

Inherited methods

setHelperSet

Sets the helper set associated with this helper.

public setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet = null): mixed

Parameters:

Parameter Type Description
$helperSet \Symfony\Component\Console\Helper\HelperSet

getHelperSet

Gets the helper set associated with this helper.

public getHelperSet(): \Symfony\Component\Console\Helper\HelperSet|null

strlen

Returns the length of a string, using mb_strwidth if it is available.

public static strlen(?string $string): int

  • This method is static.

  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.

Parameters:

Parameter Type Description
$string ?string

width

Returns the width of a string, using mb_strwidth if it is available.

public static width(?string $string): int

The width is how many characters positions the string will use.

  • This method is static.

Parameters:

Parameter Type Description
$string ?string

length

Returns the length of a string, using mb_strlen if it is available.

public static length(?string $string): int

The length is related to how many bytes the string will use.

  • This method is static.

Parameters:

Parameter Type Description
$string ?string

substr

Returns the subset of a string, using mb_substr if it is available.

public static substr(?string $string, int $from, int $length = null): string
  • This method is static.

Parameters:

Parameter Type Description
$string ?string
$from int
$length int

formatTime

public static formatTime(mixed $secs): mixed
  • This method is static.

Parameters:

Parameter Type Description
$secs mixed

formatMemory

public static formatMemory(int $memory): mixed
  • This method is static.

Parameters:

Parameter Type Description
$memory int

strlenWithoutDecoration

public static strlenWithoutDecoration(\Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter, ?string $string): mixed

  • This method is static.

  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.

Parameters:

Parameter Type Description
$formatter \Symfony\Component\Console\Formatter\OutputFormatterInterface
$string ?string

removeDecoration

public static removeDecoration(\Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter, ?string $string): mixed
  • This method is static.

Parameters:

Parameter Type Description
$formatter \Symfony\Component\Console\Formatter\OutputFormatterInterface
$string ?string