murph-doc/crud/configuration/index.html
2024-03-31 15:19:55 +00:00

2685 lines
73 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://doc.murph-project.org/crud/configuration/">
<link rel="prev" href="../generator/">
<link rel="next" href="../../settings/global/">
<link rel="icon" href="../../_static/img/logo.svg">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.16">
<title>Configuration - Documentation of Murph</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../_static/css/extra.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="Configuration - Documentation of Murph" >
<meta property="og:description" content="None" >
<meta property="og:image" content="https://doc.murph-project.org/assets/images/social/crud/configuration.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://doc.murph-project.org/crud/configuration/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Configuration - Documentation of Murph" >
<meta name="twitter:description" content="None" >
<meta name="twitter:image" content="https://doc.murph-project.org/assets/images/social/crud/configuration.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="light-blue" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#configuration" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Documentation of Murph" class="md-header__button md-logo" aria-label="Documentation of Murph" data-md-component="logo">
<img src="../../_static/img/logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Documentation of Murph
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Configuration
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="light-blue" data-md-color-accent="indigo" aria-label="Passer en mode sombre" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Passer en mode sombre" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Passer en mode clair" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Passer en mode clair" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Overview
</a>
</li>
<li class="md-tabs__item">
<a href="../../requirements/" class="md-tabs__link">
Installation
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../tree/" class="md-tabs__link">
Documentation
</a>
</li>
<li class="md-tabs__item">
<a href="../../changelog/core/" class="md-tabs__link">
Changelog
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Documentation of Murph" class="md-nav__button md-logo" aria-label="Documentation of Murph" data-md-component="logo">
<img src="../../_static/img/logo.svg" alt="logo">
</a>
Documentation of Murph
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Overview
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../sources/" class="md-nav__link">
<span class="md-ellipsis">
Source codes
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../requirements/" class="md-nav__link">
<span class="md-ellipsis">
Requirements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../procedure/" class="md-nav__link">
<span class="md-ellipsis">
Procedure
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Documentation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_1" >
<label class="md-nav__link" for="__nav_3_1" id="__nav_3_1_label" tabindex="0">
<span class="md-ellipsis">
Tree manager
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_1">
<span class="md-nav__icon md-icon"></span>
Tree manager
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../tree/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tree/navigation/" class="md-nav__link">
<span class="md-ellipsis">
Navigation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tree/menu/" class="md-nav__link">
<span class="md-ellipsis">
Menu
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tree/node/" class="md-nav__link">
<span class="md-ellipsis">
Node
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tree/page/" class="md-nav__link">
<span class="md-ellipsis">
Page
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../controller/" class="md-nav__link">
<span class="md-ellipsis">
Controller
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../template/" class="md-nav__link">
<span class="md-ellipsis">
Template
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" >
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
<span class="md-ellipsis">
Entities
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Entities
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../entities/em/" class="md-nav__link">
<span class="md-ellipsis">
Entity Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../entities/query/" class="md-nav__link">
<span class="md-ellipsis">
Repository Query
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../entities/factory/" class="md-nav__link">
<span class="md-ellipsis">
Factory
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5" checked>
<label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
<span class="md-ellipsis">
CRUD
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3_5">
<span class="md-nav__icon md-icon"></span>
CRUD
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../generator/" class="md-nav__link">
<span class="md-ellipsis">
Generator
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Configuration
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Configuration
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#setpagetitle" class="md-nav__link">
<span class="md-ellipsis">
setPageTitle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setpageroute" class="md-nav__link">
<span class="md-ellipsis">
setPageRoute
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setform" class="md-nav__link">
<span class="md-ellipsis">
setForm
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setformoptions" class="md-nav__link">
<span class="md-ellipsis">
setFormOptions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setaction" class="md-nav__link">
<span class="md-ellipsis">
setAction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setactiontitle" class="md-nav__link">
<span class="md-ellipsis">
setActionTitle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setview" class="md-nav__link">
<span class="md-ellipsis">
setView
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setviewdatas" class="md-nav__link">
<span class="md-ellipsis">
setViewDatas
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setfield" class="md-nav__link">
<span class="md-ellipsis">
setField
</span>
</a>
<nav class="md-nav" aria-label="setField">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#textfield" class="md-nav__link">
<span class="md-ellipsis">
TextField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#datefield" class="md-nav__link">
<span class="md-ellipsis">
DateField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#datetimefield" class="md-nav__link">
<span class="md-ellipsis">
DatetimeField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#buttonfield" class="md-nav__link">
<span class="md-ellipsis">
ButtonField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#imagefield" class="md-nav__link">
<span class="md-ellipsis">
ImageField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#booleanfield" class="md-nav__link">
<span class="md-ellipsis">
BooleanField
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setmaxperpage" class="md-nav__link">
<span class="md-ellipsis">
setMaxPerPage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#seti18n" class="md-nav__link">
<span class="md-ellipsis">
setI18n
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setdefaultsort" class="md-nav__link">
<span class="md-ellipsis">
setDefaultSort
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setissortablecollection" class="md-nav__link">
<span class="md-ellipsis">
setIsSortableCollection
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setsortablecollectionproperty" class="md-nav__link">
<span class="md-ellipsis">
setSortableCollectionProperty
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setbatchaction" class="md-nav__link">
<span class="md-ellipsis">
setBatchAction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setglobalbatchaction" class="md-nav__link">
<span class="md-ellipsis">
setGlobalBatchAction
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
<label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
<span class="md-ellipsis">
Settings
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_6">
<span class="md-nav__icon md-icon"></span>
Settings
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../settings/global/" class="md-nav__link">
<span class="md-ellipsis">
Global settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../settings/navigation/" class="md-nav__link">
<span class="md-ellipsis">
Navigation settings
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_7" >
<label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
<span class="md-ellipsis">
Form
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_7">
<span class="md-nav__icon md-icon"></span>
Form
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../utils/form/file_picker/" class="md-nav__link">
<span class="md-ellipsis">
Picker picker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/form/collection/" class="md-nav__link">
<span class="md-ellipsis">
Collection
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_7_3" >
<label class="md-nav__link" for="__nav_3_7_3" id="__nav_3_7_3_label" tabindex="0">
<span class="md-ellipsis">
Editors
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_7_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_7_3">
<span class="md-nav__icon md-icon"></span>
Editors
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../utils/editors/tinymce/" class="md-nav__link">
<span class="md-ellipsis">
TinyMCE
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/editors/grapesjs/" class="md-nav__link">
<span class="md-ellipsis">
GrapesJS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/editors/editorjs/" class="md-nav__link">
<span class="md-ellipsis">
Editor.js
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_8" >
<label class="md-nav__link" for="__nav_3_8" id="__nav_3_8_label" tabindex="0">
<span class="md-ellipsis">
Utils
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_8">
<span class="md-nav__icon md-icon"></span>
Utils
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../utils/cache/" class="md-nav__link">
<span class="md-ellipsis">
Cache Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/doctrine/" class="md-nav__link">
<span class="md-ellipsis">
Doctrine
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/file_handler/" class="md-nav__link">
<span class="md-ellipsis">
File upload handler
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/file_attribute/" class="md-nav__link">
<span class="md-ellipsis">
File attribute
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/mail/" class="md-nav__link">
<span class="md-ellipsis">
Mail notifier
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utils/slug/" class="md-nav__link">
<span class="md-ellipsis">
Slug
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../abtesting/" class="md-nav__link">
<span class="md-ellipsis">
A/B Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../users/" class="md-nav__link">
<span class="md-ellipsis">
Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../tasks/" class="md-nav__link">
<span class="md-ellipsis">
Tasks
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Changelog
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Changelog
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../changelog/core/" class="md-nav__link">
<span class="md-ellipsis">
murph/murph-core
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../changelog/skeleton/" class="md-nav__link">
<span class="md-ellipsis">
murph/murph-skeleton
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#setpagetitle" class="md-nav__link">
<span class="md-ellipsis">
setPageTitle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setpageroute" class="md-nav__link">
<span class="md-ellipsis">
setPageRoute
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setform" class="md-nav__link">
<span class="md-ellipsis">
setForm
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setformoptions" class="md-nav__link">
<span class="md-ellipsis">
setFormOptions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setaction" class="md-nav__link">
<span class="md-ellipsis">
setAction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setactiontitle" class="md-nav__link">
<span class="md-ellipsis">
setActionTitle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setview" class="md-nav__link">
<span class="md-ellipsis">
setView
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setviewdatas" class="md-nav__link">
<span class="md-ellipsis">
setViewDatas
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setfield" class="md-nav__link">
<span class="md-ellipsis">
setField
</span>
</a>
<nav class="md-nav" aria-label="setField">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#textfield" class="md-nav__link">
<span class="md-ellipsis">
TextField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#datefield" class="md-nav__link">
<span class="md-ellipsis">
DateField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#datetimefield" class="md-nav__link">
<span class="md-ellipsis">
DatetimeField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#buttonfield" class="md-nav__link">
<span class="md-ellipsis">
ButtonField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#imagefield" class="md-nav__link">
<span class="md-ellipsis">
ImageField
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#booleanfield" class="md-nav__link">
<span class="md-ellipsis">
BooleanField
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#setmaxperpage" class="md-nav__link">
<span class="md-ellipsis">
setMaxPerPage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#seti18n" class="md-nav__link">
<span class="md-ellipsis">
setI18n
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setdefaultsort" class="md-nav__link">
<span class="md-ellipsis">
setDefaultSort
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setissortablecollection" class="md-nav__link">
<span class="md-ellipsis">
setIsSortableCollection
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setsortablecollectionproperty" class="md-nav__link">
<span class="md-ellipsis">
setSortableCollectionProperty
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setbatchaction" class="md-nav__link">
<span class="md-ellipsis">
setBatchAction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#setglobalbatchaction" class="md-nav__link">
<span class="md-ellipsis">
setGlobalBatchAction
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="configuration">Configuration</h1>
<p>A generated crud controller contains a method named <code>getConfiguration</code>. This methods returns a instance of <code>App\Core\Crud\CrudConfiguration</code>.</p>
<h2 id="setpagetitle">setPageTitle</h2>
<p><code>setPageTitle(string $page, string $title)</code></p>
<p>Set the title of the given page.</p>
<p>Example of usage in a CRUD template: <code>&lt;title&gt;{{ configuration.pageTitle('index') }}&lt;/title&gt;</code>.</p>
<h2 id="setpageroute">setPageRoute</h2>
<p><code>setPageRoute(string $page, string $route)</code></p>
<p>Set the route of the given page. By default, pages are: <code>index</code>, <code>edit</code>, <code>new</code>, <code>show</code>. You can create a custom page for a custom controller.</p>
<p>Example of usage in a CRUD template: <code>&lt;a href="{{ path(configuration.pageRoute('new')) }}"&gt;...&lt;/a&gt;</code>.</p>
<h2 id="setform">setForm</h2>
<p><code>setForm(string $context, string $form,</code>array<code>$options = [])</code></p>
<p>Set the form used in the given context.</p>
<h2 id="setformoptions">setFormOptions</h2>
<p><code>setFormOptions(string $context,</code>array<code>$options = [])</code></p>
<p>Defines options given to a form.</p>
<h2 id="setaction">setAction</h2>
<p><code>setAction(string $page, string $action, bool|callable $enabled)</code></p>
<p>Set if an action is enabled or not in the given page. Take a look at <code>core/Resources/views/admin/crud/*.html.twig</code> for more information. Depending the context, the callable could receive the entity in parameter. Example:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>-&gt;setAction(&#39;index&#39;, &#39;edit&#39;, function(EntityInterface $entity) {
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> return $entity-&gt;getUser()-&gt;getId() === $this-&gt;getUser()-&gt;getId();
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>})
</code></pre></div>
<p>Usage in a CRUD template: <code>{% if configuration.action('index', 'new')%}...{% endif %}</code>.</p>
<h2 id="setactiontitle">setActionTitle</h2>
<p><code>setActionTitle(string $page, string $action, string $title)</code></p>
<p>Set the title of an action in the given page.</p>
<p>Example of usage in a CRUD template: <code>{{ configuration.actionTitle(context, 'new', 'New')|trans }}</code></p>
<h2 id="setview">setView</h2>
<p><code>setView(string $context, string $view)</code></p>
<p>Override a view.</p>
<table>
<thead>
<tr>
<th>Controller (context)</th>
<th>View</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>index</code></td>
<td><code>@Core/admin/crud/index.html.twig</code></td>
<td>Template of the page <code>index</code></td>
</tr>
<tr>
<td><code>edit</code></td>
<td><code>@Core/admin/crud/edit.html.twig</code></td>
<td>Template of the page <code>edit</code></td>
</tr>
<tr>
<td><code>new</code></td>
<td><code>@Core/admin/crud/new.html.twig</code></td>
<td>Template of the page <code>new</code></td>
</tr>
<tr>
<td><code>show</code></td>
<td><code>@Core/admin/crud/show.html.twig</code></td>
<td>Template of the page <code>show</code></td>
</tr>
<tr>
<td><code>filter</code></td>
<td><code>@Core/admin/crud/filter.html.twig</code></td>
<td>Template of the page <code>filter</code></td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Form (context)</th>
<th>View</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>form</code></td>
<td><code>@Core/admin/crud/_form.html.twig</code></td>
<td>Template to render a form</td>
</tr>
<tr>
<td><code>form_widget</code></td>
<td><code>@Core/admin/crud/_form_widget.html.twig</code></td>
<td>Template to render a form widget</td>
</tr>
<tr>
<td><code>form_translations</code></td>
<td><code>@Core/admin/crud/_form_translations.html.twig</code></td>
<td>Template to render a the translation field</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Entity (context)</th>
<th>View</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>show_entity</code></td>
<td><code>@Core/admin/crud/_show.html.twig</code></td>
<td>Template to render the entity</td>
</tr>
</tbody>
</table>
<h2 id="setviewdatas">setViewDatas</h2>
<p><code>setViewDatas(string $context,</code>array<code>$datas)</code> and <code>addViewData(string $context, string $name, $value)</code></p>
<p>Add datas given to a view. Useful in a custom controller.</p>
<h2 id="setfield">setField</h2>
<p><code>setField(string $context, string $label, string $field,</code>array<code>$options)</code></p>
<p>Add a field displayed in the given context. Used in the index.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>use App\Core\Crud\Field;
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>$configuration-&gt;setField(&#39;index&#39;, &#39;Title&#39;, Field\TextField::class, [
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a> // options
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>])
</code></pre></div>
<p>All fields have these options:</p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>property</code></td>
<td><code>string</code></td>
<td><code>null</code></td>
<td>Entity's property to display</td>
</tr>
<tr>
<td><code>property__builder</code></td>
<td><code>callable</code></td>
<td><code>null</code></td>
<td>A callable data and used to generate the content displayed</td>
</tr>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/text.html.twig</code></td>
<td>The templated rendered</td>
</tr>
<tr>
<td><code>default_value</code></td>
<td><code>string</code></td>
<td><code>null</code></td>
<td>Default value to display when the property is <code>null</code></td>
</tr>
<tr>
<td><code>action</code></td>
<td><code>string</code></td>
<td><code>null</code></td>
<td>An action to perform on click (<code>null</code>, <code>edit</code>, <code>view</code>)</td>
</tr>
<tr>
<td><code>raw</code></td>
<td><code>boolean</code></td>
<td><code>false</code></td>
<td>Render as HTML</td>
</tr>
<tr>
<td><code>sort</code></td>
<td><code>array | callable</code></td>
<td><code>null</code></td>
<td>Defines how to sort</td>
</tr>
<tr>
<td><code>href</code></td>
<td><code>string | callable</code></td>
<td><code>null</code></td>
<td>Data to generate a link</td>
</tr>
<tr>
<td><code>href_attr</code></td>
<td><code>array | callable</code></td>
<td><code>null</code></td>
<td>Attributes of the link</td>
</tr>
<tr>
<td><code>inline_form</code></td>
<td><code>null | callable</code></td>
<td><code>null</code></td>
<td>A method to define a form to edit datas</td>
</tr>
<tr>
<td><code>inline_form_validation</code></td>
<td><code>null | callable</code></td>
<td><code>null</code></td>
<td>A method to define a custom form validation callback</td>
</tr>
</tbody>
</table>
<div class="highlight"><span class="filename">Example #0</span><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="nv">$configuration</span><span class="o">-&gt;</span><span class="na">setField</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">,</span> <span class="s1">&#39;My field&#39;</span><span class="p">,</span> <span class="nx">TextField</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a> <span class="s1">&#39;property&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;myProperty&#39;</span><span class="p">,</span>
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a> <span class="c1">// OR</span>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a> <span class="s1">&#39;property_builder&#39;</span> <span class="o">=&gt;</span> <span class="k">function</span><span class="p">(</span><span class="nv">$entity</span><span class="p">,</span> <span class="k">array</span> <span class="nv">$options</span><span class="p">)</span> <span class="p">{</span>
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a> <span class="k">return</span> <span class="nv">$entity</span><span class="o">-&gt;</span><span class="na">getMyProperty</span><span class="p">();</span>
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a> <span class="p">},</span>
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="p">])</span>
</code></pre></div>
<div class="highlight"><span class="filename">Example #1</span><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nv">$configuration</span><span class="o">-&gt;</span><span class="na">setField</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">,</span> <span class="s1">&#39;My field&#39;</span><span class="p">,</span> <span class="nx">TextField</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> <span class="s1">&#39;raw&#39;</span> <span class="o">=&gt;</span> <span class="k">true</span><span class="p">,</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> <span class="s1">&#39;property_builder&#39;</span> <span class="o">=&gt;</span> <span class="k">function</span><span class="p">(</span><span class="nv">$entity</span><span class="p">,</span> <span class="k">array</span> <span class="nv">$options</span><span class="p">)</span> <span class="p">{</span>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> <span class="k">return</span> <span class="nb">sprintf</span><span class="p">(</span><span class="s1">&#39;&lt;span class=&quot;foo&quot;&gt;%s&lt;/span&gt;&#39;</span><span class="p">,</span> <span class="nv">$entity</span><span class="o">-&gt;</span><span class="na">getBar</span><span class="p">());</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a> <span class="p">},</span>
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="p">])</span>
</code></pre></div>
<div class="highlight"><span class="filename">Example #2</span><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1">// https://127.0.0.7:8000/admin/my_entity?_sort=property&amp;_sort_direction=asc</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nv">$configuration</span><span class="o">-&gt;</span><span class="na">setField</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">,</span> <span class="s1">&#39;My field&#39;</span><span class="p">,</span> <span class="nx">TextField</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a> <span class="s1">&#39;property&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;myProperty&#39;</span>
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a> <span class="s1">&#39;sort&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;property&#39;</span><span class="p">,</span> <span class="s1">&#39;.myProperty&#39;</span><span class="p">],</span>
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a> <span class="c1">// OR</span>
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a> <span class="s1">&#39;sort&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;property&#39;</span><span class="p">,</span> <span class="k">function</span><span class="p">(</span><span class="nx">MyEntityRepositoryQuery</span> <span class="nv">$query</span><span class="p">,</span> <span class="nv">$direction</span><span class="p">)</span> <span class="p">{</span>
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a> <span class="nv">$query</span><span class="o">-&gt;</span><span class="na">orderBy</span><span class="p">(</span><span class="s1">&#39;.myProperty&#39;</span><span class="p">,</span> <span class="nv">$direction</span><span class="p">);</span>
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a> <span class="p">}],</span>
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="p">])</span>
</code></pre></div>
<div class="highlight"><span class="filename">Example #3</span><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="k">use</span> <span class="nx">Symfony\Component\Form\FormBuilderInterface</span><span class="p">;</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="k">use</span> <span class="nx">Symfony\Component\Form\Extension\Core\Type\TextType</span><span class="p">;</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="k">use</span> <span class="nx">Symfony\Component\Validator\Constraints\NotBlank</span><span class="p">;</span>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="nv">$configuration</span><span class="o">-&gt;</span><span class="na">setField</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">,</span> <span class="s1">&#39;My field&#39;</span><span class="p">,</span> <span class="nx">TextField</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a> <span class="s1">&#39;property&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;myProperty&#39;</span><span class="p">,</span>
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a> <span class="s1">&#39;inline_form&#39;</span> <span class="o">=&gt;</span> <span class="k">function</span><span class="p">(</span><span class="nx">FormBuilderInterface</span> <span class="nv">$builder</span><span class="p">,</span> <span class="nx">EntityInterface</span> <span class="nv">$entity</span><span class="p">)</span> <span class="p">{</span>
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a> <span class="nv">$builder</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="s1">&#39;myProperty&#39;</span><span class="p">,</span> <span class="nx">TextType</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a> <span class="s1">&#39;required&#39;</span> <span class="o">=&gt;</span> <span class="k">true</span><span class="p">,</span>
<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a> <span class="s1">&#39;constraints&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="k">new</span> <span class="nx">NotBlank</span><span class="p">()],</span>
<a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a> <span class="p">]);</span>
<a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a> <span class="p">}</span>
<a id="__codelineno-5-13" name="__codelineno-5-13" href="#__codelineno-5-13"></a><span class="p">])</span>
</code></pre></div>
<h3 id="textfield">TextField</h3>
<p><code>App\Core\Crud\Field\TextField</code></p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/text.html.twig</code></td>
<td>The templated rendered</td>
</tr>
</tbody>
</table>
<h3 id="datefield">DateField</h3>
<p><code>App\Core\Crud\Field\DateField</code></p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/date.html.twig</code></td>
<td>The templated rendered</td>
</tr>
<tr>
<td><code>format</code></td>
<td><code>string</code></td>
<td><code>Y-m-d</code></td>
<td>The date format</td>
</tr>
</tbody>
</table>
<h3 id="datetimefield">DatetimeField</h3>
<p><code>App\Core\Crud\Field\DatetimeField</code></p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/date.html.twig</code></td>
<td>The templated rendered</td>
</tr>
<tr>
<td><code>format</code></td>
<td><code>string</code></td>
<td><code>Y-m-d H:i:s</code></td>
<td>The date format</td>
</tr>
</tbody>
</table>
<h3 id="buttonfield">ButtonField</h3>
<p><code>App\Core\Crud\Field\ButtonField</code></p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/button.html.twig</code></td>
<td>The templated rendered</td>
</tr>
<tr>
<td><code>button_attr</code></td>
<td><code>array</code></td>
<td><code>[]</code></td>
<td>Button HTML attributes</td>
</tr>
<tr>
<td><code>button_attr_builder</code></td>
<td><code>callabled</code></td>
<td><code>null</code></td>
<td>A callable data and used to generate <code>button__attr</code></td>
</tr>
<tr>
<td><code>button_tag</code></td>
<td><code>string</code></td>
<td><code>button</code></td>
<td>HTML tag of the button</td>
</tr>
</tbody>
</table>
<h3 id="imagefield">ImageField</h3>
<p><code>App\Core\Crud\Field\ImageField</code></p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/image.html.twig</code></td>
<td>The templated rendered</td>
</tr>
<tr>
<td><code>image_attr</code></td>
<td><code>array</code></td>
<td><code>[]</code></td>
<td>Image HTML attributes</td>
</tr>
</tbody>
</table>
<h3 id="booleanfield">BooleanField</h3>
<p><code>App\Core\Crud\Field\BooleanField</code></p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>view</code></td>
<td><code>string</code></td>
<td><code>@Core/admin/crud/field/boolean.html.twig</code></td>
<td>The templated rendered</td>
</tr>
<tr>
<td><code>display</code></td>
<td><code>string</code></td>
<td><code>toggle</code></td>
<td>Type of render (<code>toggle</code> or <code>checkbox</code>)</td>
</tr>
<tr>
<td><code>checkbox_class_when_true</code></td>
<td><code>string</code></td>
<td><code>fa-check-square</code></td>
<td>HTML class added when the value is <code>true</code> and display is <code>checkbox</code></td>
</tr>
<tr>
<td><code>checkbox_class_when_false</code></td>
<td><code>string</code></td>
<td><code>fa-square</code></td>
<td>HTML class added when the value is <code>false</code> and display is <code>checkbox</code></td>
</tr>
<tr>
<td><code>toggle_class_when_true</code></td>
<td><code>string</code></td>
<td><code>bg-success</code></td>
<td>HTML class added when the value is <code>true</code> and display is <code>toggle</code></td>
</tr>
<tr>
<td><code>toggle_class_when_false</code></td>
<td><code>string</code></td>
<td><code>bg-secondary</code></td>
<td>HTML class added when the value is <code>false</code> and display is <code>toggle</code></td>
</tr>
</tbody>
</table>
<h2 id="setmaxperpage">setMaxPerPage</h2>
<p><code>setMaxPerPage(string $page, int $max)</code></p>
<p>Set how many elements are displayed in a single page.</p>
<h2 id="seti18n">setI18n</h2>
<p><code>setI18n(array $locales, string $defaultLocale)</code></p>
<p>Set an array of locales for a translatable entity. The default locale is used in the index page.
Compatible with <a href="https://github.com/KnpLabs/DoctrineBehaviors/blob/master/docs/translatable.md">https://github.com/KnpLabs/DoctrineBehaviors/blob/master/docs/translatable.md</a>.</p>
<h2 id="setdefaultsort">setDefaultSort</h2>
<p><code>setDefaultSort(string $context, string $label, string $direction = 'asc')</code></p>
<p>Set the default sort applied in the repository query.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="nv">$configuration</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a> <span class="o">-&gt;</span><span class="na">setDefaultSort</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">,</span> <span class="s1">&#39;title&#39;</span><span class="p">,</span> <span class="s1">&#39;asc&#39;</span><span class="p">)</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a> <span class="o">-&gt;</span><span class="na">setField</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">,</span> <span class="s1">&#39;Title&#39;</span><span class="p">,</span> <span class="nx">Field\TextField</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a> <span class="s1">&#39;property&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;title&#39;</span><span class="p">,</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a> <span class="s1">&#39;sort&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;title&#39;</span><span class="p">,</span> <span class="s1">&#39;.title&#39;</span><span class="p">],</span>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a> <span class="p">]);</span>
</code></pre></div>
<h2 id="setissortablecollection">setIsSortableCollection</h2>
<p><code>setIsSortableCollection(string $page, bool $isSortableCollection)</code></p>
<p>It enables the drag &amp; drop to sort entities.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="k">class</span> <span class="nc">MyEntity</span> <span class="k">implements</span> <span class="nx">EntityInterface</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="p">{</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a> <span class="c1">// ...</span>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a> <span class="sd">/**</span>
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="sd"> * @ORM\Column(type=&quot;integer&quot;, nullable=true)</span>
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="sd"> */</span>
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a> <span class="k">private</span> <span class="nv">$sortOrder</span><span class="p">;</span>
<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a>
<a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a> <span class="k">public</span> <span class="k">function</span> <span class="nf">getSortOrder</span><span class="p">()</span><span class="o">:</span> <span class="o">?</span><span class="nx">int</span>
<a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a> <span class="p">{</span>
<a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a> <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">sortOrder</span><span class="p">;</span>
<a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a> <span class="p">}</span>
<a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a>
<a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a> <span class="k">public</span> <span class="k">function</span> <span class="nf">setSortOrder</span><span class="p">(</span><span class="o">?</span><span class="nx">int</span> <span class="nv">$sortOrder</span><span class="p">)</span><span class="o">:</span> <span class="nx">self</span>
<a id="__codelineno-7-16" name="__codelineno-7-16" href="#__codelineno-7-16"></a> <span class="p">{</span>
<a id="__codelineno-7-17" name="__codelineno-7-17" href="#__codelineno-7-17"></a> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">sortOrder</span> <span class="o">=</span> <span class="nv">$sortOrder</span><span class="p">;</span>
<a id="__codelineno-7-18" name="__codelineno-7-18" href="#__codelineno-7-18"></a>
<a id="__codelineno-7-19" name="__codelineno-7-19" href="#__codelineno-7-19"></a> <span class="k">return</span> <span class="nv">$this</span><span class="p">;</span>
<a id="__codelineno-7-20" name="__codelineno-7-20" href="#__codelineno-7-20"></a> <span class="p">}</span>
<a id="__codelineno-7-21" name="__codelineno-7-21" href="#__codelineno-7-21"></a>
<a id="__codelineno-7-22" name="__codelineno-7-22" href="#__codelineno-7-22"></a> <span class="c1">// ...</span>
<a id="__codelineno-7-23" name="__codelineno-7-23" href="#__codelineno-7-23"></a><span class="p">}</span>
</code></pre></div>
<h2 id="setsortablecollectionproperty">setSortableCollectionProperty</h2>
<p><code>setSortableCollectionProperty(string $sortableCollectionProperty)</code></p>
<p>In order to sort entities, the default property used is <code>sortOrder</code>. You can set something else.</p>
<h2 id="setbatchaction">setBatchAction</h2>
<p><code>setBatchAction(string $context, string $action, string $label, callable $callack)</code></p>
<p>Add a batch action. The callback has 2 arguments:</p>
<ul>
<li>An instance of <code>App\Core\Entity\EntityInterface</code></li>
<li>An instance of <code>App\Core\Manager\EntityManager</code></li>
</ul>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="k">use</span> <span class="nx">App\Core\Entity\EntityInterface</span><span class="p">;</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="k">use</span> <span class="nx">App\Core\Manager\EntityManager</span><span class="p">;</span>
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="nv">$configuration</span><span class="o">-&gt;</span><span class="na">setBatchAction</span><span class="p">(</span>
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a> <span class="s1">&#39;index&#39;</span><span class="p">,</span>
<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a> <span class="s1">&#39;delete&#39;</span><span class="p">,</span>
<a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a> <span class="s1">&#39;Delete&#39;</span><span class="p">,</span>
<a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a> <span class="k">function</span><span class="p">(</span><span class="nx">EntityInterface</span> <span class="nv">$entity</span><span class="p">,</span> <span class="nx">EntityManager</span> <span class="nv">$manager</span><span class="p">)</span> <span class="p">{</span>
<a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a> <span class="nv">$manager</span><span class="o">-&gt;</span><span class="na">delete</span><span class="p">(</span><span class="nv">$entity</span><span class="p">);</span>
<a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a> <span class="p">}</span>
<a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a><span class="p">);</span>
</code></pre></div>
<h2 id="setglobalbatchaction">setGlobalBatchAction</h2>
<p><code>setGlobalBatchAction(string $context, string $action, string $label, callable $callack)</code></p>
<p>Add a global batch action. The callback has 3 arguments:</p>
<ul>
<li>An instance of <code>App\Core\Repository\RepositoryQuery</code></li>
<li>An instance of <code>App\Core\Manager\EntityManager</code></li>
<li>An array of selected entities or a <code>null</code> value</li>
</ul>
<p>Do not use the same action in global and classic batch action.</p>
<p>The callback can return a response. If not, the user will be redirect automatically. See the example below:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="k">use</span> <span class="nx">App\Core\Entity\RepositoryQuery</span><span class="p">;</span>
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="k">use</span> <span class="nx">App\Core\Manager\EntityManager</span><span class="p">;</span>
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="k">use</span> <span class="nx">Symfony\Component\HttpFoundation\JsonResponse</span><span class="p">;</span>
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a>
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="nv">$configuration</span><span class="o">-&gt;</span><span class="na">setGlobalBatchAction</span><span class="p">(</span>
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a> <span class="s1">&#39;index&#39;</span><span class="p">,</span>
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a> <span class="s1">&#39;export_json&#39;</span><span class="p">,</span>
<a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a> <span class="s1">&#39;Export to JSON&#39;</span><span class="p">,</span>
<a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a> <span class="k">function</span><span class="p">(</span><span class="nx">RepositoryQuery</span> <span class="nv">$query</span><span class="p">,</span> <span class="nx">EntityManager</span> <span class="nv">$manager</span><span class="p">,</span> <span class="o">?</span><span class="k">array</span> <span class="nv">$selection</span><span class="p">)</span><span class="o">:</span> <span class="nx">JsonResponse</span> <span class="p">{</span>
<a id="__codelineno-9-10" name="__codelineno-9-10" href="#__codelineno-9-10"></a> <span class="nv">$items</span> <span class="o">=</span> <span class="nv">$selection</span> <span class="o">??</span> <span class="nv">$query</span><span class="o">-&gt;</span><span class="na">find</span><span class="p">();</span>
<a id="__codelineno-9-11" name="__codelineno-9-11" href="#__codelineno-9-11"></a>
<a id="__codelineno-9-12" name="__codelineno-9-12" href="#__codelineno-9-12"></a> <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">json</span><span class="p">(</span><span class="nv">$items</span><span class="p">);</span>
<a id="__codelineno-9-13" name="__codelineno-9-13" href="#__codelineno-9-13"></a> <span class="p">}</span>
<a id="__codelineno-9-14" name="__codelineno-9-14" href="#__codelineno-9-14"></a><span class="p">);</span>
</code></pre></div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../generator/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Generator">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Generator
</div>
</div>
</a>
<a href="../../settings/global/" class="md-footer__link md-footer__link--next" aria-label="Next: Global settings">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Global settings
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.tabs", "navigation.footer"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.bd41221c.min.js"></script>
</body>
</html>