class DataConvert

Provides an action to convert data from one type to another.

@todo Add rounding_behavior default value "round". @todo Add options_list for target type. @todo Specify the right data type for the provided result.

Plugin annotation


@RulesAction(
  id = "rules_data_convert",
  label = @Translation("Convert data"),
  category = @Translation("Data"),
  context_definitions = {
    "value" = @ContextDefinition("any",
      label = @Translation("Value"),
      description = @Translation("The first input value for the calculation."),
      assignment_restriction = "selector"
    ),
    "target_type" = @ContextDefinition("string",
      label = @Translation("Target type"),
      description = @Translation("The data type to convert a value to."),
      options_provider = "\Drupal\rules\TypedData\Options\ConvertTypeOptions",
      assignment_restriction = "input"
    ),
    "rounding_behavior" = @ContextDefinition("string",
      label = @Translation("Rounding behavior"),
      description = @Translation("For integer target types, specify how the conversion result should be rounded."),
      options_provider = "\Drupal\rules\TypedData\Options\RoundingOptions",
      default_value = NULL,
      required = FALSE
    ),
  },
  provides = {
    "conversion_result" = @ContextDefinition("any",
      label = @Translation("Conversion result")
    ),
  }
)

Hierarchy

Expanded class hierarchy of DataConvert

File

src/Plugin/RulesAction/DataConvert.php, line 46

Namespace

Drupal\rules\Plugin\RulesAction
View source
class DataConvert extends RulesActionBase {
  
  /**
   * {@inheritdoc}
   */
  public function refineContextDefinitions(array $selected_data) {
    if ($type = $this->getContextValue('target_type')) {
      $this->pluginDefinition['provides']['conversion_result']
        ->setDataType($type);
    }
  }
  
  /**
   * Executes the plugin.
   *
   * @param mixed $value
   *   The input value.
   * @param string $target_type
   *   The target type the value should be converted into.
   * @param string $rounding_behavior
   *   The behavior for rounding.
   */
  protected function doExecute($value, $target_type, $rounding_behavior = NULL) {
    // @todo Add support for objects implementing __toString().
    if (!is_scalar($value)) {
      throw new InvalidArgumentException('Only scalar values are supported.');
    }
    // Ensure valid contexts have been provided.
    // @todo check how this works. May need to use !empty to allow the selection
    // list to be used and give an empty value?
    if (isset($rounding_behavior) && $target_type != 'integer') {
      throw new InvalidArgumentException('A rounding behavior only makes sense with an integer target type.');
    }
    // First apply the rounding behavior if given.
    if (!empty($rounding_behavior)) {
      switch ($rounding_behavior) {
        case 'up':
          $value = ceil($value);
          break;

        case 'down':
          $value = floor($value);
          break;

        case 'round':
          $value = round($value);
          break;

        default:
          throw new InvalidArgumentException("Unknown rounding behavior: {$rounding_behavior}");
      }
    }
    switch ($target_type) {
      case 'float':
        $result = floatval($value);
        break;

      case 'integer':
        $result = intval($value);
        break;

      case 'string':
        $result = strval($value);
        break;

      default:
        throw new InvalidArgumentException("Unknown target type: {$target_type}");
    }
    $this->setProvidedValue('conversion_result', $result);
  }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function Aliased as: traitGetContextValue
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
ContextProviderTrait::$providedContext protected property The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext public function
ContextProviderTrait::getProvidedContextDefinition public function
ContextProviderTrait::getProvidedContextDefinitions public function
ContextProviderTrait::setProvidedValue public function
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
DataConvert::doExecute protected function Executes the plugin.
DataConvert::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides RulesActionBase::refineContextDefinitions
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
ExecutablePluginTrait::getLabelValue protected function Get the translated label from the plugin definition.
ExecutablePluginTrait::summary public function Get the translated summary from the label annotation. 4
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 85
RulesActionBase::$configuration protected property The plugin configuration. Overrides PluginBase::$configuration
RulesActionBase::access public function Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext public function Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext 14
RulesActionBase::calculateDependencies public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::defaultConfiguration public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute 2
RulesActionBase::executeMultiple public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::getConfiguration public function @todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
RulesActionBase::setConfiguration public function @todo this documentation is not actually inherited from any interface.
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.