You are here

Home » API reference » Computed Field 8 » ComputedFieldItem.php

class ComputedFieldItem in Computed Field 8

Plugin implementation of the 'computed' field type.

Plugin annotation


@FieldType(
  id = "computed",
  label = @Translation("Computed"),
  description = @Translation("Defines a field type that allows values to be computed via PHP code."),
  default_formatter = "computed"
)

Hierarchy

Expanded class hierarchy of ComputedFieldItem

File

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

Namespace

Drupal\computed_field\Plugin\Field\FieldType
View source 
class ComputedFieldItem extends FieldItemBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return array(
      'computed_code' => '$value = \'\';',
      'display_code' => '$display_output = $value;',
    ) + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return array(
      'data_type' => 'varchar',
      'data_length' => 32,
      'data_size' => 'normal',
      'data_precision' => 10,
      'data_scale' => 2,
    ) + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $type = $field_definition
      ->getSetting('data_type');
    if ($type == 'varchar' || $type == 'text') {
      $properties['value'] = DataDefinition::create('string')
        ->setLabel(t('Text value'))
        ->setSetting('case_sensitive', $field_definition
        ->getSetting('case_sensitive'))
        ->setRequired(TRUE);
    }
    if ($type == 'int') {
      $properties['value'] = DataDefinition::create('integer')
        ->setLabel(t('Integer value'))
        ->setRequired(TRUE);
    }
    if ($type == 'float') {
      $properties['value'] = DataDefinition::create('float')
        ->setLabel(t('Float'))
        ->setRequired(TRUE);
    }
    if ($type == 'decimal') {
      $properties['value'] = DataDefinition::create('string')
        ->setLabel(t('Decimal value'))
        ->setRequired(TRUE);
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $type = $field_definition
      ->getSetting('data_type');
    $schema = array(
      'columns' => array(
        'value' => array(
          'type' => $type,
        ),
      ),
    );
    if ($type == 'varchar') {
      $schema['columns']['value']['length'] = (int) $field_definition
        ->getSetting('data_length');
    }
    if ($type == 'text' || $type == 'int' || $type == 'float') {
      $schema['columns']['value']['size'] = $field_definition
        ->getSetting('data_size');
    }
    if ($type == 'decimal') {
      $schema['columns']['value']['precision'] = (int) $field_definition
        ->getSetting('data_precision');
      $schema['columns']['value']['scale'] = (int) $field_definition
        ->getSetting('data_scale');
    }
    return $schema;
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $element = array();
    $element['computed_code'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Computed Code (PHP)'),
      '#default_value' => $this
        ->getSetting('computed_code'),
      '#required' => FALSE,
      '#description' => t('<p>The variables available to your code include: <code>&$value</code>, <code>$fields</code>, <code>$entity</code>, <code>$entity_manager</code>. To set the value of the field, set <code>$value</code>. For multi-value computed fields <code>$value</code> should be an array. Here\'s a simple example which sets the computed field\'s value to the value of the sum of the number fields (<code>field_a</code> and <code>field_b</code>) in a node entity:</p><p><code>$value = $entity->field_a->value + $entity->field_b->value;</code></p><p>An alternative example:</p><p><code>$value = $fields[\'field_a\'][0][\'value\'] + $fields[\'field_b\'][0][\'value\'];</code></p>'),
    );
    $element['display_code'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Display Code (PHP)'),
      '#default_value' => $this
        ->getSetting('display_code'),
      '#required' => FALSE,
      '#description' => t('This code should assign a string to the $display_output variable, which will be printed when the field is displayed. The raw computed value of the field is in <code>$value</code>. Also following variables are available: <code>$fields</code>, <code>$entity</code>, <code>$entity_manager</code>. Note: this code has no effect if you use the "Raw computed value" display formatter.'),
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $elements = [];
    $elements['data_type'] = array(
      '#type' => 'radios',
      '#title' => t('Data Type'),
      '#description' => t('The SQL datatype to store this field in.'),
      '#default_value' => $this
        ->getSetting('data_type'),
      '#options' => array(
        'varchar' => 'varchar',
        'text' => 'text',
        'int' => 'int',
        'float' => 'float',
        'numeric' => 'decimal',
      ),
      '#required' => FALSE,
    );
    $elements['data_length'] = array(
      '#type' => 'textfield',
      '#title' => t('Data Length (varchar)'),
      '#description' => t('<strong>Only</strong> valid for <strong>varchar</strong> field. The length of the field stored in the database.'),
      '#default_value' => $this
        ->getSetting('data_length'),
      '#required' => FALSE,
    );
    $elements['data_size'] = array(
      '#type' => 'select',
      '#title' => t('Data Size (text/int/float)'),
      '#description' => t('<strong>Only</strong> valid for <strong>text</strong>, <strong>int</strong> or <strong>float</strong> fields. The size of the field stored in the database.'),
      '#default_value' => $this
        ->getSetting('data_size'),
      '#options' => array(
        'tiny' => 'tiny',
        'small' => 'small',
        'medium' => 'medium',
        'normal' => 'normal',
        'big' => 'big',
      ),
      '#required' => FALSE,
    );
    $elements['data_precision'] = array(
      '#type' => 'select',
      '#title' => t('Decimal Precision (decimal)'),
      '#description' => t('<strong>Only</strong> valid for <strong>decimal</strong> fields. The total number of digits to store in the database, including those to the right of the decimal.'),
      '#options' => array_combine(range(10, 32), range(10, 32)),
      '#default_value' => $this
        ->getSetting('data_precision'),
      '#required' => FALSE,
    );
    $elements['data_scale'] = array(
      '#type' => 'select',
      '#title' => t('Decimal Scale (decimal)'),
      '#description' => t('<strong>Only</strong> valid for <strong>decimal</strong> fields. The number of digits to the right of the decimal. '),
      '#options' => array_combine(range(0, 10), range(0, 10)),
      '#default_value' => $this
        ->getSetting('data_scale'),
      '#required' => FALSE,
    );
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this
      ->get('value')
      ->getValue();
    $data_type = $this
      ->getSetting('data_type');
    $empty = TRUE;

    // This will depend on the class of data type.
    switch ($data_type) {
      case 'int':
      case 'float':
      case 'numeric':

        // For numbers, the field is empty if the value isn't numeric.
        $empty = $value === NULL || !is_numeric($value);
        break;
      case 'varchar':
      case 'text':
      case 'longtext':

        // For strings, the field is empty if it doesn't match the empty string.
        $empty = $value === NULL || $value === '';
        break;
    }
    return $empty;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave() {
    $value = $this
      ->executeComputedCode();
    $this
      ->setValue($value);
  }
  protected function executeComputedCode() {
    $code = $this
      ->getSetting('computed_code');
    $entity_manager = \Drupal::EntityManager();
    $entity = $this
      ->getEntity();
    $fields = $this
      ->getEntity()
      ->toArray();
    $value = NULL;
    eval($code);
    return $value;
  }
  public function executeDisplayCode() {
    $code = $this
      ->getSetting('display_code');
    $entity_manager = \Drupal::EntityManager();
    $entity = $this
      ->getEntity();
    $fields = $this
      ->getEntity()
      ->toArray();
    $value = $this
      ->get('value')
      ->getValue();
    $display_output = NULL;
    eval($code);
    return $display_output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ComputedFieldItem::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
ComputedFieldItem::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemBase::defaultStorageSettings
ComputedFieldItem::executeComputedCode protected function
ComputedFieldItem::executeDisplayCode public function
ComputedFieldItem::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
ComputedFieldItem::isEmpty public function Determines whether the data structure is empty. Overrides Map::isEmpty
ComputedFieldItem::preSave public function Defines custom presave behavior for field values. Overrides FieldItemBase::preSave
ComputedFieldItem::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
ComputedFieldItem::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema
ComputedFieldItem::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemBase::storageSettingsForm
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::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::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::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemInterface::generateSampleValue 18
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::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::getConstraints public function Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints 9
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