annotate core/modules/layout_builder/layout_builder.api.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@18 1 <?php
Chris@18 2
Chris@18 3 /**
Chris@18 4 * @file
Chris@18 5 * Hooks provided by the Layout Builder module.
Chris@18 6 */
Chris@18 7
Chris@18 8 /**
Chris@18 9 * @defgroup layout_builder_access Layout Builder access
Chris@18 10 * @{
Chris@18 11 * In determining access rights for the Layout Builder UI,
Chris@18 12 * \Drupal\layout_builder\Access\LayoutBuilderAccessCheck checks if the
Chris@18 13 * specified section storage plugin (an implementation of
Chris@18 14 * \Drupal\layout_builder\SectionStorageInterface) grants access.
Chris@18 15 *
Chris@18 16 * By default, the Layout Builder access check requires the 'configure any
Chris@18 17 * layout' permission. Individual section storage plugins may override this by
Chris@18 18 * setting the 'handles_permission_check' annotation key to TRUE. Any section
Chris@18 19 * storage plugin that uses 'handles_permission_check' must provide its own
Chris@18 20 * complete routing access checking to avoid any access bypasses.
Chris@18 21 *
Chris@18 22 * This access checking is only enforced on the routing level (not on the entity
Chris@18 23 * or field level) with additional form access restrictions. All HTTP API access
Chris@18 24 * to Layout Builder data is currently forbidden.
Chris@18 25 *
Chris@18 26 * @see https://www.drupal.org/project/drupal/issues/2942975
Chris@18 27 */
Chris@18 28
Chris@18 29 /**
Chris@18 30 * @} End of "defgroup layout_builder_access".
Chris@18 31 */