Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • Admin
  • Cache
  • Helper
  • Permission
  • Session
  • Overview
  • Namespace
  • Class
  • Tree

Namespace Xmf\Module

Namespaces summary
Xmf\Module\Helper
Classes summary
Admin

Xmf\Module\Admin provides helpful methods for module administration uses.

Cache

Manage cache interaction in a module. Cache key will be prefixed with the module name to segregate it from keys set by other modules or system functions. Cache data is by definition serialized, so any arbitrary data (i.e. array, object) can be stored.

Helper

Helper gets an instance of module helper for the specified module. The helper is defined by the Xoops 2.6 Xoops\Module\Helper\HelperAbstract and in pre 2.6 systems we mimic that definition with using an instance of Xmf\Module\GenericHelper.

Permission Methods to help manage permissions within a module
Session

Manage session variables for a module. Session variable will be prefixed with the module name to separate it from variables set by other modules or system functions. All data is serialized, so any arbitrary data (i.e. array) can be stored.

API documentation generated by ApiGen