Represents a category for organizing modElement instances.

Located in /model/modx/modcategory.class.php (line 7)

xPDOObject
   |
   --modAccessibleObject
      |
      --modAccessibleSimpleObject
         |
         --modCategory

array $_invalidCharacters = array('!','@','#','$','%','^','&','*',
'(',')','+','=','[',']','{','}','\'','"',':',';','\\','/','<','>','?'
,',','`','~') (line 18)

• var: A list of invalid characters in the name of an Element.
• access: protected

boolean $_parentChanged = false (line 12)

• var: Monitors whether parent has been changed.
• access: protected

Inherited Variables

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

buildClosure (line 165)

Build the closure table for this instance.

• return: True unless building the closure fails and instance is removed.
• access: public

boolean buildClosure ()

findPolicy (line 124)

Loads the access control policies applicable to this category.

• access: public

void findPolicy ([ $context = ''])

• $context

---

Redefinition of:

modAccessibleObject::findPolicy()

Find access policies applicable to this object in a specific context.

rebuildClosure (line 220)

Rebuild closure table records for this instance, i.e. parent changed.

• access: public

void rebuildClosure ()

remove (line 85)

Overrides xPDOObject::remove to reset all Element categories back to 0 and fire modX-specific events.

{@inheritDoc}

• access: public

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

• array $ancestors

---

Redefinition of:

modAccessibleObject::remove()

Custom remove that respects access policies.

save (line 47)

Overrides xPDOObject::save to fire modX-specific events

{@inheritDoc}

• access: public

void save ([ $cacheFlag = null])

• $cacheFlag

---

Redefinition of:

modAccessibleObject::save()

Custom save that respects access policies.

set (line 27)

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

{@inheritDoc}

• access: public

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

• $k
• $v
• $vType

---

Redefinition of:

xPDOObject::set()

Set a field value by the field key or name.

Inherited Methods

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