PHP Class HtmlWriter

Show file Open project: peej/phpdoctor Class Usage Examples

Public Properties

Property Type Description
$_depth integer The directory structure depth. Used to calculate relative paths.
$_doclet doclet The doclet that created this object.
$_id str The id attribute value, used for selecting style.
$_output str The output body.
$_sections str[][] The section titles to place in the header and footer.

Public Methods

Method Description
_doctype ( ) : str Get the HTML DOCTYPE for this output
_htmlFooter ( ) : str Build the HTML footer.
_htmlHeader ( $title ) : str Build the HTML header. Includes doctype definition, and sections, meta data and window title.
_processInlineTags ( &$tag, $first = FALSE ) : str Convert inline tags into a string for outputting.
_processTags ( &$tags ) : str Format tags for output.
_shellFooter ( $path, $footer ) : str Build the HTML shell footer. Includes the end of the section, and page footer.
_shellHeader ( $path ) : str Build the HTML shell header. Includes beginning of the section, and the page header.
_write ( $path, $title, $shell, $footer = true ) Write the HTML page to disk using the given path.
htmlWriter ( &$doclet ) Writer constructor.

Method Details

_doctype() public method

Get the HTML DOCTYPE for this output
public _doctype ( ) : str
return str

_htmlFooter() public method

Build the HTML footer.
public _htmlFooter ( ) : str
return str

_htmlHeader() public method

Build the HTML header. Includes doctype definition, and sections, meta data and window title.
public _htmlHeader ( $title ) : str
return str

_processInlineTags() public method

Convert inline tags into a string for outputting.
public _processInlineTags ( &$tag, $first = FALSE ) : str
return str The string representation of the elements doc tags

_processTags() public method

Format tags for output.
public _processTags ( &$tags ) : str
return str The string representation of the elements doc tags

_shellFooter() public method

Build the HTML shell footer. Includes the end of the section, and page footer.
public _shellFooter ( $path, $footer ) : str
return str

_shellHeader() public method

Build the HTML shell header. Includes beginning of the section, and the page header.
public _shellHeader ( $path ) : str
return str

_write() public method

Write the HTML page to disk using the given path.
public _write ( $path, $title, $shell, $footer = true )

htmlWriter() public method

Writer constructor.
public htmlWriter ( &$doclet )

Property Details

$_depth public property

The directory structure depth. Used to calculate relative paths.
public int $_depth
return integer

$_doclet public property

The doclet that created this object.
public doclet $_doclet
return doclet

$_id public property

The id attribute value, used for selecting style.
public str $_id
return str

$_output public property

The output body.
public str $_output
return str

$_sections public property

The section titles to place in the header and footer.
public str[][] $_sections
return str[][]