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

Widget

class Widget implements ArrayAccess (View source)

The Widget 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 $layout, string|RendererInterface $renderer = null, string|AbstractPackage $package = null)

Class init.

string
render(array $data = array())

render

string
getLayout()

Method to get property Layout

Widget
setLayout(string $layout)

Method to set property layout

RendererInterface
getRenderer()

Method to get property Renderer

Widget
setRenderer(RendererInterface $renderer)

Method to set property renderer

Widget
registerPaths(bool $refresh = false)

registerPaths

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

addPath

PriorityQueue
getPaths()

getPaths

Widget
setPaths(array|SplPriorityQueue $paths)

setPaths

boolean
isDebug()

Method to get property Debug

Widget
setDebug(boolean $debug)

Method to set property debug

AbstractPackage
getPackage()

Method to get property Package

Widget
setPackage(AbstractPackage|string $package)

Method to set property package

Widget
reset()

reset

Widget
set(string $name, mixed $value)

set

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

get

array
getData()

Method to get property Data

Widget
setData(array $data)

Method to set property data

string
__toString()

__toString

string
getPathPrefix()

Method to get property PathPrefix

Widget
setPathPrefix(string $pathPrefix)

Method to set property pathPrefix

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 88
__construct(string $layout, string|RendererInterface $renderer = null, string|AbstractPackage $package = null)

Class init.

Parameters

string $layout
string|RendererInterface $renderer
string|AbstractPackage $package

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

render

Parameters

array $data

Return Value

string

at line line 168
string getLayout()

Method to get property Layout

Return Value

string

at line line 180
Widget setLayout(string $layout)

Method to set property layout

Parameters

string $layout

Return Value

Widget Return self to support chaining.

at line line 192
RendererInterface getRenderer()

Method to get property Renderer

Return Value

RendererInterface

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 240
Widget registerPaths(bool $refresh = false)

registerPaths

Parameters

bool $refresh

Return Value

Widget

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

addPath

Parameters

string $path
integer $priority

Return Value

Widget

at line line 295
PriorityQueue getPaths()

getPaths

Return Value

PriorityQueue

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

setPaths

Parameters

array|SplPriorityQueue $paths

Return Value

Widget

at line line 321
boolean isDebug()

Method to get property Debug

Return Value

boolean

at line line 333
Widget setDebug(boolean $debug)

Method to set property debug

Parameters

boolean $debug

Return Value

Widget Return self to support chaining.

at line line 364
AbstractPackage getPackage()

Method to get property Package

Return Value

AbstractPackage

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.

at line line 393
Widget reset()

reset

Return Value

Widget

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

set

Parameters

string $name
mixed $value

Return Value

Widget

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

get

Parameters

string $name
mixed $default

Return Value

mixed

at line line 445
array getData()

Method to get property Data

Return Value

array

at line line 457
Widget setData(array $data)

Method to set property data

Parameters

array $data

Return Value

Widget Return self to support chaining.

at line line 469
string __toString()

__toString

Return Value

string

at line line 492
string getPathPrefix()

Method to get property PathPrefix

Return Value

string

at line line 504
Widget setPathPrefix(string $pathPrefix)

Method to set property pathPrefix

Parameters

string $pathPrefix

Return Value

Widget Return self to support chaining.