• 홈
• Gregwar
• RST
• Environment

PHP 클래스 Gregwar\RST\Environment

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

공개 프로퍼티들

프로퍼티	타입	설명
$errorManager		Error manager
$letters		Letters used as separators for titles and horizontal line
$prettyTableHeader
$prettyTableJoint
$prettyTableLetter
$tableLetter		Table letters

보호된 프로퍼티들

프로퍼티	타입	설명
$anonymous		Anonymous links stack
$counters
$currentDirectory
$currentFileName		Current file name
$currentTitleLevel		Title letter for each levels
$dependencies		Dependencies of this document
$levels		Level counters
$links		Links
$metas		Metas
$references		References that can be resolved
$targetDirectory
$titleLetters
$url
$variables		Variables of the document

공개 메소드들

메소드	설명
__construct ( )
absoluteRelativePath ( $url )	Returns an absolute path for a relative given URL
addDependency ( $dependency )	Adds a dependency to the document
canonicalUrl ( $url )	Gets a canonical URL from the given one
createTitle ( $level )	Title level
found ( $section, $data )
getDependencies ( )	Getting all the dependencies for this environment
getDepth ( )	Get the depth of the current file name (the number of parent directories)
getDirName ( )	Returns the directory name
getErrorManager ( )
getLevel ( $letter )
getLink ( $name, $relative = true )	Get a link value
getMetas ( )
getMyToc ( )	Get the docs involving this document
getNumber ( $level )	Get a level number
getParent ( )	Get my parent metas
getTargetDirectory ( )
getTitleLetters ( )
getUrl ( )
getVariable ( $variable, $default = null )	Gets the variable value
pushAnonymous ( $name )	Set the current anonymous links name
registerReference ( Gregwar\RST\Reference $reference )	Registers a new reference
relativeUrl ( $url )	Resolves a relative URL using directories, for instance, if the current directory is "path/to/something", and you want to get the relative URL to "path/to/something/else.html", the result will be else.html. Else, ".
reset ( )	Puts the environment in a clean state for a new parse, like title level order.
resetAnonymousStack ( )	Resets the anonymous stack
resolve ( $section, $data )	Resolves a reference
setCurrentDirectory ( $directory )	Sets the directory of the current parsing
setCurrentFileName ( $filename )	Sets the current file name
setErrorManager ( Gregwar\RST\ErrorManager $errorManager )
setLink ( $name, $url )	Set the link url
setMetas ( $metas )
setTargetDirectory ( $directory )
setUrl ( $url )
setVariable ( $variable, $value )	Sets the giving variable to a value

보호된 메소드들

메소드	설명
canonicalize ( $url )	Canonicalize a path, a/b/c/.
samePrefix ( $url )	Returns true if the given url have the same prefix as the current document

메소드 상세

프로퍼티 상세