PHP 클래스 htmlWriter

파일 보기 프로젝트 열기: peej/phpdoctor

공개 프로퍼티들

프로퍼티 타입 설명
$_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.

공개 메소드들

메소드 설명
_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.
_nav ( $path ) : str Build the navigation bar
_processInlineTags ( &$tag, $first = FALSE ) : str Convert inline tags into a string for outputting.
_processTags ( &$tags ) : str Format tags for output.
_shellFooter ( $path ) : 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.
_sourceLocation ( $doc )
_write ( $path, $title, $shell ) Write the HTML page to disk using the given path.
htmlWriter ( &$doclet ) Writer constructor.

메소드 상세

_doctype() 공개 메소드

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

_htmlFooter() 공개 메소드

Build the HTML footer.
public _htmlFooter ( ) : str
리턴 str

_htmlHeader() 공개 메소드

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

_nav() 공개 메소드

Build the navigation bar
public _nav ( $path ) : str
리턴 str

_processInlineTags() 공개 메소드

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

_processTags() 공개 메소드

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

_shellFooter() 공개 메소드

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

_shellHeader() 공개 메소드

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

_sourceLocation() 공개 메소드

public _sourceLocation ( $doc )

_write() 공개 메소드

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

htmlWriter() 공개 메소드

Writer constructor.
public htmlWriter ( &$doclet )

프로퍼티 상세

$_depth 공개적으로 프로퍼티

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

$_doclet 공개적으로 프로퍼티

The doclet that created this object.
public doclet $_doclet
리턴 doclet

$_id 공개적으로 프로퍼티

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

$_output 공개적으로 프로퍼티

The output body.
public str $_output
리턴 str

$_sections 공개적으로 프로퍼티

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