Configuration.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. <?php
  2. /*
  3. * This file is part of the Sonata Project package.
  4. *
  5. * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Sonata\AdminBundle\DependencyInjection;
  11. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  12. use Symfony\Component\Config\Definition\ConfigurationInterface;
  13. /**
  14. * This class contains the configuration information for the bundle.
  15. *
  16. * This information is solely responsible for how the different configuration
  17. * sections are normalized, and merged.
  18. *
  19. * @author Michael Williams <mtotheikle@gmail.com>
  20. */
  21. class Configuration implements ConfigurationInterface
  22. {
  23. /**
  24. * Generates the configuration tree.
  25. *
  26. * @return TreeBuilder
  27. */
  28. public function getConfigTreeBuilder()
  29. {
  30. $treeBuilder = new TreeBuilder();
  31. $rootNode = $treeBuilder->root('sonata_admin', 'array');
  32. $rootNode
  33. ->fixXmlConfig('option')
  34. ->fixXmlConfig('admin_service')
  35. ->fixXmlConfig('template')
  36. ->fixXmlConfig('extension')
  37. ->children()
  38. ->arrayNode('security')
  39. ->addDefaultsIfNotSet()
  40. ->fixXmlConfig('admin_permission')
  41. ->fixXmlConfig('object_permission')
  42. ->children()
  43. ->scalarNode('handler')->defaultValue('sonata.admin.security.handler.noop')->end()
  44. ->arrayNode('information')
  45. ->useAttributeAsKey('id')
  46. ->prototype('array')
  47. ->performNoDeepMerging()
  48. ->beforeNormalization()
  49. ->ifString()
  50. ->then(function ($v) {
  51. return array($v);
  52. })
  53. ->end()
  54. ->prototype('scalar')->end()
  55. ->end()
  56. ->end()
  57. ->arrayNode('admin_permissions')
  58. ->defaultValue(array('CREATE', 'LIST', 'DELETE', 'UNDELETE', 'EXPORT', 'OPERATOR', 'MASTER'))
  59. ->prototype('scalar')->end()
  60. ->end()
  61. ->arrayNode('object_permissions')
  62. ->defaultValue(array('VIEW', 'EDIT', 'DELETE', 'UNDELETE', 'OPERATOR', 'MASTER', 'OWNER'))
  63. ->prototype('scalar')->end()
  64. ->end()
  65. ->scalarNode('acl_user_manager')->defaultNull()->end()
  66. ->end()
  67. ->end()
  68. ->scalarNode('title')->defaultValue('Sonata Admin')->cannotBeEmpty()->end()
  69. ->scalarNode('title_logo')->defaultValue('bundles/sonataadmin/logo_title.png')->cannotBeEmpty()->end()
  70. ->arrayNode('global_search')
  71. ->addDefaultsIfNotSet()
  72. ->children()
  73. ->scalarNode('empty_boxes')
  74. ->defaultValue('show')
  75. ->info('Perhaps one of the three options: show, fade, hide.')
  76. ->validate()
  77. ->ifTrue(function ($v) {
  78. return !in_array($v, array('show', 'fade', 'hide'));
  79. })
  80. ->thenInvalid('Configuration value of "global_search.empty_boxes" must be one of show, fade or hide.')
  81. ->end()
  82. ->end()
  83. ->end()
  84. ->end()
  85. ->arrayNode('breadcrumbs')
  86. ->addDefaultsIfNotSet()
  87. ->children()
  88. ->scalarNode('child_admin_route')
  89. ->defaultValue('edit')
  90. ->info('Change the default route used to generate the link to the parent object, when in a child admin')
  91. ->end()
  92. ->end()
  93. ->end()
  94. ->arrayNode('options')
  95. ->addDefaultsIfNotSet()
  96. ->children()
  97. ->booleanNode('html5_validate')->defaultTrue()->end()
  98. ->booleanNode('sort_admins')->defaultFalse()->info('Auto order groups and admins by label or id')->end()
  99. ->booleanNode('confirm_exit')->defaultTrue()->end()
  100. ->booleanNode('use_select2')->defaultTrue()->end()
  101. ->booleanNode('use_icheck')->defaultTrue()->end()
  102. ->booleanNode('use_bootlint')->defaultFalse()->end()
  103. ->booleanNode('use_stickyforms')->defaultTrue()->end()
  104. ->integerNode('pager_links')->defaultNull()->end()
  105. ->scalarNode('form_type')->defaultValue('standard')->end()
  106. ->integerNode('dropdown_number_groups_per_colums')->defaultValue(2)->end()
  107. ->enumNode('title_mode')
  108. ->values(array('single_text', 'single_image', 'both'))
  109. ->defaultValue('both')
  110. ->cannotBeEmpty()
  111. ->end()
  112. ->booleanNode('lock_protection')
  113. ->defaultFalse()
  114. ->info('Enable locking when editing an object, if the corresponding object manager supports it.')
  115. ->end()
  116. ->booleanNode('enable_jms_di_extra_autoregistration') // NEXT_MAJOR: remove this option
  117. ->defaultTrue()
  118. ->info('Enable automatic registration of annotations with JMSDiExtraBundle')
  119. ->end()
  120. ->end()
  121. ->end()
  122. ->arrayNode('dashboard')
  123. ->addDefaultsIfNotSet()
  124. ->fixXmlConfig('group')
  125. ->fixXmlConfig('block')
  126. ->children()
  127. ->arrayNode('groups')
  128. ->useAttributeAsKey('id')
  129. ->prototype('array')
  130. ->beforeNormalization()
  131. ->ifArray()
  132. ->then(function ($items) {
  133. if (isset($items['provider'])) {
  134. $disallowedItems = array('items', 'label');
  135. foreach ($disallowedItems as $item) {
  136. if (isset($items[$item])) {
  137. throw new \InvalidArgumentException(sprintf('The config value "%s" cannot be used alongside "provider" config value', $item));
  138. }
  139. }
  140. }
  141. return $items;
  142. })
  143. ->end()
  144. ->fixXmlConfig('item')
  145. ->fixXmlConfig('item_add')
  146. ->children()
  147. ->scalarNode('label')->end()
  148. ->scalarNode('label_catalogue')->end()
  149. ->scalarNode('icon')->defaultValue('<i class="fa fa-folder"></i>')->end()
  150. ->scalarNode('on_top')->defaultFalse()->info('Show menu item in side dashboard menu without treeview')->end()
  151. ->scalarNode('keep_open')->defaultFalse()->info('Keep menu group always open')->end()
  152. ->scalarNode('provider')->end()
  153. ->arrayNode('items')
  154. ->beforeNormalization()
  155. ->ifArray()
  156. ->then(function ($items) {
  157. foreach ($items as $key => $item) {
  158. if (is_array($item)) {
  159. if (!array_key_exists('label', $item) || !array_key_exists('route', $item)) {
  160. throw new \InvalidArgumentException('Expected either parameters "route" and "label" for array items');
  161. }
  162. if (!array_key_exists('route_params', $item)) {
  163. $items[$key]['route_params'] = array();
  164. }
  165. $items[$key]['admin'] = '';
  166. } else {
  167. $items[$key] = array(
  168. 'admin' => $item,
  169. 'label' => '',
  170. 'route' => '',
  171. 'route_params' => array(),
  172. 'route_absolute' => false,
  173. );
  174. }
  175. }
  176. return $items;
  177. })
  178. ->end()
  179. ->prototype('array')
  180. ->children()
  181. ->scalarNode('admin')->end()
  182. ->scalarNode('label')->end()
  183. ->scalarNode('route')->end()
  184. ->arrayNode('roles')
  185. ->prototype('scalar')
  186. ->info('Roles which will see the route in the menu')
  187. ->defaultValue(array())
  188. ->end()
  189. ->end()
  190. ->arrayNode('route_params')
  191. ->prototype('scalar')->end()
  192. ->end()
  193. ->booleanNode('route_absolute')
  194. ->info('Whether the generated url should be absolute')
  195. ->defaultFalse()
  196. ->end()
  197. ->end()
  198. ->end()
  199. ->end()
  200. ->arrayNode('item_adds')
  201. ->prototype('scalar')->end()
  202. ->end()
  203. ->arrayNode('roles')
  204. ->prototype('scalar')->defaultValue(array())->end()
  205. ->end()
  206. ->end()
  207. ->end()
  208. ->end()
  209. ->arrayNode('blocks')
  210. ->defaultValue(array(array(
  211. 'position' => 'left',
  212. 'settings' => array(),
  213. 'type' => 'sonata.admin.block.admin_list',
  214. 'roles' => array(),
  215. )))
  216. ->prototype('array')
  217. ->fixXmlConfig('setting')
  218. ->children()
  219. ->scalarNode('type')->cannotBeEmpty()->end()
  220. ->arrayNode('roles')
  221. ->defaultValue(array())
  222. ->prototype('scalar')->end()
  223. ->end()
  224. ->arrayNode('settings')
  225. ->useAttributeAsKey('id')
  226. ->prototype('variable')->defaultValue(array())->end()
  227. ->end()
  228. ->scalarNode('position')->defaultValue('right')->end()
  229. ->scalarNode('class')->defaultValue('col-md-4')->end()
  230. ->end()
  231. ->end()
  232. ->end()
  233. ->end()
  234. ->end()
  235. ->arrayNode('admin_services')
  236. ->prototype('array')
  237. ->children()
  238. ->scalarNode('model_manager')->defaultNull()->end()
  239. ->scalarNode('form_contractor')->defaultNull()->end()
  240. ->scalarNode('show_builder')->defaultNull()->end()
  241. ->scalarNode('list_builder')->defaultNull()->end()
  242. ->scalarNode('datagrid_builder')->defaultNull()->end()
  243. ->scalarNode('translator')->defaultNull()->end()
  244. ->scalarNode('configuration_pool')->defaultNull()->end()
  245. ->scalarNode('route_generator')->defaultNull()->end()
  246. ->scalarNode('validator')->defaultNull()->end()
  247. ->scalarNode('security_handler')->defaultNull()->end()
  248. ->scalarNode('label')->defaultNull()->end()
  249. ->scalarNode('menu_factory')->defaultNull()->end()
  250. ->scalarNode('route_builder')->defaultNull()->end()
  251. ->scalarNode('label_translator_strategy')->defaultNull()->end()
  252. ->scalarNode('pager_type')->defaultNull()->end()
  253. ->arrayNode('templates')
  254. ->addDefaultsIfNotSet()
  255. ->children()
  256. ->arrayNode('form')
  257. ->prototype('scalar')->end()
  258. ->end()
  259. ->arrayNode('filter')
  260. ->prototype('scalar')->end()
  261. ->end()
  262. ->arrayNode('view')
  263. ->useAttributeAsKey('id')
  264. ->prototype('scalar')->end()
  265. ->end()
  266. ->end()
  267. ->end()
  268. ->end()
  269. ->end()
  270. ->end()
  271. ->arrayNode('templates')
  272. ->addDefaultsIfNotSet()
  273. ->children()
  274. ->scalarNode('user_block')->defaultValue('SonataAdminBundle:Core:user_block.html.twig')->cannotBeEmpty()->end()
  275. ->scalarNode('add_block')->defaultValue('SonataAdminBundle:Core:add_block.html.twig')->cannotBeEmpty()->end()
  276. ->scalarNode('layout')->defaultValue('SonataAdminBundle::standard_layout.html.twig')->cannotBeEmpty()->end()
  277. ->scalarNode('ajax')->defaultValue('SonataAdminBundle::ajax_layout.html.twig')->cannotBeEmpty()->end()
  278. ->scalarNode('dashboard')->defaultValue('SonataAdminBundle:Core:dashboard.html.twig')->cannotBeEmpty()->end()
  279. ->scalarNode('search')->defaultValue('SonataAdminBundle:Core:search.html.twig')->cannotBeEmpty()->end()
  280. ->scalarNode('list')->defaultValue('SonataAdminBundle:CRUD:list.html.twig')->cannotBeEmpty()->end()
  281. ->scalarNode('filter')->defaultValue('SonataAdminBundle:Form:filter_admin_fields.html.twig')->cannotBeEmpty()->end()
  282. ->scalarNode('show')->defaultValue('SonataAdminBundle:CRUD:show.html.twig')->cannotBeEmpty()->end()
  283. ->scalarNode('show_compare')->defaultValue('SonataAdminBundle:CRUD:show_compare.html.twig')->cannotBeEmpty()->end()
  284. ->scalarNode('edit')->defaultValue('SonataAdminBundle:CRUD:edit.html.twig')->cannotBeEmpty()->end()
  285. ->scalarNode('preview')->defaultValue('SonataAdminBundle:CRUD:preview.html.twig')->cannotBeEmpty()->end()
  286. ->scalarNode('history')->defaultValue('SonataAdminBundle:CRUD:history.html.twig')->cannotBeEmpty()->end()
  287. ->scalarNode('acl')->defaultValue('SonataAdminBundle:CRUD:acl.html.twig')->cannotBeEmpty()->end()
  288. ->scalarNode('history_revision_timestamp')->defaultValue('SonataAdminBundle:CRUD:history_revision_timestamp.html.twig')->cannotBeEmpty()->end()
  289. ->scalarNode('action')->defaultValue('SonataAdminBundle:CRUD:action.html.twig')->cannotBeEmpty()->end()
  290. ->scalarNode('select')->defaultValue('SonataAdminBundle:CRUD:list__select.html.twig')->cannotBeEmpty()->end()
  291. ->scalarNode('list_block')->defaultValue('SonataAdminBundle:Block:block_admin_list.html.twig')->cannotBeEmpty()->end()
  292. ->scalarNode('search_result_block')->defaultValue('SonataAdminBundle:Block:block_search_result.html.twig')->cannotBeEmpty()->end()
  293. ->scalarNode('short_object_description')->defaultValue('SonataAdminBundle:Helper:short-object-description.html.twig')->cannotBeEmpty()->end()
  294. ->scalarNode('delete')->defaultValue('SonataAdminBundle:CRUD:delete.html.twig')->cannotBeEmpty()->end()
  295. ->scalarNode('batch')->defaultValue('SonataAdminBundle:CRUD:list__batch.html.twig')->cannotBeEmpty()->end()
  296. ->scalarNode('batch_confirmation')->defaultValue('SonataAdminBundle:CRUD:batch_confirmation.html.twig')->cannotBeEmpty()->end()
  297. ->scalarNode('inner_list_row')->defaultValue('SonataAdminBundle:CRUD:list_inner_row.html.twig')->cannotBeEmpty()->end()
  298. ->scalarNode('outer_list_rows_mosaic')->defaultValue('SonataAdminBundle:CRUD:list_outer_rows_mosaic.html.twig')->cannotBeEmpty()->end()
  299. ->scalarNode('outer_list_rows_list')->defaultValue('SonataAdminBundle:CRUD:list_outer_rows_list.html.twig')->cannotBeEmpty()->end()
  300. ->scalarNode('outer_list_rows_tree')->defaultValue('SonataAdminBundle:CRUD:list_outer_rows_tree.html.twig')->cannotBeEmpty()->end()
  301. ->scalarNode('base_list_field')->defaultValue('SonataAdminBundle:CRUD:base_list_field.html.twig')->cannotBeEmpty()->end()
  302. ->scalarNode('pager_links')->defaultValue('SonataAdminBundle:Pager:links.html.twig')->cannotBeEmpty()->end()
  303. ->scalarNode('pager_results')->defaultValue('SonataAdminBundle:Pager:results.html.twig')->cannotBeEmpty()->end()
  304. ->scalarNode('tab_menu_template')->defaultValue('SonataAdminBundle:Core:tab_menu_template.html.twig')->cannotBeEmpty()->end()
  305. ->scalarNode('knp_menu_template')->defaultValue('SonataAdminBundle:Menu:sonata_menu.html.twig')->cannotBeEmpty()->end()
  306. ->scalarNode('action_create')->defaultValue('SonataAdminBundle:CRUD:dashboard__action_create.html.twig')->cannotBeEmpty()->end()
  307. ->scalarNode('button_acl')->defaultValue('SonataAdminBundle:Button:acl_button.html.twig')->cannotBeEmpty()->end()
  308. ->scalarNode('button_create')->defaultValue('SonataAdminBundle:Button:create_button.html.twig')->cannotBeEmpty()->end()
  309. ->scalarNode('button_edit')->defaultValue('SonataAdminBundle:Button:edit_button.html.twig')->cannotBeEmpty()->end()
  310. ->scalarNode('button_history')->defaultValue('SonataAdminBundle:Button:history_button.html.twig')->cannotBeEmpty()->end()
  311. ->scalarNode('button_list')->defaultValue('SonataAdminBundle:Button:list_button.html.twig')->cannotBeEmpty()->end()
  312. ->scalarNode('button_show')->defaultValue('SonataAdminBundle:Button:show_button.html.twig')->cannotBeEmpty()->end()
  313. ->end()
  314. ->end()
  315. ->arrayNode('assets')
  316. ->addDefaultsIfNotSet()
  317. ->children()
  318. ->arrayNode('stylesheets')
  319. ->defaultValue(array(
  320. 'bundles/sonatacore/vendor/bootstrap/dist/css/bootstrap.min.css',
  321. 'bundles/sonatacore/vendor/components-font-awesome/css/font-awesome.min.css',
  322. 'bundles/sonatacore/vendor/ionicons/css/ionicons.min.css',
  323. 'bundles/sonataadmin/vendor/admin-lte/dist/css/AdminLTE.min.css',
  324. 'bundles/sonataadmin/vendor/admin-lte/dist/css/skins/skin-black.min.css',
  325. 'bundles/sonataadmin/vendor/iCheck/skins/square/blue.css',
  326. 'bundles/sonatacore/vendor/eonasdan-bootstrap-datetimepicker/build/css/bootstrap-datetimepicker.min.css',
  327. 'bundles/sonataadmin/vendor/jqueryui/themes/base/jquery-ui.css',
  328. 'bundles/sonatacore/vendor/select2/select2.css',
  329. 'bundles/sonatacore/vendor/select2-bootstrap-css/select2-bootstrap.min.css',
  330. 'bundles/sonataadmin/vendor/x-editable/dist/bootstrap3-editable/css/bootstrap-editable.css',
  331. 'bundles/sonataadmin/css/styles.css',
  332. 'bundles/sonataadmin/css/layout.css',
  333. 'bundles/sonataadmin/css/tree.css',
  334. ))
  335. ->prototype('scalar')->end()
  336. ->end()
  337. ->arrayNode('javascripts')
  338. ->defaultValue(array(
  339. 'bundles/sonatacore/vendor/jquery/dist/jquery.min.js',
  340. 'bundles/sonataadmin/vendor/jquery.scrollTo/jquery.scrollTo.min.js',
  341. 'bundles/sonatacore/vendor/moment/min/moment.min.js',
  342. 'bundles/sonataadmin/vendor/jqueryui/ui/minified/jquery-ui.min.js',
  343. 'bundles/sonataadmin/vendor/jqueryui/ui/minified/i18n/jquery-ui-i18n.min.js',
  344. 'bundles/sonatacore/vendor/bootstrap/dist/js/bootstrap.min.js',
  345. 'bundles/sonatacore/vendor/eonasdan-bootstrap-datetimepicker/build/js/bootstrap-datetimepicker.min.js',
  346. 'bundles/sonataadmin/vendor/jquery-form/jquery.form.js',
  347. 'bundles/sonataadmin/jquery/jquery.confirmExit.js',
  348. 'bundles/sonataadmin/vendor/x-editable/dist/bootstrap3-editable/js/bootstrap-editable.min.js',
  349. 'bundles/sonatacore/vendor/select2/select2.min.js',
  350. 'bundles/sonataadmin/vendor/admin-lte/dist/js/app.min.js',
  351. 'bundles/sonataadmin/vendor/iCheck/icheck.min.js',
  352. 'bundles/sonataadmin/vendor/slimScroll/jquery.slimscroll.min.js',
  353. 'bundles/sonataadmin/vendor/waypoints/lib/jquery.waypoints.min.js',
  354. 'bundles/sonataadmin/vendor/waypoints/lib/shortcuts/sticky.min.js',
  355. 'bundles/sonataadmin/vendor/readmore-js/readmore.min.js',
  356. 'bundles/sonataadmin/vendor/masonry/dist/masonry.pkgd.min.js',
  357. 'bundles/sonataadmin/Admin.js',
  358. 'bundles/sonataadmin/treeview.js',
  359. ))
  360. ->prototype('scalar')->end()
  361. ->end()
  362. ->end()
  363. ->end()
  364. ->arrayNode('extensions')
  365. ->useAttributeAsKey('id')
  366. ->defaultValue(array('admins' => array(), 'excludes' => array(), 'implements' => array(), 'extends' => array(), 'instanceof' => array(), 'uses' => array()))
  367. ->prototype('array')
  368. ->fixXmlConfig('admin')
  369. ->fixXmlConfig('exclude')
  370. ->fixXmlConfig('implement')
  371. ->fixXmlConfig('extend')
  372. ->fixXmlConfig('use')
  373. ->children()
  374. ->arrayNode('admins')
  375. ->prototype('scalar')->end()
  376. ->end()
  377. ->arrayNode('excludes')
  378. ->prototype('scalar')->end()
  379. ->end()
  380. ->arrayNode('implements')
  381. ->prototype('scalar')->end()
  382. ->end()
  383. ->arrayNode('extends')
  384. ->prototype('scalar')->end()
  385. ->end()
  386. ->arrayNode('instanceof')
  387. ->prototype('scalar')->end()
  388. ->end()
  389. ->arrayNode('uses')
  390. ->prototype('scalar')->end()
  391. ->validate()
  392. ->ifTrue(function ($v) {
  393. return !empty($v) && version_compare(PHP_VERSION, '5.4.0', '<');
  394. })
  395. ->thenInvalid('PHP >= 5.4.0 is required to use traits.')
  396. ->end()
  397. ->end()
  398. ->integerNode('priority')
  399. ->info('Positive or negative integer. The higher the priority, the earlier it’s executed.')
  400. ->defaultValue(0)
  401. ->end()
  402. ->end()
  403. ->end()
  404. ->end()
  405. ->scalarNode('persist_filters')->defaultFalse()->end()
  406. ->booleanNode('show_mosaic_button')
  407. ->defaultTrue()
  408. ->info('Show mosaic button on all admin screens')
  409. ->end()
  410. // NEXT_MAJOR : remove this option
  411. ->booleanNode('translate_group_label')
  412. ->defaultFalse()
  413. ->info('Translate group label')
  414. ->end()
  415. ->end()
  416. ->end();
  417. return $treeBuilder;
  418. }
  419. }