A modScript derivative representing a MODx PHP code snippet.

• extends: modScript

Located in /model/modx/modsnippet.class.php (line 8)

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

Inherited Variables

Inherited from modScript

modScript::$_scriptCacheKey
modScript::$_scriptName

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

getContent (line 72)

Get the source content of this snippet.

{@inheritDoc}

• access: public

void getContent ([ $options = array()])

• array $options

---

Redefinition of:

modElement::getContent()

Gets the raw, unprocessed source content for this element.

remove (line 46)

Overrides modElement::remove to add custom error logging and fire modX-specific events.

{@inheritDoc}

• access: public

void remove ([ $ancestors = array ()])

• array $ancestors

---

Redefinition of:

modElement::remove()

Overrides xPDOObject::remove to remove all Property Sets that are related to this object.

save (line 15)

Overrides modElement::save to add custom error logging and fire modX-specific events.

{@inheritDoc}

• access: public

void save ([ $cacheFlag = null])

• $cacheFlag

---

Redefinition of:

modAccessibleObject::save()

Custom save that respects access policies.

setContent (line 88)

Set the source content of this snippet.

{@inheritDoc}

• access: public

void setContent ( $content, [ $options = array()])

• $content
• array $options

---

Redefinition of:

modElement::setContent()

Set the raw source content for this element.

Inherited Methods

Inherited From modScript

modScript::getScriptCacheKey()
modScript::getScriptName()
modScript::loadScript()
modScript::process()
modScript::set()

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()