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

  • AbstractHelper
  • GenericHelper
  • Overview
  • Namespace
  • Class
  • Tree

Class AbstractHelper

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

Direct known subclasses

Xmf\Module\Cache, Xmf\Module\Permission, Xmf\Module\Session
Abstract
Namespace: Xmf\Module\Helper
Package: Xmf
Category: Xmf\Module\Helper\AbstractHelper
Copyright: 2011-2013 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
Version: Release: 1.0
Since: 1.0
Link: http://xoops.org
Located at oops_lib/Xmf/Module/Helper/AbstractHelper.php
Methods summary
public
# __construct( mixed $module = null )

Instantiate a XoopsModule object for the helper to use. This occurs in one of three ways - if null is passed, use the current module - if a string is passed, use as dirname for a module - if an object is passed, use it as the module object

Instantiate a XoopsModule object for the helper to use. This occurs in one of three ways - if null is passed, use the current module - if a string is passed, use as dirname for a module - if an object is passed, use it as the module object

Parameters

$module
string dirname | object XoopsModule
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