class Broken

Same name in this branch
  1. 10 core/modules/views/src/Plugin/views/sort/Broken.php \Drupal\views\Plugin\views\sort\Broken
  2. 10 core/modules/views/src/Plugin/views/field/Broken.php \Drupal\views\Plugin\views\field\Broken
  3. 10 core/modules/views/src/Plugin/views/relationship/Broken.php \Drupal\views\Plugin\views\relationship\Broken
  4. 10 core/modules/views/src/Plugin/views/filter/Broken.php \Drupal\views\Plugin\views\filter\Broken
  5. 10 core/modules/views/src/Plugin/views/area/Broken.php \Drupal\views\Plugin\views\area\Broken
  6. 10 core/modules/views/src/Plugin/views/argument/Broken.php \Drupal\views\Plugin\views\argument\Broken
  7. 10 core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/Broken.php \Drupal\Core\Entity\Plugin\EntityReferenceSelection\Broken
Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/sort/Broken.php \Drupal\views\Plugin\views\sort\Broken
  2. 9 core/modules/views/src/Plugin/views/field/Broken.php \Drupal\views\Plugin\views\field\Broken
  3. 9 core/modules/views/src/Plugin/views/relationship/Broken.php \Drupal\views\Plugin\views\relationship\Broken
  4. 9 core/modules/views/src/Plugin/views/filter/Broken.php \Drupal\views\Plugin\views\filter\Broken
  5. 9 core/modules/views/src/Plugin/views/area/Broken.php \Drupal\views\Plugin\views\area\Broken
  6. 9 core/modules/views/src/Plugin/views/argument/Broken.php \Drupal\views\Plugin\views\argument\Broken
  7. 9 core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/Broken.php \Drupal\Core\Entity\Plugin\EntityReferenceSelection\Broken
  8. 9 core/lib/Drupal/Core/Block/Plugin/Block/Broken.php \Drupal\Core\Block\Plugin\Block\Broken
  9. 8.9.x core/modules/views/src/Plugin/views/sort/Broken.php \Drupal\views\Plugin\views\sort\Broken
  10. 8.9.x core/modules/views/src/Plugin/views/field/Broken.php \Drupal\views\Plugin\views\field\Broken
  11. 8.9.x core/modules/views/src/Plugin/views/relationship/Broken.php \Drupal\views\Plugin\views\relationship\Broken
  12. 8.9.x core/modules/views/src/Plugin/views/filter/Broken.php \Drupal\views\Plugin\views\filter\Broken
  13. 8.9.x core/modules/views/src/Plugin/views/area/Broken.php \Drupal\views\Plugin\views\area\Broken
  14. 8.9.x core/modules/views/src/Plugin/views/argument/Broken.php \Drupal\views\Plugin\views\argument\Broken
  15. 8.9.x core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/Broken.php \Drupal\Core\Entity\Plugin\EntityReferenceSelection\Broken
  16. 8.9.x core/lib/Drupal/Core/Block/Plugin/Block/Broken.php \Drupal\Core\Block\Plugin\Block\Broken
  17. 11.x core/modules/views/src/Plugin/views/sort/Broken.php \Drupal\views\Plugin\views\sort\Broken
  18. 11.x core/modules/views/src/Plugin/views/field/Broken.php \Drupal\views\Plugin\views\field\Broken
  19. 11.x core/modules/views/src/Plugin/views/relationship/Broken.php \Drupal\views\Plugin\views\relationship\Broken
  20. 11.x core/modules/views/src/Plugin/views/filter/Broken.php \Drupal\views\Plugin\views\filter\Broken
  21. 11.x core/modules/views/src/Plugin/views/area/Broken.php \Drupal\views\Plugin\views\area\Broken
  22. 11.x core/modules/views/src/Plugin/views/argument/Broken.php \Drupal\views\Plugin\views\argument\Broken
  23. 11.x core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/Broken.php \Drupal\Core\Entity\Plugin\EntityReferenceSelection\Broken
  24. 11.x core/lib/Drupal/Core/Block/Plugin/Block/Broken.php \Drupal\Core\Block\Plugin\Block\Broken

Defines a fallback plugin for missing block plugins.

Hierarchy

Expanded class hierarchy of Broken

2 files declare their use of Broken
BlockManagerTest.php in core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php
ConfigImporterMissingContentTest.php in core/tests/Drupal/KernelTests/Core/Config/ConfigImporterMissingContentTest.php
22 string references to 'Broken'
BlockManager::getFallbackPluginId in core/lib/Drupal/Core/Block/BlockManager.php
Gets a fallback id for a missing plugin.
BlockManagerTest::testDefinitions in core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php
@covers ::getDefinitions
BlockManagerTest::testHandlePluginNotFound in core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php
@covers ::handlePluginNotFound
BlockResourceTestBase::getExpectedNormalizedEntity in core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php
Returns the expected normalization of the entity.
BlockTest::getExpectedDocument in core/modules/jsonapi/tests/src/Functional/BlockTest.php
Returns the expected JSON:API document for the entity.

... See full list

File

core/lib/Drupal/Core/Block/Plugin/Block/Broken.php, line 19

Namespace

Drupal\Core\Block\Plugin\Block
View source
class Broken extends PluginBase implements BlockPluginInterface, ContainerFactoryPluginInterface {
    use BlockPluginTrait;
    use CacheableDependencyTrait;
    
    /**
     * The current user.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $currentUser;
    
    /**
     * Creates a Broken Block instance.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Session\AccountInterface $current_user
     *   The current user.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, AccountInterface $current_user) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->currentUser = $current_user;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('current_user'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $build = [];
        if ($this->currentUser
            ->hasPermission('administer blocks')) {
            $build += $this->brokenMessage();
        }
        return $build;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        return $this->brokenMessage();
    }
    
    /**
     * Generate message with debugging information as to why the block is broken.
     *
     * @return array
     *   Render array containing debug information.
     */
    protected function brokenMessage() {
        $build['message'] = [
            '#markup' => $this->t('This block is broken or missing. You may be missing content or you might need to install the original module.'),
        ];
        return $build;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 18
BlockPluginTrait::blockSubmit public function 12
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual
block plugins can add elements to this form by overriding
BlockBase::blockForm(). Most block plugins should not override this
method unless they need to alter the generic form elements.
BlockPluginTrait::calculateDependencies public function 1
BlockPluginTrait::defaultConfiguration public function 18
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
Broken::$currentUser protected property The current user.
Broken::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
Broken::brokenMessage protected function Generate message with debugging information as to why the block is broken.
Broken::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
Broken::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Broken::__construct public function Creates a Broken Block instance. Overrides BlockPluginTrait::__construct
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::getCacheContexts public function 4
CacheableDependencyTrait::getCacheMaxAge public function 4
CacheableDependencyTrait::getCacheTags public function 4
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.