class MockMenuBlockDeriver

Same name in other branches
  1. 9 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php \Drupal\plugin_test\Plugin\plugin_test\mock_block\MockMenuBlockDeriver
  2. 8.9.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php \Drupal\plugin_test\Plugin\plugin_test\mock_block\MockMenuBlockDeriver
  3. 11.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php \Drupal\plugin_test\Plugin\plugin_test\mock_block\MockMenuBlockDeriver

Mock implementation of DeriverInterface for the mock menu block plugin.

Hierarchy

Expanded class hierarchy of MockMenuBlockDeriver

See also

\Drupal\plugin_test\Plugin\MockBlockManager

File

core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/mock_block/MockMenuBlockDeriver.php, line 13

Namespace

Drupal\plugin_test\Plugin\plugin_test\mock_block
View source
class MockMenuBlockDeriver implements DeriverInterface {
    use StringTranslationTrait;
    
    /**
     * {@inheritdoc}
     */
    public function getDerivativeDefinition($derivative_id, $base_plugin_definition) {
        $derivatives = $this->getDerivativeDefinitions($base_plugin_definition);
        if (isset($derivatives[$derivative_id])) {
            return $derivatives[$derivative_id];
        }
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDerivativeDefinitions($base_plugin_definition) {
        // This isn't strictly necessary, but it helps reduce clutter in
        // DerivativePluginTest::testDerivativeDecorator()'s $expected variable.
        // Since derivative definitions don't need further deriving, we remove this
        // key from the returned definitions.
        unset($base_plugin_definition['deriver']);
        // Here, we create some mock menu block definitions for menus that might
        // exist in a typical Drupal site. In a real implementation, we would query
        // Drupal's configuration to find out which menus actually exist.
        $derivatives = [
            'main_menu' => [
                'label' => $this->t('Main menu'),
            ] + $base_plugin_definition,
            'navigation' => [
                'label' => $this->t('Navigation'),
            ] + $base_plugin_definition,
            'foo' => [
                // Instead of the derivative label, the specific label will be used.
'label' => $this->t('Derivative label'),
                // This setting will be merged in.
'setting' => 'default',
            ] + $base_plugin_definition,
        ];
        return $derivatives;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
MockMenuBlockDeriver::getDerivativeDefinition public function Overrides DeriverInterface::getDerivativeDefinition
MockMenuBlockDeriver::getDerivativeDefinitions public function Overrides DeriverInterface::getDerivativeDefinitions
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.