abstract class CustomHTMLBlockBase in Content Planner 8

The base class for block base.

@todo Plugin derivates should be used instead of a class hierarchy here.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\content_planner\DashboardBlockBase implements DashboardBlockInterface, ContainerFactoryPluginInterface uses ConfigFormBaseTrait
    • class \Drupal\content_planner\Plugin\DashboardBlock\CustomHTMLBlockBase

File

src/Plugin/DashboardBlock/CustomHTMLBlockBase.php, line 14

Namespace

Drupal\content_planner\Plugin\DashboardBlock

abstract class CustomHTMLBlockBase extends DashboardBlockBase {

  /**
   * Builds the render array for the block.
   *
   * @return array
   *   The render array for the block.
   */
  public function build() {
    $build = [];

    // Get config.
    $config = $this
      ->getConfiguration();
    if (isset($config['plugin_specific_config']['content'])) {
      $build = [
        '#markup' => check_markup($config['plugin_specific_config']['content']['value'], $config['plugin_specific_config']['content']['format']),
      ];
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfigSpecificFormFields(FormStateInterface &$form_state, Request &$request, array $block_configuration) {
    $form = [];
    if (!empty($block_configuration['plugin_specific_config']['content']['value'])) {
      $default_value = $block_configuration['plugin_specific_config']['content']['value'];
    }
    else {
      $default_value = '';
    }
    $form['content'] = [
      '#type' => 'text_format',
      '#title' => t('Content'),
      '#format' => 'full_html',
      '#default_value' => $default_value,
    ];
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
CustomHTMLBlockBase::build	public	function	Builds the render array for the block. Overrides DashboardBlockBase::build
CustomHTMLBlockBase::getConfigSpecificFormFields	public	function	Add additonal form elements specific to the Plugin. Overrides DashboardBlockBase::getConfigSpecificFormFields
DashboardBlockBase::$entityTypeManager	protected	property	The route match.
DashboardBlockBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
DashboardBlockBase::getBasicConfigStructure	public static	function	Get basic configuration structure for the block configuration.
DashboardBlockBase::getConfiguration	public	function	Get Configuration passed in by Plugin Manager. Overrides DashboardBlockInterface::getConfiguration
DashboardBlockBase::getCustomConfigByKey	protected	function	Get custom config.
DashboardBlockBase::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DashboardBlockBase::getName	public	function	Return the name of the block. Overrides DashboardBlockInterface::getName
DashboardBlockBase::isConfigurable	public	function	Determines if the plugin is configurable. Overrides PluginBase::isConfigurable
DashboardBlockBase::submitSettingsForm	public	function	Submit form handler. Overrides DashboardBlockInterface::submitSettingsForm
DashboardBlockBase::validateForm	public	function	Validates teh plugin config form. Overrides DashboardBlockInterface::validateForm
DashboardBlockBase::__construct	public	function	Constructs a new UserLoginBlock instance. Overrides PluginBase::__construct	2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId