Represents a group of users with common attributes.

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

xPDOObject
   |
   --xPDOSimpleObject
      |
      --modUserGroup

Inherited Variables

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

getResourceGroups (line 100)

Get all resource groups related to the user group.

• return: An array of resource groups.
• access: public

array getResourceGroups ([$limit $limit = false], [$start $start = 0])

• $limit $limit: The number of Resource Groups to grab. Defaults to 0, which grabs all Groups.
• $start $start: The starting index for the limit query.

getUsersIn (line 67)

Get all users in a user group.

• return: An array of modUser objects.
• access: public

array getUsersIn ([ $criteria = array()])

• array $criteria

remove (line 40)

Overrides xPDOObject::remove to fire modX-specific events

{@inheritDoc}

• access: public

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

• array $ancestors

---

Redefinition of:

xPDOObject::remove()

Remove the persistent instance of an object permanently.

save (line 13)

Overrides xPDOObject::save to fire modX-specific events.

{@inheritDoc}

• access: public

void save ([ $cacheFlag = null])

• $cacheFlag

---

Redefinition of:

xPDOObject::save()

Persist new or changed objects to the database container.

Inherited Methods

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