annotate core/lib/Drupal/Core/Breadcrumb/Breadcrumb.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\Breadcrumb;
Chris@0 4
Chris@0 5 use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
Chris@0 6 use Drupal\Core\Cache\RefinableCacheableDependencyTrait;
Chris@0 7 use Drupal\Core\Link;
Chris@0 8 use Drupal\Core\Render\RenderableInterface;
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Used to return generated breadcrumbs with associated cacheability metadata.
Chris@0 12 */
Chris@0 13 class Breadcrumb implements RenderableInterface, RefinableCacheableDependencyInterface {
Chris@0 14
Chris@0 15 use RefinableCacheableDependencyTrait;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * An ordered list of links for the breadcrumb.
Chris@0 19 *
Chris@0 20 * @var \Drupal\Core\Link[]
Chris@0 21 */
Chris@0 22 protected $links = [];
Chris@0 23
Chris@0 24 /**
Chris@0 25 * Gets the breadcrumb links.
Chris@0 26 *
Chris@0 27 * @return \Drupal\Core\Link[]
Chris@0 28 */
Chris@0 29 public function getLinks() {
Chris@0 30 return $this->links;
Chris@0 31 }
Chris@0 32
Chris@0 33 /**
Chris@0 34 * Sets the breadcrumb links.
Chris@0 35 *
Chris@0 36 * @param \Drupal\Core\Link[] $links
Chris@0 37 * The breadcrumb links.
Chris@0 38 *
Chris@0 39 * @return $this
Chris@0 40 *
Chris@0 41 * @throws \LogicException
Chris@0 42 * Thrown when setting breadcrumb links after they've already been set.
Chris@0 43 */
Chris@0 44 public function setLinks(array $links) {
Chris@0 45 if (!empty($this->links)) {
Chris@0 46 throw new \LogicException('Once breadcrumb links are set, only additional breadcrumb links can be added.');
Chris@0 47 }
Chris@0 48
Chris@0 49 $this->links = $links;
Chris@0 50
Chris@0 51 return $this;
Chris@0 52 }
Chris@0 53
Chris@0 54 /**
Chris@0 55 * Appends a link to the end of the ordered list of breadcrumb links.
Chris@0 56 *
Chris@0 57 * @param \Drupal\Core\Link $link
Chris@0 58 * The link appended to the breadcrumb.
Chris@0 59 *
Chris@0 60 * @return $this
Chris@0 61 */
Chris@0 62 public function addLink(Link $link) {
Chris@0 63 $this->links[] = $link;
Chris@0 64
Chris@0 65 return $this;
Chris@0 66 }
Chris@0 67
Chris@0 68 /**
Chris@0 69 * {@inheritdoc}
Chris@0 70 */
Chris@0 71 public function toRenderable() {
Chris@0 72 $build = [
Chris@0 73 '#cache' => [
Chris@0 74 'contexts' => $this->cacheContexts,
Chris@0 75 'tags' => $this->cacheTags,
Chris@0 76 'max-age' => $this->cacheMaxAge,
Chris@0 77 ],
Chris@0 78 ];
Chris@0 79 if (!empty($this->links)) {
Chris@0 80 $build += [
Chris@0 81 '#theme' => 'breadcrumb',
Chris@0 82 '#links' => $this->links,
Chris@0 83 ];
Chris@0 84 }
Chris@0 85 return $build;
Chris@0 86 }
Chris@0 87
Chris@0 88 }