MODX 3 Object Quick Reference

The following list of MODX Revolution objects is generated from the MODX schema file. Click on one of the links below to jump to the object you want to know about.

Note: If the text background turns blue for you toward the bottom of this page, it's due to a longstanding bug in Firefox. Sometimes turning hardware acceleration off in FF fixes it. If not, try another browser.

This reference is abbreviated for convenience and there's no indication of compound indexes, but it's usually more useful because it shows inherited fields and the Full reference doesn't. Aggregate and composite aliases are combined here (although the aggregates are listed first and there's a little extra space between the aggregate and composite aliases).

To see the MODX 3 object Full Reference, go here.

To see the MODX 2 version of this page, go here.

MODX Revolution Objects

modAccess

   Extends: xPDO\Om\xPDOSimpleObject
   Fields:
      target  (string)
      principal_class  (string)
      principal  (integer)
      authority  (integer)
      policy  (integer)
   Indexes:   Indexes: target, principal_class, principal, authority, policy

   Aliases:
      Policy
        -- use getOne('Policy') -- returns a MODX\Revolution\modAccessPolicy object
      Principal
        -- use getOne('Principal') -- returns a MODX\Revolution\modPrincipal object
      GroupPrincipal
        -- use getOne('GroupPrincipal') -- returns a MODX\Revolution\modUserGroup object
      UserPrincipal
        -- use getOne('UserPrincipal') -- returns a MODX\Revolution\modUserGroup object
      MinimumRole
        -- use getOne('MinimumRole') -- returns a MODX\Revolution\modUserGroupRole object
Back to Top . . .

modAccessActionDom

   Extends: MODX\Revolution\modAccess
   Table: modx_access_actiondom

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modActionDom object
Back to Top . . .

modAccessCategory

   Extends: MODX\Revolution\modAccess
   Table: modx_access_category

   Fields:
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modCategory object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessContext

   Extends: MODX\Revolution\modAccess
   Table: modx_access_context

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessElement

   Extends: MODX\Revolution\modAccess
   Table: modx_access_elements

   Fields:
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modElement object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessMediaSource

   Extends: MODX\Revolution\modAccess
   Table: modx_access_media_source

   Fields:
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\Sources\modMediaSource object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessMenu

   Extends: MODX\Revolution\modAccess
   Table: modx_access_menus

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modMenu object
Back to Top . . .

modAccessNamespace

   Extends: MODX\Revolution\modAccess
   Table: modx_access_namespace

   Fields:
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modNamespace object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessPermission

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_access_permissions

   Fields:
      template  (integer)
      name  (string)
      description  (string)
      value  (boolean)
   Indexes:   Indexes: template, name

   Aliases:
      Template
        -- use getOne('Template') -- returns a MODX\Revolution\modAccessPolicyTemplate object
Back to Top . . .

modAccessPolicy

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_access_policies

   Fields:
      name  (string)
      description  (string)
      parent  (integer)
      template  (integer)
      class  (string)
      data  (json)
      lexicon  (string)
   Indexes:   Indexes: name, parent, class, template

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a MODX\Revolution\modAccessPolicy object
      Template
        -- use getOne('Template') -- returns a MODX\Revolution\modAccessPolicyTemplate object

      Children
        -- use getMany('Children') -- returns an array of MODX\Revolution\modAccessPolicy objects
Back to Top . . .

modAccessPolicyTemplate

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_access_policy_templates

   Fields:
      template_group  (integer)
      name  (string)
      description  (string)
      lexicon  (string)

   Aliases:
      TemplateGroup
        -- use getOne('TemplateGroup') -- returns a MODX\Revolution\modAccessPolicyTemplateGroup object

      Permissions
        -- use getMany('Permissions') -- returns an array of MODX\Revolution\modAccessPermission objects
      Policies
        -- use getMany('Policies') -- returns an array of MODX\Revolution\modAccessPolicy objects
Back to Top . . .

modAccessPolicyTemplateGroup

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_access_policy_template_groups

   Fields:
      name  (string)
      description  (string)

   Aliases:

      Templates
        -- use getMany('Templates') -- returns an array of MODX\Revolution\modAccessPolicyTemplate objects
Back to Top . . .

modAccessResource

   Extends: MODX\Revolution\modAccess
   Table: modx_access_resources

   Fields:
      context_key  (string)
   Indexes:   Indexes: context_key

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modResource object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessResourceGroup

   Extends: MODX\Revolution\modAccess
   Table: modx_access_resource_groups

   Fields:
      context_key  (string)
   Indexes:   Indexes: context_key, principal_class

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modResourceGroup object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modAccessTemplateVar

   Extends: MODX\Revolution\modAccessElement
   Table: modx_access_templatevars

   Aliases:
      Target
        -- use getOne('Target') -- returns a MODX\Revolution\modTemplateVar object
Back to Top . . .

modAccessibleObject

   Extends: xPDO\Om\xPDOObject
Back to Top . . .

modAccessibleSimpleObject

   Extends: MODX\Revolution\modAccessibleObject
   Fields:
      id  (integer)
   Indexes:   Indexes: PRIMARY
Back to Top . . .

modActionDom

   Extends: MODX\Revolution\modAccessibleSimpleObject
   Table: modx_actiondom

   Fields:
      set  (integer)
      action  (string)
      name  (string)
      description  (string)
      xtype  (string)
      container  (string)
      rule  (string)
      value  (string)
      constraint  (string)
      constraint_field  (string)
      constraint_class  (string)
      active  (boolean)
      for_parent  (boolean)
      rank  (integer)
   Indexes:
        set, action
        name, active
        for_parent, rank
   Aliases:
      FCSet
        -- use getOne('FCSet') -- returns a MODX\Revolution\modFormCustomizationSet object

      Access
        -- use getMany('Access') -- returns an array of MODX\Revolution\modAccessActionDom objects
Back to Top . . .

modActionField

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_actions_fields

   Fields:
      action  (string)
      name  (string)
      type  (string)
      tab  (string)
      form  (string)
      other  (string)
      rank  (integer)
   Indexes:   Indexes: action, type, tab

   Aliases:
      Action
        -- use getOne('Action') -- returns a MODX\Revolution\modAction object
Back to Top . . .

modActiveUser

   Extends: xPDO\Om\xPDOObject
   Table: modx_active_users

   Fields:
      internalKey  (integer)
      username  (string)
      lasthit  (timestamp)
      id  (integer)
      action  (string)
      ip  (string)
   Indexes:   Indexes: internalKey

   Aliases:
      User
        -- use getOne('User') -- returns a MODX\Revolution\modUser object
Back to Top . . .

modCategory

   Extends: MODX\Revolution\modAccessibleSimpleObject
   Table: modx_categories

   Fields:
      parent  (integer)
      category  (string)
      rank  (integer)
   Indexes:   Indexes: parent, category, rank

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a MODX\Revolution\modCategory object
      Chunks
        -- use getMany('Chunks') -- returns an array of MODX\Revolution\modChunk objects
      Snippets
        -- use getMany('Snippets') -- returns an array of MODX\Revolution\modSnippet objects
      Plugins
        -- use getMany('Plugins') -- returns an array of MODX\Revolution\modPlugin objects
      Templates
        -- use getMany('Templates') -- returns an array of MODX\Revolution\modTemplate objects
      TemplateVars
        -- use getMany('TemplateVars') -- returns an array of MODX\Revolution\modTemplateVar objects
      PropertySets
        -- use getMany('PropertySets') -- returns an array of MODX\Revolution\modPropertySet objects

      Children
        -- use getMany('Children') -- returns an array of MODX\Revolution\modCategory objects
      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessCategory objects
      Ancestors
        -- use getMany('Ancestors') -- returns an array of MODX\Revolution\modCategoryClosure objects
      Descendants
        -- use getMany('Descendants') -- returns an array of MODX\Revolution\modCategoryClosure objects
Back to Top . . .

modCategoryClosure

   Extends: xPDO\Om\xPDOObject
   Table: modx_categories_closure

   Fields:
      ancestor  (integer)
      descendant  (integer)
      depth  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Ancestor
        -- use getOne('Ancestor') -- returns a MODX\Revolution\modCategory object
      Descendant
        -- use getOne('Descendant') -- returns a MODX\Revolution\modCategory object
Back to Top . . .

modChunk

   Extends: MODX\Revolution\modElement
   Table: modx_site_htmlsnippets

   Fields:
      name  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
      cache_type  (integer)
      snippet  (string)
      locked  (boolean)
      properties  (array)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: name, category, locked, static

   Aliases:
      Category
        -- use getOne('Category') -- returns a MODX\Revolution\modCategory object

      PropertySets
        -- use getMany('PropertySets') -- returns an array of MODX\Revolution\modElementPropertySet objects
Back to Top . . .

modContentType

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_content_type

   Fields:
      name  (string)
      description  (string)
      mime_type  (string)
      file_extensions  (string)
      icon  (string)
      headers  (array)
      binary  (boolean)
   Indexes:   Indexes: name

   Aliases:
      Resources
        -- use getMany('Resources') -- returns an array of MODX\Revolution\modResource objects
Back to Top . . .

modContext

   Extends: MODX\Revolution\modAccessibleObject
   Table: modx_context

   Fields:
      key  (string)
      name  (string)
      description  (string)
      rank  (integer)
   Indexes:   Indexes: PRIMARY, name, rank

   Aliases:

      ContextResources
        -- use getMany('ContextResources') -- returns an array of MODX\Revolution\modContextResource objects
      ContextSettings
        -- use getMany('ContextSettings') -- returns an array of MODX\Revolution\modContextSetting objects
      SourceElements
        -- use getMany('SourceElements') -- returns an array of MODX\Revolution\Sources\modMediaSourceElement objects
      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessContext objects
Back to Top . . .

modContextResource

   Extends: xPDO\Om\xPDOObject
   Table: modx_context_resource

   Fields:
      context_key  (string)
      resource  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
      Resource
        -- use getOne('Resource') -- returns a MODX\Revolution\modResource object
Back to Top . . .

modContextSetting

   Extends: xPDO\Om\xPDOObject
   Table: modx_context_setting

   Fields:
      context_key  (string)
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
      SystemSetting
        -- use getOne('SystemSetting') -- returns a MODX\Revolution\modSystemSetting object
Back to Top . . .

modDashboard

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_dashboard

   Fields:
      name  (string)
      description  (string)
      hide_trees  (boolean)
      customizable  (boolean)
   Indexes:   Indexes: name, hide_trees

   Aliases:
      UserGroups
        -- use getMany('UserGroups') -- returns an array of MODX\Revolution\modUserGroup objects

      Placements
        -- use getMany('Placements') -- returns an array of MODX\Revolution\modDashboardWidgetPlacement objects
Back to Top . . .

modDashboardWidget

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_dashboard_widget

   Fields:
      name  (string)
      description  (string)
      type  (string)
      content  (string)
      properties  (json)
      namespace  (string)
      lexicon  (string)
      size  (string)
      permission  (string)
   Indexes:   Indexes: name, type, namespace, lexicon

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a MODX\Revolution\modNamespace object

      Placements
        -- use getMany('Placements') -- returns an array of MODX\Revolution\modDashboardWidgetPlacement objects
Back to Top . . .

modDashboardWidgetPlacement

   Extends: xPDO\Om\xPDOObject
   Table: modx_dashboard_widget_placement

   Fields:
      user  (integer)
      dashboard  (integer)
      widget  (integer)
      rank  (integer)
      size  (string)
   Indexes:   Indexes: PRIMARY, rank

   Aliases:
      User
        -- use getOne('User') -- returns a MODX\Revolution\modUser object
      Dashboard
        -- use getOne('Dashboard') -- returns a MODX\Revolution\modDashboard object
      Widget
        -- use getOne('Widget') -- returns a MODX\Revolution\modDashboardWidget object
Back to Top . . .

modDeprecatedCall

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_deprecated_call

   Fields:
      method  (integer)
      call_count  (integer)
      caller  (string)
      caller_file  (string)
      caller_line  (integer)
   Indexes:   Indexes: method, call_count, caller, caller_file, caller_line

   Aliases:
      Method
        -- use getOne('Method') -- returns a MODX\Revolution\modDeprecatedMethod object
Back to Top . . .

modDeprecatedMethod

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_deprecated_method

   Fields:
      definition  (string)
      since  (string)
      recommendation  (string)
   Indexes:   Indexes: definition

   Aliases:

      Callers
        -- use getMany('Callers') -- returns an array of MODX\Revolution\modDeprecatedCall objects
Back to Top . . .

modDocument

   Extends: MODX\Revolution\modResource
Back to Top . . .

modElement

   Extends: MODX\Revolution\modAccessibleSimpleObject
   Table: modx_site_element

   Fields:
      source  (integer)
      property_preprocess  (boolean)

   Aliases:
      CategoryAcls
        -- use getMany('CategoryAcls') -- returns an array of MODX\Revolution\modAccessCategory objects
      Source
        -- use getOne('Source') -- returns a MODX\Revolution\Sources\modMediaSource object

      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessElement objects
Back to Top . . .

modElementPropertySet

   Extends: xPDO\Om\xPDOObject
   Table: modx_element_property_sets

   Fields:
      element  (integer)
      element_class  (string)
      property_set  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Element
        -- use getOne('Element') -- returns a MODX\Revolution\modElement object
      PropertySet
        -- use getOne('PropertySet') -- returns a MODX\Revolution\modPropertySet object
Back to Top . . .

modEvent

   Extends: xPDO\Om\xPDOObject
   Table: modx_system_eventnames

   Fields:
      name  (string)
      service  (integer)
      groupname  (string)
   Indexes:   Indexes: PRIMARY

   Aliases:
      PluginEvents
        -- use getMany('PluginEvents') -- returns an array of MODX\Revolution\modPluginEvent objects
Back to Top . . .

modExtensionPackage

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_extension_packages

   Fields:
      namespace  (string)
      name  (string)
      path  (string)
      table_prefix  (string)
      service_class  (string)
      service_name  (string)
      created_at  (datetime)
      updated_at  (datetime)
   Indexes:   Indexes: namespace, name

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a MODX\Revolution\modNamespace object
Back to Top . . .

modFTPMediaSource

   Extends: MODX\Revolution\Sources\modMediaSource
Back to Top . . .

modFileMediaSource

   Extends: MODX\Revolution\Sources\modMediaSource
Back to Top . . .

modFormCustomizationProfile

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_fc_profiles

   Fields:
      name  (string)
      description  (string)
      active  (integer)
      rank  (integer)
   Indexes:   Indexes: name, rank, active

   Aliases:

      Sets
        -- use getMany('Sets') -- returns an array of MODX\Revolution\modFormCustomizationSet objects
      UserGroups
        -- use getMany('UserGroups') -- returns an array of MODX\Revolution\modFormCustomizationProfileUserGroup objects
Back to Top . . .

modFormCustomizationProfileUserGroup

   Extends: xPDO\Om\xPDOObject
   Table: modx_fc_profiles_usergroups

   Fields:
      usergroup  (integer)
      profile  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      UserGroup
        -- use getOne('UserGroup') -- returns a MODX\Revolution\modUserGroup object
      Profile
        -- use getOne('Profile') -- returns a MODX\Revolution\modFormCustomizationProfile object
Back to Top . . .

modFormCustomizationSet

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_fc_sets

   Fields:
      profile  (integer)
      action  (string)
      description  (string)
      active  (integer)
      template  (integer)
      constraint  (string)
      constraint_field  (string)
      constraint_class  (string)
   Indexes:   Indexes: profile, action, active, template

   Aliases:
      Template
        -- use getOne('Template') -- returns a MODX\Revolution\modTemplate object
      Profile
        -- use getOne('Profile') -- returns a MODX\Revolution\modFormCustomizationProfile object

      Rules
        -- use getMany('Rules') -- returns an array of MODX\Revolution\modActionDom objects
Back to Top . . .

modLexiconEntry

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_lexicon_entries

   Fields:
      name  (string)
      value  (string)
      topic  (string)
      namespace  (string)
      language  (string)
      createdon  (datetime)
      editedon  (timestamp)
   Indexes:   Indexes: name, topic, namespace, language

   Aliases:
      Namespace
        -- use getOne('Namespace') -- returns a MODX\Revolution\modNamespace object
Back to Top . . .

modManagerLog

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_manager_log

   Fields:
      user  (integer)
      occurred  (datetime)
      action  (string)
      classKey  (string)
      item  (string)
   Indexes:   Indexes: user_occurred

   Aliases:
      User
        -- use getOne('User') -- returns a MODX\Revolution\modUser object
Back to Top . . .

modMediaSource

   Extends: MODX\Revolution\modAccessibleSimpleObject
   Table: modx_media_sources

   Fields:
      name  (string)
      description  (string)
      class_key  (string)
      properties  (array)
      is_stream  (boolean)
   Indexes:   Indexes: name, class_key, is_stream

   Aliases:
      Chunks
        -- use getMany('Chunks') -- returns an array of MODX\Revolution\modChunk objects
      Plugins
        -- use getMany('Plugins') -- returns an array of MODX\Revolution\modPlugin objects
      Snippets
        -- use getMany('Snippets') -- returns an array of MODX\Revolution\modSnippet objects
      Templates
        -- use getMany('Templates') -- returns an array of MODX\Revolution\modTemplate objects
      TemplateVars
        -- use getMany('TemplateVars') -- returns an array of MODX\Revolution\modTemplateVar objects

      SourceElement
        -- use getOne('SourceElement') -- returns aMODX\Revolution\Sources\modMediaSourceElement object
Back to Top . . .

modMediaSourceContext

   Extends: xPDO\Om\xPDOObject
   Table: modx_media_sources_contexts

   Fields:
      source  (integer)
      context_key  (string)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Source
        -- use getOne('Source') -- returns a MODX\Revolution\Sources\modMediaSource object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modMediaSourceElement

   Extends: xPDO\Om\xPDOObject
   Table: modx_media_sources_elements

   Fields:
      source  (integer)
      object_class  (string)
      object  (integer)
      context_key  (string)
   Indexes:   Indexes: PRIMARY

   Aliases:
      Source
        -- use getOne('Source') -- returns a MODX\Revolution\Sources\modMediaSource object
      Element
        -- use getOne('Element') -- returns a MODX\Revolution\modElement object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object
Back to Top . . .

modMenu

   Extends: MODX\Revolution\modAccessibleObject
   Table: modx_menus

   Fields:
      text  (string)
      parent  (string)
      action  (string)
      description  (string)
      icon  (string)
      menuindex  (integer)
      params  (string)
      handler  (string)
      permissions  (string)
      namespace  (string)
   Indexes:   Indexes: PRIMARY, parent, action, namespace

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a MODX\Revolution\modMenu object
      Children
        -- use getMany('Children') -- returns an array of MODX\Revolution\modMenu objects

      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessMenu objects
Back to Top . . .

modNamespace

   Extends: MODX\Revolution\modAccessibleObject
   Table: modx_namespaces

   Fields:
      name  (string)
      path  (string)
      assets_path  (string)
   Indexes:   Indexes: PRIMARY

   Aliases:

      LexiconEntries
        -- use getMany('LexiconEntries') -- returns an array of MODX\Revolution\modLexiconEntry objects
      SystemSettings
        -- use getMany('SystemSettings') -- returns an array of MODX\Revolution\modSystemSetting objects
      ContextSettings
        -- use getMany('ContextSettings') -- returns an array of MODX\Revolution\modContextSetting objects
      UserSettings
        -- use getMany('UserSettings') -- returns an array of MODX\Revolution\modUserSetting objects
      ExtensionPackages
        -- use getMany('ExtensionPackages') -- returns an array of MODX\Revolution\modExtensionPackage objects
      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessNamespace objects
Back to Top . . .

modPlugin

   Extends: MODX\Revolution\modScript
   Table: modx_site_plugins

   Fields:
      cache_type  (integer)
      plugincode  (string)
      locked  (boolean)
      properties  (array)
      disabled  (boolean)
      moduleguid  (string)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: locked, disabled, static

   Aliases:

      PropertySets
        -- use getMany('PropertySets') -- returns an array of MODX\Revolution\modElementPropertySet objects
      PluginEvents
        -- use getMany('PluginEvents') -- returns an array of MODX\Revolution\modPluginEvent objects
Back to Top . . .

modPluginEvent

   Extends: xPDO\Om\xPDOObject
   Table: modx_site_plugin_events

   Fields:
      pluginid  (integer)
      event  (string)
      priority  (integer)
      propertyset  (integer)
   Indexes:   Indexes: PRIMARY, priority

   Aliases:
      Plugin
        -- use getOne('Plugin') -- returns a MODX\Revolution\modPlugin object
      Event
        -- use getOne('Event') -- returns a MODX\Revolution\modEvent object
      PropertySet
        -- use getOne('PropertySet') -- returns a MODX\Revolution\modPropertySet object
Back to Top . . .

modPrincipal

   Extends: xPDO\Om\xPDOSimpleObject
   Aliases:

      Acls
        -- use getMany('Acls') -- returns an array of modAccess objects
Back to Top . . .

modPropertySet

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_property_set

   Fields:
      name  (string)
      category  (integer)
      description  (string)
      properties  (array)
   Indexes:   Indexes: name, category

   Aliases:
      Category
        -- use getOne('Category') -- returns a MODX\Revolution\modCategory object

      Elements
        -- use getMany('Elements') -- returns an array of MODX\Revolution\modElementPropertySet objects
Back to Top . . .

modResource

   Extends: MODX\Revolution\modAccessibleSimpleObject
   Table: modx_site_content

   Fields:
      type  (string)
      pagetitle  (string)
      longtitle  (string)
      description  (string)
      alias  (string)
      link_attributes  (string)
      published  (boolean)
      pub_date  (timestamp)
      unpub_date  (timestamp)
      parent  (integer)
      isfolder  (boolean)
      introtext  (string)
      content  (string)
      richtext  (boolean)
      template  (integer)
      menuindex  (integer)
      searchable  (boolean)
      cacheable  (boolean)
      createdby  (integer)
      createdon  (timestamp)
      editedby  (integer)
      editedon  (timestamp)
      deleted  (boolean)
      deletedon  (timestamp)
      deletedby  (integer)
      publishedon  (timestamp)
      publishedby  (integer)
      menutitle  (string)
      donthit  (boolean)
      privateweb  (boolean)
      privatemgr  (boolean)
      content_dispo  (integer)
      hidemenu  (boolean)
      class_key  (string)
      context_key  (string)
      content_type  (integer)
      uri  (string)
      uri_override  (integer)
      hide_children_in_tree  (integer)
      show_in_tree  (integer)
      properties  (json)
      alias_visible  (boolean)
   Indexes:
        alias, published, pub_date, unpub_date
        parent, isfolder, template, menuindex
        searchable, cacheable, hidemenu, class_key
        context_key, uri, uri_override, hide_children_in_tree
        show_in_tree, content_ft_idx, cache_refresh_idx
   Aliases:
      Parent
        -- use getOne('Parent') -- returns a MODX\Revolution\modResource object
      CreatedBy
        -- use getOne('CreatedBy') -- returns a MODX\Revolution\modUser object
      EditedBy
        -- use getOne('EditedBy') -- returns a MODX\Revolution\modUser object
      DeletedBy
        -- use getOne('DeletedBy') -- returns a MODX\Revolution\modUser object
      PublishedBy
        -- use getOne('PublishedBy') -- returns a MODX\Revolution\modUser object
      Template
        -- use getOne('Template') -- returns a MODX\Revolution\modTemplate object
      TemplateVars
        -- use getMany('TemplateVars') -- returns an array of MODX\Revolution\modTemplateVar objects
      TemplateVarTemplates
        -- use getMany('TemplateVarTemplates') -- returns an array of MODX\Revolution\modTemplateVarTemplate objects
      ContentType
        -- use getOne('ContentType') -- returns a MODX\Revolution\modContentType object
      Context
        -- use getOne('Context') -- returns a MODX\Revolution\modContext object

      Children
        -- use getMany('Children') -- returns an array of MODX\Revolution\modResource objects
      TemplateVarResources
        -- use getMany('TemplateVarResources') -- returns an array of MODX\Revolution\modTemplateVarResource objects
      ResourceGroupResources
        -- use getMany('ResourceGroupResources') -- returns an array of MODX\Revolution\modResourceGroupResource objects
      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessResource objects
      ContextResources
        -- use getMany('ContextResources') -- returns an array of MODX\Revolution\modContextResource objects
Back to Top . . .

modResourceGroup

   Extends: MODX\Revolution\modAccessibleSimpleObject
   Table: modx_documentgroup_names

   Fields:
      name  (string)
      private_memgroup  (boolean)
      private_webgroup  (boolean)
   Indexes:   Indexes: name

   Aliases:

      ResourceGroupResources
        -- use getMany('ResourceGroupResources') -- returns an array of MODX\Revolution\modResourceGroupResource objects
      TemplateVarResourceGroups
        -- use getMany('TemplateVarResourceGroups') -- returns an array of MODX\Revolution\modTemplateVarResourceGroup objects
      Acls
        -- use getMany('Acls') -- returns an array of MODX\Revolution\modAccessResourceGroup objects
Back to Top . . .

modResourceGroupResource

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_document_groups

   Fields:
      document_group  (integer)
      document  (integer)
   Indexes:   Indexes: document_group, document

   Aliases:
      ResourceGroup
        -- use getOne('ResourceGroup') -- returns a MODX\Revolution\modResourceGroup object
      Resource
        -- use getOne('Resource') -- returns a MODX\Revolution\modResource object
Back to Top . . .

modS3MediaSource

   Extends: MODX\Revolution\Sources\modMediaSource
Back to Top . . .

modScript

   Extends: MODX\Revolution\modElement
   Table: modx_site_script

   Fields:
      name  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
   Indexes:   Indexes: name, category

   Aliases:
      Category
        -- use getOne('Category') -- returns a MODX\Revolution\modCategory object
Back to Top . . .

modSession

   Extends: xPDO\Om\xPDOObject
   Table: modx_session

   Fields:
      id  (string)
      access  (timestamp)
      data  (string)
   Indexes:   Indexes: PRIMARY, access
Back to Top . . .

modSnippet

   Extends: MODX\Revolution\modScript
   Table: modx_site_snippets

   Fields:
      cache_type  (integer)
      snippet  (string)
      locked  (boolean)
      properties  (array)
      moduleguid  (string)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: locked, moduleguid, static

   Aliases:

      PropertySets
        -- use getMany('PropertySets') -- returns an array of MODX\Revolution\modElementPropertySet objects
Back to Top . . .

modStaticResource

   Extends: MODX\Revolution\modResource
Back to Top . . .

modSymLink

   Extends: MODX\Revolution\modResource
Back to Top . . .

modSystemSetting

   Extends: xPDO\Om\xPDOObject
   Table: modx_system_settings

   Fields:
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      ContextSetting
        -- use getOne('ContextSetting') -- returns a MODX\Revolution\modContextSetting object
      Namespace
        -- use getOne('Namespace') -- returns a MODX\Revolution\modNamespace object
Back to Top . . .

modTemplate

   Extends: MODX\Revolution\modElement
   Table: modx_site_templates

   Fields:
      templatename  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
      icon  (string)
      template_type  (integer)
      content  (string)
      locked  (boolean)
      properties  (array)
      static  (boolean)
      static_file  (string)
      preview_file  (string)
   Indexes:   Indexes: templatename, category, locked, static

   Aliases:
      Category
        -- use getOne('Category') -- returns a MODX\Revolution\modCategory object
      Resources
        -- use getMany('Resources') -- returns an array of MODX\Revolution\modResource objects

      PropertySets
        -- use getMany('PropertySets') -- returns an array of MODX\Revolution\modElementPropertySet objects
      TemplateVarTemplates
        -- use getMany('TemplateVarTemplates') -- returns an array of MODX\Revolution\modTemplateVarTemplate objects
Back to Top . . .

modTemplateVar

   Extends: MODX\Revolution\modElement
   Table: modx_site_tmplvars

   Fields:
      type  (string)
      name  (string)
      caption  (string)
      description  (string)
      editor_type  (integer)
      category  (integer)
      locked  (boolean)
      elements  (string)
      rank  (integer)
      display  (string)
      default_text  (string)
      properties  (array)
      input_properties  (array)
      output_properties  (array)
      static  (boolean)
      static_file  (string)
   Indexes:   Indexes: name, category, locked, rank, static

   Aliases:
      Category
        -- use getOne('Category') -- returns a MODX\Revolution\modCategory object

      PropertySets
        -- use getMany('PropertySets') -- returns an array of MODX\Revolution\modElementPropertySet objects
      TemplateVarTemplates
        -- use getMany('TemplateVarTemplates') -- returns an array of MODX\Revolution\modTemplateVarTemplate objects
      TemplateVarResources
        -- use getMany('TemplateVarResources') -- returns an array of MODX\Revolution\modTemplateVarResource objects
      TemplateVarResourceGroups
        -- use getMany('TemplateVarResourceGroups') -- returns an array of MODX\Revolution\modTemplateVarResourceGroup objects
Back to Top . . .

modTemplateVarResource

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_site_tmplvar_contentvalues

   Fields:
      tmplvarid  (integer)
      contentid  (integer)
      value  (string)
   Indexes:   Indexes: tmplvarid, contentid, tv_cnt

   Aliases:
      TemplateVar
        -- use getOne('TemplateVar') -- returns a MODX\Revolution\modTemplateVar object
      Resource
        -- use getOne('Resource') -- returns a MODX\Revolution\modResource object
Back to Top . . .

modTemplateVarResourceGroup

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_site_tmplvar_access

   Fields:
      tmplvarid  (integer)
      documentgroup  (integer)
   Indexes:   Indexes: tmplvar_template

   Aliases:
      TemplateVar
        -- use getOne('TemplateVar') -- returns a MODX\Revolution\modTemplateVar object
      ResourceGroup
        -- use getOne('ResourceGroup') -- returns a MODX\Revolution\modResourceGroup object
Back to Top . . .

modTemplateVarTemplate

   Extends: xPDO\Om\xPDOObject
   Table: modx_site_tmplvar_templates

   Fields:
      tmplvarid  (integer)
      templateid  (integer)
      rank  (integer)
   Indexes:   Indexes: PRIMARY

   Aliases:
      TemplateVar
        -- use getOne('TemplateVar') -- returns a MODX\Revolution\modTemplateVar object
      Template
        -- use getOne('Template') -- returns a MODX\Revolution\modTemplate object
Back to Top . . .

modTransportPackage

   Extends: xPDO\Om\xPDOObject
   Table: modx_transport_packages

   Fields:
      signature  (string)
      created  (datetime)
      updated  (timestamp)
      installed  (datetime)
      state  (integer)
      workspace  (integer)
      provider  (integer)
      disabled  (boolean)
      source  (string)
      manifest  (array)
      attributes  (array)
      package_name  (string)
      metadata  (array)
      version_major  (integer)
      version_minor  (integer)
      version_patch  (integer)
      release  (string)
      release_index  (integer)
   Indexes:
        PRIMARY, workspace
        provider, disabled
        package_name, version_major
        version_minor, version_patch
        release, release_index
   Aliases:
      Workspace
        -- use getOne('Workspace') -- returns a MODX\Revolution\modWorkspace object
      Provider
        -- use getOne('Provider') -- returns a MODX\Revolution\Transport\modTransportProvider object
Back to Top . . .

modTransportProvider

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_transport_providers

   Fields:
      name  (string)
      description  (string)
      service_url  (string)
      username  (string)
      api_key  (string)
      created  (datetime)
      updated  (timestamp)
      active  (boolean)
      priority  (integer)
      properties  (json)
   Indexes:   Indexes: name, api_key, username, active, priority

   Aliases:
      Packages
        -- use getMany('Packages') -- returns an array of MODX\Revolution\Transport\modTransportPackage objects
Back to Top . . .

modUser

   Extends: MODX\Revolution\modPrincipal
   Table: modx_users

   Fields:
      username  (string)
      password  (string)
      cachepwd  (string)
      class_key  (string)
      active  (boolean)
      remote_key  (string)
      remote_data  (json)
      hash_class  (string)
      salt  (string)
      primary_group  (integer)
      session_stale  (array)
      sudo  (boolean)
      createdon  (timestamp)
   Indexes:   Indexes: username, class_key, remote_key, primary_group

   Aliases:
      CreatedResources
        -- use getMany('CreatedResources') -- returns an array of MODX\Revolution\modResource objects
      EditedResources
        -- use getMany('EditedResources') -- returns an array of MODX\Revolution\modResource objects
      DeletedResources
        -- use getMany('DeletedResources') -- returns an array of MODX\Revolution\modResource objects
      PublishedResources
        -- use getMany('PublishedResources') -- returns an array of MODX\Revolution\modResource objects
      SentMessages
        -- use getMany('SentMessages') -- returns an array of MODX\Revolution\modUserMessage objects
      ReceivedMessages
        -- use getMany('ReceivedMessages') -- returns an array of MODX\Revolution\modUserMessage objects
      PrimaryGroup
        -- use getOne('PrimaryGroup') -- returns a MODX\Revolution\modUserGroup object

      Profile
        -- use getOne('Profile') -- returns aMODX\Revolution\modUserProfile object
      UserSettings
        -- use getMany('UserSettings') -- returns an array of MODX\Revolution\modUserSetting objects
      UserGroupMembers
        -- use getMany('UserGroupMembers') -- returns an array of MODX\Revolution\modUserGroupMember objects
      ActiveUsers
        -- use getMany('ActiveUsers') -- returns an array of MODX\Revolution\modActiveUser objects
      DashboardWidgets
        -- use getMany('DashboardWidgets') -- returns an array of MODX\Revolution\modDashboardWidgetPlacement objects
Back to Top . . .

modUserGroup

   Extends: MODX\Revolution\modPrincipal
   Table: modx_membergroup_names

   Fields:
      name  (string)
      description  (string)
      parent  (integer)
      rank  (integer)
      dashboard  (integer)
   Indexes:   Indexes: name, parent, rank, dashboard

   Aliases:
      Parent
        -- use getOne('Parent') -- returns a MODX\Revolution\modUserGroup object
      Dashboard
        -- use getOne('Dashboard') -- returns a MODX\Revolution\modDashboard object

      Children
        -- use getMany('Children') -- returns an array of MODX\Revolution\modUserGroup objects
      UserGroupMembers
        -- use getMany('UserGroupMembers') -- returns an array of MODX\Revolution\modUserGroupMember objects
      FormCustomizationProfiles
        -- use getMany('FormCustomizationProfiles') -- returns an array of MODX\Revolution\modFormCustomizationProfileUserGroup objects
Back to Top . . .

modUserGroupMember

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_member_groups

   Fields:
      user_group  (integer)
      member  (integer)
      role  (integer)
      rank  (integer)
   Indexes:   Indexes: role, rank

   Aliases:
      UserGroupRole
        -- use getOne('UserGroupRole') -- returns a MODX\Revolution\modUserGroupRole object
      UserGroup
        -- use getOne('UserGroup') -- returns a MODX\Revolution\modUserGroup object
      User
        -- use getOne('User') -- returns a MODX\Revolution\modUser object
Back to Top . . .

modUserGroupRole

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_user_group_roles

   Fields:
      name  (string)
      description  (string)
      authority  (integer)
   Indexes:   Indexes: name, authority

   Aliases:
      UserGroupMembers
        -- use getMany('UserGroupMembers') -- returns an array of MODX\Revolution\modUserGroupMember objects
Back to Top . . .

modUserGroupSetting

   Extends: xPDO\Om\xPDOObject
   Table: modx_user_group_settings

   Fields:
      group  (integer)
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      UserGroup
        -- use getOne('UserGroup') -- returns a MODX\Revolution\modUserGroup object
      Namespace
        -- use getOne('Namespace') -- returns a MODX\Revolution\modNamespace object
Back to Top . . .

modUserMessage

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_user_messages

   Fields:
      type  (string)
      subject  (string)
      message  (string)
      sender  (integer)
      recipient  (integer)
      private  (integer)
      date_sent  (datetime)
      read  (integer)

   Aliases:
      Sender
        -- use getOne('Sender') -- returns a MODX\Revolution\modUser object
      Recipient
        -- use getOne('Recipient') -- returns a MODX\Revolution\modUser object
Back to Top . . .

modUserProfile

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_user_attributes

   Fields:
      internalKey  (integer)
      fullname  (string)
      email  (string)
      phone  (string)
      mobilephone  (string)
      blocked  (boolean)
      blockeduntil  (integer)
      blockedafter  (integer)
      logincount  (integer)
      lastlogin  (integer)
      thislogin  (integer)
      failedlogincount  (integer)
      sessionid  (string)
      dob  (integer)
      gender  (integer)
      address  (string)
      country  (string)
      city  (string)
      state  (string)
      zip  (string)
      fax  (string)
      photo  (string)
      comment  (string)
      website  (string)
      extended  (json)
   Indexes:   Indexes: internalKey

   Aliases:
      User
        -- use getOne('User') -- returns a MODX\Revolution\modUser object
Back to Top . . .

modUserSetting

   Extends: xPDO\Om\xPDOObject
   Table: modx_user_settings

   Fields:
      user  (integer)
      key  (string)
      value  (string)
      xtype  (string)
      namespace  (string)
      area  (string)
      editedon  (timestamp)
   Indexes:   Indexes: PRIMARY

   Aliases:
      User
        -- use getOne('User') -- returns a MODX\Revolution\modUser object
      Namespace
        -- use getOne('Namespace') -- returns a MODX\Revolution\modNamespace object
Back to Top . . .

modWebLink

   Extends: MODX\Revolution\modResource
Back to Top . . .

modWorkspace

   Extends: xPDO\Om\xPDOSimpleObject
   Table: modx_workspaces

   Fields:
      name  (string)
      path  (string)
      created  (timestamp)
      active  (boolean)
      attributes  (array)
   Indexes:   Indexes: name, path, active

   Aliases:

      Packages
        -- use getMany('Packages') -- returns an array of MODX\Revolution\Transport\modTransportPackage objects
Back to Top . . .

 

My book, MODX: The Official Guide - Digital Edition is now available here. The paper version of the book may still be available from Amazon.

If you have the book and would like to download the code, you can find it here.

If you have the book and would like to see the updates and corrections page, you can find it here.

MODX: The Official Guide is 772 pages long and goes far beyond this web site in explaining beginning and advanced MODX techniques. It includes detailed information on:

  • Installing MODX
  • How MODX Works
  • Working with MODX resources and Elements
  • Using Git with MODX
  • Using common MODX add-on components like SPForm, Login, getResources, and FormIt
  • MODX security Permissions
  • Customizing the MODX Manager
  • Using Form Customization
  • Creating Transport Packages
  • MODX and xPDO object methods
  • MODX System Events
  • Using PHP with MODX

Go here for more information about the book.

Thank you for visiting BobsGuides.com

  —  Bob Ray