MenuGroup
in package
implements
Sortable
Class MenuGroup
Interfaces, Classes and Traits
- Sortable
- Interface Sortable
Table of Contents
- $brand : string|null
- $conditions : Conditions|null
- $icon : string|null
- $id : string
- $items : MenuItems
- $sortOrder : int|null
- $title : string|null
- $type : string|null
- add() : void
- Adds a menu item to the menu group.
- conditions() : Conditions|null
- Filter condition.
- filterItems() : void
- Filters menu items.
- fromArray() : static
- Factory method to create MenuGroup from an array.
- id() : string
- Returns the group identifier.
- isEqual() : bool
- Compares menu group with another one.
- merge() : void
- Merges items with given menu group.
- sort() : void
- Sort menu item collection.
- sortOrder() : int
- toArray() : array<string|int, mixed>
- Array serialization
- __construct() : mixed
- MenuGroup constructor.
Properties
$brand
private
string|null
$brand
$conditions
private
Conditions|null
$conditions
$icon
private
string|null
$icon
$id
private
string
$id
$items
private
MenuItems
$items
$sortOrder
private
int|null
$sortOrder
$title
private
string|null
$title
$type
private
string|null
$type
Methods
add()
Adds a menu item to the menu group.
public
add(MenuItem $menuItem) : void
Parameters
- $menuItem : MenuItem
Return values
void —conditions()
Filter condition.
public
conditions() : Conditions|null
Return values
Conditions|null —filterItems()
Filters menu items.
public
filterItems(FilterFactory $filterFactory) : void
Parameters
- $filterFactory : FilterFactory
Return values
void —fromArray()
Factory method to create MenuGroup from an array.
public
static fromArray(array<string|int, mixed> $data, MenuItems $items[, Conditions|null $conditions = null ]) : static
Parameters
- $data : array<string|int, mixed>
- $items : MenuItems
- $conditions : Conditions|null = null
Return values
static —id()
Returns the group identifier.
public
id() : string
Return values
string —isEqual()
Compares menu group with another one.
public
isEqual(MenuGroup $other) : bool
Parameters
- $other : MenuGroup
Return values
bool —merge()
Merges items with given menu group.
public
merge(MenuGroup $other) : void
Parameters
- $other : MenuGroup
Return values
void —sort()
Sort menu item collection.
public
sort() : void
Return values
void —sortOrder()
public
sortOrder() : int
Return values
int —toArray()
Array serialization
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —__construct()
MenuGroup constructor.
private
__construct(string $id, string|null $title, string|null $icon, int|null $sortOrder, string|null $brand, string|null $type, MenuItems $items[, Conditions|null $conditions = null ]) : mixed
Parameters
- $id : string
- $title : string|null
- $icon : string|null
- $sortOrder : int|null
- $brand : string|null
- $type : string|null
- $items : MenuItems
- $conditions : Conditions|null = null