class GeneratedButton
This class holds a <button> generated from the <button> route.
Unlike \Drupal\Core\Render\Element\Button, this is not for generating buttons for forms. This class is for putting a button in a list of links such as a multi-level menu.
Hierarchy
- class \Drupal\Core\Cache\CacheableMetadata implements \Drupal\Core\Cache\RefinableCacheableDependencyInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait
- class \Drupal\Core\Render\BubbleableMetadata implements \Drupal\Core\Render\AttachmentsInterface uses \Drupal\Core\Render\AttachmentsTrait extends \Drupal\Core\Cache\CacheableMetadata
- class \Drupal\Core\GeneratedLink implements \Drupal\Component\Render\MarkupInterface, \Drupal\Core\Countable extends \Drupal\Core\Render\BubbleableMetadata
- class \Drupal\Core\GeneratedButton extends \Drupal\Core\GeneratedLink
- class \Drupal\Core\GeneratedLink implements \Drupal\Component\Render\MarkupInterface, \Drupal\Core\Countable extends \Drupal\Core\Render\BubbleableMetadata
- class \Drupal\Core\Render\BubbleableMetadata implements \Drupal\Core\Render\AttachmentsInterface uses \Drupal\Core\Render\AttachmentsTrait extends \Drupal\Core\Cache\CacheableMetadata
Expanded class hierarchy of GeneratedButton
2 files declare their use of GeneratedButton
- LinkGenerator.php in core/
lib/ Drupal/ Core/ Utility/ LinkGenerator.php - LinkGeneratorTest.php in core/
tests/ Drupal/ Tests/ Core/ Utility/ LinkGeneratorTest.php
File
-
core/
lib/ Drupal/ Core/ GeneratedButton.php, line 12
Namespace
Drupal\CoreView source
class GeneratedButton extends GeneratedLink {
/**
* {@inheritdoc}
*/
const TAG = 'button';
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
|---|---|---|---|---|
| AttachmentsTrait::$attachments | protected | property | The attachments for this response. | |
| AttachmentsTrait::addAttachments | public | function | ||
| AttachmentsTrait::getAttachments | public | function | ||
| AttachmentsTrait::setAttachments | public | function | ||
| BubbleableMetadata::addCacheableDependency | public | function | Overrides RefinableCacheableDependencyTrait::addCacheableDependency | |
| BubbleableMetadata::applyTo | public | function | Applies the values of this bubbleable metadata object to a render array. | Overrides CacheableMetadata::applyTo |
| BubbleableMetadata::createFromObject | public static | function | Creates a bubbleable metadata object from a depended object. | Overrides CacheableMetadata::createFromObject |
| BubbleableMetadata::createFromRenderArray | public static | function | Creates a bubbleable metadata object with values taken from a render array. | Overrides CacheableMetadata::createFromRenderArray |
| BubbleableMetadata::merge | public | function | Creates a new bubbleable metadata object by merging this one with another. | Overrides CacheableMetadata::merge |
| BubbleableMetadata::mergeAttachments | public static | function | Merges two attachments arrays (which live under the '#attached' key). | |
| CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |
| CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |
| CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |
| CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |
| CacheableMetadata::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts |
| CacheableMetadata::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge |
| CacheableMetadata::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags |
| CacheableMetadata::setCacheContexts | public | function | Sets cache contexts. | |
| CacheableMetadata::setCacheMaxAge | public | function | Sets the maximum age (in seconds). | |
| CacheableMetadata::setCacheTags | public | function | Sets cache tags. | |
| GeneratedButton::TAG | constant | HTML tag to use when building the link. | Overrides GeneratedLink::TAG | |
| GeneratedLink::$generatedLink | protected | property | The HTML string value containing a link. | |
| GeneratedLink::count | public | function | #[\ReturnTypeWillChange] | |
| GeneratedLink::getGeneratedLink | public | function | Gets the generated link. | |
| GeneratedLink::jsonSerialize | public | function | #[\ReturnTypeWillChange] | |
| GeneratedLink::setGeneratedLink | public | function | Sets the generated link. | |
| GeneratedLink::__toString | public | function | Returns markup. | Overrides MarkupInterface::__toString |
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | ||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.