class PageUrlQrCodeBlock in Page URL QR Code Block 8

Provides my custom block.

Plugin annotation


@Block(
  id = "page_url_qr_code_block",
  admin_label = @Translation("Page URL QR Code"),
  category = @Translation("Blocks")
)

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\page_url_qr_code_block\Plugin\Block\PageUrlQrCodeBlock implements BlockPluginInterface

Expanded class hierarchy of PageUrlQrCodeBlock

File

src/Plugin/Block/PageUrlQrCodeBlock.php, line 23: Contains \Drupal\page_url_qr_code_block\Plugin\Block\page_url_qr_code_block.

Namespace

Drupal\page_url_qr_code_block\Plugin\Block

View source

class PageUrlQrCodeBlock extends BlockBase implements BlockPluginInterface {

  /**
   * Constructs a new BookNavigationBlock instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $default_config = \Drupal::config('page_url_qr_code_block.settings');
    return array(
      'page_url_qr_code_caption' => $default_config
        ->get('page_url_qr_code_block.page_url_qr_code_caption'),
      'page_url_qr_code_alt' => $default_config
        ->get('page_url_qr_code_block.page_url_qr_code_alt'),
      'page_url_qr_code_width_height' => $default_config
        ->get('page_url_qr_code_block.page_url_qr_code_width_height'),
      'page_url_qr_code_api' => $default_config
        ->get('page_url_qr_code_block.page_url_qr_code_api'),
    );
  }

  /**
   * {@inheritdoc}
   */
  function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['page_url_qr_code_caption'] = array(
      '#type' => 'textfield',
      '#title' => t('Caption'),
      '#description' => t('Will display under the QR Code'),
      '#default_value' => isset($config['page_url_qr_code_caption']) ? $config['page_url_qr_code_caption'] : 'Page URL',
    );
    $form['page_url_qr_code_alt'] = array(
      '#type' => 'textfield',
      '#title' => t('Alt Text'),
      '#default_value' => isset($config['page_url_qr_code_alt']) ? $config['page_url_qr_code_alt'] : 'QR code for this page URL',
    );
    $form['page_url_qr_code_width_height'] = array(
      '#type' => 'textfield',
      '#title' => t('QR Code Width & Height'),
      '#description' => t('Width & Height will be same. i.e. 150'),
      '#default_value' => isset($config['page_url_qr_code_width_height']) ? $config['page_url_qr_code_width_height'] : '150',
    );
    $form['page_url_qr_code_api'] = array(
      '#type' => 'radios',
      '#title' => t('Select API'),
      '#description' => t('Select other API where Google is restricted'),
      '#options' => array(
        'google' => 'Google API (recommended)',
        'liantu' => 'Liantu API',
      ),
      '#default_value' => isset($config['page_url_qr_code_api']) ? $config['page_url_qr_code_api'] : 'google',
    );
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function build() {
    global $base_url;
    $path = \Drupal::request()
      ->getRequestUri();
    $path = \Drupal::service('path.alias_manager')
      ->getAliasByPath($path);
    $width = $this->configuration['page_url_qr_code_width_height'];
    $api = $this->configuration['page_url_qr_code_api'];
    $page_url = urlencode($base_url . $path);
    if ('liantu' == $api) {
      $url = "//qr.liantu.com/api.php?bg=ffffff&w={$width}&text={$page_url}";
    }
    else {
      $url = "//chart.apis.google.com/chart?chs={$width}x{$width}&cht=qr&chl={$page_url}";
    }
    return array(
      '#theme' => 'page_url_qr_code_block',
      '#url' => $url,
      '#alt' => $this->configuration['page_url_qr_code_alt'],
      '#width' => $width,
      '#height' => $this->configuration['page_url_qr_code_width_height'],
      '#caption' => $this->configuration['page_url_qr_code_caption'],
      '#attached' => array(
        'library' => array(
          'page_url_qr_code_block/page_url_qr_code_block_style',
        ),
      ),
      '#cache' => [
        'contexts' => [
          'url',
        ],
        'max-age' => 0,
      ],
    );
  }

}

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::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.
PageUrlQrCodeBlock::blockForm		function	Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
PageUrlQrCodeBlock::blockSubmit	public	function	Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
PageUrlQrCodeBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
PageUrlQrCodeBlock::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides BlockPluginTrait::defaultConfiguration
PageUrlQrCodeBlock::__construct	public	function	Constructs a new BookNavigationBlock instance. Overrides BlockPluginTrait::__construct
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 PageUrlQrCodeBlock in Page URL QR Code Block 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation