class Barcode in Barcodes 2.0.x

Same name in this branch

2.0.x src/Template/Barcode.php \Drupal\barcodes\Template\Barcode
2.0.x src/Plugin/Block/Barcode.php \Drupal\barcodes\Plugin\Block\Barcode
2.0.x src/Plugin/Field/FieldFormatter/Barcode.php \Drupal\barcodes\Plugin\Field\FieldFormatter\Barcode

Same name and namespace in other branches

8 src/Plugin/Field/FieldFormatter/Barcode.php \Drupal\barcodes\Plugin\Field\FieldFormatter\Barcode

Plugin implementation of the 'barcode' formatter.

Plugin annotation


@FieldFormatter(
  id = "barcode",
  label = @Translation("Barcode"),
  field_types = {
    "email",
    "integer",
    "link",
    "string",
    "telephone",
    "text",
    "text_long",
    "text_with_summary",
    "bigint",
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\barcodes\Plugin\Field\FieldFormatter\Barcode

Expanded class hierarchy of Barcode

File

src/Plugin/Field/FieldFormatter/Barcode.php, line 30

Namespace

Drupal\barcodes\Plugin\Field\FieldFormatter

View source

class Barcode extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'type' => 'QRCODE',
      'format' => 'SVG',
      'color' => '#000000',
      'height' => 100,
      'width' => 100,
      'padding_top' => 0,
      'padding_right' => 0,
      'padding_bottom' => 0,
      'padding_left' => 0,
      'show_value' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $generator = new BarcodeGenerator();
    $settings['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Barcode Type'),
      '#description' => $this
        ->t('The Barcode type.'),
      '#options' => array_combine($generator
        ->getTypes(), $generator
        ->getTypes()),
      '#default_value' => $this
        ->getSetting('type'),
    ];
    $settings['format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Display Format'),
      '#description' => $this
        ->t('The display format, e.g. png, svg, jpg.'),
      '#options' => [
        'PNG' => 'PNG Image',
        'SVG' => 'SVG Image',
        'HTMLDIV' => 'HTML DIV',
        'UNICODE' => 'Unicode String',
        'BINARY' => 'Binary String',
      ],
      '#default_value' => $this
        ->getSetting('format'),
    ];
    $settings['color'] = [
      '#type' => 'color',
      '#title' => $this
        ->t('Color'),
      '#default_value' => $this
        ->getSetting('color'),
      '#description' => $this
        ->t('The color code.'),
    ];
    $settings['height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#size' => 10,
      '#default_value' => $this
        ->getSetting('height'),
      '#description' => $this
        ->t('The height in pixels.'),
    ];
    $settings['width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#size' => 10,
      '#default_value' => $this
        ->getSetting('width'),
      '#description' => $this
        ->t('The width in pixels'),
    ];
    $settings['padding_top'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Padding-Top'),
      '#size' => 4,
      '#maxlength' => 4,
      '#default_value' => $this
        ->getSetting('padding_top'),
      '#description' => $this
        ->t('The top padding in pixels'),
    ];
    $settings['padding_right'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Padding-Right'),
      '#size' => 4,
      '#maxlength' => 4,
      '#default_value' => $this
        ->getSetting('padding_right'),
      '#description' => $this
        ->t('The right padding in pixels'),
    ];
    $settings['padding_bottom'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Padding-Bottom'),
      '#size' => 4,
      '#maxlength' => 4,
      '#default_value' => $this
        ->getSetting('padding_bottom'),
      '#description' => $this
        ->t('The bottom padding in pixels'),
    ];
    $settings['padding_left'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Padding-Left'),
      '#size' => 4,
      '#maxlength' => 4,
      '#default_value' => $this
        ->getSetting('padding_left'),
      '#description' => $this
        ->t('The left padding in pixels'),
    ];
    $settings['show_value'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show value'),
      '#default_value' => $this
        ->getSetting('show_value'),
      '#description' => $this
        ->t('Show the actual value in addition to the barcode'),
    ];
    return $settings + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary[] = $this
      ->t('Type: %type </br> Display format: %format', [
      '%type' => $this
        ->getSetting('type'),
      '%format' => $this
        ->getSetting('format'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $token_service = \Drupal::token();
    $generator = new BarcodeGenerator();
    foreach ($items as $delta => $item) {
      $suffix = str_replace('+', 'plus', strtolower($this
        ->getSetting('type')));
      $tokens = [];
      if ($entity = $items
        ->getEntity()) {
        $tokens[$entity
          ->getEntityTypeId()] = $entity;
      }
      $value = $token_service
        ->replace($this
        ->viewValue($item), $tokens);
      $elements[$delta] = [
        '#theme' => 'barcode__' . $suffix,
        '#attached' => [
          'library' => [
            'barcodes/' . $suffix,
          ],
        ],
        '#type' => $this
          ->getSetting('type'),
        '#value' => $value,
        '#width' => $this
          ->getSetting('width'),
        '#height' => $this
          ->getSetting('height'),
        '#color' => $this
          ->getSetting('color'),
        '#padding_top' => $this
          ->getSetting('padding_top'),
        '#padding_right' => $this
          ->getSetting('padding_right'),
        '#padding_bottom' => $this
          ->getSetting('padding_bottom'),
        '#padding_left' => $this
          ->getSetting('padding_left'),
        '#show_value' => $this
          ->getSetting('show_value'),
      ];
      try {
        $barcode = $generator
          ->getBarcodeObj($this
          ->getSetting('type'), $value, $this
          ->getSetting('width'), $this
          ->getSetting('height'), $this
          ->getSetting('color'), [
          $this
            ->getSetting('padding-top'),
          $this
            ->getSetting('padding-right'),
          $this
            ->getSetting('padding-bottom'),
          $this
            ->getSetting('padding-left'),
        ]);
        $elements[$delta]['#format'] = $this
          ->getSetting('format');
        $elements[$delta]['#svg'] = $barcode
          ->getSvgCode();
        $elements[$delta]['#png'] = "<img alt=\"Embedded Image\" src=\"data:image/png;base64," . base64_encode($barcode
          ->getPngData()) . "\" />";
        $elements[$delta]['#htmldiv'] = $barcode
          ->getHtmlDiv();
        $elements[$delta]['#unicode'] = "<pre style=\"font-family:monospace;line-height:0.61em;font-size:6px;\">" . $barcode
          ->getGrid(json_decode('"\\u00A0"'), json_decode('"\\u2584"')) . "</pre>";
        $elements[$delta]['#binary'] = "<pre style=\"font-family:monospace;\">" . $barcode
          ->getGrid() . "</pre>";
        $elements[$delta]['#barcode'] = $elements[$delta]['#' . strtolower($this
          ->getSetting('format'))];
        $elements[$delta]['#extended_value'] = $barcode
          ->getExtendedCode();
      } catch (\Exception $e) {

        /** @var \Drupal\Core\Logger\LoggerChannelInterface $logger */
        $logger = \Drupal::service('logger.factory')
          ->get('barcodes');
        $logger
          ->error('Error: @error, given: @value', [
          '@error' => $e
            ->getMessage(),
          '@value' => $this
            ->viewValue($item),
        ]);
      }
    }
    return $elements;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {
    if ($item
      ->mainPropertyName()) {
      $value = $item
        ->__get($item
        ->mainPropertyName());
    }
    else {
      $value = $item
        ->getValue();
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Barcode::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
Barcode::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
Barcode::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
Barcode::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
Barcode::viewValue	protected	function	Generate the output appropriate for one field item.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	12
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	12
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.

You are here

class Barcode in Barcodes 2.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation