Class: XoopsHandlerRegistry

Source Location: /kernel/handlerregistry.php

Class XoopsHandlerRegistry

Class Overview

A registry for holding references to XoopsObjectHandler classes

Located in /kernel/handlerregistry.php [line 33]



		
				Author(s):
		
		
		

Information Tags:
Copyright:  copyright (c) 2000-2003 XOOPS.org

Methods

[ Top ]
Method Summary
static object Reference   &instance()   get a reference to the only instance of this class
object {@link   &getHandler()   Get a registered handler class object
object {@link   &getModuleHandler()   Get a registered handler class object for a module
void   setHandler()   Register a handler class object
void   setModuleHandler()   Register a handler class object for a module
void   unsetHandler()   Unregister a handler class object
void   unsetModuleHandler()   Unregister a handler class object for a module

[ Top ]
Methods
static method instance  [line 53]

  static object Reference &instance( )

get a reference to the only instance of this class

if the class has not been instantiated yet, this will also take care of that


API Tags:
Return:  to the only instance of this class
Staticvar:  object The $instance: only instance of this class


[ Top ]
getHandler  [line 80]

  object {@link &getHandler( string $name  )

Get a registered handler class object

Parameters:
string   $name:  Short name of a handler class

API Tags:
Return:  XoopsObjectHandler}, FALSE if not registered


[ Top ]
getModuleHandler  [line 118]

  object {@link &getModuleHandler( string $module, string $name  )

Get a registered handler class object for a module

Parameters:
string   $module:  Directory name of a module
string   $name:  Short name of a handler class

API Tags:
Return:  XoopsObjectHandler}, FALSE if not registered


[ Top ]
setHandler  [line 68]

  void setHandler( string $name, object &$handler  )

Register a handler class object

Parameters:
string   $name:  Short name of a handler class
object   &$handler:  XoopsObjectHandler class object


[ Top ]
setModuleHandler  [line 105]

  void setModuleHandler( string $module, string $name, object &$handler  )

Register a handler class object for a module

Parameters:
string   $module:  Directory name of a module
string   $name:  Short name of a handler class
object   &$handler:  XoopsObjectHandler class object


[ Top ]
unsetHandler  [line 93]

  void unsetHandler( string $name  )

Unregister a handler class object

Parameters:
string   $name:  Short name of a handler class


[ Top ]
unsetModuleHandler  [line 132]

  void unsetModuleHandler( string $module, string $name  )

Unregister a handler class object for a module

Parameters:
string   $module:  Directory name of a module
string   $name:  Short name of a handler class


[ Top ]

Documentation generated on Sat, 12 Dec 2009 21:20:14 -0600 by phpDocumentor 1.4.1