• Home
• Gregwar
• RST
• Parser

PHP Class Gregwar\RST\Parser

Show file Open project: gregwar/rst Class Usage Examples

Protected Properties

Property	Type	Description
$buffer		The buffer is an array containing current lines that are parsed
$currentLine		Current line
$directive		Current directive to be applied on next node
$directives		Current directives
$document		Current document
$environment		Environment
$filename		File name
$includeAllowed		Allow include directives?
$includeRoot		Behaves like PHP's open_basedir
$isCode		Is the current node code ?
$lineInfo
$listFlow
$listLine
$specialLetter		Current level of special lines (==== and so)
$state		Current state

Public Methods

Method	Description
__construct ( $environment = null, $kernel = null )
createSpan ( $span ) : Span	Create a span, which is a text with inline style
getCurrentLine ( )	Gets the current line
getDocument ( ) : Gregwar\RST\Document	Get the current document
getEnvironment ( ) : Environment	Get the current environment
getFilename ( )	Gets the current filename
getIncludeAllowed ( ) : boolean
getIncludeRoot ( ) : string
getKernel ( ) : Kernel	Get the current kernel
getSubParser ( ) : Parser	Get a parser with the same environment that this one
includeFileAllowed ( $path ) : boolean	Is this file allowed to be included?
includeFiles ( $document )	Include all files described in $document and returns the new string of the given document with includes processed
initDirectives ( )	Initializing built-in directives
initReferences ( )	Initializing references
parse ( string $document ) : Gregwar\RST\Document	Parse a document and return a Document instance
parseFile ( string $file ) : Gregwar\RST\Document	Parses a given file and return a Document instance
parseLink ( string $line ) : boolean	Try to parse a link definition
parseLocal ( string $document ) : Gregwar\RST\Document
pushListLine ( string $line, boolean $flush = false ) : boolean	Push a line to the current list node buffer
registerDirective ( Gregwar\RST\Directive $directive )	Register a new directive handler
setIncludePolicy ( boolean $allow, string $directory = null ) : self	Allow/disallow includes, or restrict them to a directory

Protected Methods

Method	Description
directiveAddOption ( string $line )	Try to add an option line to the current directive, returns true if sucess and false if failure
findTableChars ( string $line ) : array | boolean	Finding the table chars
flush ( )	Flushes the current buffer to create a node
getCurrentDirective ( ) : Gregwar\RST\Directive	Gets the current directive
init ( )
initDirective ( string $line ) : false	Get current directive if the buffer contains one
isBlockLine ( string $line ) : boolean	A line is a code line if it's empty or if it begins with a trimable caracter, for instance:
isComment ( string $line ) : boolean	Is this line a comment ?
isDirective ( string $line ) : boolean	Is this line a directive ?
isListLine ( string $line ) : boolean	Is the given line a list line ?
isSpecialLine ( string $line ) : boolean	Tell if a line is a special separating line for title and separators, returns the depth of the special line
parseLine ( string &$line )	Process one line
parseLines ( string $document )	Process all the lines of a document string
parseListLine ( string $line ) : array	Parses a list line
parseTableLine ( string $line ) : mixed	If the given line is a table line, this will returns the parts of the given line, i.e the offset of the separators
prepareCode ( ) : boolean	Tells if the current buffer is announcing a block of code

Method Details

Property Details