You are here

Home » API reference » Zircon Profile 8 » DateTimeFieldItemList.php

class DateTimeFieldItemList in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/datetime/src/Plugin/Field/FieldType/DateTimeFieldItemList.php \Drupal\datetime\Plugin\Field\FieldType\DateTimeFieldItemList

Represents a configurable entity datetime field.

Hierarchy

Expanded class hierarchy of DateTimeFieldItemList

File

core/modules/datetime/src/Plugin/Field/FieldType/DateTimeFieldItemList.php, line 19
Contains \Drupal\datetime\Plugin\Field\FieldType\DateTimeFieldItemList.

Namespace

Drupal\datetime\Plugin\Field\FieldType
View source 
class DateTimeFieldItemList extends FieldItemList {

  /**
   * Defines the default value as now.
   */
  const DEFAULT_VALUE_NOW = 'now';

  /**
   * Defines the default value as relative.
   */
  const DEFAULT_VALUE_CUSTOM = 'relative';

  /**
   * {@inheritdoc}
   */
  public function defaultValuesForm(array &$form, FormStateInterface $form_state) {
    if (empty($this
      ->getFieldDefinition()
      ->getDefaultValueCallback())) {
      $default_value = $this
        ->getFieldDefinition()
        ->getDefaultValueLiteral();
      $element = array(
        '#parents' => array(
          'default_value_input',
        ),
        'default_date_type' => array(
          '#type' => 'select',
          '#title' => t('Default date'),
          '#description' => t('Set a default value for this date.'),
          '#default_value' => isset($default_value[0]['default_date_type']) ? $default_value[0]['default_date_type'] : '',
          '#options' => array(
            static::DEFAULT_VALUE_NOW => t('Current date'),
            static::DEFAULT_VALUE_CUSTOM => t('Relative date'),
          ),
          '#empty_value' => '',
        ),
        'default_date' => array(
          '#type' => 'textfield',
          '#title' => t('Relative default value'),
          '#description' => t("Describe a time by reference to the current day, like '+90 days' (90 days from the day the field is created) or '+1 Saturday' (the next Saturday). See <a href=\"@url\">@strtotime</a> for more details.", array(
            '@strtotime' => 'strtotime',
            '@url' => 'http://www.php.net/manual/en/function.strtotime.php',
          )),
          '#default_value' => isset($default_value[0]['default_date_type']) && $default_value[0]['default_date_type'] == static::DEFAULT_VALUE_CUSTOM ? $default_value[0]['default_date'] : '',
          '#states' => array(
            'visible' => array(
              ':input[id="edit-default-value-input-default-date-type"]' => array(
                'value' => static::DEFAULT_VALUE_CUSTOM,
              ),
            ),
          ),
        ),
      );
      return $element;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function defaultValuesFormValidate(array $element, array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue([
      'default_value_input',
      'default_date_type',
    ]) == static::DEFAULT_VALUE_CUSTOM) {
      $is_strtotime = @strtotime($form_state
        ->getValue(array(
        'default_value_input',
        'default_date',
      )));
      if (!$is_strtotime) {
        $form_state
          ->setErrorByName('default_value_input][default_date', t('The relative date value entered is invalid.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function defaultValuesFormSubmit(array $element, array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue(array(
      'default_value_input',
      'default_date_type',
    ))) {
      if ($form_state
        ->getValue(array(
        'default_value_input',
        'default_date_type',
      )) == static::DEFAULT_VALUE_NOW) {
        $form_state
          ->setValueForElement($element['default_date'], static::DEFAULT_VALUE_NOW);
      }
      return array(
        $form_state
          ->getValue('default_value_input'),
      );
    }
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public static function processDefaultValue($default_value, FieldableEntityInterface $entity, FieldDefinitionInterface $definition) {
    $default_value = parent::processDefaultValue($default_value, $entity, $definition);
    if (isset($default_value[0]['default_date_type'])) {

      // A default value should be in the format and timezone used for date
      // storage.
      $date = new DrupalDateTime($default_value[0]['default_date'], DATETIME_STORAGE_TIMEZONE);
      $storage_format = $definition
        ->getSetting('datetime_type') == DateTimeItem::DATETIME_TYPE_DATE ? DATETIME_DATE_STORAGE_FORMAT : DATETIME_DATETIME_STORAGE_FORMAT;
      $value = $date
        ->format($storage_format);

      // We only provide a default value for the first item, as do all fields.
      // Otherwise, there is no way to clear out unwanted values on multiple value
      // fields.
      $default_value = array(
        array(
          'value' => $value,
          'date' => $date,
        ),
      );
    }
    return $default_value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DateTimeFieldItemList::defaultValuesForm public function Returns a form for the default value input. Overrides FieldItemList::defaultValuesForm
DateTimeFieldItemList::defaultValuesFormSubmit public function Processes the submitted default value. Overrides FieldItemList::defaultValuesFormSubmit
DateTimeFieldItemList::defaultValuesFormValidate public function Validates the submitted default value. Overrides FieldItemList::defaultValuesFormValidate
DateTimeFieldItemList::DEFAULT_VALUE_CUSTOM constant Defines the default value as relative.
DateTimeFieldItemList::DEFAULT_VALUE_NOW constant Defines the default value as now.
DateTimeFieldItemList::processDefaultValue public static function Processes the default value before being applied. Overrides FieldItemList::processDefaultValue
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
FieldItemList::access public function Checks data value access. Overrides AccessibleInterface::access
FieldItemList::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue
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 2
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 1
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
FieldItemList::filterEmptyItems public function Filters out empty field items and re-numbers the item deltas. Overrides FieldItemListInterface::filterEmptyItems
FieldItemList::generateSampleItems public function 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
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::getValue public function @todo Revisit the need when all entity types are converted to NG entities. Overrides ItemList::getValue
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
FieldItemList::setLangcode public function Sets the langcode of the field values held in the object. Overrides FieldItemListInterface::setLangcode
FieldItemList::setValue public function Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides ItemList::setValue
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::appendItem public function Appends a new item to the list. Overrides ListInterface::appendItem
ItemList::count public function
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::get public function Returns the item at the specified position in this list. Overrides ListInterface::get 1
ItemList::getItemDefinition public function Gets the definition of a contained item. Overrides ListInterface::getItemDefinition
ItemList::getIterator public function
ItemList::getString public function Returns a string representation of the data. Overrides TypedData::getString
ItemList::isEmpty public function Determines whether the list contains any non-empty items. Overrides ListInterface::isEmpty
ItemList::offsetExists public function 1
ItemList::offsetGet public function
ItemList::offsetSet public function
ItemList::offsetUnset public function
ItemList::onChange public function React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange
ItemList::rekey protected function Renumbers the items in the list.
ItemList::removeItem public function Removes the item at the specified position. Overrides ListInterface::removeItem
ItemList::set public function Sets the value of the item at a given position in the list. Overrides ListInterface::set
ItemList::__clone public function Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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. 1
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 1