Class: PHP_CompatInfo_Renderer

Source Location: /PHP_CompatInfo-1.8.0RC1/CompatInfo/Renderer.php

Class Overview

Base class used by all renderers

Author(s):

Laurent Laville <pear at laurent-laville.org>

Version:

Release: 1.8.0RC1

Variables

Methods

Child classes:

PHP_CompatInfo_Renderer_Csv: The PHP_CompatInfo_Renderer_Csv class is a concrete implementation of PHP_CompatInfo_Renderer abstract class. It simply output informations in Comma Seperated Value style.

PHP_CompatInfo_Renderer_Html: The PHP_CompatInfo_Renderer_Html class is a concrete implementation of PHP_CompatInfo_Renderer abstract class. It simply display results as web/html content with help of PEAR::Html_Table

PHP_CompatInfo_Renderer_Xml: The PHP_CompatInfo_Renderer_Xml class is a concrete implementation of PHP_CompatInfo_Renderer abstract class. It simply display results as an XML stream.

PHP_CompatInfo_Renderer_Null: The PHP_CompatInfo_Renderer_Null class is a concrete implementation of PHP_CompatInfo_Renderer abstract class. It simply consumes output events.

PHP_CompatInfo_Renderer_Text: The PHP_CompatInfo_Renderer_Text class is a concrete implementation of PHP_CompatInfo_Renderer abstract class. It simply display results for the command line interface with help of PEAR::Console_Table

PHP_CompatInfo_Renderer_Array: The PHP_CompatInfo_Renderer_Array class is a concrete implementation of PHP_CompatInfo_Renderer abstract class. It simply display results as a PHP array.

Inherited Variables

Inherited Methods

Class Details

[line 34]
Base class used by all renderers

Author: Laurent Laville <pear@laurent-laville.org>
Version: Release: 1.8.0RC1
Link: http://pear.php.net/package/PHP_CompatInfo
Abstract:
Since: Class available since Release 1.8.0b2
License: PHP License 3.01

[ Top ]

Class Variables

$args =

[line 80]

All console arguments that have been parsed and recognized

Since: 1.8.0RC1
Access: public

Type:

array

[ Top ]

$conf =

[line 89]

A hash containing any additional configuration of specific driver

Since: 1.8.0RC1
Access: public

Type:

array

[ Top ]

$eol =

[line 55]

Var: End of line string (depending of server API)
Access: public

Type:

string

[ Top ]

$parseData =

[line 71]

Data source parsed final results

Access: public

Type:

array

[ Top ]

$silent =

[line 63]

Silent mode. Display or not extra info messages.

Access: public

Type:

boolean

[ Top ]

Method Detail

__construct (Constructor) [line 114]

PHP_CompatInfo_Renderer __construct(
object
&$parser, array
$conf)

Base Renderer Class constructor (ZE2) for PHP5+

Since: version 1.8.0b2 (2008-06-03)
Access: public

Overridden in child classes as:

PHP_CompatInfo_Renderer_Csv::__construct(): Csv Renderer Class constructor (ZE2) for PHP5+

PHP_CompatInfo_Renderer_Html::__construct(): Html Renderer Class constructor (ZE2) for PHP5+

PHP_CompatInfo_Renderer_Xml::__construct(): Xml Renderer Class constructor (ZE2) for PHP5+

PHP_CompatInfo_Renderer_Null::__construct(): Null Renderer Class constructor (ZE2) for PHP5+

PHP_CompatInfo_Renderer_Text::__construct(): Text Renderer Class constructor (ZE2) for PHP5+

PHP_CompatInfo_Renderer_Array::__construct(): Array Renderer Class constructor (ZE2) for PHP5+

Parameters:

object	`&$parser`	—	Instance of the parser (model of MVC pattern)
array	`$conf`	—	A hash containing any additional configuration

[ Top ]

PHP_CompatInfo_Renderer (Constructor) [line 100]

PHP_CompatInfo_Renderer PHP_CompatInfo_Renderer(
object
&$parser, array
$conf)

Base Renderer Class constructor (ZE1) for PHP4

Since: version 1.8.0b2 (2008-06-03)
Access: public

Parameters:

object	`&$parser`	—	Instance of the parser (model of MVC pattern)
array	`$conf`	—	A hash containing any additional configuration

[ Top ]

endWaitProgress [line 339]

void endWaitProgress(
)

Finish waiting process

Finish waiting process, by erasing the progress bar

Since: version 1.8.0b2 (2008-06-03)
Access: public

[ Top ]

factory [line 198]

object PHP_CompatInfo_Renderer &factory(
object
&$parser, [string
$type = 'array'], [array
$conf = array()])

Create required instance of the Output 'driver'.

Return: A concrete PHP_CompatInfo_Renderer instance, or null on error.
Since: version 1.8.0b2 (2008-06-03)
Access: public

Parameters:

object	`&$parser`	—	A concrete instance of the parser
string	`$type`	—	(optional) Type of instance required, lowercase.
array	`$conf`	—	(optional) A hash containing any additional configuration information that a subclass might need.

[ Top ]

isIncludable [line 360]

boolean isIncludable(
string
$file)

Returns whether or not a file is in the include path

Return: True if the file is in the include path, false otherwise
Since: version 1.7.0b4 (2008-04-03)
Access: public

Parameters:

string $file — Path to filename to check if includable

[ Top ]

startWaitProgress [line 276]

void startWaitProgress(
integer
$maxEntries)

Initialize the wait process

Initialize the wait process, with a simple message or a progress bar.

Since: version 1.8.0b2 (2008-06-03)
Access: public

Parameters:

integer $maxEntries — Number of source to parse

[ Top ]

stillWaitProgress [line 311]

void stillWaitProgress(
string
$source, string
$index)

Update the wait message

Update the wait message, or status of the progress bar

Since: version 1.8.0b2 (2008-06-03)
Access: public

Parameters:

string	`$source`	—	Source (file, string) currently parsing
string	`$index`	—	Position of the $source in the data source list to parse

[ Top ]

update [line 233]

void update(
object
&$auditEvent)

Interface to update the view with current information

Listen events produced by Event_Dispatcher and the PHP_CompatInfo_Parser

Since: version 1.8.0b2 (2008-06-03)
Access: public

Parameters:

object &$auditEvent — Instance of Event_Dispatcher

[ Top ]