CoolCMS API

Menu extends Menu
in package

Tags
extends
Attributes
#[Entity]
#[Table]
$name: 'cms_system_menu'
#[TableAlias]
'menu'

Table of Contents

Properties

$id  : int|null
$items  : Collection
$title  : string
$translations  : Collection

Methods

__construct()  : mixed
addItem()  : $this
addTranslation()  : $this
callInitMethods()  : void
Calls `init{TraitName}()` for every used trait that defines such a method.
clearItems()  : $this
getAllTraits()  : array<string, string>
Returns all traits the class uses, including those used by parent classes and nested traits.
getId()  : int|null
getItem()  : TItem|null
getItems()  : Collection<int, TItem>
getTitle()  : string
getTranslation()  : TTranslation|null
getTranslations()  : Collection<int, TTranslation>
isPersisted()  : bool
itemCollectionInit()  : void
removeItem()  : $this
removeTranslation()  : $this
setId()  : $this
setItems()  : $this
setTitle()  : $this
setTranslations()  : $this
translationCollectionInit()  : void
getTraitsRecursive()  : array<string, string>
Walks the trait list recursively and collects nested traits too.

Properties

$id

protected int|null $id = null
Attributes
#[Column]
$type: 'integer'
$name: 'menu_id'
$options: ['unsigned' => true]
#[GeneratedValue]
$strategy: 'AUTO'
#[Id]

$items

protected Collection $items
Attributes
#[OneToMany]
$targetEntity: \App\UI\Api\System\Models\Entities\MenuItem::class
$mappedBy: 'menu'
$cascade: ['persist', 'remove']
$orphanRemoval: true
$fetch: "LAZY"

$title

protected string $title = ""
Attributes
#[Column]
$type: 'string'
$length: 255

$translations

protected Collection $translations
Attributes
#[OneToMany]
$targetEntity: \App\UI\Api\System\Models\Entities\MenuText::class
$mappedBy: "parent"
$cascade: ["persist", "remove"]
$orphanRemoval: true
$fetch: "LAZY"

Methods

__construct()

public __construct([int|null $id = null ][, string $title = "" ][, Collection $items = new ArrayCollection() ][, Collection $translations = new ArrayCollection() ]) : mixed
Parameters
$id : int|null = null
$title : string = ""
$items : Collection = new ArrayCollection()
$translations : Collection = new ArrayCollection()

addItem()

public addItem(TItem $item) : $this
Parameters
$item : TItem
Return values
$this

addTranslation()

public addTranslation(TTranslation $translation) : $this
Parameters
$translation : TTranslation
Return values
$this

callInitMethods()

Calls `init{TraitName}()` for every used trait that defines such a method.

public callInitMethods() : void

getAllTraits()

Returns all traits the class uses, including those used by parent classes and nested traits.

public getAllTraits() : array<string, string>
Return values
array<string, string>

getItem()

public getItem(int $itemId) : TItem|null
Parameters
$itemId : int
Return values
TItem|null

getItems()

public getItems() : Collection<int, TItem>
Return values
Collection<int, TItem>

getTitle()

public getTitle() : string
Return values
string

getTranslation()

public getTranslation(int $langId) : TTranslation|null
Parameters
$langId : int
Return values
TTranslation|null

getTranslations()

public getTranslations() : Collection<int, TTranslation>
Return values
Collection<int, TTranslation>

removeItem()

public removeItem(TItem $item) : $this
Parameters
$item : TItem
Return values
$this

removeTranslation()

public removeTranslation(TTranslation $translation) : $this
Parameters
$translation : TTranslation
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setItems()

public setItems(Collection<int, TItem>|array<int, TItem> $items) : $this
Parameters
$items : Collection<int, TItem>|array<int, TItem>
Return values
$this

setTitle()

public setTitle(string $title) : $this
Parameters
$title : string
Return values
$this

setTranslations()

public setTranslations(Collection<int, TTranslation>|array<int, TTranslation> $translations) : $this
Parameters
$translations : Collection<int, TTranslation>|array<int, TTranslation>
Return values
$this

getTraitsRecursive()

Walks the trait list recursively and collects nested traits too.

private static getTraitsRecursive(array<string, string> $traits) : array<string, string>
Parameters
$traits : array<string, string>
Return values
array<string, string>
On this page

Search results