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

  • Dummy
  • HelperAbstract
  • Overview
  • Namespace
  • Class
  • Tree

Class HelperAbstract

Direct known subclasses

Avatars, Banners, Thumbs, Userconfigs, Xlanguage, Xoops\Module\Helper\Dummy, Comments, Images, Menus, Notifications, Page, Publisher, Search, Smilies
Abstract
Namespace: Xoops\Module\Helper
Copyright: XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Version: $Id$
Located at oops_lib/Xoops/Module/Helper/HelperAbstract.php
Methods summary
public
# init( )
protected
# setDirname( string $dirname )

Parameters

$dirname
dirname of the module
protected
# setDebug( boolean $debug )

Parameters

$debug
public static Xoops\Module\Helper\HelperAbstract
# getInstance( )

Returns

Xoops\Module\Helper\HelperAbstract
public null|XoopsModule
# getModule( )

Returns

null|XoopsModule
public
# xoops( )
public string
# getConfig( string $name )

Parameters

$name

Returns

string
public array
# getConfigs( )

getConfigs

getConfigs

Returns

array
of config items for module
public XoopsObjectHandler
# getHandler( string $name )

Parameters

$name

Returns

XoopsObjectHandler
public
# disableCache( )
public boolean
# isCurrentModule( )

Is this the currently active module?

Is this the currently active module?

Returns

boolean
public boolean
# isUserAdmin( )

Does user have admin rights to this module?

Does user have admin rights to this module?

Returns

boolean
true is user has admin right, else false
public string
# url( string $url = '' )

Return absolute URL for a module relative URL

Return absolute URL for a module relative URL

Parameters

$url

Returns

string
public string
# path( string $path = '' )

Return absolute filesystem path for a module relative path

Return absolute filesystem path for a module relative path

Parameters

$path

Returns

string
public
# redirect( $url, integer $time = 3, string $message = '', boolean $addredirect = true, boolean $allowExternalLink = false )

Redirect the user to a page within this module

Redirect the user to a page within this module

TODO remove addredirect and allowExternalLink paramaters since they are pointless in this context.

Parameters

$url
$time
$message
$addredirect
$allowExternalLink
public string
# loadLanguage( string $language )

Parameters

$language

Returns

string
public
# loadLocale( )
public Xoops\Form\Form|boolean
# getForm( null|XoopsObject $obj, string $name )

Parameters

$obj
$name

Returns

Xoops\Form\Form|boolean
protected
# _addLog( string $log )

Parameters

$log
Properties summary
protected string $_dirname

dirname of the module

dirname of the module

# ''
protected null|XoopsModule $_module
# null
protected boolean $_debug
# false
API documentation generated by ApiGen