*/ class Configuration implements ConfigurationInterface { public function getConfigTreeBuilder() { $treeBuilder = new TreeBuilder('easy_admin'); $rootNode = $this->getRootNode($treeBuilder, 'easy_admin'); $this->addGlobalOptionsSection($rootNode); $this->addUserSection($rootNode); $this->addDesignSection($rootNode); $this->addViewsSection($rootNode); $this->addEntitiesSection($rootNode); return $treeBuilder; } private function addGlobalOptionsSection(ArrayNodeDefinition $rootNode) { $rootNode ->children() ->scalarNode('site_name') ->defaultValue('EasyAdmin') ->info('The name displayed as the title of the administration zone (e.g. company name, project name).') ->end() ->arrayNode('formats') ->addDefaultsIfNotSet() ->children() ->scalarNode('date') ->defaultValue('Y-m-d') ->info('The PHP date format applied to "date" and "date_immutable" field types.') ->example('d/m/Y (see http://php.net/manual/en/function.date.php)') ->end() ->scalarNode('time') ->defaultValue('H:i:s') ->info('The PHP time format applied to "time" and "time_immutable" field types.') ->example('h:i a (see http://php.net/date)') ->end() ->scalarNode('datetime') ->defaultValue('F j, Y H:i') ->info('The PHP date/time format applied to "datetime" and "datetime_immutable" field types.') ->example('l, F jS Y / h:i (see http://php.net/date)') ->end() ->scalarNode('number') ->info('The sprintf-compatible format applied to numeric values.') ->example('%.2d (see http://php.net/sprintf)') ->end() ->scalarNode('dateinterval') ->defaultValue('%%y Year(s) %%m Month(s) %%d Day(s)') ->info('The PHP dateinterval-compatible format applied to "dateinterval" field types.') ->example('%%y Year(s) %%m Month(s) %%d Day(s) (see http://php.net/manual/en/dateinterval.format.php)') ->end() ->end() ->end() ->variableNode('disabled_actions') ->info('The names of the actions disabled for all backend entities.') ->defaultValue([]) ->validate() ->ifTrue(function ($v) { return false === \is_array($v); }) ->thenInvalid('The disabled_actions option must be an array of action names.') ->end() ->end() ->scalarNode('translation_domain') ->validate() ->ifTrue(function ($v) { return '' === $v; }) ->thenInvalid('The translation_domain option cannot be an empty string (use false to disable translations).') ->end() ->defaultValue('messages') ->info('The translation domain used to translate the main menu and the labels, titles and help messages of all entities.') ->end() ->end() ; } private function addUserSection(ArrayNodeDefinition $rootNode) { $rootNode ->children() ->arrayNode('user') ->addDefaultsIfNotSet() ->children() ->booleanNode('display_name') ->defaultTrue() ->info('If true, the user name is displayed in the logged user section.') ->end() ->booleanNode('display_avatar') ->defaultTrue() ->info('If true, the user avatar image is displayed in the logged user section.') ->end() ->scalarNode('name_property_path') ->defaultValue('__toString') ->info('A valid PropertyPath expression used to get the value of the user name (by default, __toString() is used).') ->end() ->scalarNode('avatar_property_path') ->defaultNull() ->info('A valid PropertyPath expression used to get the value of the avatar image path which is used as the "src" attribute of the element.') ->end() ->end() ->end() ->end() ; } private function addDesignSection(ArrayNodeDefinition $rootNode) { $rootNode ->children() ->arrayNode('design') ->addDefaultsIfNotSet() ->children() ->booleanNode('rtl') ->info('If true, the interface uses RTL (right-to-left) writing (needed for Arabic, Hebrew and Persian).') ->end() ->scalarNode('brand_color') ->info('The color used in the backend design to highlight important elements.') ->defaultValue('hsl(230, 55%%, 60%%)') ->treatNullLike('hsl(230, 55%%, 60%%)') ->validate() // if present, remove the trailing ';' to avoid CSS issues ->ifTrue(function ($v) { return ';' === trim($v)[-1]; }) ->then(function ($v) { return trim(mb_substr(trim($v), 0, -1)); }) ->end() ->end() ->variableNode('form_theme') ->defaultValue(['@EasyAdmin/form/bootstrap_4.html.twig']) ->treatNullLike(['@EasyAdmin/form/bootstrap_4.html.twig']) ->info('The form theme applied to backend forms. Allowed values: any valid form theme path or an array of theme paths.') ->validate()->castToArray()->end() ->end() ->arrayNode('assets') ->addDefaultsIfNotSet() ->children() ->arrayNode('css') ->prototype('scalar')->end() ->info('The array of CSS assets to load in all backend pages.') ->end() ->arrayNode('js') ->prototype('scalar')->end() ->info('The array of JavaScript assets to load in all backend pages.') ->end() ->arrayNode('favicon') ->addDefaultsIfNotSet() ->info('The favicon to use in all backend pages.') ->children() ->scalarNode('path')->cannotBeEmpty()->defaultValue('favicon.ico')->end() ->scalarNode('mime_type')->defaultValue('image/x-icon')->end() ->end() ->beforeNormalization() ->always(function ($v) { if (\is_string($v)) { $v = ['path' => $v]; } $mimeTypes = [ 'ico' => 'image/x-icon', 'png' => 'image/png', 'gif' => 'image/gif', 'jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg', ]; if (!isset($v['mime_type']) && isset($mimeTypes[$ext = pathinfo($v['path'], PATHINFO_EXTENSION)])) { $v['mime_type'] = $mimeTypes[$ext]; } elseif (!isset($v['mime_type'])) { $v['mime_type'] = null; } return $v; }) ->end() ->validate() ->ifTrue(function ($v) { return empty($v['mime_type']); }) ->thenInvalid('The "mime_type" key is required as we were unable to guess it from the favicon extension.') ->end() ->end() ->end() ->end() ->arrayNode('templates') ->info('The custom templates used to render each backend element.') ->children() ->scalarNode('layout')->info('Used to decorate the main templates (list, edit, new and show)')->end() ->scalarNode('menu')->info('Used to render the main menu')->end() ->scalarNode('edit')->info('Used to render the page where entities are edited')->end() ->scalarNode('list')->info('Used to render the listing page and the search results page')->end() ->scalarNode('new')->info('Used to render the page where new entities are created')->end() ->scalarNode('show')->info('Used to render the contents stored by a given entity')->end() ->scalarNode('action')->info('Used to render an action for a given entity')->end() ->scalarNode('exception')->info('Used to render the error page when some exception happens')->end() ->scalarNode('flash_messages')->info('Used to render the notification area were flash messages are displayed')->end() ->scalarNode('paginator')->info('Used to render the paginator in the list page')->end() ->scalarNode('field_array')->info('Used to render array field types')->end() ->scalarNode('field_association')->info('Used to render fields that store Doctrine associations')->end() ->scalarNode('field_avatar')->info('Used to render fields related to user avatar images')->end() ->scalarNode('field_bigint')->info('Used to render bigint field types')->end() ->scalarNode('field_boolean')->info('Used to render boolean field types')->end() ->scalarNode('field_country')->info('Used to render the country names and/or flags')->end() ->scalarNode('field_date')->info('Used to render date and date_immutable field types')->end() ->scalarNode('field_datetime')->info('Used to render datetime and datetime_immutable field types')->end() ->scalarNode('field_datetimetz')->info('Used to render datetimetz field types')->end() ->scalarNode('field_decimal')->info('Used to render decimal field types')->end() ->scalarNode('field_email')->info('Used to render clickable email addresses')->end() ->scalarNode('field_float')->info('Used to render float field types')->end() ->scalarNode('field_id')->info('Used to render the field called "id". This avoids formatting its value as any other regular number (with decimals and thousand separators) ')->end() ->scalarNode('field_image')->info('Used to render image field types (a special type that displays the image contents)')->end() ->scalarNode('field_integer')->info('Used to render integer field types')->end() ->scalarNode('field_raw')->info('Used to render unescaped values')->end() ->scalarNode('field_simple_array')->info('Used to render simple array field types')->end() ->scalarNode('field_smallint')->info('Used to render smallint field types')->end() ->scalarNode('field_string')->info('Used to render string field types')->end() ->scalarNode('field_tel')->info('Used to render clickable telephone number')->end() ->scalarNode('field_text')->info('Used to render text field types')->end() ->scalarNode('field_time')->info('Used to render time and time_immutable field types')->end() ->scalarNode('field_toggle')->info('Used to render toggle field types (a special type that display booleans as flip switches)')->end() ->scalarNode('field_url')->info('Used to render clickable URLs')->end() ->scalarNode('label_empty')->info('Used when the field to render is an empty collection')->end() ->scalarNode('label_inaccessible')->info('Used when is not possible to access the value of the field to render (there is no getter or public property)')->end() ->scalarNode('label_null')->info('Used when the value of the field to render is null')->end() ->scalarNode('label_undefined')->info('Used when any kind of error or exception happens when trying to access the value of the field to render')->end() ->end() ->end() ->arrayNode('menu') ->normalizeKeys(false) ->defaultValue([]) ->info('The items to display in the main menu.') ->prototype('variable') ->end() ->end() ->end() ->end() ; } private function addViewsSection(ArrayNodeDefinition $rootNode) { $rootNode ->children() ->arrayNode('list') ->addDefaultsIfNotSet() ->children() ->scalarNode('title') ->info('The visible page title displayed in the list view.') ->end() ->arrayNode('actions') ->prototype('variable')->end() ->info('The list of actions enabled in the "list" view.') ->end() ->booleanNode('collapse_actions') ->defaultValue(false) ->info('If true, collapse the list of actions enabled in the "list" view.') ->end() ->arrayNode('batch_actions') ->prototype('variable')->end() ->info('The list of batch actions enabled in the "list" view.') ->end() ->integerNode('max_results') ->defaultValue(15) ->info('The maximum number of items to show on listing and search pages.') ->end() ->scalarNode('item_permission') ->defaultNull() ->info('The permission or array of permissions that the user must have to see the list items') ->end() ->end() ->end() ->arrayNode('search') ->addDefaultsIfNotSet() ->children() ->scalarNode('title') ->info('The visible page title displayed in the search view.') ->end() ->end() ->end() ->arrayNode('edit') ->addDefaultsIfNotSet() ->children() ->scalarNode('title') ->info('The visible page title displayed in the edit view.') ->end() ->arrayNode('actions') ->prototype('variable')->end() ->info('The list of actions enabled in the "edit" view.') ->end() ->scalarNode('item_permission') ->defaultNull() ->info('The permission or array of permissions that the user must have to edit the item') ->end() ->end() ->end() ->arrayNode('new') ->addDefaultsIfNotSet() ->children() ->scalarNode('title') ->info('The visible page title displayed in the new view.') ->end() ->arrayNode('actions') ->prototype('variable')->end() ->info('The list of actions enabled in the "new" view.') ->end() ->scalarNode('item_permission') ->defaultNull() ->info('The permission or array of permissions that the user must have to create new items') ->end() ->end() ->end() ->arrayNode('show') ->addDefaultsIfNotSet() ->children() ->scalarNode('title') ->info('The visible page title displayed in the show view.') ->end() ->arrayNode('actions') ->prototype('variable')->end() ->info('The list of actions enabled in the "show" view.') ->end() ->integerNode('max_results') ->defaultValue(10) ->info('The maximum number of items displayed for related fields in the show page and for autocomplete fields in the new/edit pages.') ->end() ->scalarNode('item_permission') ->defaultNull() ->info('The permission or array of permissions that the user must have to see the item') ->end() ->end() ->end() ->end() ; } private function addEntitiesSection(ArrayNodeDefinition $rootNode) { $rootNode ->children() ->arrayNode('entities') ->normalizeKeys(false) ->useAttributeAsKey('name', false) ->defaultValue([]) ->info('The list of entities to manage in the administration zone.') ->prototype('variable') ->end() ->end() ; } private function getRootNode(TreeBuilder $treeBuilder, $name) { // BC layer for symfony/config 4.1 and older if (!method_exists($treeBuilder, 'getRootNode')) { return $treeBuilder->root($name); } return $treeBuilder->getRootNode(); } }