DOM\CurrentContext
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext
DESCRIPTION
METHODS
getAllVariables()
getIsInEditMode()
getIsInEmail()
getVariable()
setVariable()
setVariablePush()
unsetVariable()
unsetVariablePop()
\Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

CurrentContext

rendered.

Methods

Invoke via \Framework\DOM\CurrentContext::method()
Click a method name to copy it.
array getAllVariables()
Returns all set variables
Return
array
bool getIsInEditMode()
Returns whether the request is taking place within the context of a design that is currently rendering around a HTMLEditor (behind the stripe overlay). This context has limited access to client side scripting and content served into it may need special handling.
Return
bool
bool getIsInEmail()
Returns if the current context renders out to an email
Return
bool
mixed getVariable($strVarName)
Returns the value of a parser variable
Parameters
$strVarName
mixed
Return
$mixedValue Value of the variable
void setVariable($strVarName, $mixedValue)
Adds a variable to document

The variable is registered into the document, making it possible to referenced via script.
Parameters
$strVarName
mixed
$mixedValue
mixed
void setVariablePush($strVarName, $mixedValue)
Adds a variable to document

The variable is registered into the document, making it possible to referenced via script.
Parameters
$strVarName
mixed
$mixedValue
mixed
void unsetVariable($strVarName)
Unregisters a variable from the parser
Parameters
$strVarName
mixed
void unsetVariablePop($strVarName)
Unregisters a variable from the parser
Parameters
$strVarName
mixed