WidgetArea class - Documentation for SproutCMS

Info Page:

Page options:

class WidgetArea

Stores information about an individual widget area, including the names of all widgets
that are allowed to be in this area.

File: /sprout/Helpers/WidgetArea.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$defaults`
`$embed`
`$index`
`$name`
`$nice_name`
`$orientation`
`$orientation_classes`	(static)	Class names which are output in the wrapper div
`$widgets`

Functions

Name	Visibility	Description
__construct	public	Constructor
addDefault	public	Adds a widget to the list of widgets allowed for this area
addWidget	public	Adds a widget to the list of widgets allowed for this area
findAreaByName	public (static)	Returns the widget area which has the specified name.
getIndex	public	Returns the index of this widget area
getName	public	Returns the name of this widget area
getNiceName	public	Returns the nice name of this widget area
getOrientation	public	Gets the orientation of the widget area
getWidgets	public	Gets the list of allowed widgets
isEmbed	public	If the widget area is an embedding area
setEmbed	public	If true, the widget area is an 'embedding' area.
setNiceName	public	Sets the nice name of this widget area
setOrientation	public	Sets the orientation of the widget area

public __construct

void $WidgetArea->__construct ( string $name , int $index );

Constructor

public addDefault

void $WidgetArea->addDefault ( string $widget_name , mixed $settings );

Adds a widget to the list of widgets allowed for this area

public addWidget

void $WidgetArea->addWidget ( string $widget_name );

Adds a widget to the list of widgets allowed for this area

public findAreaByName

unknown WidgetArea::findAreaByName ( string $name );

Returns the widget area which has the specified name.
Uses the widget areas defined in the sprout config.

public getIndex

unknown $WidgetArea->getIndex ( );

Returns the index of this widget area

public getName

unknown $WidgetArea->getName ( );

Returns the name of this widget area

public getNiceName

unknown $WidgetArea->getNiceName ( );

Returns the nice name of this widget area

public getOrientation

unknown $WidgetArea->getOrientation ( );

Gets the orientation of the widget area

public getWidgets

unknown $WidgetArea->getWidgets ( );

Gets the list of allowed widgets

public isEmbed

unknown $WidgetArea->isEmbed ( );

If the widget area is an embedding area

public setEmbed

void $WidgetArea->setEmbed ( mixed $embed );

If true, the widget area is an 'embedding' area.

public setNiceName

void $WidgetArea->setNiceName ( string $name );

Sets the nice name of this widget area

public setOrientation

void $WidgetArea->setOrientation ( int $value );

Sets the orientation of the widget area

SproutCMS

Search documentation