CoolCMS API

MenuItemRelCollectionTrait

Tags
template

Table of Contents

Properties

$menuItemRels  : Collection<int, TMenuItemRel>

Methods

addMenuItemRel()  : $this
clearMenuItemRels()  : $this
getMenuItemIds()  : array<int, int>
Returns ids of the menu items the page is attached to.
getMenuItemRels()  : Collection<int, TMenuItemRel>
menuItemRelCollectionInit()  : void
removeMenuItemRel()  : $this
setMenuItemRels()  : $this

Properties

Methods

addMenuItemRel()

public addMenuItemRel(TMenuItemRel $menuItemRel) : $this
Parameters
$menuItemRel : TMenuItemRel
Return values
$this

getMenuItemIds()

Returns ids of the menu items the page is attached to.

public getMenuItemIds() : array<int, int>

The relation has no scalar column and the id is read from the association, so the caller must load the page with the include menuItemRels.adminMenuItem; menuItemRels alone returns rows with a null adminMenuItem and the result is empty.

Return values
array<int, int>

getMenuItemRels()

public getMenuItemRels() : Collection<int, TMenuItemRel>
Return values
Collection<int, TMenuItemRel>

removeMenuItemRel()

public removeMenuItemRel(TMenuItemRel $menuItemRel) : $this
Parameters
$menuItemRel : TMenuItemRel
Return values
$this

setMenuItemRels()

public setMenuItemRels(Collection<int, TMenuItemRel>|array<int, TMenuItemRel> $menuItemRels) : $this
Parameters
$menuItemRels : Collection<int, TMenuItemRel>|array<int, TMenuItemRel>
Return values
$this
On this page

Search results