class RadioactivityReferenceItem in Radioactivity 4.0.x

Plugin implementation of the Radioactivity Reference field type.

Plugin annotation


@FieldType(
  id = "radioactivity_reference",
  label = @Translation("Radioactivity Reference"),
  description = @Translation("This field stores the ID of an radioactivity energy entity."),
  category = @Translation("Reference"),
  list_class = "\Drupal\radioactivity\RadioactivityReferenceFieldItemList",
  default_widget = "radioactivity_reference",
  default_formatter = "radioactivity_reference_emitter",
  cardinality = 1,
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem implements PreconfiguredFieldUiOptionsInterface, OptionsProviderInterface
    class \Drupal\radioactivity\Plugin\Field\FieldType\RadioactivityReferenceItem

Expanded class hierarchy of RadioactivityReferenceItem

File

src/Plugin/Field/FieldType/RadioactivityReferenceItem.php, line 26

Namespace

Drupal\radioactivity\Plugin\Field\FieldType

View source

class RadioactivityReferenceItem extends EntityReferenceItem {

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return [
      'target_type' => 'radioactivity',
      'profile' => 'decay',
      'halflife' => 60 * 60 * 12,
      'granularity' => 60 * 15,
      'cutoff' => 1,
    ] + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'default_energy' => 0,
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function getPreconfiguredOptions() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = parent::propertyDefinitions($field_definition);
    $properties['energy'] = DataDefinition::create('float')
      ->setLabel(new TranslatableMarkup('Energy level'))
      ->setDescription(new TranslatableMarkup('The radioactivity energy level'))
      ->setComputed(TRUE)
      ->setReadOnly(FALSE);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $elements = parent::storageSettingsForm($form, $form_state, $has_data);
    $elements['target_type']['#access'] = FALSE;
    $elements['profile'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Energy profile'),
      '#default_value' => $this
        ->getSetting('profile'),
      '#required' => TRUE,
      '#options' => [
        'count' => 'Count',
        'linear' => 'Linear',
        'decay' => 'Decay',
      ],
      '#description' => $this
        ->t('Count: Energy increases by 1 with each view. Never decreases.<br/>
Linear: Energy increases by the emission amount. Decreases by 1 per second.<br/>
Decay: Energy increases by the emission amount. Decreases 50% per half-life time.'),
    ];
    $elements['granularity'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Granularity'),
      '#min' => 1,
      '#default_value' => $this
        ->getSetting('granularity'),
      '#description' => $this
        ->t('The time in seconds that the energy levels are kept before applying the decay.'),
      '#states' => [
        'visible' => [
          'input[name="settings[profile]"]' => [
            [
              'value' => 'linear',
            ],
            [
              'value' => 'decay',
            ],
          ],
        ],
      ],
    ];
    $elements['halflife'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Half-life time'),
      '#min' => 1,
      '#default_value' => $this
        ->getSetting('halflife'),
      '#description' => $this
        ->t('The time in seconds in which the energy level halves.'),
      '#states' => [
        'visible' => [
          'input[name="settings[profile]"]' => [
            'value' => 'decay',
          ],
        ],
      ],
    ];
    $elements['cutoff'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cutoff'),
      '#pattern' => '[0-9]+(\\.[0-9]+)?',
      '#size' => 20,
      '#default_value' => $this
        ->getSetting('cutoff'),
      '#description' => $this
        ->t('Energy levels under this value is set to zero. Example: 0.5, 2.'),
      '#states' => [
        'invisible' => [
          'input[name="settings[profile]"]' => [
            'value' => 'count',
          ],
        ],
      ],
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $field = $form_state
      ->getFormObject()
      ->getEntity();
    $form = parent::fieldSettingsForm($form, $form_state);
    $form['handler']['#access'] = FALSE;
    $form['default_energy'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default energy'),
      '#description' => $this
        ->t('The default energy value for this field, used when creating new content.'),
      '#required' => TRUE,
      '#default_value' => $field
        ->getSetting('default_energy'),
      '#pattern' => '[0-9]+(\\.[0-9]+)?',
      '#size' => 20,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave() {
    $needsSave = FALSE;
    $requestTime = \Drupal::time()
      ->getRequestTime();

    // New entity: Store the energy value in the entity. Saving the entity is
    // handled by parent::preSave.
    if ($this
      ->hasNewEntity()) {
      $this->entity
        ->setEnergy($this->energy);
      $this->entity
        ->setTimestamp($requestTime);
    }
    elseif ($this->energy != $this->initial_energy) {
      $this->entity
        ->setEnergy($this->energy);
      $this->entity
        ->setTimestamp($requestTime);
      $needsSave = TRUE;
    }

    // Keep the language code of the radioactivity entity in sync with the
    // language code of the host.
    if ($this
      ->getLangcode() !== $this->entity->getLangcode) {
      $this->entity
        ->setLangcode($this
        ->getLangcode());
      if (!$this
        ->hasNewEntity()) {
        $needsSave = TRUE;
      }
    }
    if ($needsSave) {
      $this->entity
        ->save();
    }
    parent::preSave();
  }

  /**
   * {@inheritdoc}
   */
  public function delete() {
    if ($this->entity) {
      $this->entity
        ->delete();
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $entity_storage = \Drupal::entityTypeManager()
      ->getStorage('radioactivity');
    $entity = $entity_storage
      ->createWithSampleValues('radioactivity');
    return [
      'entity' => $entity,
      'energy' => $entity
        ->getEnergy(),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityReferenceItem::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemBase::calculateDependencies
EntityReferenceItem::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemBase::calculateStorageDependencies
EntityReferenceItem::fieldSettingsAjaxProcess	public static	function	Render API callback: Processes the field settings form.
EntityReferenceItem::fieldSettingsAjaxProcessElement	public static	function	Adds entity_reference specific properties to AJAX form elements from the field settings form.
EntityReferenceItem::fieldSettingsFormValidate	public static	function	Form element validation handler; Invokes selection plugin's validation.
EntityReferenceItem::formProcessMergeParent	public static	function	Render API callback: Moves entity_reference specific Form API elements (i.e. 'handler_settings') up a level for easier processing by the validation and submission handlers.
EntityReferenceItem::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedData::getConstraints
EntityReferenceItem::getPossibleOptions	public	function	Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
EntityReferenceItem::getPossibleValues	public	function	Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
EntityReferenceItem::getRandomBundle	protected static	function	Gets a bundle for a given entity type and selection options.
EntityReferenceItem::getSettableOptions	public	function	Returns an array of settable values with labels for display. Overrides OptionsProviderInterface::getSettableOptions
EntityReferenceItem::getSettableValues	public	function	Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
EntityReferenceItem::getValue	public	function	Gets the data value. Overrides Map::getValue
EntityReferenceItem::hasNewEntity	public	function	Determines whether the item holds an unsaved entity.
EntityReferenceItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
EntityReferenceItem::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
EntityReferenceItem::onChange	public	function	React to changes to a child property or item. Overrides Map::onChange
EntityReferenceItem::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemBase::onDependencyRemoval
EntityReferenceItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema	1
EntityReferenceItem::settingsAjax	public static	function	Ajax callback for the handler settings form.
EntityReferenceItem::settingsAjaxSubmit	public static	function	Submit handler for the non-JS case.
EntityReferenceItem::setValue	public	function	Sets the data value. Overrides FieldItemBase::setValue
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
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::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
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::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.
RadioactivityReferenceItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides EntityReferenceItem::defaultFieldSettings
RadioactivityReferenceItem::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides EntityReferenceItem::defaultStorageSettings
RadioactivityReferenceItem::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemBase::delete
RadioactivityReferenceItem::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides EntityReferenceItem::fieldSettingsForm
RadioactivityReferenceItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides EntityReferenceItem::generateSampleValue
RadioactivityReferenceItem::getPreconfiguredOptions	public static	function	Returns preconfigured field options for a field type. Overrides EntityReferenceItem::getPreconfiguredOptions
RadioactivityReferenceItem::preSave	public	function	Defines custom presave behavior for field values. Overrides EntityReferenceItem::preSave
RadioactivityReferenceItem::propertyDefinitions	public static	function	Defines field item properties. Overrides EntityReferenceItem::propertyDefinitions
RadioactivityReferenceItem::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides EntityReferenceItem::storageSettingsForm
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.
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

You are here

class RadioactivityReferenceItem in Radioactivity 4.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation