CrudDto
in package
FinalYes
Tags
Table of Contents
Properties
- $actionConfigDto : ActionConfigDto|null
- $actionName : string|null
- $autofocusSearch : bool
- $contentWidth : string|null
- $controllerFqcn : string|null
- $customPageTitles : array<string|int, mixed>
- $dateIntervalFormat : string
- $datePattern : string|null
- $dateTimePattern : array<string|int, mixed>
- $defaultPageTitles : array<string|int, mixed>
- $defaultSort : array<string|int, mixed>
- $editFormOptions : KeyValueStore
- $entityFqcn : string|null
- $entityLabelInPlural : mixed
- $entityLabelInSingular : mixed
- $entityPermission : string|null
- $fieldAssetsDto : AssetsDto
- $filters : FilterConfigDto|null
- $formThemes : array<string|int, mixed>
- $helpMessages : array<string|int, mixed>
- $newFormOptions : KeyValueStore
- $numberFormat : string|null
- $overriddenTemplates : mixed
- $pageName : string|null
- $paginatorDto : PaginatorDto|null
- $searchFields : array<string|int, mixed>|null
- $showEntityActionsAsDropdown : bool
- $sidebarWidth : string|null
- $timePattern : string|null
- $timezone : string|null
Methods
- __construct() : mixed
- addFormTheme() : void
- autofocusSearch() : bool
- getActionsConfig() : ActionConfigDto
- getContentWidth() : string|null
- getControllerFqcn() : string|null
- getCurrentAction() : string
- getCurrentPage() : string|null
- getCustomPageTitle() : TranslatableInterface|null
- getDateIntervalFormat() : string
- getDatePattern() : string|null
- getDateTimePattern() : array<string|int, mixed>
- getDefaultPageTitle() : TranslatableInterface|null
- getDefaultSort() : array<string|int, mixed>
- getEditFormOptions() : KeyValueStore
- getEntityFqcn() : string
- getEntityLabelInPlural() : TranslatableInterface|string|null
- getEntityLabelInSingular() : TranslatableInterface|string|null
- getEntityPermission() : string|null
- getFieldAssets() : AssetsDto
- getFiltersConfig() : FilterConfigDto
- getFormThemes() : array<string|int, mixed>
- getHelpMessage() : TranslatableInterface|string
- getHelpMessages() : array<string|int, mixed>
- getNewFormOptions() : KeyValueStore
- getNumberFormat() : string|null
- getOverriddenTemplates() : array<string|int, mixed>
- getPaginator() : PaginatorDto
- getSearchFields() : array<string|int, mixed>|null
- getSidebarWidth() : string|null
- getTimePattern() : string|null
- getTimezone() : string|null
- isSearchEnabled() : bool
- overrideTemplate() : void
- setActionsConfig() : void
- setAutofocusSearch() : void
- setContentWidth() : void
- setControllerFqcn() : void
- setCurrentAction() : void
- setCustomPageTitle() : void
- setDateIntervalFormat() : void
- setDatePattern() : void
- setDateTimePattern() : void
- setDefaultSort() : void
- setEditFormOptions() : void
- setEntityFqcn() : void
- setEntityLabelInPlural() : void
- setEntityLabelInSingular() : void
- setEntityPermission() : void
- setFieldAssets() : void
- setFiltersConfig() : void
- setFormThemes() : void
- setHelpMessage() : void
- setNewFormOptions() : void
- setNumberFormat() : void
- setPageName() : void
- setPaginator() : void
- setSearchFields() : void
- setShowEntityActionsAsDropdown() : void
- setSidebarWidth() : void
- setTimePattern() : void
- setTimezone() : void
- showEntityActionsAsDropdown() : bool
Properties
$actionConfigDto
private
ActionConfigDto|null
$actionConfigDto
= null
$actionName
private
string|null
$actionName
= null
$autofocusSearch
private
bool
$autofocusSearch
= false
$contentWidth
private
string|null
$contentWidth
= null
$controllerFqcn
private
string|null
$controllerFqcn
= null
$customPageTitles
private
array<string|int, mixed>
$customPageTitles
= [\EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_DETAIL => null, \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_EDIT => null, \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_INDEX => null, \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_NEW => null]
$dateIntervalFormat
private
string
$dateIntervalFormat
= '%%y Year(s) %%m Month(s) %%d Day(s)'
$datePattern
private
string|null
$datePattern
= 'medium'
$dateTimePattern
private
array<string|int, mixed>
$dateTimePattern
= ['medium', 'medium']
$defaultPageTitles
private
array<string|int, mixed>
$defaultPageTitles
= [\EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_DETAIL => 'page_title.detail', \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_EDIT => 'page_title.edit', \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_INDEX => 'page_title.index', \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_NEW => 'page_title.new']
$defaultSort
private
array<string|int, mixed>
$defaultSort
= []
$editFormOptions
private
KeyValueStore
$editFormOptions
$entityFqcn
private
string|null
$entityFqcn
= null
$entityLabelInPlural
private
mixed
$entityLabelInPlural
$entityLabelInSingular
private
mixed
$entityLabelInSingular
$entityPermission
private
string|null
$entityPermission
= null
$fieldAssetsDto
private
AssetsDto
$fieldAssetsDto
$filters
private
FilterConfigDto|null
$filters
= null
$formThemes
private
array<string|int, mixed>
$formThemes
= ['@EasyAdmin/crud/form_theme.html.twig']
$helpMessages
private
array<string|int, mixed>
$helpMessages
= [\EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_DETAIL => null, \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_EDIT => null, \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_INDEX => null, \EasyCorp\Bundle\EasyAdminBundle\Config\Crud::PAGE_NEW => null]
$newFormOptions
private
KeyValueStore
$newFormOptions
$numberFormat
private
string|null
$numberFormat
= null
$overriddenTemplates
private
mixed
$overriddenTemplates
$pageName
private
string|null
$pageName
= null
$paginatorDto
private
PaginatorDto|null
$paginatorDto
= null
$searchFields
private
array<string|int, mixed>|null
$searchFields
= []
$showEntityActionsAsDropdown
private
bool
$showEntityActionsAsDropdown
= true
$sidebarWidth
private
string|null
$sidebarWidth
= null
$timePattern
private
string|null
$timePattern
= 'medium'
$timezone
private
string|null
$timezone
= null
Methods
__construct()
public
__construct() : mixed
addFormTheme()
public
addFormTheme(string $formThemePath) : void
Parameters
- $formThemePath : string
autofocusSearch()
public
autofocusSearch() : bool
Return values
boolgetActionsConfig()
public
getActionsConfig() : ActionConfigDto
Return values
ActionConfigDtogetContentWidth()
public
getContentWidth() : string|null
Return values
string|nullgetControllerFqcn()
public
getControllerFqcn() : string|null
Return values
string|nullgetCurrentAction()
public
getCurrentAction() : string
Return values
stringgetCurrentPage()
public
getCurrentPage() : string|null
Return values
string|nullgetCustomPageTitle()
public
getCustomPageTitle([string|null $pageName = null ][, mixed $entityInstance = null ][, array<string|int, mixed> $translationParameters = [] ]) : TranslatableInterface|null
Parameters
- $pageName : string|null = null
- $entityInstance : mixed = null
- $translationParameters : array<string|int, mixed> = []
Return values
TranslatableInterface|nullgetDateIntervalFormat()
public
getDateIntervalFormat() : string
Return values
stringgetDatePattern()
public
getDatePattern() : string|null
Return values
string|nullgetDateTimePattern()
public
getDateTimePattern() : array<string|int, mixed>
Return values
array<string|int, mixed>getDefaultPageTitle()
public
getDefaultPageTitle([string|null $pageName = null ][, mixed $entityInstance = null ][, array<string|int, mixed> $translationParameters = [] ]) : TranslatableInterface|null
Parameters
- $pageName : string|null = null
- $entityInstance : mixed = null
- $translationParameters : array<string|int, mixed> = []
Return values
TranslatableInterface|nullgetDefaultSort()
public
getDefaultSort() : array<string|int, mixed>
Return values
array<string|int, mixed>getEditFormOptions()
public
getEditFormOptions() : KeyValueStore
Return values
KeyValueStoregetEntityFqcn()
public
getEntityFqcn() : string
Return values
stringgetEntityLabelInPlural()
public
getEntityLabelInPlural([mixed $entityInstance = null ][, mixed $pageName = null ]) : TranslatableInterface|string|null
Parameters
- $entityInstance : mixed = null
- $pageName : mixed = null
Return values
TranslatableInterface|string|nullgetEntityLabelInSingular()
public
getEntityLabelInSingular([mixed $entityInstance = null ][, mixed $pageName = null ]) : TranslatableInterface|string|null
Parameters
- $entityInstance : mixed = null
- $pageName : mixed = null
Return values
TranslatableInterface|string|nullgetEntityPermission()
public
getEntityPermission() : string|null
Return values
string|nullgetFieldAssets()
public
getFieldAssets(string $pageName) : AssetsDto
Parameters
- $pageName : string
Return values
AssetsDtogetFiltersConfig()
public
getFiltersConfig() : FilterConfigDto
Return values
FilterConfigDtogetFormThemes()
public
getFormThemes() : array<string|int, mixed>
Return values
array<string|int, mixed>getHelpMessage()
public
getHelpMessage([string|null $pageName = null ]) : TranslatableInterface|string
Parameters
- $pageName : string|null = null
Return values
TranslatableInterface|stringgetHelpMessages()
public
getHelpMessages() : array<string|int, mixed>
Return values
array<string|int, mixed>getNewFormOptions()
public
getNewFormOptions() : KeyValueStore
Return values
KeyValueStoregetNumberFormat()
public
getNumberFormat() : string|null
Return values
string|nullgetOverriddenTemplates()
public
getOverriddenTemplates() : array<string|int, mixed>
Return values
array<string|int, mixed>getPaginator()
public
getPaginator() : PaginatorDto
Return values
PaginatorDtogetSearchFields()
public
getSearchFields() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetSidebarWidth()
public
getSidebarWidth() : string|null
Return values
string|nullgetTimePattern()
public
getTimePattern() : string|null
Return values
string|nullgetTimezone()
public
getTimezone() : string|null
Return values
string|nullisSearchEnabled()
public
isSearchEnabled() : bool
Return values
booloverrideTemplate()
public
overrideTemplate(string $templateName, string $templatePath) : void
Parameters
- $templateName : string
- $templatePath : string
setActionsConfig()
public
setActionsConfig(ActionConfigDto $actionConfig) : void
Parameters
- $actionConfig : ActionConfigDto
setAutofocusSearch()
public
setAutofocusSearch(bool $autofocusSearch) : void
Parameters
- $autofocusSearch : bool
setContentWidth()
public
setContentWidth(string $contentWidth) : void
Parameters
- $contentWidth : string
setControllerFqcn()
public
setControllerFqcn(string $fqcn) : void
Parameters
- $fqcn : string
setCurrentAction()
public
setCurrentAction(string $actionName) : void
Parameters
- $actionName : string
setCustomPageTitle()
public
setCustomPageTitle(string $pageName, mixed $pageTitle) : void
Parameters
- $pageName : string
- $pageTitle : mixed
setDateIntervalFormat()
public
setDateIntervalFormat(string $format) : void
Parameters
- $format : string
setDatePattern()
public
setDatePattern(string|null $format) : void
Parameters
- $format : string|null
setDateTimePattern()
public
setDateTimePattern(string $dateFormatOrPattern[, string $timeFormat = DateTimeField::FORMAT_NONE ]) : void
Parameters
- $dateFormatOrPattern : string
- $timeFormat : string = DateTimeField::FORMAT_NONE
setDefaultSort()
public
setDefaultSort(array<string|int, mixed> $defaultSort) : void
Parameters
- $defaultSort : array<string|int, mixed>
setEditFormOptions()
public
setEditFormOptions(KeyValueStore $formOptions) : void
Parameters
- $formOptions : KeyValueStore
setEntityFqcn()
public
setEntityFqcn(string $entityFqcn) : void
Parameters
- $entityFqcn : string
setEntityLabelInPlural()
public
setEntityLabelInPlural(TranslatableInterface|string|callable $label) : void
Parameters
- $label : TranslatableInterface|string|callable
setEntityLabelInSingular()
public
setEntityLabelInSingular(TranslatableInterface|string|callable $label) : void
Parameters
- $label : TranslatableInterface|string|callable
setEntityPermission()
public
setEntityPermission(string $entityPermission) : void
Parameters
- $entityPermission : string
setFieldAssets()
public
setFieldAssets(AssetsDto $assets) : void
Parameters
- $assets : AssetsDto
setFiltersConfig()
public
setFiltersConfig(FilterConfigDto $filterConfig) : void
Parameters
- $filterConfig : FilterConfigDto
setFormThemes()
public
setFormThemes(array<string|int, mixed> $formThemes) : void
Parameters
- $formThemes : array<string|int, mixed>
setHelpMessage()
public
setHelpMessage(string $pageName, TranslatableInterface|string $helpMessage) : void
Parameters
- $pageName : string
- $helpMessage : TranslatableInterface|string
setNewFormOptions()
public
setNewFormOptions(KeyValueStore $formOptions) : void
Parameters
- $formOptions : KeyValueStore
setNumberFormat()
public
setNumberFormat(string $numberFormat) : void
Parameters
- $numberFormat : string
setPageName()
public
setPageName(string|null $pageName) : void
Parameters
- $pageName : string|null
setPaginator()
public
setPaginator(PaginatorDto $paginatorDto) : void
Parameters
- $paginatorDto : PaginatorDto
setSearchFields()
public
setSearchFields(array<string|int, mixed>|null $searchFields) : void
Parameters
- $searchFields : array<string|int, mixed>|null
setShowEntityActionsAsDropdown()
public
setShowEntityActionsAsDropdown(bool $showAsDropdown) : void
Parameters
- $showAsDropdown : bool
setSidebarWidth()
public
setSidebarWidth(string $sidebarWidth) : void
Parameters
- $sidebarWidth : string
setTimePattern()
public
setTimePattern(string|null $format) : void
Parameters
- $format : string|null
setTimezone()
public
setTimezone(string $timezoneId) : void
Parameters
- $timezoneId : string
showEntityActionsAsDropdown()
public
showEntityActionsAsDropdown() : bool