Provides an interface for accessing and managing the context of the documents and entities

rendered.

Class Methods

The following methods can be invoked on instances of this class.

setVariable(mixed strVarName, mixed mixedValue)

Adds a variable to document
The variable is registered into the document, making it possible to referenced via script.

setVariableArray(mixed arrVar)

TODO: deprecate!

getVariable(string strVarName)

Returns the value of a parser variable

getAllVariables()

Returns all set variables

unsetVariable(string strVarName)

Unregisters a variable from the parser

pushDocument(\Framewok\DOM\Nodes\Document pDocument)

Pushes a document onto the context stack

popDocument()

Pops a document off the context stack

getCurrentDocument()

Returns the current document

pushEntity(mixed strComponent, string strEntityId)

Pushes an entity onto the context stack

popEntity()

Pops an entity off the context stack

getCurrentEntity()

Returns the current entity

setIsInEmail(bool bInEmail)

Sets if the current context renders out to an email

getIsInEmail()

Returns if the current context renders out to an email

setEditModeHTMLEditor(\Controls\Forms\HTMLEditor pHTMLEditor)

Sets whether or not the request is in edit mode

getEditModeHTMLEditor()

Returns whether or not the request is in edit mode

setEditModeAdditional(array arrAdditional)

Sets the current state of the additional items in the editor

getEditModeAdditional()

Returns the current state of the additional items in the editor

getEditModeAdditionalKeyValue(mixed strKey)

Returns a key value of the current state of the additional items in the editor

getIsInEditMode()

Returns whether or not the request is in edit mode

__call(mixed strName, array arrArguments)

Magic function to trap calls to undefined functions and throw an exception rather than
a fatal error.

__callStatic(mixed strName, array arrArguments)

Magic function to trap static calls to undefined functions and throw an exception rather
than a fatal error.

classGetFolder()

Returns the folder where the class exists

__set_state(mixed arrValues)

classGetFolderResources()

Returns the folder where the class's resources exist

classGetSrcFile()

Returns the folder where the class exists

classGetSrcHash()

Returns the folder where the class exists

classGetReflection()

Returns the reflection data for the current class

classGetReflectionAnnotation(string strField)

Returns a specific class annotation for the current class