class GeolocationItem in Geolocation Field 8

Same name and namespace in other branches

8.3 src/Plugin/Field/FieldType/GeolocationItem.php \Drupal\geolocation\Plugin\Field\FieldType\GeolocationItem
8.2 src/Plugin/Field/FieldType/GeolocationItem.php \Drupal\geolocation\Plugin\Field\FieldType\GeolocationItem

Plugin implementation of the 'geolocation' field type.

Plugin annotation


@FieldType(
  id = "geolocation",
  label = @Translation("Geolocation"),
  description = @Translation("This field stores location data (lat, lng)."),
  default_widget = "geolocation_latlng",
  default_formatter = "geolocation_latlng"
)

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\geolocation\Plugin\Field\FieldType\GeolocationItem

Expanded class hierarchy of GeolocationItem

File

src/Plugin/Field/FieldType/GeolocationItem.php, line 22

Namespace

Drupal\geolocation\Plugin\Field\FieldType

View source

class GeolocationItem extends FieldItemBase {

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'lat' => [
          'description' => 'Stores the latitude value',
          'type' => 'float',
          'size' => 'big',
          'not null' => TRUE,
        ],
        'lng' => [
          'description' => 'Stores the longitude value',
          'type' => 'float',
          'size' => 'big',
          'not null' => TRUE,
        ],
        'lat_sin' => [
          'description' => 'Stores the sine of latitude',
          'type' => 'float',
          'size' => 'big',
          'not null' => TRUE,
        ],
        'lat_cos' => [
          'description' => 'Stores the cosine of latitude',
          'type' => 'float',
          'size' => 'big',
          'not null' => TRUE,
        ],
        'lng_rad' => [
          'description' => 'Stores the radian longitude',
          'type' => 'float',
          'size' => 'big',
          'not null' => TRUE,
        ],
        'data' => [
          'description' => 'Serialized array of geolocation meta information.',
          'type' => 'blob',
          'size' => 'big',
          'not null' => FALSE,
          'serialize' => TRUE,
        ],
      ],
      'indexes' => [
        'lat' => [
          'lat',
        ],
        'lng' => [
          'lng',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['lat'] = DataDefinition::create('float')
      ->setLabel(t('Latitude'));
    $properties['lng'] = DataDefinition::create('float')
      ->setLabel(t('Longitude'));
    $properties['lat_sin'] = DataDefinition::create('float')
      ->setLabel(t('Latitude sine'))
      ->setComputed(TRUE);
    $properties['lat_cos'] = DataDefinition::create('float')
      ->setLabel(t('Latitude cosine'))
      ->setComputed(TRUE);
    $properties['lng_rad'] = DataDefinition::create('float')
      ->setLabel(t('Longitude radian'))
      ->setComputed(TRUE);
    $properties['data'] = MapDataDefinition::create()
      ->setLabel(t('Meta data'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $values['lat'] = rand(-90, 90) - rand(0, 999999) / 1000000;
    $values['lng'] = rand(-180, 180) - rand(0, 999999) / 1000000;
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $lat = $this
      ->get('lat')
      ->getValue();
    $lng = $this
      ->get('lng')
      ->getValue();
    return $lat === NULL || $lat === '' || $lng === NULL || $lng === '';
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) {
    parent::setValue($values, $notify);

    // If the values being set do not contain lat_sin, lat_cos or lng_rad,
    // recalculate them.
    if ((empty($values['lat_sin']) || empty($values['lat_cos']) || empty($values['lat_rad'])) && !$this
      ->isEmpty()) {
      $this
        ->get('lat_sin')
        ->setValue(sin(deg2rad(trim($this
        ->get('lat')
        ->getValue()))), FALSE);
      $this
        ->get('lat_cos')
        ->setValue(cos(deg2rad(trim($this
        ->get('lat')
        ->getValue()))), FALSE);
      $this
        ->get('lng_rad')
        ->setValue(deg2rad(trim($this
        ->get('lng')
        ->getValue())), FALSE);
    }
  }

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

    // Update the values and return them.
    foreach ($this->properties as $name => $property) {
      $value = $property
        ->getValue();

      // Only write NULL values if the whole map is not NULL.
      if (isset($this->values) || isset($value)) {
        $this->values[$name] = $value;
      }
    }

    // See #3024504 for an explanation.
    if (array_key_exists('data', $this->values) && empty($this->values['data'])) {
      unset($this->values['data']);
    }
    return $this->values;
  }

  /**
   * {@inheritdoc}
   */
  public function onChange($property_name, $notify = TRUE) {
    parent::onChange($property_name, $notify);

    // Update the calculated properties if lat or lng changed.
    if ($property_name == 'lat' || $property_name == 'lng') {
      $this
        ->get('lat_sin')
        ->setValue(sin(deg2rad(trim($this
        ->get('lat')
        ->getValue()))), FALSE);
      $this
        ->get('lat_cos')
        ->setValue(cos(deg2rad(trim($this
        ->get('lat')
        ->getValue()))), FALSE);
      $this
        ->get('lng_rad')
        ->setValue(deg2rad(trim($this
        ->get('lng')
        ->getValue())), FALSE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preSave() {
    $this
      ->get('lat')
      ->setValue(trim($this
      ->get('lat')
      ->getValue()));
    $this
      ->get('lng')
      ->setValue(trim($this
      ->get('lng')
      ->getValue()));
  }

}

Members

Name	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::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemInterface::defaultFieldSettings	7
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::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::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::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
GeolocationItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
GeolocationItem::getValue	public	function	Gets the data value. Overrides Map::getValue
GeolocationItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
GeolocationItem::onChange	public	function	React to changes to a child property or item. Overrides Map::onChange
GeolocationItem::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemBase::preSave
GeolocationItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
GeolocationItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
GeolocationItem::setValue	public	function	Sets the data value. Overrides FieldItemBase::setValue
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::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

You are here

class GeolocationItem in Geolocation Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation