• 홈
• Gregwar
• RST
• Builder

PHP 클래스 Gregwar\RST\Builder

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

보호된 프로퍼티들

프로퍼티	타입	설명
$beforeHooks		Hooks before the parsing on the environment
$directory		Source and target directory
$documents		Parsed documents waiting to be rendered
$errorManager		Error manager
$hooks		Hooks after the parsing
$indexName		Tree index name
$kernel		Kernel
$metas		Metas for documents
$parseQueue		Queue of documents to be parsed
$states		States (decision) of the scanned documents
$targetDirectory
$toCopy		Files to copy at the end of the build
$toMkdir
$verbose		Verbose build ?

공개 메소드들

메소드	설명
__construct ( $kernel = null )
addBeforeHook ( $function )	Adds an hook which will be called on each environment during building
addHook ( $function )	Adds an hook which will be called on each document after parsing
build ( $directory, $targetDirectory = 'output', $verbose = true )
copy ( $source, $destination = null )	Add a file to copy
doCopy ( )	Run the copy
doMkdir ( )	Run the directories creation
getErrorManager ( )
getIndexName ( )
getRST ( $file )	Gets the .rst of a source file
getSourceFile ( $filename )	Gets the name of a source file
getTargetFile ( $filename )	Gets the name of a target file
getTargetOf ( $file )	Gets the name of a target for a file, for instance /introduction/part1 could be resolved into /path/to/introduction/part1.html
getUrl ( $document )	Gets the URL of a target file
mkdir ( $directory )	Creates a directory in the target
scan ( $file )	Scans a file, this will check the status of the file and tell if it needs to be parsed or not
scanMetas ( )	Scans all the metas
setIndexName ( $name )

보호된 메소드들

메소드	설명
addToParseQueue ( $file )	Adding a file to the parse queue
display ( $text )
getFileToParse ( )	Returns the next file to parse
getMetaFile ( )	Get the meta file name
loadMetas ( )	Try to inport the metas from the meta files
parseAll ( )	Parses all the document that need to be parsed
render ( )	Renders all the pending documents
saveMetas ( )	Saving the meta files

메소드 상세

프로퍼티 상세