You are here

class PostBlock in Open Social 8.8

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  2. 8 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  3. 8.2 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  4. 8.3 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  5. 8.4 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  6. 8.5 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  7. 8.6 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  8. 8.7 modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  9. 10.3.x modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  10. 10.0.x modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  11. 10.1.x modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock
  12. 10.2.x modules/social_features/social_post/src/Plugin/Block/PostBlock.php \Drupal\social_post\Plugin\Block\PostBlock

Provides a 'PostBlock' block.

Plugin annotation


@Block(
  id = "post_block",
  admin_label = @Translation("Post block"),
)

Hierarchy

Expanded class hierarchy of PostBlock

1 file declares its use of PostBlock
PostPhotoBlock.php in modules/social_features/social_post/modules/social_post_photo/src/Plugin/Block/PostPhotoBlock.php

File

modules/social_features/social_post/src/Plugin/Block/PostBlock.php, line 24

Namespace

Drupal\social_post\Plugin\Block
View source
class PostBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type ID.
   *
   * @var string
   */
  public $entityType;

  /**
   * The bundle.
   *
   * @var string
   */
  public $bundle;

  /**
   * The form display.
   *
   * @var string
   */
  public $formDisplay;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * PostBlock constructor.
   *
   * @param array $configuration
   *   The plugin configuration, i.e. an array with configuration values keyed
   *   by configuration option name. The special key 'context' may be used to
   *   initialize the defined contexts by setting it to an array of context
   *   values keyed by context names.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, AccountProxyInterface $current_user, FormBuilderInterface $form_builder, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityType = 'post';
    $this->bundle = 'post';
    $this->formDisplay = 'default';
    $this->entityTypeManager = $entity_type_manager;
    $this->currentUser = $current_user;
    $this->formBuilder = $form_builder;
    $this->moduleHandler = $module_handler;
    if ($module_handler
      ->moduleExists('social_post_photo')) {
      $this->bundle = 'photo';
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('current_user'), $container
      ->get('form_builder'), $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    return $this->entityTypeManager
      ->getAccessControlHandler($this->entityType)
      ->createAccess($this->bundle, $account, [], TRUE);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $values = [];

    // Specify selected bundle if the entity has bundles.
    if ($this->entityTypeManager
      ->getDefinition($this->entityType)
      ->hasKey('bundle')) {
      $bundle_key = $this->entityTypeManager
        ->getDefinition($this->entityType)
        ->getKey('bundle');
      $values = [
        $bundle_key => $this->bundle,
      ];
    }
    $entity = $this->entityTypeManager
      ->getStorage($this->entityType)
      ->create($values);
    if ($entity instanceof EntityOwnerInterface) {
      $entity
        ->setOwnerId($this->currentUser
        ->id());
    }
    $display = $this->entityTypeManager
      ->getStorage('entity_form_display')
      ->load($this->entityType . '.' . $this->bundle . '.' . $this->formDisplay);
    $form_object = $this->entityTypeManager
      ->getFormObject($entity
      ->getEntityTypeId(), 'default');
    $form_object
      ->setEntity($entity);
    $form_state = (new FormState())
      ->setFormState([]);
    $form_state
      ->set('form_display', $display);
    return $this->formBuilder
      ->buildForm($form_object, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::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. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. 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
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
PostBlock::$bundle public property The bundle.
PostBlock::$currentUser protected property The current user.
PostBlock::$entityType public property The entity type ID.
PostBlock::$entityTypeManager protected property The entity type manager.
PostBlock::$formBuilder protected property The form builder.
PostBlock::$formDisplay public property The form display.
PostBlock::$moduleHandler protected property The module handler.
PostBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess 1
PostBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
PostBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
PostBlock::__construct public function PostBlock constructor. Overrides BlockPluginTrait::__construct 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2