Xinc-Gui-Widget
[ class tree: Xinc-Gui-Widget ] [ index: Xinc-Gui-Widget ] [ all elements ]

Class: Xinc_Gui_Widget_Interface

Source Location: /Xinc/Gui/Widget/Interface.php

Interface Overview




Methods



Class Details

[line 33]


[ Top ]


Class Methods


constructor __construct [line 45]

Xinc_Gui_Widget_Interface __construct( Xinc_Plugin_Interface $plugin)

Constructor for a Widget

The plugin passed itself as a variable to the constructor.

The Widget can access the plugins shared functionality




Tags:

access:  public


Parameters:

Xinc_Plugin_Interface   $plugin  

[ Top ]

method getExtensionPoints [line 89]

array getExtensionPoints( )

get the defined hooks of this widget

Hooks can be used to allow other widgets to extend this widget




Tags:

access:  public


[ Top ]

method getPaths [line 71]

void getPaths( )

returns the Pathnames for which the Widget wants to register itself for execution

getPaths() returns array('/dashboard', '/olddashboard'); Widget is called for: http://mydomain.com/dashboard AND http://mydomain.com/olddashboard BUT NOT FOR http://mydomain.com/dashboard/




Tags:

access:  public


[ Top ]

method handleEvent [line 56]

void handleEvent( integer $eventId)

The Xinc_Gui_Handler fires different events on the Widgets (see Xinc_Gui_Event)

The Widget can react differently on the events. A normal page load-event is Xinc_Gui_Event::PAGE_LOAD




Tags:

access:  public


Parameters:

integer   $eventId  

[ Top ]

method handleException [line 107]

void handleException( Exception $e)



Tags:

access:  public


Parameters:

Exception   $e  

[ Top ]

method hasExceptionHandler [line 102]

boolean hasExceptionHandler( )



Tags:

access:  public


[ Top ]

method init [line 80]

void init( )

Is called after all widgets have

been registered. This is the place where widgets need to register the hooks for another Widget




Tags:

access:  public


[ Top ]

method registerExtension [line 97]

void registerExtension( string $extensionPoint, Xinc_Gui_Widget_Extension $extension)

Register an extensions



Tags:

access:  public


Parameters:

string   $extensionPoint  
Xinc_Gui_Widget_Extension   $extension   extension

[ Top ]


Documentation generated on Sun, 09 Dec 2012 21:49:28 +0100 by phpDocumentor 1.4.4