You are here

Home » API reference » Barcode 8 » BarcodeItem.php

class BarcodeItem in Barcode 8

Defines the 'barcode' field type.

Plugin annotation


@FieldType(
  id = "barcode",
  label = @Translation("Barcode"),
  category = @Translation("General"),
  default_widget = "barcode",
  default_formatter = "barcode_png"
)

Hierarchy

Expanded class hierarchy of BarcodeItem

File

src/Plugin/Field/FieldType/BarcodeItem.php, line 23

Namespace

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

  /**
   * {@inheritdoc}
   */
  public static $types = [
    'C128A' => [
      'name' => 'CODE 128 A',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C128B' => [
      'name' => 'CODE 128 B',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C128C' => [
      'name' => 'CODE 128 C',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C128' => [
      'name' => 'CODE 128',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C39E+' => [
      'name' => 'CODE 39 EXTENDED + CHECKSUM',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C39E' => [
      'name' => 'CODE 39 EXTENDED',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C39+' => [
      'name' => 'CODE 39 + CHECKSUM',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C39' => [
      'name' => 'CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'C93' => [
      'name' => 'CODE 93 - USS-93',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'CODABAR' => [
      'name' => 'CODABAR',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'CODE11' => [
      'name' => 'CODE 11',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'EAN13' => [
      'name' => 'EAN 13',
      'length' => 13,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'EAN2' => [
      'name' => 'EAN 2-Digits UPC-Based Extension',
      'length' => 2,
      'type' => 'numeric',
      'placeholder' => '01',
      'description' => '',
    ],
    'EAN5' => [
      'name' => 'EAN 5-Digits UPC-Based Extension',
      'length' => 5,
      'type' => 'numeric',
      'placeholder' => '01234',
      'description' => '',
    ],
    'EAN8' => [
      'name' => 'EAN 8',
      'length' => 8,
      'type' => 'numeric',
      'placeholder' => '01234567',
      'description' => '',
    ],
    'I25+' => [
      'name' => 'Interleaved 2 of 5 + CHECKSUM',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'I25' => [
      'name' => 'Interleaved 2 of 5',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'IMB' => [
      'name' => 'IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'IMBPRE' => [
      'name' => 'IMB - Intelligent Mail Barcode pre-processed',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'KIX' => [
      'name' => 'KIX (Klant index - Customer index)',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
    'MSI+' => [
      'name' => 'MSI + CHECKSUM (modulo 11)',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'MSI' => [
      'name' => 'MSI (Variation of Plessey code)',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'PHARMA2T' => [
      'name' => 'PHARMACODE TWO-TRACKS',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'PHARMA' => [
      'name' => 'PHARMACODE',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'PLANET' => [
      'name' => 'PLANET',
      'length' => 14,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'POSTNET' => [
      'name' => 'POSTNET',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'RMS4CC' => [
      'name' => 'RMS4CC (Royal Mail 4-state Customer Bar Code)',
      'length' => 255,
      'placeholder' => '',
      'description' => '',
    ],
    'S25+' => [
      'name' => 'Standard 2 of 5 + CHECKSUM',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'S25' => [
      'name' => 'Standard 2 of 5',
      'length' => 255,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'UPCA' => [
      'name' => 'UPC-A',
      'length' => 12,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'UPCE' => [
      'name' => 'UPC-E',
      'length' => 12,
      'type' => 'numeric',
      'placeholder' => '',
      'description' => '',
    ],
    'LRAW' => [
      'name' => '1D RAW MODE (comma-separated rows of 01 strings)',
      'length' => 255,
      'type' => 'mixed',
      'placeholder' => '',
      'description' => '',
    ],
  ];

  /**
   * {@inheritdoc}
   */
  public static function standardBarcodes() {
    foreach ([
      'UPCA',
      'UPCE',
      'EAN13',
      'EAN8',
      'EAN5',
      'EAN2',
    ] as $code) {
      $barcodes[$code] = static::$types[$code]['name'];
    }
    return $barcodes;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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.
BarcodeItem::$types public static property An array of barcode types this widget supports. Overrides BarcodeBase::$types
BarcodeItem::standardBarcodes public static function Get the standard allowed type of barcodes. Overrides BarcodeBase::standardBarcodes
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