You are here

Home » API reference » Google QR Code Generator 8 » google_qr_code_block.php

class google_qr_code_block in Google QR Code Generator 8

Provides a Google QR Code Block

Plugin annotation


@Block(
    id = "Google QR Code",
    admin_label = @Translation ("Google QR Code"),
  )

Hierarchy

Expanded class hierarchy of google_qr_code_block

File

src/Plugin/Block/google_qr_code_block.php, line 23
Contains \Drupal\google_qr_code\Plugin\Block\google_qr_code_block

Namespace

Drupal\google_qr_code\Plugin\Block
View source 
class google_qr_code_block extends BlockBase {
  public function build() {

    // Determine render type, and get the current URL.
    $render_type = \Drupal::config('google_qr_code.settings')
      ->get('whenshow');
    $google_qr_current_url = \Drupal::request()
      ->getUri();
    $qr_code_height = \Drupal::config('google_qr_code.settings')
      ->get('height');
    $qr_code_width = \Drupal::config('google_qr_code.settings')
      ->get('width');
    if ($render_type == 'on_click') {
      $requested_url_obj = Url::fromUri($google_qr_current_url);
      $link_object = Link::fromTextAndUrl(t('Click to see QR Code for this URL'), $requested_url_obj);
      $output = $link_object
        ->toRenderable();
      $output['#class'] = 'google-qr-code-link';
      $output['#cache'] = array(
        'contexts' => array(
          'url.path',
        ),
      );
      $output['#attached']['library'][] = 'google_qr_code/google-qr-code-js';
      $output['#attached']['drupalSettings']['google_qr_code_url'] = $google_qr_current_url;
      $output['#attached']['drupalSettings']['google_qr_code_height'] = $qr_code_height;
      $output['#attached']['drupalSettings']['google_qr_code_width'] = $qr_code_width;

      // Return markup, and return the block as being cached per URL path.
      return $output;
    }
    else {

      // Get the google charts API image URL.
      $google_qr_image_url = "https://chart.googleapis.com/chart?chs=" . $qr_code_width . "x" . $qr_code_height . "&cht=qr&chl=" . $google_qr_current_url . '&chld=H|0';

      // Write the alternate description for the QR image.
      $google_qr_alt = $this
        ->t('QR Code for @url', array(
        '@url' => $google_qr_current_url,
      ));

      // Return markup, and return the block as being cached per URL path.
      return array(
        '#theme' => 'image',
        '#uri' => $google_qr_image_url,
        '#width' => $qr_code_width,
        '#height' => $qr_code_height,
        '#alt' => $google_qr_alt,
        '#class' => 'google-qr-code-image',
        '#cache' => array(
          'contexts' => array(
            'url.path',
          ),
        ),
      );
    }
  }
  public function blockAccess(AccountInterface $account) {

    //return AccessResult::allowedIfHasPermission($account, 'view rsvplist');
    return AccessResult::allowed();
  }

}

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
BlockPluginTrait::__construct public function 22
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
google_qr_code_block::blockAccess public function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
google_qr_code_block::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
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