SearchWidget Class Reference

Inheritance diagram for SearchWidget:

Collaboration diagram for SearchWidget:

Public Member Functions
	__construct ($url= '')
	setId ($id)
	getId ()
	setMethod ($method)
	getMethod ()
	addNeedle ($label, $name, $placeholder=false)
	addFilter ($label, $key)
	hasElements ()
	render ($variables=array())
Public Member Functions inherited from SidebarWidget
	__construct ()
	setTitle ($title)
	getTitle ()
	removeTitle ()
	setExtra ($extra)
	getExtra ()
	removeExtra ()
Public Member Functions inherited from Widget
	addElement (WidgetElement $element, $index=null)
	insertElement (WidgetElement $element, $before_index, $index=null)
	getElement ($index)
	removeElement ($index)
	forceRendering ($state=true)
	__isset ($offset)
	__get ($offset)
	__set ($offset, $value)
	__unset ($offset)

Data Fields
const	INDEX = 'search'

Protected Member Functions
	hasData ()

Protected Attributes
	$url
	$needles = array()
	$filters = array()
	$method = 'get'
	$id = null

Constructor & Destructor Documentation

__construct

(

$url = ''

)

Here is the call graph for this function:

Member Function Documentation

addFilter	(		$label,
			$key
	)

addNeedle	(		$label,
			$name,
			$placeholder = false
	)

Here is the call graph for this function:

getId

(

)

getMethod

(

)

hasData ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

hasElements

(

)

Returns whether this widget has any elements.

Returns

bool True if the widget has at least one element, false otherwise.

Reimplemented from Widget.

render

(

$variables = array()

)

Renders the widget. The widget will only be rendered if it contains at least one element.

Returns

String The THML code of the rendered sidebar widget

Reimplemented from SidebarWidget.

Here is the call graph for this function:

setId

(

$id

)

setMethod

(

$method

)

Field Documentation

$filters = array()

protected

$id = null

protected

$method = 'get'

protected

$needles = array()

protected

$url

protected

const INDEX = 'search'

---

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

• lib/classes/sidebar/SearchWidget.php