HumHub Documentation (unofficial)

Menu extends HeaderControlsMenu
in package

Menu compatibility

Tags
see
HeaderControlsMenu
deprecated

since version 1.1

author

Luke

Table of Contents

Constants

EVENT_AFTER_RUN  = 'afterRun'
EVENT_BEFORE_RUN  = 'beforeRun'
EVENT_CREATE  = 'create'
EVENT_INIT  = 'init'
EVENT_RUN  = 'run'

Properties

$autoIdPrefix  : string
$behaviors  : array<string|int, Behavior>
$container  : string
$content  : string
$events  : mixed
Event action handler.
$fadeIn  : bool|string|int
If set to true or 'fast', 'slow' or a integer duration in milliseconds the jsWidget will fade in the root element after initialization.
$id  : mixed
$id  : string|null
$init  : mixed
Auto init flag.
$jsWidget  : string
Js Widget namespace
$label  : string
$options  : mixed
$render  : bool
$space  : Space
$template  : string
$view  : View
$view  : View
$viewPath  : string
$visible  : bool
Used to hide/show the actual input element.
$widgetLayout  : string
$entries  : array<string|int, MenuEntry>
$_behaviors  : array<string|int, Behavior>|null
$_events  : array<string|int, mixed>
$_eventWildcards  : array<string|int, mixed>
$_id  : mixed
$_view  : mixed

Methods

__call()  : mixed
Calls the named method which is not a class method.
__clone()  : mixed
This method is called after the object is created by cloning an existing one.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of a component property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets the value of a component property.
__unset()  : mixed
Sets a component property to be null.
addEntry()  : mixed
Add new menu entry to the navigation
addItem()  : mixed
addItemGroup()  : array<string|int, mixed>
afterRun()  : mixed
This method is invoked right after a widget is executed.
attachBehavior()  : Behavior
Attaches a behavior to this component.
attachBehaviors()  : mixed
Attaches a list of behaviors to the component.
beforeRun()  : bool
This method is invoked right before the widget is executed.
begin()  : static
Begins a widget.
behaviors()  : array<string|int, mixed>
Returns a list of behaviors that this component should behave as.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
deleteItemByUrl()  : mixed
detachBehavior()  : Behavior|null
Detaches a behavior from the component.
detachBehaviors()  : mixed
Detaches all behaviors from the component.
end()  : static
Ends a widget.
ensureBehaviors()  : mixed
Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getActive()  : array<string|int, mixed>
getActiveEntry()  : MenuEntry
Returns the first active menu entry
getAttributes()  : mixed
Returns all html attributes for used by this widget and will normally inserted in the widgets root html element.
getBehavior()  : Behavior|null
Returns the named behavior object.
getBehaviors()  : array<string|int, Behavior>
Returns all behaviors attached to this component.
getData()  : mixed
Returns an array of data-* attributes to configure your clientside js widget.
getEntries()  : array<string|int, MenuEntry>
Returns all entries filtered by $type. If no $type filter is given all entries are returned.
getEntryById()  : MenuEntry
Returns the first entry with the given id
getEntryByUrl()  : MenuLink
Returns the first entry with the given URL
getFirstEntry()  : MenuEntry|null
getId()  : string
Returns the html id of this widget, if no id is set this function will generate an id if $autoGenerate is set to true (default).
getItemGroups()  : array<string|int, mixed>
getItems()  : array<string|int, mixed>
getLayoutViewParams()  : array<string|int, mixed>
Returns an array of view parameter used if [[layout]] is set.
getSortedEntries()  : array<string|int, MenuEntry>
Sorts the entry list by sortOrder and returns the sorted entry list.
getView()  : View
Returns the view object that can be used to render views or view files.
getViewPath()  : string
Returns the directory containing the view files for this widget.
hasEventHandlers()  : bool
Returns a value indicating whether there is any handler attached to the named event.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasMultipleEntries()  : bool
Checks if this menu contains multiple entries of the given $type, or at all if no $type filter is given.
hasProperty()  : bool
Returns a value indicating whether a property is defined for this component.
init()  : mixed
Initializes the object.
markAsActive()  : mixed
This function provides static menu entry activation, by entry id or url.
markAsInactive()  : mixed
This function provides static menu entry inactivation, by entry id or url.
off()  : bool
Detaches an existing event handler from this component.
on()  : mixed
Attaches an event handler to an event.
process()  : mixed
Process is a wrapper for the run method
removeEntry()  : bool
Removes the entry from the navigation
render()  : string
Renders a view.
renderFile()  : string
Renders a view file.
run()  : string
Executes the navigation widget.
setActive()  : mixed
Activates an entry by given id or url search string.
setDefaultOptions()  : mixed
Sets some default data options required by all widgets as the widget implementation and the widget events and initialization trigger.
setEntryActive()  : mixed
Sets an menu entry active and inactive all other entries
setId()  : mixed
Sets the ID of the widget.
setInactive()  : mixed
Deactivates an entry by given id or url search string.
setView()  : mixed
Sets the view object to be used by this widget.
setViewState()  : mixed
trigger()  : mixed
Triggers an event.
widget()  : string
Creates a widget instance and runs it.
getOptions()  : array<string|int, mixed>
Assembles all widget attributes and data settings of this widget.
getViewParams()  : array<string|int, mixed>
Returns the parameters which are passed to the view template
attachBehaviorInternal()  : Behavior
Attaches a behavior to this component.

Constants

EVENT_AFTER_RUN

public mixed EVENT_AFTER_RUN = 'afterRun'
Tags
event

WidgetEvent an event raised right after executing a widget.

since
2.0.11

EVENT_BEFORE_RUN

public mixed EVENT_BEFORE_RUN = 'beforeRun'
Tags
event

WidgetEvent an event raised right before executing a widget. You may set [[WidgetEvent::isValid]] to be false to cancel the widget execution.

since
2.0.11

EVENT_CREATE

public mixed EVENT_CREATE = 'create'
Tags
event

WidgetCreateEvent an event raised before creating a widget.

EVENT_INIT

public mixed EVENT_INIT = 'init'
Tags
event

Event an event that is triggered when the widget is initialized via [[init()]].

since
2.0.11

EVENT_RUN

public mixed EVENT_RUN = 'run'
Tags
event

MenuEvent an event raised before running the navigation widget.

Properties

$autoIdPrefix

public static string $autoIdPrefix = 'w'

the prefix to the automatically generated widget IDs.

Tags
see
getId()

$behaviors read-only

public array<string|int, Behavior> $behaviors

List of behaviors attached to this component.

$container

public string $container = 'div'

html container element.

$content

public string $content

html content.

$events

Event action handler.

public mixed $events = []
Tags
@var

[]

$fadeIn

If set to true or 'fast', 'slow' or a integer duration in milliseconds the jsWidget will fade in the root element after initialization.

public bool|string|int $fadeIn = false

This can be handy for widgets which need some time to initialize.

Tags
since
1.2.2

$id

public string|null $id

ID of the widget. Note that the type of this property differs in getter and setter. See [[getId()]] and [[setId()]] for details.

$init

Auto init flag.

public mixed $init = false

$jsWidget

Js Widget namespace

public string $jsWidget

$render

public bool $render = true

if set to false this widget won't be rendered

$template

public string $template = '@ui/menu/widgets/views/dropdown-menu.php'

template view file of the navigation

Tags
inheritdoc

$view

public View $view

The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See [[getView()]] and [[setView()]] for details.

$viewPath read-only

public string $viewPath

The directory containing the view files for this widget.

$visible

Used to hide/show the actual input element.

public bool $visible = true

$widgetLayout

public string $widgetLayout

defines an optional layout

$entries

protected array<string|int, MenuEntry> $entries = []

the menu entries

$_behaviors

private array<string|int, Behavior>|null $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events

private array<string|int, mixed> $_events = []

the attached event handlers (event name => handlers)

$_eventWildcards

private array<string|int, mixed> $_eventWildcards = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

Tags
since
2.0.14

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.

public __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.

public __get(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only.

see
__set()
Return values
mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set

__set()

Sets the value of a component property.

public __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only.

see
__get()

__unset()

Sets a component property to be null.

public __unset(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

addEntry()

Add new menu entry to the navigation

public addEntry(MenuEntry $entry) : mixed
Parameters
$entry : MenuEntry

addItem()

public addItem(array<string|int, mixed> $entryArray) : mixed
Parameters
$entryArray : array<string|int, mixed>
Tags
deprecated

since 1.4

addItemGroup()

public addItemGroup(mixed $itemGroup) : array<string|int, mixed>
Parameters
$itemGroup : mixed
Tags
deprecated

since 1.4 not longer supported!

Return values
array<string|int, mixed> —

item group

afterRun()

This method is invoked right after a widget is executed.

public afterRun(mixed $result) : mixed

The method will trigger the [[EVENT_AFTER_RUN]] event. The return value of the method will be used as the widget return value.

If you override this method, your code should look like the following:

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
Parameters
$result : mixed

the widget return result.

Tags
since
2.0.11
Return values
mixed —

the processed widget result.

attachBehavior()

Attaches a behavior to this component.

public attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters
$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

  • a [[Behavior]] object
  • a string specifying the behavior class
  • an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
Tags
see
detachBehavior()
Return values
Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.

public attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters
$behaviors : array<string|int, mixed>

list of behaviors to be attached to the component

Tags
see
attachBehavior()

beforeRun()

This method is invoked right before the widget is executed.

public beforeRun() : bool

The method will trigger the [[EVENT_BEFORE_RUN]] event. The return value of the method will determine whether the widget should continue to run.

When overriding this method, make sure you call the parent implementation like the following:

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
Tags
since
2.0.11
Return values
bool —

whether the widget should continue to be executed.

begin()

Begins a widget.

public static begin([array<string|int, mixed> $config = [] ]) : static

This method creates an instance of the calling class. It will apply the configuration to the created instance. A matching [[end()]] call should be called later. As some widgets may use output buffering, the [[end()]] call should be made in the same view to avoid breaking the nesting of output buffers.

Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

Tags
see
end()
Return values
static —

the newly created widget instance

behaviors()

Returns a list of behaviors that this component should behave as.

public behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values
array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

deleteItemByUrl()

public deleteItemByUrl(mixed $url) : mixed
Parameters
$url : mixed

string the URL or route

Tags
deprecated

since 1.4

detachBehavior()

Detaches a behavior from the component.

public detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters
$name : string

the behavior's name.

Return values
Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.

public detachBehaviors() : mixed

end()

Ends a widget.

public static end() : static

Note that the rendering result of the widget is directly echoed out.

Tags
throws
InvalidCallException

if [[begin()]] and [[end()]] calls are not properly nested

see
begin()
Return values
static —

the widget instance that is ended.

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.

public ensureBehaviors() : mixed

getActive()

public getActive() : array<string|int, mixed>
Tags
deprecated

since 1.4

Return values
array<string|int, mixed> —

the menu entry as array

getAttributes()

Returns all html attributes for used by this widget and will normally inserted in the widgets root html element.

public getAttributes() : mixed
Tags
inheritdoc

getBehavior()

Returns the named behavior object.

public getBehavior(string $name) : Behavior|null
Parameters
$name : string

the behavior name

Return values
Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.

public getBehaviors() : array<string|int, Behavior>
Return values
array<string|int, Behavior> —

list of behaviors attached to this component

getData()

Returns an array of data-* attributes to configure your clientside js widget.

public getData() : mixed
Tags
inheritdoc

getEntries()

Returns all entries filtered by $type. If no $type filter is given all entries are returned.

public getEntries([null|string $type = null ][, bool $filterVisible = false ]) : array<string|int, MenuEntry>

If $filterVisible is set, only visible entries will be returned

Parameters
$type : null|string = null
$filterVisible : bool = false
Return values
array<string|int, MenuEntry>

getEntryById()

Returns the first entry with the given id

public getEntryById(mixed $id) : MenuEntry
Parameters
$id : mixed

string the menueId

Return values
MenuEntry

getEntryByUrl()

Returns the first entry with the given URL

public getEntryByUrl(mixed $url) : MenuLink
Parameters
$url : mixed

string|array the url or route

Return values
MenuLink

getFirstEntry()

public getFirstEntry([null $type = null ][, bool $filterVisible = false ]) : MenuEntry|null
Parameters
$type : null = null
$filterVisible : bool = false
Return values
MenuEntry|null

getId()

Returns the html id of this widget, if no id is set this function will generate an id if $autoGenerate is set to true (default).

public getId([bool $autoGenerate = true ]) : string

Note that the id is automatically included within the getOptions() function.

Parameters
$autoGenerate : bool = true
Return values
string

getItemGroups()

public getItemGroups() : array<string|int, mixed>
Tags
deprecated

since 1.4

Return values
array<string|int, mixed> —

the item group

getItems()

public getItems([mixed $group = '' ]) : array<string|int, mixed>
Parameters
$group : mixed = ''
Tags
deprecated

since 1.4

Return values
array<string|int, mixed> —

the menu items as array list

getLayoutViewParams()

Returns an array of view parameter used if [[layout]] is set.

public getLayoutViewParams() : array<string|int, mixed>

By default the actual widget output created by [[run()]] is set as content param.

Return values
array<string|int, mixed>

getSortedEntries()

Sorts the entry list by sortOrder and returns the sorted entry list.

public getSortedEntries() : array<string|int, MenuEntry>
Return values
array<string|int, MenuEntry>

getView()

Returns the view object that can be used to render views or view files.

public getView() : View

The [[render()]] and [[renderFile()]] methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.

Return values
View —

the view object that can be used to render views or view files.

getViewPath()

Returns the directory containing the view files for this widget.

public getViewPath() : string

The default implementation returns the 'views' subdirectory under the directory containing the widget class file.

Return values
string —

the directory containing the view files for this widget.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public hasEventHandlers(string $name) : bool
Parameters
$name : string

the event name

Return values
bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkBehaviors : bool = true

whether to treat behaviors' methods as methods of this component

Return values
bool —

whether the method is defined

hasMultipleEntries()

Checks if this menu contains multiple entries of the given $type, or at all if no $type filter is given.

public hasMultipleEntries([null $type = null ]) : bool
Parameters
$type : null = null
Return values
bool

hasProperty()

Returns a value indicating whether a property is defined for this component.

public hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

markAsActive()

This function provides static menu entry activation, by entry id or url.

public static markAsActive(mixed $searchStr) : mixed
Parameters
$searchStr : mixed

markAsInactive()

This function provides static menu entry inactivation, by entry id or url.

public static markAsInactive(mixed $url) : mixed
Parameters
$url : mixed

off()

Detaches an existing event handler from this component.

public off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters
$name : string

event name

$handler : callable|null = null

the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Tags
see
on()
Return values
bool —

if a handler is found and detached

on()

Attaches an event handler to an event.

public on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});
Parameters
$name : string

the event name

$handler : callable

the event handler

$data : mixed = null

the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].

$append : bool = true

whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Tags
see
off()

process()

Process is a wrapper for the run method

public process() : mixed

removeEntry()

Removes the entry from the navigation

public removeEntry(MenuEntry $entry) : bool
Parameters
$entry : MenuEntry
Return values
bool

render()

Renders a view.

public render(string $view[, array<string|int, mixed> $params = [] ]) : string

The view to be rendered can be specified in one of the following formats:

  • path alias (e.g. "@app/views/site/index");
  • absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the [[Application::viewPath|view path]] of the application.
  • absolute path within module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the [[Module::viewPath|view path]] of the currently active module.
  • relative path (e.g. "index"): the actual view file will be looked for under [[viewPath]].

If the view name does not contain a file extension, it will use the default one .php.

Parameters
$view : string

the view name.

$params : array<string|int, mixed> = []

the parameters (name-value pairs) that should be made available in the view.

Tags
throws
InvalidArgumentException

if the view file does not exist.

Return values
string —

the rendering result.

renderFile()

Renders a view file.

public renderFile(string $file[, array<string|int, mixed> $params = [] ]) : string
Parameters
$file : string

the view file to be rendered. This can be either a file path or a path alias.

$params : array<string|int, mixed> = []

the parameters (name-value pairs) that should be made available in the view.

Tags
throws
InvalidArgumentException

if the view file does not exist.

Return values
string —

the rendering result.

run()

Executes the navigation widget.

public run() : string
Return values
string —

the result of navigation widget execution to be outputted.

setActive()

Activates an entry by given id or url search string.

public setActive(mixed $searchStr) : mixed
Parameters
$searchStr : mixed

menu entry id or url

setDefaultOptions()

Sets some default data options required by all widgets as the widget implementation and the widget events and initialization trigger.

public setDefaultOptions() : mixed

setEntryActive()

Sets an menu entry active and inactive all other entries

public setEntryActive(MenuEntry $entry) : mixed
Parameters
$entry : MenuEntry

setId()

Sets the ID of the widget.

public setId(string $value) : mixed
Parameters
$value : string

id of the widget.

setInactive()

Deactivates an entry by given id or url search string.

public setInactive(mixed $searchStr) : mixed
Parameters
$searchStr : mixed

menu entry id or url

setView()

Sets the view object to be used by this widget.

public setView(View $view) : mixed
Parameters
$view : View

the view object that can be used to render views or view files.

setViewState()

public static setViewState() : mixed
Tags
deprecated

since 1.4

trigger()

Triggers an event.

public trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters
$name : string

the event name

$event : Event|null = null

the event instance. If not set, a default [[Event]] object will be created.

widget()

Creates a widget instance and runs it.

public static widget([array<string|int, mixed> $config = [] ]) : string

The widget rendering result is returned by this method.

Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

Tags
throws
Exception
Return values
string —

the rendering result of the widget.

getOptions()

Assembles all widget attributes and data settings of this widget.

protected getOptions() : array<string|int, mixed>

Those attributes/options are are normally transfered to the js client by ordinary html attributes or by using data-* attributes.

Return values
array<string|int, mixed>

getViewParams()

Returns the parameters which are passed to the view template

protected getViewParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —

the view parameters

attachBehaviorInternal()

Attaches a behavior to this component.

private attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior
Parameters
$name : string|int

the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.

$behavior : string|array<string|int, mixed>|Behavior

the behavior to be attached

Return values
Behavior —

the attached behavior.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results