class SystemHelpBlock

Provides a 'System Help' block.

Plugin annotation


@Plugin(
  id = "system_help_block",
  admin_label = @Translation("System Help"),
  module = "system"
)

Hierarchy

Expanded class hierarchy of SystemHelpBlock

File

drupal/core/modules/system/lib/Drupal/system/Plugin/Block/SystemHelpBlock.php, line 23
Contains \Drupal\system\Plugin\Block\SystemHelpBlock.

Namespace

Drupal\system\Plugin\Block
View source
class SystemHelpBlock extends BlockBase {

  /**
   * Stores the help text associated with the active menu item.
   *
   * @var string
   */
  protected $help;

  /**
   * Overrides \Drupal\block\BlockBase::access().
   */
  public function access() {
    $this->help = menu_get_active_help();
    return (bool) $this->help;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    return array(
      '#children' => $this->help,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::blockForm public function Returns the configuration form elements specific to this block plugin. 11
BlockBase::blockSubmit public function Adds block type-specific submission handling for the block form. 11
BlockBase::blockValidate public function Adds block type-specific validation for the block form.
BlockBase::form public function Implements \Drupal\block\BlockPluginInterface::form(). Overrides BlockPluginInterface::form 1
BlockBase::getConfig public function Returns the configuration data for the block plugin.
BlockBase::setConfig public function Sets a particular value in the block settings.
BlockBase::settings public function Returns plugin-specific settings for the block. Overrides BlockPluginInterface::settings 13
BlockBase::submit public function Implements \Drupal\block\BlockPluginInterface::submit(). Overrides BlockPluginInterface::submit
BlockBase::validate public function Implements \Drupal\block\BlockPluginInterface::validate(). Overrides BlockPluginInterface::validate
BlockBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
SystemHelpBlock::$help protected property Stores the help text associated with the active menu item.
SystemHelpBlock::access public function Overrides \Drupal\block\BlockBase::access(). Overrides BlockBase::access
SystemHelpBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build