abstract class ForumBlockBase in Zircon Profile 8

Provides a base class for Forum blocks.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
    • class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
      • class \Drupal\Core\Block\BlockBase implements BlockPluginInterface uses ContextAwarePluginAssignmentTrait
        • class \Drupal\forum\Plugin\Block\ForumBlockBase

File

core/modules/forum/src/Plugin/Block/ForumBlockBase.php, line 20

Contains \Drupal\forum\Plugin\Block\ForumBlockBase.

Namespace

Drupal\forum\Plugin\Block

abstract class ForumBlockBase extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $result = $this
      ->buildForumQuery()
      ->execute();
    $elements = array();
    if ($node_title_list = node_title_list($result)) {
      $elements['forum_list'] = $node_title_list;
      $elements['forum_more'] = array(
        '#type' => 'more_link',
        '#url' => Url::fromRoute('forum.index'),
        '#attributes' => array(
          'title' => $this
            ->t('Read the latest forum topics.'),
        ),
      );
    }
    return $elements;
  }

  /**
   * Builds the select query to use for this forum block.
   *
   * @return \Drupal\Core\Database\Query\Select
   *   A Select object.
   */
  protected abstract function buildForumQuery();

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return array(
      'properties' => array(
        'administrative' => TRUE,
      ),
      'block_count' => 5,
    );
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    return AccessResult::allowedIfHasPermission($account, 'access content');
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $range = range(2, 20);
    $form['block_count'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Number of topics'),
      '#default_value' => $this->configuration['block_count'],
      '#options' => array_combine($range, $range),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['block_count'] = $form_state
      ->getValue('block_count');
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), [
      'user.node_grants:view',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return Cache::mergeTags(parent::getCacheTags(), [
      'node_list',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockBase::$transliteration	protected	property	The transliteration service.
BlockBase::access	public	function	Indicates whether the block should be shown. Overrides BlockPluginInterface::access
BlockBase::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockBase::blockValidate	public	function	Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate	1
BlockBase::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. Overrides PluginFormInterface::buildConfigurationForm	1
BlockBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BlockBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration	1
BlockBase::getMachineNameSuggestion	public	function	Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion	1
BlockBase::label	public	function	Returns the user-facing block label. Overrides BlockPluginInterface::label
BlockBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
BlockBase::setConfigurationValue	public	function	Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue
BlockBase::setTransliteration	public	function	Sets the transliteration service.
BlockBase::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm
BlockBase::transliteration	protected	function	Wraps the transliteration service.
BlockBase::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm
BlockBase::__construct	public	function	Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct	15
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheMaxAge	public	function		7
ContextAwarePluginBase::getContext	public	function	Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ForumBlockBase::blockAccess	protected	function	Indicates whether the block should be shown. Overrides BlockBase::blockAccess
ForumBlockBase::blockForm	public	function	Returns the configuration form elements specific to this block plugin. Overrides BlockBase::blockForm
ForumBlockBase::blockSubmit	public	function	Adds block type-specific submission handling for the block form. Overrides BlockBase::blockSubmit
ForumBlockBase::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ForumBlockBase::buildForumQuery	abstract protected	function	Builds the select query to use for this forum block.	2
ForumBlockBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides BlockBase::defaultConfiguration
ForumBlockBase::getCacheContexts	public	function	Overrides ContextAwarePluginBase::getCacheContexts
ForumBlockBase::getCacheTags	public	function	Overrides ContextAwarePluginBase::getCacheTags
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	1
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	1