annotate core/lib/Drupal/Core/Access/AccessResultNeutral.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 * Value object indicating a neutral access result, with cacheability metadata.
Chris@0 7 */
Chris@0 8 class AccessResultNeutral extends AccessResult implements AccessResultReasonInterface {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * The reason why access is neutral. For use in messages.
Chris@0 12 *
Chris@0 13 * @var string|null
Chris@0 14 */
Chris@0 15 protected $reason;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Constructs a new AccessResultNeutral instance.
Chris@0 19 *
Chris@0 20 * @param null|string $reason
Chris@0 21 * (optional) A message to provide details about this access result
Chris@0 22 */
Chris@0 23 public function __construct($reason = NULL) {
Chris@0 24 $this->reason = $reason;
Chris@0 25 }
Chris@0 26
Chris@0 27 /**
Chris@0 28 * {@inheritdoc}
Chris@0 29 */
Chris@0 30 public function isNeutral() {
Chris@0 31 return TRUE;
Chris@0 32 }
Chris@0 33
Chris@0 34 /**
Chris@0 35 * {@inheritdoc}
Chris@0 36 */
Chris@0 37 public function getReason() {
Chris@0 38 return $this->reason;
Chris@0 39 }
Chris@0 40
Chris@0 41 /**
Chris@0 42 * {@inheritdoc}
Chris@0 43 */
Chris@0 44 public function setReason($reason) {
Chris@0 45 $this->reason = $reason;
Chris@0 46 return $this;
Chris@0 47 }
Chris@0 48
Chris@0 49 }