Mercurial > hg > isophonics-drupal-site
view core/lib/Drupal/Core/Access/AccessResultReasonInterface.php @ 17:129ea1e6d783
Update, including to Drupal core 8.6.10
author | Chris Cannam |
---|---|
date | Thu, 28 Feb 2019 13:21:36 +0000 |
parents | 4c8ae668cc8c |
children |
line wrap: on
line source
<?php namespace Drupal\Core\Access; /** * Interface for access result value objects with stored reason for developers. * * For example, a developer can specify the reason for forbidden access: * @code * new AccessResultForbidden('You are not authorized to hack core'); * @endcode * * @see \Drupal\Core\Access\AccessResultInterface */ interface AccessResultReasonInterface extends AccessResultInterface { /** * Gets the reason for this access result. * * @return string|null * The reason of this access result or NULL if no reason is provided. */ public function getReason(); /** * Sets the reason for this access result. * * @param $reason string|null * The reason of this access result or NULL if no reason is provided. * * @return \Drupal\Core\Access\AccessResultInterface * The access result instance. */ public function setReason($reason); }