dcWidgets Class Reference

Public Member Functions
	store ()
	create (string $id, string $name, $callback, $append_callback=null, string $desc='')
	append (dcWidget $widget)
	isEmpty ()
	elements (bool $sorted=false)
	__get ($id)
	__wakeup ()

Static Public Member Functions
static	load ($s)
static	loadArray (array $A, dcWidgets $widgets)

Member Function Documentation

load()

static load (   $s )

static

Load widgets from string setting (base64 encoded)

Parameters

string

$s

Setting

Returns

self

References dcCore\app(), and loadArray().

Referenced by adminWidgets\init(), and installWidgets\install().

store()

store

(

)

Return encoded widgets

Returns

string

create()

create	(	string	$id,
		string	$name,
			$callback,
			$append_callback = null,
		string	$desc = ''
	)

Create a new widget

Parameters

string	$id	The identifier
string	$name	The name
mixed	$callback	The callback
mixed	$append_callback	The append callback
string	$desc	The description

Returns

dcWidget

Referenced by blogrollWidgets\initWidgets(), pagesWidgets\initWidgets(), simpleMenuWidgets\initWidgets(), and tagsWidgets\initWidgets().

append()

append

(

dcWidget

$widget

)

Append a widget

Parameters

dcWidget

$widget

The widget

isEmpty()

isEmpty

(

)

Determines if widgets list is empty.

Returns

bool True if empty, False otherwise.

elements()

elements

(

bool

$sorted = false

)

Return list of widgets

Parameters

bool

$sorted

Sort the list

Returns

array ( description_of_the_return_value )

References dcUtils\removeDiacritics().

__get()

__get

(

$id

)

Get a widget

Parameters

string

$id

The widget identifier

Returns

mixed

__wakeup()

__wakeup

(

)

Unset all widgets

loadArray()

static loadArray ( array  $A, dcWidgets  $widgets  )

static

Loads an array of widgets.

Parameters

array	$A	{ parameter_description }
dcWidgets	$widgets	The widgets

Returns

bool|dcWidgets|self

Referenced by load().

---

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

• plugins/widgets/inc/widgets.php