Overview

Namespaces

  • Composer
    • Autoload
  • Geekwright
    • RegDom
  • League
    • OAuth2
      • Client
        • Provider
  • None
  • Xmf
    • Database
    • Jwt
    • Key
    • Module
      • Helper

Classes

  • AbstractHelper
  • Cache
  • GenericHelper
  • Permission
  • Session
  • Overview
  • Namespace
  • Class
  • Tree

Namespace Xmf\Module\Helper

Classes summary
AbstractHelper

Xmf\Module\Helper\AbstractHelper defines the basis for various helpers that simplify routine module tasks.

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.

GenericHelper

GenericHelper implements a Xoops 2.6 Xoops\Module\Helper\HelperAbstract. We use it pre 2.6 systems so we can encapsulate many of the changes needed to make modules more compatible with 2.6 in these methods. The most common deprecated warnings can be avoided by using module helper methods.

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