Gdn_Pluggable Class Reference

Inheritance diagram for Gdn_Pluggable:

Collaboration diagram for Gdn_Pluggable:

Public Member Functions
	__construct ()
	GetReturn ($PluginName, $HandlerName)
	FireEvent ($EventName)
	__call ($MethodName, $Arguments)
Public Member Functions inherited from Gdn_SliceProvider
	EnableSlicing (&$Sender)
	Slice ($SliceName, $Arguments=array())
	AddSliceAsset ($Asset)
	RenderSliceConfig ()

Data Fields
	$EventArguments
	$Returns = array()
	$HandlerType

Protected Attributes
	$ClassName
Protected Attributes inherited from Gdn_SliceProvider
	$SliceHandler
	$SliceConfig

Constructor & Destructor Documentation

__construct

(

)

The public constructor of the class. If any extender of this class overrides this one, parent::__construct(); should be called to ensure interoperability.

Member Function Documentation

__call	(		$MethodName,
			$Arguments
	)

Used to extend any method

There are two types of extended method calls:

1. Declared: The method was declared with the lowercase "x" prefix and called without it. ie. Declaration: public function xMethodName() {} Call: $Object->MethodName();
2. Called: The method was declared without the lowercase "x" prefix and called with it. ie. Declaration: public function MethodName() {} Call: $Object->xMethodName();

Note: Plugins will always refer to the method name without the "x" regardless of the type. So, $ReferenceMethodName is declared below without the "x".

Parameters

string	$MethodName
array	$Arguments

Returns

mixed

Here is the call graph for this function:

FireEvent

(

$EventName

)

Fires an event to be dealt with by plugins. Plugins can create custom methods to handle the event simply by naming their handler method appropriately. The convention is: public function SenderClassName_EventName_Handler($Sender) {}

Parameters

string

$EventName

The name of the event being fired.

Here is the call graph for this function:

GetReturn	(		$PluginName,
			$HandlerName
	)

Parameters

unknown_type	$PluginName
unknown_type	$HandlerName

Returns

Todo:

add doc

Field Documentation

$ClassName

protected

$EventArguments

$HandlerType

$Returns = array()

---

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

• class.pluggable.php