class TestItemWithPreconfiguredOptions

Same name and namespace in other branches
  1. 11.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithPreconfiguredOptions.php \Drupal\field_test\Plugin\Field\FieldType\TestItemWithPreconfiguredOptions
  2. 10 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithPreconfiguredOptions.php \Drupal\field_test\Plugin\Field\FieldType\TestItemWithPreconfiguredOptions
  3. 8.9.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithPreconfiguredOptions.php \Drupal\field_test\Plugin\Field\FieldType\TestItemWithPreconfiguredOptions
  4. main core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithPreconfiguredOptions.php \Drupal\field_test\Plugin\Field\FieldType\TestItemWithPreconfiguredOptions

Defines the 'test_field_with_preconfigured_options' entity field item.

Plugin annotation


@FieldType(
  id = "test_field_with_preconfigured_options",
  label = @Translation("Test field with preconfigured options"),
  description = @Translation("Dummy field type used for tests."),
  default_widget = "test_field_widget",
  default_formatter = "field_test_default"
)

Hierarchy

Expanded class hierarchy of TestItemWithPreconfiguredOptions

File

View on git.drupalcode.org

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithPreconfiguredOptions.php, line 20

Namespace

Drupal\field_test\Plugin\Field\FieldType
View source 
class TestItemWithPreconfiguredOptions extends TestItem implements PreconfiguredFieldUiOptionsInterface {
  
  /**
   * {@inheritdoc}
   */
  public static function getPreconfiguredOptions() {
    return [
      'custom_options' => [
        'label' => new TranslatableMarkup('All custom options'),
        'category' => new TranslatableMarkup('Custom category'),
        'field_storage_config' => [
          'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
          'settings' => [
            'test_field_storage_setting' => 'preconfigured_storage_setting',
          ],
        ],
        'field_config' => [
          'required' => TRUE,
          'settings' => [
            'test_field_setting' => 'preconfigured_field_setting',
          ],
        ],
        'entity_form_display' => [
          'type' => 'test_field_widget_multiple',
        ],
        'entity_view_display' => [
          'type' => 'field_test_multiple',
        ],
      ],
    ];
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
FieldItemBase::calculateDependencies public static function Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::deleteRevision public function Overrides FieldItemInterface::deleteRevision
FieldItemBase::generateSampleValue public static function Overrides FieldItemInterface::generateSampleValue 18
FieldItemBase::getEntity public function Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function 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 Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::postSave public function Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Overrides FieldItemInterface::preSave 7
FieldItemBase::setValue public function Overrides Map::setValue 4
FieldItemBase::view public function 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 Overrides TypedData::__construct 1
FieldItemBase::__get public function Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function 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 Overrides TypedData::applyDefaultValue 4
Map::get public function Overrides ComplexDataInterface::get
Map::getIterator public function #[\ReturnTypeWillChange]
Map::getProperties public function Overrides ComplexDataInterface::getProperties
Map::getString public function Overrides TypedData::getString
Map::getValue public function Overrides TypedData::getValue 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
Map::set public function Overrides ComplexDataInterface::set
Map::toArray public function Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
TestItem::defaultFieldSettings public static function Overrides FieldItemBase::defaultFieldSettings
TestItem::defaultStorageSettings public static function Overrides FieldItemBase::defaultStorageSettings
TestItem::delete public function Overrides FieldItemBase::delete
TestItem::fieldSettingsForm public function Overrides FieldItemBase::fieldSettingsForm
TestItem::fieldSettingsFromConfigData public static function Overrides FieldItemBase::fieldSettingsFromConfigData
TestItem::fieldSettingsToConfigData public static function Overrides FieldItemBase::fieldSettingsToConfigData
TestItem::getConstraints public function Overrides TypedData::getConstraints
TestItem::isEmpty public function Overrides Map::isEmpty
TestItem::propertyDefinitions public static function Overrides FieldItemInterface::propertyDefinitions
TestItem::schema public static function Overrides FieldItemInterface::schema
TestItem::storageSettingsForm public function Overrides FieldItemBase::storageSettingsForm
TestItem::storageSettingsFromConfigData public static function Overrides FieldItemBase::storageSettingsFromConfigData
TestItem::storageSettingsToConfigData public static function Overrides FieldItemBase::storageSettingsToConfigData
TestItemWithPreconfiguredOptions::getPreconfiguredOptions public static function Overrides PreconfiguredFieldUiOptionsInterface::getPreconfiguredOptions
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Overrides TypedDataInterface::getName
TypedData::getParent public function Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Overrides TypedDataInterface::getRoot
TypedData::setContext public function Overrides TypedDataInterface::setContext
TypedData::validate public function 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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.