You are here

Home » API reference » Voting API Reaction 8 » VotingApiReactionItem.php

class VotingApiReactionItem in Voting API Reaction 8

Plugin implementation of the 'votingapi_reaction' field type.

Plugin annotation


@FieldType(
  id = "votingapi_reaction",
  label = @Translation("Reaction"),
  description = @Translation("Allows user to react to an entity"),
  default_widget = "votingapi_reaction_default",
  default_formatter = "votingapi_reaction_default",
  cardinality = 1,
)

Hierarchy

Expanded class hierarchy of VotingApiReactionItem

File

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

Namespace

Drupal\votingapi_reaction\Plugin\Field\FieldType
View source 
class VotingApiReactionItem extends FieldItemBase implements VotingApiReactionItemInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'anonymous_detection' => [
        VotingApiReactionItemInterface::BY_COOKIES,
        VotingApiReactionItemInterface::BY_IP,
      ],
      'anonymous_rollover' => VotingApiReactionItemInterface::VOTINGAPI_ROLLOVER,
      'reactions' => [
        'reaction_angry',
        'reaction_laughing',
        'reaction_like',
        'reaction_love',
        'reaction_sad',
        'reaction_surprised',
      ],
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    return [
      'status' => DataDefinition::create('integer')
        ->setLabel(t('Reaction status'))
        ->setRequired(TRUE),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'status' => [
          'description' => 'Whether reactions are allowed on this entity: 0 = no, 1 = closed (read only), 2 = open (read/write).',
          'type' => 'int',
          'default' => 0,
        ],
      ],
      'indexes' => [],
      'foreign keys' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $element = [
      '#attached' => [
        'library' => [
          'votingapi_reaction/settings_styles',
        ],
      ],
    ];
    $element['anonymous_detection'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Anonymous detection method'),
      '#description' => $this
        ->t("By which method anonymous users must be detected. Warning: Detecting users by cookies is not a reliable way, as cookies could be easily manipulated by users."),
      '#options' => [
        VotingApiReactionItemInterface::BY_COOKIES => $this
          ->t('By cookies'),
        VotingApiReactionItemInterface::BY_IP => $this
          ->t('By IP'),
      ],
      '#default_value' => $this
        ->getSetting('anonymous_detection'),
      '#required' => TRUE,
    ];
    $options = [
      300,
      900,
      1800,
      3600,
      10800,
      21600,
      32400,
      43200,
      86400,
      172800,
      345600,
      604800,
    ];
    foreach ($options as $key => $option) {
      unset($options[$key]);
      $options[$option] = \Drupal::service('date.formatter')
        ->formatInterval($option);
    }
    $options[VotingApiReactionItemInterface::NEVER_ROLLOVER] = $this
      ->t('Never');
    $options[VotingApiReactionItemInterface::VOTINGAPI_ROLLOVER] = $this
      ->t('Voting API Default');
    $element['anonymous_rollover'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Anonymous vote rollover'),
      '#description' => $this
        ->t("The amount of time that must pass before two anonymous votes from the same computer are considered unique. Setting this to 'never' will eliminate most double-voting, but will make it impossible for multiple anonymous on the same computer (like internet cafe customers) from casting votes."),
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('anonymous_rollover'),
    ];
    $reactionManager = \Drupal::service('votingapi_reaction.manager');
    $element['reactions'] = [
      '#title' => $this
        ->t('Reactions'),
      '#type' => 'checkboxes',
      '#required' => TRUE,
      '#options' => $reactionManager
        ->getReactions([
        'show_icon' => TRUE,
        'show_label' => TRUE,
        'show_count' => FALSE,
        'sort_reactions' => 'none',
        'reactions' => array_keys($reactionManager
          ->allReactions()),
      ], []),
      '#default_value' => $this
        ->getSetting('reactions'),
      '#attributes' => [
        'class' => [
          'votingapi-reaction-settings',
        ],
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function mainPropertyName() {
    return 'status';
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {

    // @TODO check if Voting API tables have records for this field
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $statuses = [
      VotingApiReactionItemInterface::HIDDEN,
      VotingApiReactionItemInterface::CLOSED,
      VotingApiReactionItemInterface::OPEN,
    ];
    return [
      'status' => $statuses[mt_rand(0, count($statuses) - 1)],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings 10
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::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::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::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm 8
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
VotingApiReactionItem::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
VotingApiReactionItem::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
VotingApiReactionItem::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
VotingApiReactionItem::isEmpty public function Determines whether the data structure is empty. Overrides Map::isEmpty
VotingApiReactionItem::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
VotingApiReactionItem::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
VotingApiReactionItem::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema
VotingApiReactionItemInterface::BY_COOKIES constant Methods by which sessions for anonymous users will be detected.
VotingApiReactionItemInterface::BY_IP constant
VotingApiReactionItemInterface::CLOSED constant Reactions for this entity are closed.
VotingApiReactionItemInterface::HIDDEN constant Reactions for this entity are hidden.
VotingApiReactionItemInterface::NEVER_ROLLOVER constant Reactions for this entity will never rollover.
VotingApiReactionItemInterface::OPEN constant Reactions for this entity are open.
VotingApiReactionItemInterface::VOTINGAPI_ROLLOVER constant Reactions for this entity will rollover based on Voting API settings.