PHP_CompatInfo
[ class tree: PHP_CompatInfo ] [ index: PHP_CompatInfo ] [ all elements ]

Class: PHP_CompatInfo_Renderer

Source Location: /PHP_CompatInfo-1.9.0/CompatInfo/Renderer.php

Class Overview


Base class used by all renderers


Author(s):

Version:

  • Release: 1.9.0

Variables

Methods


Child classes:

PHP_CompatInfo_Renderer_Array
Array renderer for PHP_CompatInfo component.
PHP_CompatInfo_Renderer_Csv
Csv renderer for PHP_CompatInfo component.
PHP_CompatInfo_Renderer_Html
Html renderer for PHP_CompatInfo component.
PHP_CompatInfo_Renderer_Null
Null renderer for PHP_CompatInfo component.
PHP_CompatInfo_Renderer_Text
Text renderer for PHP_CompatInfo component.
PHP_CompatInfo_Renderer_Xml
Array renderer for PHP_CompatInfo component.

Inherited Variables

Inherited Methods


Class Details

[line 55]
Base class used by all renderers


[ Top ]


Class Variables

$args =

[line 101]

All console arguments that have been parsed and recognized
  • Since: 1.8.0RC1
  • Access: public

Type:   array


[ Top ]

$conf =

[line 110]

A hash containing any additional configuration of specific driver
  • Since: 1.8.0RC1
  • Access: public

Type:   array


[ Top ]

$eol =

[line 76]

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

Type:   string


[ Top ]

$parseData =

[line 92]

Data source parsed final results
  • Access: public

Type:   array


[ Top ]

$silent =

[line 84]

Silent mode. Display or not extra info messages.
  • Access: public

Type:   boolean


[ Top ]



Method Detail

__construct (Constructor)   [line 139]

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

Base Renderer Class constructor

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_Array::__construct()
Array Renderer Class constructor (ZE2) for PHP5+
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_Null::__construct()
Null Renderer Class constructor (ZE2) for PHP5+
PHP_CompatInfo_Renderer_Text::__construct()
Text Renderer Class constructor (ZE2) for PHP5+
PHP_CompatInfo_Renderer_Xml::__construct()
Xml 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 123]

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

Base Renderer Class constructor

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 367]

void endWaitProgress( )

Finish the wait process

Finish the wait process, by erasing the progress bar

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

[ Top ]

factory   [line 225]

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

Create required instance of the Output 'driver'.

Creates a concrete instance of the renderer depending of $type

  • 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, case insensitive
array   $conf     (optional) A hash containing any additional configuration information that a subclass might need.

[ Top ]

isIncludable   [line 390]

boolean isIncludable( string $file)

Checks if in the include path

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 304]

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 339]

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 261]

void update( object &$auditEvent)

Update the current view

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 ]


Documentation generated on Mon, 19 Jan 2009 05:30:59 -0500 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.