class RgbItem

Plugin implementation of the 'field_example_rgb' field type.

Plugin annotation

@FieldType(
  id = "field_example_rgb",
  label = @Translation("Example Color RGB"),
  module = "field_example",
  description = @Translation("Demonstrates a field composed of an RGB color."),
  default_widget = "field_example_text",
  default_formatter = "field_example_simple_text"
)

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
  • class \Drupal\Core\TypedData\Plugin\DataType\Map extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface
    • class \Drupal\Core\Field\FieldItemBase extends \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\Field\FieldItemInterface
      • class \Drupal\field_example\Plugin\Field\FieldType\RgbItem extends \Drupal\Core\Field\FieldItemBase

Expanded class hierarchy of RgbItem

File

modules/field_example/src/Plugin/Field/FieldType/RgbItem.php, line 21

Namespace

class RgbItem extends FieldItemBase {
    
    /**
     * {@inheritdoc}
     */
    public static function schema(FieldStorageDefinitionInterface $field_definition) {
        return [
            'columns' => [
                'value' => [
                    'type' => 'text',
                    'size' => 'tiny',
                    'not null' => FALSE,
                ],
            ],
        ];
    }
    
    /**
     * {@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('Hex value'));
        return $properties;
    }

}

Members