class FractionTarget in Fraction 8

Same name and namespace in other branches

2.x src/Feeds/Target/FractionTarget.php \Drupal\fraction\Feeds\Target\FractionTarget

Defines a fraction field mapper.

Plugin annotation


@FeedsTarget(
  id = "fraction",
  field_types = {
    "fraction",
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\feeds\Plugin\Type\PluginBase implements FeedsPluginInterface uses DependencyTrait
    class \Drupal\feeds\Plugin\Type\ConfigurablePluginBase implements PluginFormInterface
    class \Drupal\feeds\Plugin\Type\Target\TargetBase implements TargetInterface
    class \Drupal\feeds\Plugin\Type\Target\FieldTargetBase implements ConfigurableTargetInterface, TranslatableTargetInterface
    class \Drupal\fraction\Feeds\Target\FractionTarget implements ConfigurableTargetInterface

Expanded class hierarchy of FractionTarget

1 file declares its use of FractionTarget

FractionTargetTest.php in tests/src/Unit/Feeds/Target/FractionTargetTest.php

File

src/Feeds/Target/FractionTarget.php, line 20

Namespace

Drupal\fraction\Feeds\Target

View source

class FractionTarget extends FieldTargetBase implements ConfigurableTargetInterface {

  /**
   * Helper function to define the ways to import the fraction data.
   *
   * @return array
   *   Array with all the possible types.
   */
  protected function importTypes() {
    return [
      'fraction' => $this
        ->t('Fraction'),
      'decimal' => $this
        ->t('Decimal'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'type' => 'fraction',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Filter format'),
      '#options' => $this
        ->importTypes(),
      '#default_value' => $this->configuration['type'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $types = $this
      ->importTypes();
    return $this
      ->t('Import type: %type', [
      '%type' => $types[$this->configuration['type']],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareValue($delta, array &$values) {
    $item = trim($values['value']);
    unset($values['value']);
    switch ($this->configuration['type']) {
      case 'fraction':

        // Pull out the numerator and denominator.
        $parts = explode('/', $item);
        if (!empty($parts[0]) && is_numeric($parts[0]) && !empty($parts[1]) && is_numeric($parts[1]) && $parts[1] >= 0) {
          $values['numerator'] = $parts[0];
          $values['denominator'] = $parts[1];
        }
        else {
          $values['numerator'] = '';
          $values['denominator'] = '';
        }
        break;
      case 'decimal':

        // If item is non-numeric or an empty string, create an empty fraction.
        // Otherwise, pass the value to createFromDecimal().
        if (!is_numeric($item) || $item === '') {
          $values['numerator'] = '';
          $values['denominator'] = '';
        }
        else {
          $fraction = Fraction::createFromDecimal($item);
          $values['numerator'] = $fraction
            ->getNumerator();
          $values['denominator'] = $fraction
            ->getDenominator();
        }
        break;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
FieldTargetBase::$fieldSettings	protected	property	The field settings.
FieldTargetBase::$languageManager	protected	property	The language manager.
FieldTargetBase::addMessage	protected	function	Adds a message.
FieldTargetBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
FieldTargetBase::getEntityTarget	public	function	Get entity, or entity translation to set the map.
FieldTargetBase::getLangcode	public	function	Gets the configured language. Overrides TranslatableTargetInterface::getLangcode
FieldTargetBase::getLanguageManager	protected	function	Gets the language manager.
FieldTargetBase::getMessenger	protected	function	Returns the messenger to use.
FieldTargetBase::getUniqueQuery	protected	function	Constructs a base query which is used to find an existing entity.
FieldTargetBase::getUniqueValue	public	function	Looks for an existing entity and returns an entity ID if found.
FieldTargetBase::isEmpty	public	function	Returns if the value for the target is empty. Overrides TargetInterface::isEmpty
FieldTargetBase::isMutable	public	function	Returns if the target is mutable. Overrides TargetInterface::isMutable	1
FieldTargetBase::isTargetFieldTranslatable	protected	function	Checks if the targeted field is translatable.
FieldTargetBase::isTargetTranslatable	public	function	Checks if the target is translatable. Overrides TranslatableTargetInterface::isTargetTranslatable
FieldTargetBase::languageExists	public	function	Checks if the language selected on the target exists. Overrides TranslatableTargetInterface::languageExists
FieldTargetBase::onDependencyRemoval	public	function	Allows a plugin to define whether it should be removed. Overrides TargetBase::onDependencyRemoval
FieldTargetBase::prepareTarget	protected static	function	Prepares a target definition.	10
FieldTargetBase::prepareValues	protected	function	Prepares the the values that will be mapped to an entity.
FieldTargetBase::setLanguageManager	public	function	Sets the language manager.
FieldTargetBase::setTarget	public	function	Sets the values on an object. Overrides TargetInterface::setTarget	4
FieldTargetBase::targets	public static	function	Returns the targets defined by this plugin. Overrides TargetInterface::targets	1
FieldTargetBase::__construct	public	function	Constructs a TargetBase object. Overrides TargetBase::__construct	5
FractionTarget::buildConfigurationForm	public	function	Form constructor. Overrides FieldTargetBase::buildConfigurationForm
FractionTarget::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FieldTargetBase::defaultConfiguration
FractionTarget::getSummary	public	function	Returns the summary for a target. Overrides FieldTargetBase::getSummary
FractionTarget::importTypes	protected	function	Helper function to define the ways to import the fraction data.
FractionTarget::prepareValue	protected	function	Prepares a single value. Overrides FieldTargetBase::prepareValue
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$feedType	protected	property	The importer this plugin is working for.
PluginBase::$linkGenerator	protected	property	The link generator.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$urlGenerator	protected	property	The url generator.
PluginBase::container	private	function	Returns the service container.
PluginBase::defaultFeedConfiguration	public	function	Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration	3
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::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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::l	protected	function	Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator	protected	function	Returns the link generator service.
PluginBase::onFeedDeleteMultiple	public	function	A feed is being deleted.	3
PluginBase::onFeedSave	public	function	A feed is being saved.
PluginBase::onFeedTypeDelete	public	function	The feed type is being deleted.	1
PluginBase::onFeedTypeSave	public	function	The feed type is being saved.	1
PluginBase::pluginType	public	function	Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
PluginBase::url	protected	function	Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator	protected	function	Returns the URL generator service.
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.
TargetBase::$targetDefinition	protected	property	The target definition.
TargetBase::getTargetDefinition	public	function	Returns the target's definition. Overrides TargetInterface::getTargetDefinition
TargetBase::submitConfigurationForm	public	function	Form submission handler. Overrides ConfigurablePluginBase::submitConfigurationForm

You are here

class FractionTarget in Fraction 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation