eZPublish(LegacyStack)  5.1
ezpAutoloadCliOutput Class Reference
+ Inheritance diagram for ezpAutoloadCliOutput:
+ Collaboration diagram for ezpAutoloadCliOutput:

Public Member Functions

 __construct ()
 
 finishPhase1 ()
 Closes down progress update for phase 1, also inserts some newlines to make sure output is displayed nicely. More...
 
 finishPhase2 ()
 Finishes progress output for class search phase. More...
 
 getData ($phase)
 Returns data array used to keep statistical information for each $phase. More...
 
 initPhase1 ()
 Sets up the class for handling progress information for file searching phase. More...
 
 initPhase2 ()
 Sets up the class for displaying progress information for class search phase. More...
 
 outputCli ($message, $type)
 Outputs a $message on the CLI, and formats it according to type. More...
 
 progressUpdatePhase1 ()
 Pushes an progress update for file searching phase. More...
 
 progressUpdatePhase2 ()
 Pushes a progress update for class search phase. More...
 
 updateData ($phase, $data)
 Updates the internal data array for each $phase More...
 
 updateProgress ($phase)
 Calls the correct phase progress update method depending on $phase More...
 

Protected Attributes

 $data = null
 
 $fileSearchProgress = null
 
 $output = null
 
 $tokenizerProgress = null
 

Constructor & Destructor Documentation

ezpAutoloadCliOutput::__construct ( )

Member Function Documentation

ezpAutoloadCliOutput::finishPhase1 ( )

Closes down progress update for phase 1, also inserts some newlines to make sure output is displayed nicely.

Returns
void

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::finishPhase2 ( )

Finishes progress output for class search phase.

Also inserts some extra newlines to make the output clearer.

Returns
void

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::getData (   $phase)

Returns data array used to keep statistical information for each $phase.

Parameters
int$phase
See Also
eZAutoloadGenerator::OUTPUT_PROGRESS_PHASE1
eZAutoloadGenerator::OUTPUT_PROGRESS_PHASE2
Returns
array

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::initPhase1 ( )

Sets up the class for handling progress information for file searching phase.

Returns
void

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::initPhase2 ( )

Sets 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 Also
function updateData
Returns
void

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::outputCli (   $message,
  $type 
)

Outputs a $message on the CLI, and formats it according to type.

Currently $type of "normal" and "warning" is supported.

Parameters
string$message
string$type
Returns
void

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::progressUpdatePhase1 ( )

Pushes an progress update for file searching phase.

Returns
void

Implements ezpAutoloadOutput.

Referenced by updateProgress().

ezpAutoloadCliOutput::progressUpdatePhase2 ( )

Pushes a progress update for class search phase.

Returns
void

Implements ezpAutoloadOutput.

Referenced by updateProgress().

ezpAutoloadCliOutput::updateData (   $phase,
  $data 
)

Updates the internal data array for each $phase

Parameters
int$phase
array$data
Returns
void

Implements ezpAutoloadOutput.

ezpAutoloadCliOutput::updateProgress (   $phase)

Calls the correct phase progress update method depending on $phase

Parameters
int$phase
Returns
void

Implements ezpAutoloadOutput.

Member Data Documentation

ezpAutoloadCliOutput::$data = null
protected

Referenced by updateData().

ezpAutoloadCliOutput::$fileSearchProgress = null
protected
ezpAutoloadCliOutput::$output = null
protected
ezpAutoloadCliOutput::$tokenizerProgress = null
protected

The documentation for this class was generated from the following file: