Skip to content

Latest commit

 

History

History
359 lines (261 loc) · 7.33 KB

StylizedProgressBar.md

File metadata and controls

359 lines (261 loc) · 7.33 KB

BumbleDocGen / Technical description of the project / Class map / StylizedProgressBar


namespace BumbleDocGen\Console\ProgressBar;

final class StylizedProgressBar

Initialization methods:

  1. __construct

Methods:

  1. advance
  2. finish
  3. iterate
  4. setMaxSteps
  5. setName
  6. setStepDescription
  7. start

Method details:

public function __construct(\Symfony\Component\Console\Style\OutputStyle $io);

Parameters:

Name Type Description
$io \Symfony\Component\Console\Style\OutputStyle -

public function advance(int $step): void;

Parameters:

Name Type Description
$step int -

Return value: void


public function finish(): void;

Parameters: not specified

Return value: void


public function iterate(iterable $iterable, int|null $max = null): \Generator;

Parameters:

Name Type Description
$iterable iterable -
$max int | null -

Return value: \Generator


public function setMaxSteps(int $maxSteps): void;

Parameters:

Name Type Description
$maxSteps int -

Return value: void


public function setName(string $name): void;

Parameters:

Name Type Description
$name string -

Return value: void


public function setStepDescription(string $stepDescription): void;

Parameters:

Name Type Description
$stepDescription string -

Return value: void


public function start(int|null $max = null): void;

Parameters:

Name Type Description
$max int | null -

Return value: void