class WorkflowsFieldItem in Workflows Field 2.x

Same name and namespace in other branches

8 src/Plugin/Field/FieldType/WorkflowsFieldItem.php \Drupal\workflows_field\Plugin\Field\FieldType\WorkflowsFieldItem

Workflow state field item.

Plugin annotation


@FieldType(
  id = "workflows_field_item",
  label = @Translation("Workflows"),
  description = @Translation("Allows you to store a workflow state."),
  constraints = {"WorkflowsFieldConstraint" = {}},
  default_formatter = "list_default",
  default_widget = "options_select"
)

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\workflows_field\Plugin\Field\FieldType\WorkflowsFieldItem implements OptionsProviderInterface

Expanded class hierarchy of WorkflowsFieldItem

2 files declare their use of WorkflowsFieldItem

StatesListFormatter.php in src/Plugin/Field/FieldFormatter/StatesListFormatter.php
WorkflowsFieldTest.php in tests/src/Kernel/WorkflowsFieldTest.php

File

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

Namespace

Drupal\workflows_field\Plugin\Field\FieldType

View source

class WorkflowsFieldItem extends FieldItemBase implements OptionsProviderInterface {

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['value'] = DataDefinition::create('string')
      ->setLabel(t('State'))
      ->setRequired(TRUE);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'value' => [
          'type' => 'varchar',
          'length' => 64,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    $settings = [
      'workflow' => NULL,
    ];
    return $settings + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $workflows = Workflow::loadMultipleByType('workflows_field');
    $options = [];
    foreach ($workflows as $workflow) {
      $options[$workflow
        ->id()] = $workflow
        ->label();
    }
    $element = [];
    $element['workflow'] = [
      '#title' => $this
        ->t('Workflow'),
      '#required' => TRUE,
      '#default_value' => $this
        ->getSetting('workflow'),
      '#type' => 'select',
      '#options' => $options,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function getPossibleValues(AccountInterface $account = NULL) {
    return array_keys($this
      ->getPossibleOptions($account));
  }

  /**
   * {@inheritdoc}
   */
  public function getPossibleOptions(AccountInterface $account = NULL) {
    $workflow = $this
      ->getWorkflow();
    if (!$workflow) {

      // The workflow is not known yet, the field is probably being created.
      return [];
    }
    $state_labels = array_map(function ($state) {
      return $state
        ->label();
    }, $workflow
      ->getTypePlugin()
      ->getStates());
    return $state_labels;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettableValues(AccountInterface $account = NULL) {
    return array_keys($this
      ->getSettableOptions($account));
  }

  /**
   * {@inheritdoc}
   */
  public function getSettableOptions(AccountInterface $account = NULL) {

    // $this->value is unpopulated due to https://www.drupal.org/node/2629932
    $field_name = $this
      ->getFieldDefinition()
      ->getName();
    $value = $this
      ->getEntity()
      ->get($field_name)->value;
    $workflow = $this
      ->getWorkflow();
    $type = $workflow
      ->getTypePlugin();
    $allowed_states = $type
      ->getStates();

    /** @var \Drupal\workflows\State $current */
    if ($value && $type
      ->hasState($value) && ($current = $type
      ->getState($value))) {
      $allowed_states = array_filter($allowed_states, function (StateInterface $state) use ($current, $workflow, $account) {
        if ($current
          ->id() === $state
          ->id()) {
          return TRUE;
        }

        // If we don't have a valid transition or we don't have an account then
        // all we care about is whether the transition is valid so return.
        $valid_transition = $current
          ->canTransitionTo($state
          ->id());
        if (!$valid_transition || !$account) {
          return $valid_transition;
        }

        // If we have an account object then ensure the user has permission to
        // this transition and that it's a valid transition.
        $transition = $current
          ->getTransitionTo($state
          ->id());
        return $account
          ->hasPermission(sprintf('use %s transition %s', $workflow
          ->id(), $transition
          ->id()));
      });
    }
    $state_labels = array_map(function ($state) {
      return $state
        ->label();
    }, $allowed_states);
    return $state_labels;
  }

  /**
   * {@inheritdoc}
   */
  public function applyDefaultValue($notify = TRUE) {
    if ($workflow = $this
      ->getWorkflow()) {
      $initial_state = $workflow
        ->getTypePlugin()
        ->getInitialState();
      $this
        ->setValue([
        'value' => $initial_state
          ->id(),
      ], $notify);
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public static function calculateStorageDependencies(FieldStorageDefinitionInterface $field_definition) {
    $dependencies['config'][] = sprintf('workflows.workflow.%s', $field_definition
      ->getSetting('workflow'));
    return $dependencies;
  }

  /**
   * Gets the workflow associated with this field.
   *
   * @return \Drupal\workflows\WorkflowInterface|null
   *   The workflow of NULL.
   */
  public function getWorkflow() {
    return !empty($this
      ->getSetting('workflow')) ? Workflow::load($this
      ->getSetting('workflow')) : NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FieldItemBase::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies	2
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::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::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::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::isEmpty	public	function	Determines whether the data structure is empty. Overrides ComplexDataInterface::isEmpty	17
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.	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::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
WorkflowsFieldItem::applyDefaultValue	public	function	Applies the default value. Overrides Map::applyDefaultValue
WorkflowsFieldItem::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemBase::calculateStorageDependencies
WorkflowsFieldItem::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides FieldItemBase::defaultStorageSettings
WorkflowsFieldItem::getPossibleOptions	public	function	Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
WorkflowsFieldItem::getPossibleValues	public	function	Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
WorkflowsFieldItem::getSettableOptions	public	function	Returns an array of settable values with labels for display. Overrides OptionsProviderInterface::getSettableOptions
WorkflowsFieldItem::getSettableValues	public	function	Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
WorkflowsFieldItem::getWorkflow	public	function	Gets the workflow associated with this field.
WorkflowsFieldItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
WorkflowsFieldItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
WorkflowsFieldItem::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FieldItemBase::storageSettingsForm

You are here

class WorkflowsFieldItem in Workflows Field 2.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation