kernel/private/classes/ezpautoloadclioutput.php
inherited
Classes
File containing the ezpAutoloadCliOutput class
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Version
- 4.6.0
\ezpAutoloadCliOutput
Utility class for providing CLI output and incremental progress information.
- Parent(s)
- \ezpAutoloadOutput
Properties
array
$data= 'null'
Array holding information used to collect statistics in the different phases.
nullDetails- Type
- array
\ezcConsoleStatusBar
$fileSearchProgress= 'null'
Object controlling progress information for the file search phase.
nullDetails- Type
- \ezcConsoleStatusBar
\ezcConsoleOutput
$output= 'null'
The console output object
nullDetails- Type
- \ezcConsoleOutput
\ezcConsoleProgressbar
$tokenizerProgress= 'null'
Object controlling progress information for tokenization / class search phase.
nullDetails- Type
- \ezcConsoleProgressbar
Methods
__construct(
)
:
voidfinishPhase1(
)
:
voidCloses down progress update for phase 1, also inserts some newlines to make sure output is displayed nicely.
finishPhase2(
)
:
voidFinishes progress output for class search phase.
Also inserts some extra newlines to make the output clearer.
getData(
int $phase
)
:
arrayReturns data array used to keep statistical information for each $phase.
| Name | Type | Description |
|---|---|---|
| $phase | int |
| Type | Description |
|---|---|
| array |
initPhase1(
)
:
voidSets up the class for handling progress information for file searching phase.
initPhase2(
)
:
voidSets up the class for displaying progress information for class search phase.
This method expects the total file count to be present in the internal $data array.
Example:
$statArray = array( 'nFiles' => count( $fileList ),
'classCount' => 0,
'classAdded' => 0,
);
This array can set via the updateData() function.
- See
- \function
outputCli(
string $message, string $type
)
:
voidOutputs a $message on the CLI, and formats it according to type.
Currently $type of "normal" and "warning" is supported.
| Name | Type | Description |
|---|---|---|
| $message | string | |
| $type | string |
progressUpdatePhase1(
)
:
voidPushes an progress update for file searching phase.
progressUpdatePhase2(
)
:
voidPushes a progress update for class search phase.
updateData(
int $phase, array $data
)
:
voidUpdates the internal data array for each $phase
| Name | Type | Description |
|---|---|---|
| $phase | int | |
| $data | array |
updateProgress(
int $phase
)
:
voidCalls the correct phase progress update method depending on $phase
| Name | Type | Description |
|---|---|---|
| $phase | int |