Toolkit Class Reference

Utility class for Toolkit2. More...

Inheritance diagram for Toolkit:

[legend]

List of all members.

Static Public Member Functions
static	getComponent ($id)
	Retrieves a component based on its ID.
static	getDefaultTheme ()
	Retrieves the current default theme for new objects.
static	setDefaultTheme ($theme, $updateAll=false)
	Sets the default theme for all new objects.

---

Detailed Description

Utility class for Toolkit2.

This class cannot be instantiated, and generally contains methods that are used internally by the toolkit. Only a few are interesting to end developers, and a few more are needed when extending the toolkit. Please heed the comments about not using certain functions, and only use those which are documented.

---

Member Function Documentation

static Toolkit::getComponent

(

$

id

)

[static]

Retrieves a component based on its ID.

All toolkit objects have a (hopefully) unique ID. You can retrieve any TK object by calling this static function, provided you know its ID.

Parameters:

$id

[string]: object id to look for

Returns:

[TKComponent] the object specified by $id, if it exists

static Toolkit::getDefaultTheme

(

)

[static]

Retrieves the current default theme for new objects.

Returns:

[TKTheme] current default them

static Toolkit::setDefaultTheme	(	$	theme,
		$	updateAll = false
	)			[static]

Sets the default theme for all new objects.

It can also be made to update the theme of existing objects

Parameters:

	$theme	[TKTheme]: new theme
	$updateAll	[boolean]: whether to update existing objects to the new theme

---

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

• tk2/Toolkit.php5