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

Class AbstractHelper

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

Direct known subclasses

Xmf\Module\Helper\Cache, Xmf\Module\Helper\Permission, Xmf\Module\Helper\Session
Abstract
Namespace: Xmf\Module\Helper
Package: Xmf
Category: Xmf\Module\Helper\AbstractHelper
Copyright: 2011-2016 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at lass/libraries/vendor/xoops/xmf/src/Xmf/Module/Helper/AbstractHelper.php
Methods summary
public
# __construct( string|null $dirname = null )

Instantiate a XoopsModule object for the helper to use. The module is determined as follows: - if null is passed, use the current module - if a string is passed, use as dirname to load

Instantiate a XoopsModule object for the helper to use. The module is determined as follows: - if null is passed, use the current module - if a string is passed, use as dirname to load

Parameters

$dirname
dirname
abstract public
# init( )

init() is called once/if __construct has a module object. $this->module will have a module object that any further initialization can use.

init() is called once/if __construct has a module object. $this->module will have a module object that any further initialization can use.

public
# setDebug( boolean $bool = true )

Set debug option on or off

Set debug option on or off

Parameters

$bool
true to turn on debug logging, false for off
public
# addLog( string $log )

Add a message to the module log

Add a message to the module log

Parameters

$log
log message
Properties summary
protected XoopsModule $module
#
protected boolean $debug

true if debug is enabled

true if debug is enabled

#
API documentation generated by ApiGen