You are here

Home » API reference » CiviCRM Entity 8.3 » ActivityEndDateFieldItemList.php

class ActivityEndDateFieldItemList in CiviCRM Entity 8.3

A computed field item list for Activities to provide an end date and time.

In this class, you will notice timezone conversions from the default timezone to UTC. CiviCRM stores dates in the expected timezone, and Drupal always stores them in UTC. So we have to do a bit of conversion.

This is also automatically done when a CivicrmEntity instance is saved and when an entity is loaded.

Hierarchy

Expanded class hierarchy of ActivityEndDateFieldItemList

See also

\Drupal\civicrm_entity\Entity\CivicrmEntity::civicrmApiNormalize

\Drupal\civicrm_entity\CiviEntityStorage::initFieldValues

1 file declares its use of ActivityEndDateFieldItemList
CivicrmEntity.php in src/Entity/CivicrmEntity.php

File

src/Plugin/Field/ActivityEndDateFieldItemList.php, line 23

Namespace

Drupal\civicrm_entity\Plugin\Field
View source 
class ActivityEndDateFieldItemList extends FieldItemList {
  use ComputedItemListTrait;

  /**
   * {@inheritdoc}
   */
  protected function computeValue() {
    $entity = $this
      ->getEntity();
    assert($entity instanceof CivicrmEntity);
    $activity_date_time = $entity
      ->get('activity_date_time')->value;
    $duration = $entity
      ->get('duration')->value;
    if (!$activity_date_time) {
      return;
    }

    // The time is already in UTC due to ::initFieldValues in storage.
    // @see \Drupal\civicrm_entity\CiviEntityStorage::initFieldValues
    $date = new \DateTime($activity_date_time, new \DateTimeZone('UTC'));

    // We have to change this _back_ to the default timezone, as initFieldValues
    // will be called again and it assumes the value is from CiviCRM, in the
    // default timezone.
    $date
      ->setTimezone(new \DateTimeZone(date_default_timezone_get()));
    if (is_numeric($duration)) {
      $date
        ->add(new \DateInterval("PT{$duration}M"));
    }
    $this->list[0] = $this
      ->createItem(0, $date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT));
  }

  /**
   * {@inheritdoc}
   *
   * Recalculate the activities duration if the end date has been changed.
   */
  public function onChange($delta) {
    $entity = $this
      ->getEntity();
    assert($entity instanceof CivicrmEntity);

    // Since we're calculating a difference in times, we can use UTC.
    $activity_date_time = new \DateTime($entity
      ->get('activity_date_time')->value, new \DateTimeZone('UTC'));
    $new_end_date = new \DateTime($this
      ->get($delta)->value, new \DateTimeZone('UTC'));
    $diff = $new_end_date
      ->getTimestamp() - $activity_date_time
      ->getTimestamp();
    $minutes = $diff / 60;
    $entity
      ->get('duration')
      ->setValue($minutes);
    parent::onChange($delta);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActivityEndDateFieldItemList::computeValue protected function Computes the values for an item list. Overrides ComputedItemListTrait::computeValue
ActivityEndDateFieldItemList::onChange public function Recalculate the activities duration if the end date has been changed. Overrides ItemList::onChange
ComputedItemListTrait::$valueComputed protected property Whether the values have already been computed or not.
ComputedItemListTrait::appendItem public function
ComputedItemListTrait::applyDefaultValue public function
ComputedItemListTrait::count public function
ComputedItemListTrait::ensureComputedValue protected function Ensures that values are only computed once.
ComputedItemListTrait::get public function
ComputedItemListTrait::getIterator public function
ComputedItemListTrait::getString public function
ComputedItemListTrait::getValue public function
ComputedItemListTrait::isEmpty public function
ComputedItemListTrait::offsetExists public function
ComputedItemListTrait::removeItem public function
ComputedItemListTrait::set public function
ComputedItemListTrait::setValue public function 1
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
FieldItemList::$langcode protected property The langcode of the field values held in the object.
FieldItemList::$list protected property Numerically indexed array of field items. Overrides ItemList::$list 1
FieldItemList::access public function Checks data value access. Overrides AccessibleInterface::access 1
FieldItemList::createItem protected function Helper for creating a list item object. Overrides ItemList::createItem
FieldItemList::defaultAccess public function Contains the default access logic of this field. Overrides FieldItemListInterface::defaultAccess 3
FieldItemList::defaultValuesForm public function Returns a form for the default value input. Overrides FieldItemListInterface::defaultValuesForm 2
FieldItemList::defaultValuesFormSubmit public function Processes the submitted default value. Overrides FieldItemListInterface::defaultValuesFormSubmit 2
FieldItemList::defaultValuesFormValidate public function Validates the submitted default value. Overrides FieldItemListInterface::defaultValuesFormValidate 1
FieldItemList::defaultValueWidget protected function Returns the widget object used in default value form.
FieldItemList::delegateMethod protected function Calls a method on each FieldItem.
FieldItemList::delete public function Defines custom delete behavior for field values. Overrides FieldItemListInterface::delete 2
FieldItemList::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemListInterface::deleteRevision 1
FieldItemList::equals public function Determines equality to another object implementing FieldItemListInterface. Overrides FieldItemListInterface::equals 2
FieldItemList::filterEmptyItems public function Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems
FieldItemList::generateSampleItems public function Populates a specified number of field items with valid sample data. Overrides FieldItemListInterface::generateSampleItems
FieldItemList::getConstraints public function Gets a list of validation constraints. Overrides TypedData::getConstraints 1
FieldItemList::getEntity public function Gets the entity that field belongs to. Overrides FieldItemListInterface::getEntity 1
FieldItemList::getFieldDefinition public function Gets the field definition. Overrides FieldItemListInterface::getFieldDefinition
FieldItemList::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemListInterface::getLangcode
FieldItemList::getSetting public function Returns the value of a given field setting. Overrides FieldItemListInterface::getSetting
FieldItemList::getSettings public function Returns the array of field settings. Overrides FieldItemListInterface::getSettings
FieldItemList::hasAffectingChanges public function Determines whether the field has relevant changes. Overrides FieldItemListInterface::hasAffectingChanges 1
FieldItemList::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemListInterface::postSave 1
FieldItemList::preSave public function Defines custom presave behavior for field values. Overrides FieldItemListInterface::preSave 1
FieldItemList::processDefaultValue public static function Processes the default value before being applied. Overrides FieldItemListInterface::processDefaultValue 2
FieldItemList::setLangcode public function Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
FieldItemList::view public function Returns a renderable array for the field items. Overrides FieldItemListInterface::view
FieldItemList::__get public function Magic method: Gets a property value of to the first field item. Overrides FieldItemListInterface::__get
FieldItemList::__isset public function Magic method: Determines whether a property of the first field item is set. Overrides FieldItemListInterface::__isset
FieldItemList::__set public function Magic method: Sets a property value of the first field item. Overrides FieldItemListInterface::__set
FieldItemList::__unset public function Magic method: Unsets a property of the first field item. Overrides FieldItemListInterface::__unset
ItemList::filter public function Filters the items in the list using a custom callback. Overrides ListInterface::filter
ItemList::first public function Returns the first item in this list. Overrides ListInterface::first
ItemList::getItemDefinition public function Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
ItemList::offsetGet public function
ItemList::offsetSet public function
ItemList::offsetUnset public function
ItemList::rekey protected function Renumbers the items in the list.
ItemList::__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::$definition protected property The data definition. 1
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::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
TypedData::__construct public function Constructs a TypedData object given its definition and context. 3
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