vendor/easycorp/easyadmin-bundle/src/DependencyInjection/Configuration.php line 316

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the EasyAdminBundle.
  5.  *
  6.  * (c) Javier Eguiluz <javier.eguiluz@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace EasyCorp\Bundle\EasyAdminBundle\DependencyInjection;
  14. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  15. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  16. use Symfony\Component\Config\Definition\ConfigurationInterface;
  18. /**
  19.  * Defines the configuration options of the bundle and validates its values.
  20.  *
  21.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  22.  */
  23. class Configuration implements ConfigurationInterface
  24. {
  25.     public function getConfigTreeBuilder()
  26.     {
  27.         $treeBuilder = new TreeBuilder('easy_admin');
  28.         $rootNode = $this->getRootNode($treeBuilder, 'easy_admin');
  30.         $this->addDeprecationsSection($rootNode);
  31.         $this->addGlobalOptionsSection($rootNode);
  32.         $this->addDesignSection($rootNode);
  33.         $this->addViewsSection($rootNode);
  34.         $this->addEntitiesSection($rootNode);
  36.         return $treeBuilder;
  37.     }
  39.     private function addDeprecationsSection(ArrayNodeDefinition $rootNode)
  40.     {
  41.         $rootNode
  42.             // 'list_max_results' global option was deprecated in 1.0.8
  43.             // and replaced by 'list -> max_results'
  44.             ->beforeNormalization()
  45.                 ->ifTrue(function ($v) {
  46.                     return isset($v['list_max_results']);
  47.                 })
  48.                 ->then(function ($v) {
  49.                     if (!isset($v['list'])) {
  50.                         $v['list'] = array();
  51.                     }
  53.                     // if the new option is defined, don't override it with the legacy option
  54.                     if (!isset($v['list']['max_results'])) {
  55.                         $v['list']['max_results'] = $v['list_max_results'];
  56.                     }
  58.                     unset($v['list_max_results']);
  60.                     return $v;
  61.                 })
  62.             ->end()
  64.             // 'list_actions' global option was deprecated in 1.0.8
  65.             // and replaced by 'list -> actions'
  66.             ->beforeNormalization()
  67.                 ->ifTrue(function ($v) {
  68.                     return isset($v['list_actions']);
  69.                 })
  70.                 ->then(function ($v) {
  71.                     // if the new option is defined, don't override it with the legacy option
  72.                     if (!isset($v['list']['actions'])) {
  73.                         $v['list']['actions'] = $v['list_actions'];
  74.                     }
  76.                     unset($v['list_actions']);
  78.                     return $v;
  79.                 })
  80.             ->end()
  82.             // make sure the new 'design' global option exists to simplify
  83.             // updating the deprecated 'assets -> css' and 'assets -> js' options
  84.             ->beforeNormalization()
  85.                 ->always()
  86.                 ->then(function ($v) {
  87.                     if (!isset($v['design'])) {
  88.                         $v['design'] = array('assets' => array());
  89.                     }
  91.                     return $v;
  92.                 })
  93.             ->end()
  95.             // 'assets -> css' global option was deprecated in 1.1.0
  96.             // and replaced by 'design -> assets -> css'
  97.             ->beforeNormalization()
  98.                 ->ifTrue(function ($v) {
  99.                     return isset($v['assets']['css']);
  100.                 })
  101.                 ->then(function ($v) {
  102.                     // if the new option is defined, don't override it with the legacy option
  103.                     if (!isset($v['design']['assets']['css'])) {
  104.                         $v['design']['assets']['css'] = $v['assets']['css'];
  105.                     }
  107.                     unset($v['assets']['css']);
  109.                     return $v;
  110.                 })
  111.             ->end()
  113.             // 'assets -> js' global option was deprecated in 1.1.0
  114.             // and replaced by 'design -> assets -> js'
  115.             ->beforeNormalization()
  116.                 ->ifTrue(function ($v) {
  117.                     return isset($v['assets']['js']);
  118.                 })
  119.                 ->then(function ($v) {
  120.                     // if the new option is defined, don't override it with the legacy option
  121.                     if (!isset($v['design']['assets']['js'])) {
  122.                         $v['design']['assets']['js'] = $v['assets']['js'];
  123.                     }
  125.                     unset($v['assets']['js']);
  127.                     return $v;
  128.                 })
  129.             ->end()
  131.             // after updating 'assets -> css' and 'assets -> js' deprecated options,
  132.             // remove the parent 'assets' deprecated option if it's defined
  133.             ->beforeNormalization()
  134.                 ->always()
  135.                 ->then(function ($v) {
  136.                     if (isset($v['assets'])) {
  137.                         unset($v['assets']);
  138.                     }
  140.                     return $v;
  141.                 })
  142.             ->end()
  144.             ->children()
  145.                 ->variableNode('list_actions')
  146.                     ->info('DEPRECATED: use the "actions" option of the "list" view.')
  147.                 ->end()
  149.                 ->integerNode('list_max_results')
  150.                     ->info('DEPRECATED: use "max_results" option under the "list" global key.')
  151.                 ->end()
  153.                 ->arrayNode('assets')
  154.                     ->children()
  155.                         ->arrayNode('css')
  156.                             ->info('DEPRECATED: use the "design -> assets -> css" option.')
  157.                         ->end()
  158.                         ->arrayNode('js')
  159.                             ->info('DEPRECATED: use the "design -> assets -> js" option.')
  160.                         ->end()
  161.                     ->end()
  162.                 ->end()
  163.             ->end()
  164.         ;
  165.     }
  167.     private function addGlobalOptionsSection(ArrayNodeDefinition $rootNode)
  168.     {
  169.         $rootNode
  170.             ->children()
  171.                 ->scalarNode('site_name')
  172.                     ->defaultValue('EasyAdmin')
  173.                     ->info('The name displayed as the title of the administration zone (e.g. company name, project name).')
  174.                 ->end()
  176.                 ->arrayNode('formats')
  177.                     ->addDefaultsIfNotSet()
  178.                     ->children()
  179.                         ->scalarNode('date')
  180.                             ->defaultValue('Y-m-d')
  181.                             ->info('The PHP date format applied to "date" and "date_immutable" field types.')
  182.                             ->example('d/m/Y (see http://php.net/manual/en/function.date.php)')
  183.                         ->end()
  184.                         ->scalarNode('time')
  185.                             ->defaultValue('H:i:s')
  186.                             ->info('The PHP time format applied to "time" and "time_immutable" field types.')
  187.                             ->example('h:i a (see http://php.net/date)')
  188.                         ->end()
  189.                         ->scalarNode('datetime')
  190.                             ->defaultValue('F j, Y H:i')
  191.                             ->info('The PHP date/time format applied to "datetime" and "datetime_immutable" field types.')
  192.                             ->example('l, F jS Y / h:i (see http://php.net/date)')
  193.                         ->end()
  194.                         ->scalarNode('number')
  195.                             ->info('The sprintf-compatible format applied to numeric values.')
  196.                             ->example('%.2d (see http://php.net/sprintf)')
  197.                         ->end()
  198.                         ->scalarNode('dateinterval')
  199.                             ->defaultValue('%%y Year(s) %%m Month(s) %%d Day(s)')
  200.                             ->info('The PHP dateinterval-compatible format applied to "dateinterval" field types.')
  201.                             ->example('%%y Year(s) %%m Month(s) %%d Day(s) (see http://php.net/manual/en/dateinterval.format.php)')
  202.                         ->end()
  203.                     ->end()
  204.                 ->end()
  206.                 ->variableNode('disabled_actions')
  207.                     ->info('The names of the actions disabled for all backend entities.')
  208.                     ->defaultValue(array())
  209.                     ->validate()
  210.                         ->ifTrue(function ($v) {
  211.                             return false === is_array($v);
  212.                         })
  213.                         ->thenInvalid('The disabled_actions option must be an array of action names.')
  214.                     ->end()
  215.                 ->end()
  217.                 ->scalarNode('translation_domain')
  218.                     ->validate()
  219.                         ->ifTrue(function ($v) {
  220.                             return '' === $v;
  221.                         })
  222.                         ->thenInvalid('The translation_domain option cannot be an empty string (use false to disable translations).')
  223.                     ->end()
  224.                     ->defaultValue('messages')
  225.                     ->info('The translation domain used to translate the labels, titles and help messages of all entities.')
  226.                 ->end()
  227.             ->end()
  228.         ;
  229.     }
  231.     private function addDesignSection(ArrayNodeDefinition $rootNode)
  232.     {
  233.         $rootNode
  234.             ->children()
  235.                 ->arrayNode('design')
  236.                     ->addDefaultsIfNotSet()
  237.                     ->children()
  238.                         // the 'theme' option is not used at the moment, but it allows us to be prepared for the future
  239.                         ->scalarNode('theme')
  240.                             ->defaultValue('default')
  241.                             ->info('The theme used to render the backend pages. For now this value can only be "default".')
  242.                             ->beforeNormalization()
  243.                                 ->always(function ($v) {
  244.                                     @trigger_error('The "design.theme" option is deprecated since EasyAdmin 1.x version and it will be removed in 2.0.', E_USER_DEPRECATED);
  246.                                     return $v;
  247.                                 })
  248.                             ->end()
  249.                             ->validate()
  250.                                 ->ifNotInArray(array('default'))
  251.                                 ->thenInvalid('The theme name can only be "default".')
  252.                             ->end()
  253.                         ->end()
  255.                         ->enumNode('color_scheme')
  256.                             ->values(array('dark', 'light'))
  257.                             ->info('The color scheme applied to the backend design (values: "dark" or "light").')
  258.                             ->defaultValue('dark')
  259.                             ->treatNullLike('dark')
  260.                             ->beforeNormalization()
  261.                                 ->always(function ($v) {
  262.                                     @trigger_error('The "design.color_scheme" option is deprecated since EasyAdmin 1.x version and it will be removed in 2.0.', E_USER_DEPRECATED);
  264.                                     return $v;
  265.                                 })
  266.                             ->end()
  267.                         ->end()
  269.                         ->booleanNode('rtl')
  270.                             ->info('If true, the interface uses RTL (right-to-left) writing (needed for Arabic, Hebrew and Persian).')
  271.                         ->end()
  273.                         ->scalarNode('brand_color')
  274.                             ->info('The color used in the backend design to highlight important elements.')
  275.                             ->defaultValue('#205081')
  276.                             ->treatNullLike('#205081')
  277.                             ->validate()
  278.                                 // if present, remove the trailing ';' to avoid CSS issues
  279.                                 ->ifTrue(function ($v) {
  280.                                     return ';' === substr(trim($v), -1);
  281.                                 })
  282.                                 ->then(function ($v) {
  283.                                     return trim(substr(trim($v), 0, -1));
  284.                                 })
  285.                             ->end()
  286.                         ->end()
  288.                         ->variableNode('form_theme')
  289.                             ->defaultValue(array('@EasyAdmin/form/bootstrap_3_horizontal_layout.html.twig'))
  290.                             ->treatNullLike(array('@EasyAdmin/form/bootstrap_3_horizontal_layout.html.twig'))
  291.                             ->info('The form theme applied to backend forms. Allowed values: "horizontal", "vertical", any valid form theme path or an array of theme paths.')
  292.                             ->beforeNormalization()
  293.                                 ->ifTrue(function ($v) {
  294.                                     return in_array($v, array('@EasyAdmin/form/bootstrap_3_horizontal_layout.html.twig', '@EasyAdmin/form/bootstrap_3_layout.html.twig'), true);
  295.                                 })
  296.                                 ->then(function ($v) {
  297.                                     @trigger_error(sprintf('The "%s" form theme is deprecated since EasyAdmin 1.x version and it will be removed in 2.0. Remove "%s" from the "design.form_theme" config option.', $v, $v), E_USER_DEPRECATED);
  299.                                     return $v;
  300.                                 })
  301.                             ->end()
  302.                             ->validate()
  303.                                 ->ifString()->then(function ($v) {
  304.                                     return array($v);
  305.                                 })
  306.                             ->end()
  307.                             ->validate()
  308.                                 ->ifArray()->then(function ($values) {
  309.                                     foreach ($values as $k => $v) {
  310.                                         $deprecationMessage = sprintf('The "%s" form theme shortcut is deprecated since EasyAdmin 1.x version and it will be removed in 2.0. Remove "%s" from the "design.form_theme" config option.', $v, $v);
  312.                                         if ('horizontal' === $v) {
  313.                                             @trigger_error($deprecationMessage, E_USER_DEPRECATED);
  314.                                             $values[$k] = '@EasyAdmin/form/bootstrap_3_horizontal_layout.html.twig';
  315.                                         } elseif ('vertical' === $v) {
  316.                                             @trigger_error($deprecationMessage, E_USER_DEPRECATED);
  317.                                             $values[$k] = '@EasyAdmin/form/bootstrap_3_layout.html.twig';
  318.                                         }
  319.                                     }
  321.                                     return $values;
  322.                                 })
  323.                             ->end()
  324.                         ->end()
  326.                         ->arrayNode('assets')
  327.                             ->addDefaultsIfNotSet()
  328.                             ->children()
  329.                                 ->arrayNode('css')
  330.                                     ->prototype('scalar')->end()
  331.                                     ->info('The array of CSS assets to load in all backend pages.')
  332.                                 ->end()
  333.                                 ->arrayNode('js')
  334.                                     ->prototype('scalar')->end()
  335.                                     ->info('The array of JavaScript assets to load in all backend pages.')
  336.                                 ->end()
  337.                                 ->arrayNode('favicon')
  338.                                     ->addDefaultsIfNotSet()
  339.                                     ->info('The favicon to use in all backend pages.')
  340.                                     ->children()
  341.                                         ->scalarNode('path')->cannotBeEmpty()->defaultValue('favicon.ico')->end()
  342.                                         ->scalarNode('mime_type')->defaultValue('image/x-icon')->end()
  343.                                     ->end()
  344.                                     ->beforeNormalization()
  345.                                         ->always(function ($v) {
  346.                                             if (is_string($v)) {
  347.                                                 $v = array('path' => $v);
  348.                                             }
  349.                                             $mimeTypes = array(
  350.                                                 'ico' => 'image/x-icon',
  351.                                                 'png' => 'image/png',
  352.                                                 'gif' => 'image/gif',
  353.                                                 'jpg' => 'image/jpeg',
  354.                                                 'jpeg' => 'image/jpeg',
  355.                                             );
  356.                                             if (!isset($v['mime_type']) && isset($mimeTypes[$ext = pathinfo($v['path'], PATHINFO_EXTENSION)])) {
  357.                                                 $v['mime_type'] = $mimeTypes[$ext];
  358.                                             } elseif (!isset($v['mime_type'])) {
  359.                                                 $v['mime_type'] = null;
  360.                                             }
  362.                                             return $v;
  363.                                         })
  364.                                     ->end()
  365.                                     ->validate()
  366.                                         ->ifTrue(function ($v) {
  367.                                             return empty($v['mime_type']);
  368.                                         })
  369.                                         ->thenInvalid('The "mime_type" key is required as we were unable to guess it from the favicon extension.')
  370.                                     ->end()
  371.                                 ->end()
  372.                             ->end()
  373.                         ->end()
  375.                         ->arrayNode('templates')
  376.                             ->info('The custom templates used to render each backend element.')
  377.                             ->children()
  378.                                 ->scalarNode('layout')->info('Used to decorate the main templates (list, edit, new and show)')->end()
  379.                                 ->scalarNode('menu')->info('Used to render the main menu')->end()
  380.                                 ->scalarNode('edit')->info('Used to render the page where entities are edited')->end()
  381.                                 ->scalarNode('list')->info('Used to render the listing page and the search results page')->end()
  382.                                 ->scalarNode('new')->info('Used to render the page where new entities are created')->end()
  383.                                 ->scalarNode('show')->info('Used to render the contents stored by a given entity')->end()
  384.                                 ->scalarNode('exception')->info('Used to render the error page when some exception happens')->end()
  385.                                 ->scalarNode('flash_messages')->info('Used to render the notification area were flash messages are displayed')->end()
  386.                                 ->scalarNode('paginator')->info('Used to render the paginator in the list page')->end()
  387.                                 ->scalarNode('field_array')->info('Used to render array field types')->end()
  388.                                 ->scalarNode('field_association')->info('Used to render fields that store Doctrine associations')->end()
  389.                                 ->scalarNode('field_bigint')->info('Used to render bigint field types')->end()
  390.                                 ->scalarNode('field_boolean')->info('Used to render boolean field types')->end()
  391.                                 ->scalarNode('field_date')->info('Used to render date and date_immutable field types')->end()
  392.                                 ->scalarNode('field_datetime')->info('Used to render datetime and datetime_immutable field types')->end()
  393.                                 ->scalarNode('field_datetimetz')->info('Used to render datetimetz field types')->end()
  394.                                 ->scalarNode('field_decimal')->info('Used to render decimal field types')->end()
  395.                                 ->scalarNode('field_email')->info('Used to render clickable email addresses')->end()
  396.                                 ->scalarNode('field_float')->info('Used to render float field types')->end()
  397.                                 ->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()
  398.                                 ->scalarNode('field_image')->info('Used to render image field types (a special type that displays the image contents)')->end()
  399.                                 ->scalarNode('field_integer')->info('Used to render integer field types')->end()
  400.                                 ->scalarNode('field_raw')->info('Used to render unescaped values')->end()
  401.                                 ->scalarNode('field_simple_array')->info('Used to render simple array field types')->end()
  402.                                 ->scalarNode('field_smallint')->info('Used to render smallint field types')->end()
  403.                                 ->scalarNode('field_string')->info('Used to render string field types')->end()
  404.                                 ->scalarNode('field_tel')->info('Used to render clickable telephone number')->end()
  405.                                 ->scalarNode('field_text')->info('Used to render text field types')->end()
  406.                                 ->scalarNode('field_time')->info('Used to render time and time_immutable field types')->end()
  407.                                 ->scalarNode('field_toggle')->info('Used to render toggle field types (a special type that display booleans as flip switches)')->end()
  408.                                 ->scalarNode('field_url')->info('Used to render clickable URLs')->end()
  409.                                 ->scalarNode('label_empty')->info('Used when the field to render is an empty collection')->end()
  410.                                 ->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()
  411.                                 ->scalarNode('label_null')->info('Used when the value of the field to render is null')->end()
  412.                                 ->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()
  413.                             ->end()
  414.                         ->end()
  416.                         ->arrayNode('menu')
  417.                             ->normalizeKeys(false)
  418.                             ->defaultValue(array())
  419.                             ->info('The items to display in the main menu.')
  420.                             ->prototype('variable')
  421.                         ->end()
  422.                     ->end()
  423.                 ->end()
  424.             ->end()
  425.         ;
  426.     }
  428.     private function addViewsSection(ArrayNodeDefinition $rootNode)
  429.     {
  430.         $rootNode
  431.             ->children()
  432.                 ->arrayNode('list')
  433.                     ->addDefaultsIfNotSet()
  434.                     ->children()
  435.                         ->scalarNode('title')
  436.                             ->info('The visible page title displayed in the list view.')
  437.                         ->end()
  438.                         ->arrayNode('actions')
  439.                             ->prototype('variable')->end()
  440.                             ->info('The list of actions enabled in the "list" view.')
  441.                         ->end()
  442.                         ->integerNode('max_results')
  443.                             ->defaultValue(15)
  444.                             ->info('The maximum number of items to show on listing and search pages.')
  445.                         ->end()
  446.                     ->end()
  447.                 ->end()
  449.                 ->arrayNode('search')
  450.                     ->addDefaultsIfNotSet()
  451.                     ->children()
  452.                         ->scalarNode('title')
  453.                             ->info('The visible page title displayed in the search view.')
  454.                         ->end()
  455.                     ->end()
  456.                 ->end()
  458.                 ->arrayNode('edit')
  459.                     ->addDefaultsIfNotSet()
  460.                     ->children()
  461.                         ->scalarNode('title')
  462.                             ->info('The visible page title displayed in the edit view.')
  463.                         ->end()
  464.                         ->arrayNode('actions')
  465.                             ->prototype('variable')->end()
  466.                             ->info('The list of actions enabled in the "edit" view.')
  467.                         ->end()
  468.                     ->end()
  469.                 ->end()
  471.                 ->arrayNode('new')
  472.                     ->addDefaultsIfNotSet()
  473.                     ->children()
  474.                         ->scalarNode('title')
  475.                             ->info('The visible page title displayed in the new view.')
  476.                         ->end()
  477.                         ->arrayNode('actions')
  478.                             ->prototype('variable')->end()
  479.                             ->info('The list of actions enabled in the "new" view.')
  480.                         ->end()
  481.                     ->end()
  482.                 ->end()
  484.                 ->arrayNode('show')
  485.                     ->addDefaultsIfNotSet()
  486.                     ->children()
  487.                         ->scalarNode('title')
  488.                             ->info('The visible page title displayed in the show view.')
  489.                         ->end()
  490.                         ->arrayNode('actions')
  491.                             ->prototype('variable')->end()
  492.                             ->info('The list of actions enabled in the "show" view.')
  493.                         ->end()
  494.                         ->integerNode('max_results')
  495.                             ->defaultValue(10)
  496.                             ->info('The maximum number of items displayed for related fields in the show page and for autocomplete fields in the new/edit pages.')
  497.                         ->end()
  498.                     ->end()
  499.                 ->end()
  500.             ->end()
  501.         ;
  502.     }
  504.     private function addEntitiesSection(ArrayNodeDefinition $rootNode)
  505.     {
  506.         $rootNode
  507.             ->children()
  508.                 ->arrayNode('entities')
  509.                     ->normalizeKeys(false)
  510.                     ->useAttributeAsKey('name', false)
  511.                     ->defaultValue(array())
  512.                     ->info('The list of entities to manage in the administration zone.')
  513.                     ->prototype('variable')
  514.                 ->end()
  515.             ->end()
  516.         ;
  517.     }
  519.     private function getRootNode(TreeBuilder $treeBuilder, $name)
  520.     {
  521.         // BC layer for symfony/config 4.1 and older
  522.         if (!method_exists($treeBuilder, 'getRootNode')) {
  523.             return $treeBuilder->root($name);
  524.         }
  526.         return $treeBuilder->getRootNode();
  527.     }
  528. }
  530. class_alias('EasyCorp\Bundle\EasyAdminBundle\DependencyInjection\Configuration', 'JavierEguiluz\Bundle\EasyAdminBundle\DependencyInjection\Configuration', false);