Docs For Class Gadget

Description

Gadget_Widget

Base widget.

since: 1.0

Gadget_Object
   |
   --Gadget_Widget

Direct descendents

Class	Description
Gadget_Pager	Gadget_Pager
Breadcrumbs	Breadcrumbs
DivContainer	DivContainer
LoginBox	LoginBox
Menu	Menu
PageFooter	PageFooter
PageHeader	PageHeader

Variable Summary

bool $aggregateFormatter

bool $auth

array $elements

object $form

int $ID

string $location

bool $main

object $qform

string $queryString

bool $render

mixed $rights

bool $show

string $template

Method Summary

void aggregateFormatter ()

object &create (mixed $widget, mixed $options)

object &form (string $formName, [array $attributes = array()], [mixed $location = null], [mixed $method = 'post'])

string load (string $template, [bool $render = false])

void main ()

string oddEven (int $int)

void onAfterConstruct ()

void onBeforeConstruct ()

void queue ([mixed $ID = null])

bool queueAfter (object Gadget_Widget &$after)

string render ([mixed $finish = false])

void requeue ()

void unqueue ()

void unsufficientRights ()

Variables

bool $aggregateFormatter = false (line 123)

Whether to call aggregateFormatter() at construction time

Redefined in descendants as:

Gadget_Pager::$aggregateFormatter : Load Gadget_Formatter by default
Breadcrumbs::$aggregateFormatter
Menu::$aggregateFormatter

bool $auth = false (line 88)

Whether user needs to authenticate

array $elements = array() (line 137)

Gadget Formelement Hooks

object $form (line 67)

Rendered Form

int $ID = -1 (line 53)

Widget Queue ID

string $location (line 74)

Current Location

bool $main = true (line 102)

Whether to run main() at construction time

object $qform (line 60)

HTML_QuickForm

string $queryString (line 81)

Query String

bool $render = false (line 109)

Whether to run render() at construction time

mixed $rights = 0 (line 95)

Whether user needs special rights

bool $show = true (line 116)

Whether to call render() on Gadget::finish()

string $template (line 130)

Template

Redefined in descendants as:

Methods

aggregateFormatter (line 276)

Aggregate Formatter

access: protected

void aggregateFormatter ()

create (line 309)

Create a new Widget

access: public
see: Gadget::newWidget()
static:
since: 1.2

object &create (mixed $widget, mixed $options)

form (line 214)

Attach QuickForm

access: public

object &form (string $formName, [array $attributes = array()], [mixed $location = null], [mixed $method = 'post'])

string $formName
array $attributes

load (line 256)

Load Template

access: public

string load (string $template, [bool $render = false])

string $template
bool $render

main (line 201)

Main

access: protected

void main ()

Redefined in descendants as:

oddEven (line 243)

Odd Even

access: public

string oddEven (int $int)

int $int

onAfterConstruct (line 162)

On After Construct

access: protected

void onAfterConstruct ()

Redefinition of:

Gadget_Object::onAfterConstruct(): On After Construct

Redefined in descendants as:

Gadget_Pager::onAfterConstruct() : On After Construct

onBeforeConstruct (line 145)

On Before Construct

access: protected

void onBeforeConstruct ()

Redefinition of:

Gadget_Object::onBeforeConstruct(): On Before Construct

Redefined in descendants as:

Gadget_Pager::onBeforeConstruct() : On Before Construct
PageHeader::onBeforeConstruct() : On Before Construct

queue (line 334)

Queue Widget

access: protected
since: 1.2

void queue ([mixed $ID = null])

queueAfter (line 373)

Queue Widget after another

access: public
since: 1.2

bool queueAfter (object Gadget_Widget &$after)

object Gadget_Widget $after

render (line 230)

Render

access: public

string render ([mixed $finish = false])

requeue (line 359)

Requeue this Widget

access: public
since: 1.2

void requeue ()

unqueue (line 347)

Unqueue this Widget

access: public
since: 1.2

void unqueue ()

unsufficientRights (line 293)

Unsufficient Rights Hook

access: protected

void unsufficientRights ()

Inherited Methods

Inherited From Gadget_Object

Gadget_Object::Gadget_Object()
Gadget_Object::onAfterConstruct()
Gadget_Object::onBeforeConstruct()
Gadget_Object::setOptions()

Class Gadget_Widget

Inherited Methods