You are here

Home » API reference » Barcode 8 » BarcodeBase.php

abstract class BarcodeBase in Barcode 8

Hierarchy

Expanded class hierarchy of BarcodeBase

1 file declares its use of BarcodeBase
BarcodeFormatterBase.php in src/Plugin/Field/FieldFormatter/BarcodeFormatterBase.php

File

src/Plugin/Field/FieldType/BarcodeBase.php, line 12

Namespace

Drupal\barcode\Plugin\Field\FieldType
View source 
abstract class BarcodeBase extends FieldItemBase {

  /**
   * @var array $types
   *   An array of barcode types this widget supports.
   */
  public static $types = [];

  /**
   * Get the standard allowed type of barcodes.
   *
   * @return array
   *   An array of barcode types.
   */
  public static abstract function standardBarcodes();

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    $settings = [
      'types' => static::standardBarcodes(),
    ];
    return $settings + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $types = $this
      ->getSetting('types');
    $element['types'] = [
      '#type' => 'textarea',
      '#title' => t('Allowed Barcode Types'),
      '#default_value' => $this
        ->getTypesString($types),
      '#rows' => 10,
      '#access' => empty($allowed_values_function),
      '#element_validate' => [
        [
          get_class($this),
          'validateTypes',
        ],
      ],
      '#field_has_data' => $has_data,
      '#field_name' => $this
        ->getFieldDefinition()
        ->getName(),
      '#entity_type' => $this
        ->getEntity()
        ->getEntityTypeId(),
      '#current_types' => $types,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this
      ->get('value')
      ->getValue();
    return $value === NULL || $value === '';
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['value'] = DataDefinition::create('string')
      ->setLabel(t('Barcode'))
      ->setRequired(TRUE);
    $properties['type'] = DataDefinition::create('string')
      ->setLabel(t('Barcode Type'))
      ->setRequired(TRUE);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraints = parent::getConstraints();

    /*$constraint_manager = \Drupal::typedDataManager()->getValidationConstraintManager();

        // @DCG Suppose our value must not be longer than 10 characters.
        $options['value']['Length']['max' = 10;

        // @DCG
        // See /core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint
        // directory for available constraints.
        $constraints[] = $constraint_manager->create('ComplexData', $options);
        */
    return $constraints;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $columns = [
      'value' => [
        'type' => 'varchar',
        'not null' => FALSE,
        'description' => 'Barcode Data.',
        'length' => 255,
      ],
      'type' => [
        'type' => 'varchar',
        'not null' => FALSE,
        'description' => 'Barcode Type.',
        'length' => 64,
      ],
    ];
    $schema = [
      'columns' => $columns,
    ];
    return $schema;
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $random = new Random();
    $values['value'] = $random
      ->word(mt_rand(1, 50));
    return $values;
  }

  /**
   * Generates a string representation of an array of allowed types.
   *
   * This string format is suitable for editing in a textarea.
   *
   * @param array $values
   *   An array of barcode types, where keys are types and values are labels.
   *
   * @return string
   *   The string representation of the $values array:
   *    - Types are separated by a carriage return.
   *    - Each type is in the format "type|label".
   */
  protected function getTypesString($types) {
    foreach ($types as $type => $label) {
      $lines[] = "{$type}|{$label}";
    }
    return implode("\n", $lines);
  }

  /**
   * #element_validate callback for options field allowed values.
   *
   * @param $element
   *   An associative array containing the properties and children of the
   *   generic form element.
   * @param $form_state
   *   The current state of the form for the form this element belongs to.
   *
   * @see \Drupal\Core\Render\Element\FormElement::processPattern()
   */
  public static function validateTypes($element, FormStateInterface $form_state) {
    $types = static::extractTypes($element['#value']);
    if (!is_array($types)) {
      $form_state
        ->setError($element, t('Allowed types list: invalid input.'));
    }
    else {

      // Check that keys are valid for the field type.
      foreach ($types as $type => $label) {
        if ($error = static::validateType($type)) {
          $form_state
            ->setError($element, $error);
          break;
        }
      }

      // Prevent removing types currently in use.
      if ($element['#field_has_data']) {
        $lost_keys = array_keys(array_diff_key($element['#current_types'], $types));
        if (_options_values_in_use($element['#entity_type'], $element['#field_name'], $lost_keys)) {
          $form_state
            ->setError($element, t('Allowed types list: some types are being removed while currently in use.'));
        }
      }
      $form_state
        ->setValueForElement($element, $types);
    }
  }

  /**
   * Extracts the allowed types array from the types element.
   *
   * @param string $string
   *   The raw string to extract types/labels from.
   *
   * @return array|null
   *   The array of extracted type/label pairs, or NULL if the string is invalid.
   *
   * @see \Drupal\barcode\Plugin\Field\FieldType\BarcodeBase::getTypesString()
   */
  protected static function extractTypes($string) {
    $list = array_map('trim', explode("\n", $string));
    $list = array_filter($list, 'strlen');
    foreach ($list as $text) {
      $matches = [];
      if (preg_match('/(.*)\\|(.*)/', $text, $matches)) {

        // Trim type and label to avoid unwanted spaces issues.
        $type = trim($matches[1]);
        $label = trim($matches[2]);
      }
      else {
        return;
      }
      $types[$type] = $label;
    }
    return $types;
  }

  /**
   * Checks whether a candidate allowed value is valid.
   *
   * @param string $type
   *   The type entered by the user.
   *
   * @return string | null
   *   The error message if the specified type is invalid, NULL otherwise.
   */
  protected static function validateType($type) {
    if (!isset(static::$types[$type])) {
      return t('Allowed Type list: type %type is invalid', [
        '%type' => $type,
      ]);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BarcodeBase::$types public static property An array of barcode types this widget supports. 2
BarcodeBase::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemBase::defaultStorageSettings
BarcodeBase::extractTypes protected static function Extracts the allowed types array from the types element.
BarcodeBase::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
BarcodeBase::getConstraints public function Gets a list of validation constraints. Overrides TypedData::getConstraints
BarcodeBase::getTypesString protected function Generates a string representation of an array of allowed types.
BarcodeBase::isEmpty public function Determines whether the data structure is empty. Overrides Map::isEmpty
BarcodeBase::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
BarcodeBase::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema
BarcodeBase::standardBarcodes abstract public static function Get the standard allowed type of barcodes. 2
BarcodeBase::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemBase::storageSettingsForm
BarcodeBase::validateType protected static function Checks whether a candidate allowed value is valid.
BarcodeBase::validateTypes public static function #element_validate callback for options field allowed values.
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
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemInterface::defaultFieldSettings 7
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemInterface::fieldSettingsForm 7
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave 7
FieldItemBase::setValue public function Sets the data value. Overrides Map::setValue 4
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct public function Constructs a TypedData object given its definition and context. Overrides TypedData::__construct 1
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue 4
Map::get public function Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString public function Returns a string representation of the data. Overrides TypedData::getString
Map::getValue public function Gets the data value. Overrides TypedData::getValue 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
Map::set public function Sets a property value. Overrides ComplexDataInterface::set
Map::toArray public function Returns an array of all property values. Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
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.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
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