annotate core/lib/Drupal/Core/Access/AccessResultReasonInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Access;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Interface for access result value objects with stored reason for developers.
Chris@0 7 *
Chris@0 8 * For example, a developer can specify the reason for forbidden access:
Chris@0 9 * @code
Chris@0 10 * new AccessResultForbidden('You are not authorized to hack core');
Chris@0 11 * @endcode
Chris@0 12 *
Chris@0 13 * @see \Drupal\Core\Access\AccessResultInterface
Chris@0 14 */
Chris@0 15 interface AccessResultReasonInterface extends AccessResultInterface {
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Gets the reason for this access result.
Chris@0 19 *
Chris@0 20 * @return string|null
Chris@0 21 * The reason of this access result or NULL if no reason is provided.
Chris@0 22 */
Chris@0 23 public function getReason();
Chris@0 24
Chris@0 25 /**
Chris@0 26 * Sets the reason for this access result.
Chris@0 27 *
Chris@0 28 * @param $reason string|null
Chris@0 29 * The reason of this access result or NULL if no reason is provided.
Chris@0 30 *
Chris@0 31 * @return \Drupal\Core\Access\AccessResultInterface
Chris@0 32 * The access result instance.
Chris@0 33 */
Chris@0 34 public function setReason($reason);
Chris@0 35
Chris@0 36 }