XOOPS  2.6.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Xoops\Module\Helper\HelperAbstract Class Reference
Inheritance diagram for Xoops\Module\Helper\HelperAbstract:
Inheritance graph

Public Member Functions

 disableCache ()
 
 getConfig ($name)
 
 getConfigs ()
 
 getForm ($obj, $name)
 
 getHandler ($name)
 
 getModule ()
 
 init ()
 
 isCurrentModule ()
 
 isUserAdmin ()
 
 loadLanguage ($language)
 
 loadLocale ()
 
 path ($path= '')
 
 redirect ($url, $time=3, $message= '', $addredirect=true, $allowExternalLink=false)
 
 url ($url= '')
 
 xoops ()
 

Static Public Member Functions

static getInstance ()
 

Protected Member Functions

 _addLog ($log)
 
 setDebug ($debug)
 
 setDirname ($dirname)
 

Protected Attributes

 $_debug = false
 
 $_dirname = ''
 
 $_module = null
 

Private Member Functions

 _initModule ()
 

Detailed Description

Copyright
The XOOPS Project http://sourceforge.net/projects/xoops/ GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author
trabis lusop.nosp@m.oema.nosp@m.s@gma.nosp@m.il.c.nosp@m.om
Version
$Id$

Definition at line 21 of file HelperAbstract.php.

Member Function Documentation

Xoops\Module\Helper\HelperAbstract::_addLog (   $log)
protected
Parameters
string$log

Definition at line 254 of file HelperAbstract.php.

References Xoops\Module\Helper\HelperAbstract\getModule(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Xoops\Module\Helper\HelperAbstract\_initModule(), Xoops\Module\Helper\Dummy\addLog(), Xoops\Module\Helper\HelperAbstract\disableCache(), Xoops\Module\Helper\HelperAbstract\getConfig(), Xoops\Module\Helper\HelperAbstract\getConfigs(), Xoops\Module\Helper\HelperAbstract\getForm(), Xoops\Module\Helper\HelperAbstract\getHandler(), Xoops\Module\Helper\HelperAbstract\loadLanguage(), and Xoops\Module\Helper\HelperAbstract\loadLocale().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::_initModule ( )
private

Initialize module

Definition at line 238 of file HelperAbstract.php.

References Xoops\Module\Helper\HelperAbstract\_addLog(), Xoops\Module\Helper\HelperAbstract\isCurrentModule(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Xoops\Module\Helper\HelperAbstract\getModule().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::disableCache ( )

Definition at line 130 of file HelperAbstract.php.

References Xoops\Module\Helper\HelperAbstract\_addLog(), Xoops\Module\Helper\HelperAbstract\getModule(), and Xoops\Module\Helper\HelperAbstract\xoops().

Here is the call graph for this function:

Xoops\Module\Helper\HelperAbstract::getConfig (   $name)
Parameters
string$name
Returns
string

Definition at line 98 of file HelperAbstract.php.

References $name, $result, Xoops\Module\Helper\HelperAbstract\_addLog(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Thumbs\buildThumbPath(), and Comments\getUserConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::getConfigs ( )

getConfigs

Returns
array of config items for module

Definition at line 111 of file HelperAbstract.php.

References $result, Xoops\Module\Helper\HelperAbstract\_addLog(), and Xoops\Module\Helper\HelperAbstract\xoops().

Here is the call graph for this function:

Xoops\Module\Helper\HelperAbstract::getForm (   $obj,
  $name 
)
Parameters
null | XoopsObject$obj
string$name
Returns
|boolean

Definition at line 228 of file HelperAbstract.php.

References $name, Xoops\Module\Helper\HelperAbstract\_addLog(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Comments\displayCommentForm().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::getHandler (   $name)
Parameters
string$name
Returns
XoopsObjectHandler

Definition at line 123 of file HelperAbstract.php.

References $name, Xoops\Module\Helper\HelperAbstract\_addLog(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Avatars\getHandlerAvatar(), Images\getHandlerCategories(), Comments\getHandlerComment(), Userconfigs\getHandlerConfig(), Images\getHandlerImages(), Images\getHandlerImagesBody(), Userconfigs\getHandlerItem(), Menus\getHandlerMenu(), Menus\getHandlerMenus(), Notifications\getHandlerNotification(), Userconfigs\getHandlerOption(), Smilies\getHandlerSmilies(), and Avatars\getHandlerUserlink().

Here is the call graph for this function:

Here is the caller graph for this function:

static Xoops\Module\Helper\HelperAbstract::getInstance ( )
static
Returns
Xoops

Definition at line 61 of file HelperAbstract.php.

References $id, and Xoops\getInstance().

Referenced by b_search_show(), and SearchSearchForm\getSearchFrom().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::getModule ( )
Returns
null|XoopsModule

Definition at line 80 of file HelperAbstract.php.

References Xoops\Module\Helper\HelperAbstract\$_module, and Xoops\Module\Helper\HelperAbstract\_initModule().

Referenced by Xoops\Module\Helper\HelperAbstract\_addLog(), Xoops\Module\Helper\HelperAbstract\disableCache(), Comments\getUserConfig(), and Xoops\Module\Helper\HelperAbstract\isUserAdmin().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::init ( )

Definition at line 38 of file HelperAbstract.php.

Xoops\Module\Helper\HelperAbstract::isCurrentModule ( )

Is this the currently active module?

Returns
bool

Definition at line 141 of file HelperAbstract.php.

References moduleDirname, and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Xoops\Module\Helper\HelperAbstract\_initModule().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::isUserAdmin ( )

Does user have admin rights to this module?

Returns
bool true is user has admin right, else false

Definition at line 154 of file HelperAbstract.php.

References Xoops\Module\Helper\HelperAbstract\getModule(), Xoops\isUser(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Comments\renderView().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::loadLanguage (   $language)
Parameters
string$language
Returns
string

Definition at line 210 of file HelperAbstract.php.

References $language, Xoops\Module\Helper\HelperAbstract\_addLog(), and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Comments\init().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::loadLocale ( )

Definition at line 216 of file HelperAbstract.php.

References Xoops\Module\Helper\HelperAbstract\_addLog(), and Xoops\Module\Helper\HelperAbstract\xoops().

Here is the call graph for this function:

Xoops\Module\Helper\HelperAbstract::path (   $path = '')

Return absolute filesystem path for a module relative path

Parameters
string$path
Returns
string

Definition at line 181 of file HelperAbstract.php.

References $path, and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Menus\getSkinInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::redirect (   $url,
  $time = 3,
  $message = '',
  $addredirect = true,
  $allowExternalLink = false 
)

Redirect the user to a page within this module

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

Parameters
$url
int$time
string$message
bool$addredirect
bool$allowExternalLink
Returns
void

Definition at line 200 of file HelperAbstract.php.

References $url, Xoops\Module\Helper\HelperAbstract\url(), and Xoops\Module\Helper\HelperAbstract\xoops().

Here is the call graph for this function:

Xoops\Module\Helper\HelperAbstract::setDebug (   $debug)
protected
Parameters
bool$debug

Definition at line 53 of file HelperAbstract.php.

Xoops\Module\Helper\HelperAbstract::setDirname (   $dirname)
protected
Parameters
string$dirnamedirname of the module

Definition at line 45 of file HelperAbstract.php.

References $dirname.

Referenced by Avatars\init(), Menus\init(), Search\init(), Smilies\init(), Notifications\init(), Images\init(), Comments\init(), and Userconfigs\init().

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::url (   $url = '')

Return absolute URL for a module relative URL

Parameters
string$url
Returns
string

Definition at line 169 of file HelperAbstract.php.

References $url, and Xoops\Module\Helper\HelperAbstract\xoops().

Referenced by Comments\displayDelete(), Comments\displayPost(), Xoops\Module\Helper\HelperAbstract\redirect(), and Comments\renderView().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Module\Helper\HelperAbstract::xoops ( )

Definition at line 88 of file HelperAbstract.php.

Referenced by Xoops\Module\Helper\HelperAbstract\_addLog(), Xoops\Module\Helper\HelperAbstract\_initModule(), Xoops\Module\Helper\HelperAbstract\disableCache(), Xoops\Module\Helper\HelperAbstract\getConfig(), Xoops\Module\Helper\HelperAbstract\getConfigs(), Xoops\Module\Helper\HelperAbstract\getForm(), Xoops\Module\Helper\HelperAbstract\getHandler(), Menus\getSkinInfo(), Comments\getUserConfig(), Xoops\Module\Helper\HelperAbstract\isCurrentModule(), Xoops\Module\Helper\HelperAbstract\isUserAdmin(), Xoops\Module\Helper\HelperAbstract\loadLanguage(), Xoops\Module\Helper\HelperAbstract\loadLocale(), Xoops\Module\Helper\HelperAbstract\path(), Xoops\Module\Helper\HelperAbstract\redirect(), and Xoops\Module\Helper\HelperAbstract\url().

Here is the caller graph for this function:

Member Data Documentation

Xoops\Module\Helper\HelperAbstract::$_debug = false
protected

Definition at line 36 of file HelperAbstract.php.

Xoops\Module\Helper\HelperAbstract::$_dirname = ''
protected

Definition at line 26 of file HelperAbstract.php.

Xoops\Module\Helper\HelperAbstract::$_module = null
protected

Definition at line 31 of file HelperAbstract.php.

Referenced by Xoops\Module\Helper\HelperAbstract\getModule().

The documentation for this class was generated from the following file: