PHP 클래스 MDWriter

파일 보기 프로젝트 열기: peej/phpdoctor 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$_depth integer The directory structure depth. Used to calculate relative paths.
$_doclet doclet The doclet that created this object.
$_gitHubBranch string
$_gitHubRepository string
$_gitHubSourceDirectory string
$_gitHubSourcesBranch string
$_gitHubSourcesRepository string
$_id str The id attribute value, used for selecting style.
$_output str The output body.

공개 메소드들

메소드 설명
_asPath ( $element )
_asURL ( $element )
_fieldSignature ( $element )
_flatSignature ( $method )
_methodSignature ( $method )
_normalize ( $name )
_processInlineTags ( &$tag, $first = FALSE ) : str Convert inline tags into a string for outputting.
_processTags ( &$tags ) : str Format tags for output.
_sourceLocation ( $doc )
_write ( $path ) Write the HTML page to disk using the given path.
getDirBaseURL ( )
getFileBaseURL ( )
getSourcesBaseURL ( )
mdWriter ( &$doclet ) Writer constructor.

메소드 상세

_asPath() 공개 메소드

public _asPath ( $element )

_asURL() 공개 메소드

public _asURL ( $element )

_fieldSignature() 공개 메소드

public _fieldSignature ( $element )

_flatSignature() 공개 메소드

public _flatSignature ( $method )

_methodSignature() 공개 메소드

public _methodSignature ( $method )

_normalize() 공개 메소드

public _normalize ( $name )

_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

_sourceLocation() 공개 메소드

public _sourceLocation ( $doc )

_write() 공개 메소드

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

getDirBaseURL() 공개 메소드

public getDirBaseURL ( )

getFileBaseURL() 공개 메소드

public getFileBaseURL ( )

getSourcesBaseURL() 공개 메소드

public getSourcesBaseURL ( )

mdWriter() 공개 메소드

Writer constructor.
public mdWriter ( &$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

$_gitHubBranch 공개적으로 프로퍼티

public string $_gitHubBranch
리턴 string

$_gitHubRepository 공개적으로 프로퍼티

public string $_gitHubRepository
리턴 string

$_gitHubSourceDirectory 공개적으로 프로퍼티

public string $_gitHubSourceDirectory
리턴 string

$_gitHubSourcesBranch 공개적으로 프로퍼티

public string $_gitHubSourcesBranch
리턴 string

$_gitHubSourcesRepository 공개적으로 프로퍼티

public string $_gitHubSourcesRepository
리턴 string

$_id 공개적으로 프로퍼티

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

$_output 공개적으로 프로퍼티

The output body.
public str $_output
리턴 str