Class: phpDocumentor_XML_Beautifier_Tokenizer

Source Location: /phpDocumentor/Converters/XML/DocBook/peardoc2/Tokenizer.php

Class Overview [line 50]

XML_Beautifier_Tokenizer
   |
   --phpDocumentor_XML_Beautifier_Tokenizer

Highlights source code using parse()

Author(s):

Version:

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Highlights source code using parse()

[ Top ]


Class Variables

$eventHandlers = array(
                                PHPDOC_XMLTOKEN_EVENT_NOEVENTS => 'normalHandler',
                                PHPDOC_XMLTOKEN_EVENT_XML => 'parseXMLHandler',
                                PHPDOC_XMLTOKEN_EVENT_PI => 'parsePiHandler',
                                PHPDOC_XMLTOKEN_EVENT_ATTRIBUTE => 'attrHandler',
                                PHPDOC_XMLTOKEN_EVENT_OPENTAG => 'tagHandler',
                                PHPDOC_XMLTOKEN_EVENT_IN_CDATA => 'realcdataHandler',
                                PHPDOC_XMLTOKEN_EVENT_DEF => 'defHandler',
                                PHPDOC_XMLTOKEN_EVENT_CLOSETAG => 'closetagHandler',
                                PHPDOC_XMLTOKEN_EVENT_ENTITY => 'entityHandler',
                                PHPDOC_XMLTOKEN_EVENT_COMMENT => 'commentHandler',
                                PHPDOC_XMLTOKEN_EVENT_SINGLEQUOTE => 'stringHandler',
                                PHPDOC_XMLTOKEN_EVENT_DOUBLEQUOTE => 'stringHandler',
                                PHPDOC_XMLTOKEN_EVENT_CDATA => 'parseCdataHandler',
    )

[line 64]

Type: array

Overrides:

[ Top ]


Class Methods

phpDocumentor_XML_Beautifier_Tokenizer

phpDocumentor_XML_Beautifier_Tokenizer phpDocumentor_XML_Beautifier_Tokenizer( )

[line 570]

Initialize the $tokenpushEvent, $wordpushEvent arrays

Parameters:

[ Top ]

checkEventPop

mixed checkEventPop( $word, $pevent)

[line 535]

this function checks whether parameter $word is a token for popping the current event off of the Event Stack.

Tags:

  • return - returns false, or the event number popped off of the stack

Parameters:

  • $word -
  • $pevent -

[ Top ]

checkEventPush

mixed checkEventPush( $word, $pevent)

[line 513]

this function checks whether parameter $word is a token for pushing a new event onto the Event Stack.

Tags:

  • return - returns false, or the event number

Parameters:

  • $word -
  • $pevent -

[ Top ]

configWordParser

void configWordParser( $value $e)

[line 504]

tell the parser's WordParser $wp to set up tokens to parse words by.

tokens are word separators. In English, a space or punctuation are examples of tokens. In PHP, a token can be a ;, a parenthesis, or even the word "function"

Tags:

Parameters:

  • $value $e - integer an event number

[ Top ]

getParserEventName

void getParserEventName( $value)

[line 661]

Parameters:

  • $value -

[ Top ]

incdataHandler

void incdataHandler( object XML $parser, string $cdata)

[line 408]

Handler for real character data

Tags:

  • access - protected

Parameters:

  • object XML $parser - parser object
  • string $cdata - CDATA

[ Top ]

parseString

bool parseString( string $parse_data, Converter 1, false|string 2, false|integer 3)

[line 108]

Parse a new file

The parse() method is a do...while() loop that retrieves tokens one by one from the $_event_stack, and uses the token event array set up by the class constructor to call event handlers.

The event handlers each process the tokens passed to them, and use the _addoutput() method to append the processed tokens to the $_line variable. The word parser calls newLineNum() every time a line is reached.

In addition, the event handlers use special linking functions _link() and its cousins (_classlink(), etc.) to create in-code hyperlinks to the documentation for source code elements that are in the source code.

Tags:

Parameters:

  • Converter 1 -
  • false|string 2 - full path to file with @filesource tag, if this is a @filesource parse
  • false|integer 3 - starting line number from [email protected] linenum}
  • string $parse_data -

[ Top ]

setupStates

void setupStates( boolean $parsedata, false|string 1)

[line 553]

Initialize all parser state variables

Tags:

Parameters:

  • false|string 1 - name of class we are going to start from
  • boolean $parsedata - true if we are highlighting an inline [email protected]} tag's output

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:58 -0600 by phpDocumentor 1.4.4