You are here

Home » API reference » Drupal 9 » Block.php

class Block in Drupal 9

Same name in this branch
  1. 9 core/modules/block/src/Entity/Block.php \Drupal\block\Entity\Block
  2. 9 core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
  3. 9 core/modules/views/src/Plugin/views/display/Block.php \Drupal\views\Plugin\views\display\Block
  4. 9 core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block
Same name and namespace in other branches
  1. 8 core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block

Drupal block source from database.

For available configuration keys, refer to the parent classes:

Plugin annotation


@MigrateSource(
  id = "block",
  source_module = "block"
)

Hierarchy

Expanded class hierarchy of Block

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

2 files declare their use of Block
BlockTranslation.php in core/modules/block/src/Plugin/migrate/source/d6/BlockTranslation.php
BlockTranslation.php in core/modules/block/src/Plugin/migrate/source/d7/BlockTranslation.php
41 string references to 'Block'
block.info.yml in core/modules/block/block.info.yml
core/modules/block/block.info.yml
block.schema.yml in core/modules/block/config/schema/block.schema.yml
core/modules/block/config/schema/block.schema.yml
BlockLibraryController::listBlocks in core/modules/block/src/Controller/BlockLibraryController.php
Shows a list of blocks that can be added to a theme's layout.
BlockListBuilder::buildBlocksForm in core/modules/block/src/BlockListBuilder.php
Builds the main "Blocks" portion of the form.
BlockManagerTest::setUp in core/tests/Drupal/Tests/Core/Block/BlockManagerTest.php

... See full list

File

core/modules/block/src/Plugin/migrate/source/Block.php, line 20

Namespace

Drupal\block\Plugin\migrate\source
View source 
class Block extends DrupalSqlBase {

  /**
   * The default theme name.
   *
   * @var string
   */
  protected $defaultTheme;

  /**
   * The admin theme name.
   *
   * @var string
   */
  protected $adminTheme;

  /**
   * Table containing block configuration.
   *
   * @var string
   */
  protected $blockTable;

  /**
   * Table mapping blocks to user roles.
   *
   * @var string
   */
  protected $blockRoleTable;

  /**
   * Table listing user roles.
   *
   * @var string
   */
  protected $userRoleTable;

  /**
   * {@inheritdoc}
   */
  public function query() {
    if ($this
      ->getModuleSchemaVersion('system') >= 7000) {
      $this->blockTable = 'block';
      $this->blockRoleTable = 'block_role';
    }
    else {
      $this->blockTable = 'blocks';
      $this->blockRoleTable = 'blocks_roles';
    }

    // Drupal 6 & 7 both use the same name for the user roles table.
    $this->userRoleTable = 'role';
    return $this
      ->select($this->blockTable, 'b')
      ->fields('b');
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $this->defaultTheme = $this
      ->variableGet('theme_default', 'Garland');
    $this->adminTheme = $this
      ->variableGet('admin_theme', NULL);
    return parent::initializeIterator();
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'bid' => $this
        ->t('The block numeric identifier.'),
      'module' => $this
        ->t('The module providing the block.'),
      'delta' => $this
        ->t("The block's delta."),
      'theme' => $this
        ->t('Which theme the block is placed in.'),
      'status' => $this
        ->t('Whether or not the block is enabled.'),
      'weight' => $this
        ->t('Weight of the block for ordering within regions.'),
      'region' => $this
        ->t('Region the block is placed in.'),
      'visibility' => $this
        ->t('Visibility expression.'),
      'pages' => $this
        ->t('Pages list.'),
      'title' => $this
        ->t('Block title.'),
      'cache' => $this
        ->t('Cache rule.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['module']['type'] = 'string';
    $ids['delta']['type'] = 'string';
    $ids['theme']['type'] = 'string';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $row
      ->setSourceProperty('default_theme', $this->defaultTheme);
    $row
      ->setSourceProperty('admin_theme', $this->adminTheme);
    $module = $row
      ->getSourceProperty('module');
    $delta = $row
      ->getSourceProperty('delta');
    $query = $this
      ->select($this->blockRoleTable, 'br')
      ->fields('br', [
      'rid',
    ])
      ->condition('module', $module)
      ->condition('delta', $delta);
    $query
      ->join($this->userRoleTable, 'ur', '[br].[rid] = [ur].[rid]');
    $roles = $query
      ->execute()
      ->fetchCol();
    $row
      ->setSourceProperty('roles', $roles);
    $settings = [];
    switch ($module) {
      case 'aggregator':
        list($type, $id) = explode('-', $delta);
        if ($type == 'feed') {
          $item_count = $this
            ->select('aggregator_feed', 'af')
            ->fields('af', [
            'block',
          ])
            ->condition('fid', $id)
            ->execute()
            ->fetchField();
        }
        else {
          $item_count = $this
            ->select('aggregator_category', 'ac')
            ->fields('ac', [
            'block',
          ])
            ->condition('cid', $id)
            ->execute()
            ->fetchField();
        }
        $settings['aggregator']['item_count'] = $item_count;
        break;
      case 'book':
        $settings['book']['block_mode'] = $this
          ->variableGet('book_block_mode', 'all pages');
        break;
      case 'forum':
        $settings['forum']['block_num'] = $this
          ->variableGet('forum_block_num_' . $delta, 5);
        break;
      case 'statistics':
        foreach ([
          'statistics_block_top_day_num',
          'statistics_block_top_all_num',
          'statistics_block_top_last_num',
        ] as $name) {
          $settings['statistics'][$name] = $this
            ->variableGet($name, 0);
        }
        break;
      case 'user':
        switch ($delta) {
          case 2:
          case 'new':
            $settings['user']['block_whois_new_count'] = $this
              ->variableGet('user_block_whois_new_count', 5);
            break;
          case 3:
          case 'online':
            $settings['user']['block_seconds_online'] = $this
              ->variableGet('user_block_seconds_online', 900);
            $settings['user']['max_list_count'] = $this
              ->variableGet('user_block_max_list_count', 10);
            break;
        }
        break;
    }
    $row
      ->setSourceProperty('settings', $settings);
    return parent::prepareRow($row);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Block::$adminTheme protected property The admin theme name.
Block::$blockRoleTable protected property Table mapping blocks to user roles.
Block::$blockTable protected property Table containing block configuration.
Block::$defaultTheme protected property The default theme name.
Block::$userRoleTable protected property Table listing user roles.
Block::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields 2
Block::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds 2
Block::initializeIterator protected function Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
Block::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow 1
Block::query public function Overrides SqlBase::query 2
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DrupalSqlBase::$entityTypeManager protected property The entity type manager.
DrupalSqlBase::$requirements protected property If the source provider is missing.
DrupalSqlBase::$systemData protected property The contents of the system table.
DrupalSqlBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
DrupalSqlBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides SqlBase::checkRequirements 4
DrupalSqlBase::create public static function Creates an instance of the plugin. Overrides SqlBase::create 3
DrupalSqlBase::getModuleSchemaVersion protected function Retrieves a module schema_version from the source Drupal database.
DrupalSqlBase::getSystemData public function Retrieves all system data information from the source Drupal database.
DrupalSqlBase::moduleExists protected function Checks if a given module is enabled in the source Drupal database.
DrupalSqlBase::variableGet protected function Reads a variable from a source Drupal database.
DrupalSqlBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 6
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
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 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
SourcePluginBase::$cache protected property The backend cache.
SourcePluginBase::$cacheCounts protected property Whether this instance should cache the source count. 1
SourcePluginBase::$cacheKey protected property Key to use for caching counts.
SourcePluginBase::$currentRow protected property The current row from the query.
SourcePluginBase::$currentSourceIds protected property The primary key of the current row.
SourcePluginBase::$highWaterProperty protected property Information on the property used as the high-water mark.
SourcePluginBase::$highWaterStorage protected property The key-value storage for the high-water value.
SourcePluginBase::$idMap protected property The migration ID map.
SourcePluginBase::$iterator protected property The iterator to iterate over the source rows.
SourcePluginBase::$mapRowAdded protected property Flags whether source plugin will read the map row and add to data row.
SourcePluginBase::$migration protected property The entity migration object.
SourcePluginBase::$moduleHandler protected property The module handler service. 2
SourcePluginBase::$originalHighWater protected property The high water mark at the beginning of the import operation.
SourcePluginBase::$skipCount protected property Whether this instance should not attempt to count the source. 1
SourcePluginBase::$trackChanges protected property Flags whether to track changes to incoming data. 1
SourcePluginBase::aboveHighwater protected function Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::count public function Gets the source count. 9
SourcePluginBase::current public function
SourcePluginBase::getCache protected function Gets the cache object.
SourcePluginBase::getCurrentIds public function Gets the currentSourceIds data member.
SourcePluginBase::getHighWater protected function The current value of the high water mark.
SourcePluginBase::getHighWaterField protected function Get the name of the field used as the high watermark.
SourcePluginBase::getHighWaterProperty protected function Get information on the property used as the high watermark.
SourcePluginBase::getHighWaterStorage protected function Get the high water storage object.
SourcePluginBase::getIterator protected function Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler protected function Gets the module handler.
SourcePluginBase::getSourceModule public function Gets the source module providing the source data. Overrides MigrateSourceInterface::getSourceModule
SourcePluginBase::key public function Gets the iterator key.
SourcePluginBase::next public function
SourcePluginBase::postRollback public function Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback public function Performs pre-rollback tasks. Overrides RollbackAwareInterface::preRollback
SourcePluginBase::rewind public function Rewinds the iterator.
SourcePluginBase::rowChanged protected function Checks if the incoming row has changed since our last import.
SourcePluginBase::saveHighWater protected function Save the new high water mark.
SourcePluginBase::valid public function Checks whether the iterator is currently valid.
SqlBase::$batch protected property The count of the number of batches run.
SqlBase::$batchSize protected property Number of records to fetch from the database during each batch.
SqlBase::$database protected property The database object. 1
SqlBase::$query protected property The query string.
SqlBase::$state protected property State service for retrieving database info.
SqlBase::doCount protected function Gets the source count using countQuery(). Overrides SourcePluginBase::doCount
SqlBase::fetchNextBatch protected function Prepares query for the next set of data from the source database.
SqlBase::fetchNextRow protected function Position the iterator to the following row. Overrides SourcePluginBase::fetchNextRow
SqlBase::getDatabase public function Gets the database connection object. 2
SqlBase::mapJoinable protected function Checks if we can join against the map table. 1
SqlBase::prepareQuery protected function Adds tags and metadata to the query.
SqlBase::select protected function Wrapper for database select.
SqlBase::setUpDatabase protected function Gets a connection to the referenced database.
SqlBase::__sleep public function Overrides DependencySerializationTrait::__sleep
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.