Documentation

CrudMenuItem
in package
implements MenuItemInterface Uses MenuItemTrait

FinalYes
Tags
see
MenuItem::linkToCrud()
author

Javier Eguiluz javier.eguiluz@gmail.com

Table of Contents

Interfaces

MenuItemInterface

Properties

$dto  : MenuItemDto

Methods

__construct()  : mixed
getAsDto()  : MenuItemDto
setAction()  : self
setBadge()  : self
setController()  : self
setCssClass()  : self
setDefaultSort()  : self
setEntityId()  : self
setLinkRel()  : self
setLinkTarget()  : self
setPermission()  : self
setQueryParameter()  : self
setTranslationParameters()  : self

Properties

Methods

setAction()

public setAction(string $actionName) : self
Parameters
$actionName : string
Return values
self

setBadge()

public setBadge(mixed $content[, string $style = 'secondary' ]) : self
Parameters
$content : mixed

This is rendered as the value of the badge; it can be anything that can be cast to a string (numbers, stringable objects, etc.)

$style : string = 'secondary'

Pass one of these values for predefined styles: 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark' Otherwise, the passed value is applied "as is" to the style attribute of the HTML element of the badge

Return values
self

setController()

public setController(string $controllerFqcn) : self
Parameters
$controllerFqcn : string
Return values
self

setCssClass()

public setCssClass(string $cssClass) : self
Parameters
$cssClass : string
Return values
self

setDefaultSort()

public setDefaultSort(array<string|int, mixed> $sortFieldsAndOrder) : self
Parameters
$sortFieldsAndOrder : array<string|int, mixed>

['fieldName' => 'ASC|DESC', ...]

Return values
self

setEntityId()

public setEntityId(mixed $entityId) : self
Parameters
$entityId : mixed
Return values
self

setLinkRel()

public setLinkRel(string $rel) : self
Parameters
$rel : string
Return values
self

setLinkTarget()

public setLinkTarget(string $target) : self
Parameters
$target : string
Return values
self

setPermission()

public setPermission(string $permission) : self
Parameters
$permission : string
Return values
self

setQueryParameter()

public setQueryParameter(string $parameterName, mixed $parameterValue) : self
Parameters
$parameterName : string
$parameterValue : mixed
Return values
self

setTranslationParameters()

public setTranslationParameters(array<string|int, mixed> $parameters) : self
Parameters
$parameters : array<string|int, mixed>
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results