An element representing executable PHP script content.

These elements are defined by some type of source content that when processed will provide output or some type of logical result based on mutable properties.

This class creates an instance of a modElement object. This should not be called directly, but rather extended for derivative modElement classes.

• abstract: Implement a derivative class that defines a table for storage.

Located in /model/modx/modscript.class.php (line 10)

xPDOObject
   |
   --modAccessibleObject
      |
      --modAccessibleSimpleObject
         |
         --modElement
            |
            --modScript

mixed $_scriptCacheKey = null (line 12)

• access: public

mixed $_scriptName = null (line 11)

• access: public

Inherited Variables

Inherited from modElement

modElement::$_cacheable
modElement::$_content
modElement::$_filters
modElement::$_invalidCharacters
modElement::$_output
modElement::$_processed
modElement::$_properties
modElement::$_propertyString
modElement::$_result
modElement::$_tag
modElement::$_token

Inherited from modAccessibleObject

modAccessibleObject::$_policies

Inherited from xPDOObject

xPDOObject::$container
xPDOObject::$fieldNames
xPDOObject::$xpdo
xPDOObject::$_aggregates
xPDOObject::$_alias
xPDOObject::$_cacheFlag
xPDOObject::$_class
xPDOObject::$_composites
xPDOObject::$_dirty
xPDOObject::$_fieldMeta
xPDOObject::$_fields
xPDOObject::$_lazy
xPDOObject::$_new
xPDOObject::$_options
xPDOObject::$_package
xPDOObject::$_pk
xPDOObject::$_pktype
xPDOObject::$_relatedObjects
xPDOObject::$_table
xPDOObject::$_tableMeta
xPDOObject::$_validated
xPDOObject::$_validationLoaded
xPDOObject::$_validationRules
xPDOObject::$_validator

getScriptCacheKey (line 73)

Get the name of the script source file, written to the cache file system

• return: The filename containing the function generated from the script element.
• access: public

string getScriptCacheKey ()

getScriptName (line 85)

Get the name of the function the script has been given.

• return: The function name representing this script element.
• access: public

string getScriptName ()

loadScript (line 98)

Loads and evaluates the script, returing the result.

• return: The result of the script.
• access: public

mixed loadScript ()

process (line 38)

Process specifically script-related functionality for modScript objects.

• access: public

void process ([ $properties = null], [ $content = null])

• $properties
• $content

---

Redefinition of:

modElement::process()

Process the element source content to produce a result.

set (line 19)

Override set to properly strip invalid tags from script code

• access: public

void set ( $k, [ $v = null], [ $vType = ''])

• $k
• $v
• $vType

---

Redefinition of:

modElement::set()

Overrides xPDOObject::set to strip invalid characters from element names.

Inherited Methods

Inherited From modElement

modElement::addPropertySet()
modElement::cache()
modElement::filterInput()
modElement::filterOutput()
modElement::findPolicy()
modElement::get()
modElement::getContent()
modElement::getInputFilter()
modElement::getOutputFilter()
modElement::getProperties()
modElement::getPropertySet()
modElement::getTag()
modElement::getToken()
modElement::isCacheable()
modElement::process()
modElement::remove()
modElement::removePropertySet()
modElement::set()
modElement::setCacheable()
modElement::setContent()
modElement::setProperties()
modElement::setTag()
modElement::setToken()
modElement::toPlaceholders()

Inherited From modAccessibleObject

modAccessibleObject::checkPolicy()
modAccessibleObject::findPolicy()
modAccessibleObject::getPolicies()
modAccessibleObject::load()
modAccessibleObject::loadCollection()
modAccessibleObject::remove()
modAccessibleObject::save()
modAccessibleObject::setPolicies()
modAccessibleObject::_loadCollectionInstance()
modAccessibleObject::_loadInstance()

Inherited From xPDOObject

xPDOObject::__construct()
xPDOObject::addMany()
xPDOObject::addOne()
xPDOObject::addValidationRule()
xPDOObject::encode()
xPDOObject::fromArray()
xPDOObject::fromJSON()
xPDOObject::get()
xPDOObject::getFieldName()
xPDOObject::getFKClass()
xPDOObject::getFKDefinition()
xPDOObject::getMany()
xPDOObject::getOne()
xPDOObject::getOption()
xPDOObject::getPK()
xPDOObject::getPKType()
xPDOObject::getPrimaryKey()
xPDOObject::getSelectColumns()
xPDOObject::getValidator()
xPDOObject::isDirty()
xPDOObject::isLazy()
xPDOObject::isNew()
xPDOObject::isValidated()
xPDOObject::load()
xPDOObject::loadCollection()
xPDOObject::loadCollectionGraph()
xPDOObject::remove()
xPDOObject::removeValidationRules()
xPDOObject::save()
xPDOObject::set()
xPDOObject::setDirty()
xPDOObject::setOption()
xPDOObject::toArray()
xPDOObject::toJSON()
xPDOObject::validate()
xPDOObject::_getAliases()
xPDOObject::_getDataType()
xPDOObject::_getPHPType()
xPDOObject::_getRelatedObjectsByFK()
xPDOObject::_initFields()
xPDOObject::_loadCollectionInstance()
xPDOObject::_loadFieldData()
xPDOObject::_loadInstance()
xPDOObject::_loadRows()
xPDOObject::_loadValidation()
xPDOObject::_saveRelatedObject()
xPDOObject::_saveRelatedObjects()
xPDOObject::_setRaw()