1. class
  2. Windwalker
  3. Core
  4. Widget
  5. WidgetComponent

WidgetComponent

class WidgetComponent extends Widget (View source)

The WidgetComponent class.

Traits

ArrayAccessTrait
The ArrayAccessTrait class.

Methods

boolean
offsetExists(mixed $offset)

Property is exist or not.

from ArrayAccessTrait
mixed
offsetGet(mixed $offset)

Get a value of property.

from ArrayAccessTrait
void
offsetSet(mixed $offset, mixed $value)

Set value to property

from ArrayAccessTrait
void
offsetUnset(mixed $offset)

Unset a property.

from ArrayAccessTrait
__construct(string|AbstractPackage $package = null)

Class init.

string
render(array $data = array())

render

from Widget
string
getLayout()

Method to get property Layout

from Widget
Widget
setLayout(string $layout)

Method to set property layout

from Widget
RendererInterface
getRenderer()

Method to get property Renderer

from Widget
Widget
setRenderer(RendererInterface $renderer)

Method to set property renderer

from Widget
Widget
registerPaths(bool $refresh = false)

registerPaths

Widget
addPath(string $path, integer $priority = PriorityQueue::NORMAL)

addPath

from Widget
PriorityQueue
getPaths()

getPaths

from Widget
Widget
setPaths(array|SplPriorityQueue $paths)

setPaths

from Widget
boolean
isDebug()

Method to get property Debug

from Widget
Widget
setDebug(boolean $debug)

Method to set property debug

from Widget
AbstractPackage
getPackage()

Method to get property Package

from Widget
Widget
setPackage(AbstractPackage|string $package)

Method to set property package

from Widget
Widget
reset()

reset

from Widget
Widget
set(string $name, mixed $value)

set

from Widget
mixed
get(string $name, mixed $default = null)

get

from Widget
array
getData()

Method to get property Data

from Widget
Widget
setData(array $data)

Method to set property data

from Widget
string
__toString()

__toString

from Widget
string
getPathPrefix()

Method to get property PathPrefix

from Widget
Widget
setPathPrefix(string $pathPrefix)

Method to set property pathPrefix

from Widget
mixed
getName()

Method to get property Name

WidgetComponent
setName(mixed $name)

Method to set property name

Details

in ArrayAccessTrait at line line 32
boolean offsetExists(mixed $offset)

Property is exist or not.

Parameters

mixed $offset Property key.

Return Value

boolean

in ArrayAccessTrait at line line 46
mixed offsetGet(mixed $offset)

Get a value of property.

Parameters

mixed $offset Property key.

Return Value

mixed The value of this property.

in ArrayAccessTrait at line line 66
void offsetSet(mixed $offset, mixed $value)

Set value to property

Parameters

mixed $offset Property key.
mixed $value Property value to set.

Return Value

void

in ArrayAccessTrait at line line 87
void offsetUnset(mixed $offset)

Unset a property.

Parameters

mixed $offset Key to unset.

Return Value

void

at line line 41
__construct(string|AbstractPackage $package = null)

Class init.

Parameters

string|AbstractPackage $package

in Widget at line line 134
string render(array $data = array())

render

Parameters

array $data

Return Value

string

in Widget at line line 168
string getLayout()

Method to get property Layout

Return Value

string

in Widget at line line 180
Widget setLayout(string $layout)

Method to set property layout

Parameters

string $layout

Return Value

Widget Return self to support chaining.

in Widget at line line 192
RendererInterface getRenderer()

Method to get property Renderer

Return Value

RendererInterface

in Widget at line line 204
Widget setRenderer(RendererInterface $renderer)

Method to set property renderer

Parameters

RendererInterface $renderer

Return Value

Widget Return self to support chaining.

at line line 60
Widget registerPaths(bool $refresh = false)

registerPaths

Parameters

bool $refresh

Return Value

Widget

in Widget at line line 283
Widget addPath(string $path, integer $priority = PriorityQueue::NORMAL)

addPath

Parameters

string $path
integer $priority

Return Value

Widget

in Widget at line line 295
PriorityQueue getPaths()

getPaths

Return Value

PriorityQueue

in Widget at line line 307
Widget setPaths(array|SplPriorityQueue $paths)

setPaths

Parameters

array|SplPriorityQueue $paths

Return Value

Widget

in Widget at line line 321
boolean isDebug()

Method to get property Debug

Return Value

boolean

in Widget at line line 333
Widget setDebug(boolean $debug)

Method to set property debug

Parameters

boolean $debug

Return Value

Widget Return self to support chaining.

in Widget at line line 364
AbstractPackage getPackage()

Method to get property Package

Return Value

AbstractPackage

in Widget at line line 381
Widget setPackage(AbstractPackage|string $package)

Method to set property package

Parameters

AbstractPackage|string $package

Return Value

Widget Return self to support chaining.

in Widget at line line 393
Widget reset()

reset

Return Value

Widget

in Widget at line line 415
Widget set(string $name, mixed $value)

set

Parameters

string $name
mixed $value

Return Value

Widget

in Widget at line line 430
mixed get(string $name, mixed $default = null)

get

Parameters

string $name
mixed $default

Return Value

mixed

in Widget at line line 445
array getData()

Method to get property Data

Return Value

array

in Widget at line line 457
Widget setData(array $data)

Method to set property data

Parameters

array $data

Return Value

Widget Return self to support chaining.

in Widget at line line 469
string __toString()

__toString

Return Value

string

in Widget at line line 492
string getPathPrefix()

Method to get property PathPrefix

Return Value

string

in Widget at line line 504
Widget setPathPrefix(string $pathPrefix)

Method to set property pathPrefix

Parameters

string $pathPrefix

Return Value

Widget Return self to support chaining.

at line line 108
mixed getName()

Method to get property Name

Return Value

mixed

at line line 120
WidgetComponent setName(mixed $name)

Method to set property name

Parameters

mixed $name

Return Value

WidgetComponent Return self to support chaining.