class BlockUploadBlock in Block Upload 8

Same name in this branch

8 src/Plugin/Derivative/BlockUploadBlock.php \Drupal\block_upload\Plugin\Derivative\BlockUploadBlock
8 src/Plugin/Block/BlockUploadBlock.php \Drupal\block_upload\Plugin\Block\BlockUploadBlock

Provides a Custom block.

Plugin annotation


@Block(
  id = "block_upload",
  admin_label = @Translation("Block Upload"),
  category = @Translation("Block Upload"),
  deriver = "Drupal\block_upload\Plugin\Derivative\BlockUploadBlock"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\block_upload\Plugin\Block\BlockUploadBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of BlockUploadBlock

File

src/Plugin/Block/BlockUploadBlock.php, line 23

Namespace

Drupal\block_upload\Plugin\Block

View source

class BlockUploadBlock extends BlockBase implements ContainerFactoryPluginInterface {
  protected $account;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, AccountProxyInterface $account) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->account = $account;
  }

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

  /**
   * Build the content for mymodule block.
   */
  public function build() {
    if (!$this->account
      ->hasPermission('block upload')) {
      return [];
    }
    $block_id = $this
      ->getDerivativeId();
    return [
      BlockUploadManager::blockUploadBuildBlockContent($block_id),
      '#cache' => [
        'max-age' => 0,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $block_id = $this
      ->getDerivativeId();
    $form = parent::blockForm($form, $form_state);

    // Retrieve existing configuration for this block.
    $config = $this
      ->getConfiguration();

    // Add a form field to the existing block configuration form.
    $fields = BlockUploadManager::blockUploadGetFieldList();
    $form['block_upload_' . $block_id . '_field'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Field'),
      '#description' => $this
        ->t('Select field you wish to upload file.'),
      '#options' => $fields,
      '#default_value' => \Drupal::state()
        ->get('block_upload_' . $block_id . '_field') ?: '',
      '#ajax' => [
        'callback' => [
          $this,
          'blockUploadAjaxCallback',
        ],
        'wrapper' => 'config',
        'effect' => 'fade',
      ],
    ];
    $form['block_upload_id'] = [
      '#type' => 'textfield',
      '#default_value' => $block_id,
      '#access' => FALSE,
    ];

    // Add field additional display options.
    $field_name = \Drupal::state()
      ->get('block_upload_' . $block_id . '_field') ?: '';
    $field = FieldStorageConfig::loadByName(explode('.', $field_name)[0], explode('.', $field_name)[1]);
    if (!empty($field)) {
      BlockUploadManager::blockUploadFieldOptionsFormElements($form, $block_id, $field
        ->getType());
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $block_id = 'block_upload_' . $form_state
      ->getValue('block_upload_id') . '_';
    \Drupal::state()
      ->set($block_id . 'field', $form_state
      ->getValue($block_id . 'field'));
    $settings = [];
    $settings['alt'] = $form_state
      ->getValue([
      'config',
      $block_id . 'alt',
    ]);
    $settings['title'] = $form_state
      ->getValue([
      'config',
      $block_id . 'title',
    ]);
    $settings['desc'] = $form_state
      ->getValue([
      'config',
      $block_id . 'desc',
    ]);
    $settings['plupload'] = $form_state
      ->getValue($block_id . 'plupload_status');
    \Drupal::state()
      ->set($block_id . 'settings', $settings);
  }

  /**
   * Display fields checkboxes depends on selected field.
   */
  public function blockUploadAjaxCallback(array &$form, FormStateInterface $form_state) {
    $block_upload_id = $form_state
      ->getValue([
      'settings',
      'block_upload_id',
    ]);
    if (empty($form_state
      ->getValue([
      'settings',
      'block_upload_' . $block_upload_id . '_field',
    ]))) {
      return;
    }
    $field_name = $form_state
      ->getValue([
      'settings',
      'block_upload_' . $block_upload_id . '_field',
    ]);
    $field = field_info_field($field_name);
    BlockUploadManager::blockUploadFieldOptionsFormElements($form, $block_upload_id, $field['type']);
    return $form['config'];
  }

}

Members

Name	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::blockAccess	protected	function	Indicates whether the block should be shown.	16
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
BlockUploadBlock::$account	protected	property
BlockUploadBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
BlockUploadBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
BlockUploadBlock::blockUploadAjaxCallback	public	function	Display fields checkboxes depends on selected field.
BlockUploadBlock::build	public	function	Build the content for mymodule block. Overrides BlockPluginInterface::build
BlockUploadBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockUploadBlock::__construct	public	function	Overrides BlockPluginTrait::__construct
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
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

You are here

class BlockUploadBlock in Block Upload 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation