g
Frontend | Backend | Api

Admin\Models\Backend\MenuElement

MenuElement

Method Description Returns
getId() int
getPosition() int
getName() string
getIdentifier() string
isVisible() bool
isPredefined() bool
getIcon() string
getModuleRoute() string
getControllerRoute() string
getParameters() array
getUrl() string
getAuthModule() string
getAuthModulePermission() string
getAuthEntity() string
getAuthEntityPermission() string
getAuthRequiredUserType() string
getParent() MenuElement
getChildren() Collection (MenuElement)
isNewRecord() Check if the record is a new record bool
isHierarchicalModel() Check whether a model is a hierarchical model, i.e. can have children bool
isVersionedModel() Check whether a model is versioned bool
getVisibleChildren() Returns the visible children of this menu element Collection
isVisibleToUser() Checks whether the menu element is visible to the user bool
isActive() Determines whether the menu element is active bool
getTranslatedName() Returns the translated name of the menu element, if a dot is contained in the menu element name string
hasVisibleChildren() Checks whether the menu element has any visible children bool
hasActiveChildren() Checks whether the menu element has any active children bool
getModulePath() Returns the module path of the menu element string
getFullPath() Returns the full path of the menu element, using either the specified URL or generating a URL based on the provided route and parameters string
isAddressable() Checks whether the menu element is addressable => can have a link bool
getAvailableRequiredUserTypes() Provides the available user types to be selected for restricting a menu element to a specific user type array
getParametersString() Retrieves the parameters for the route as JSON encoded string string
getHateoasLinks() Get the HATEOAS links for the record array
getCreateChildUrl() Get the url for creating a child record. string
getEditUrl() Get the url for editing the record. string
getDeleteUrl() Get the url for deleting the record. string
getMoveUrl() Get the url for moving the record. string