PublicationDateItem.php in Publication Date 8

Contains \Drupal\publication_date\Plugin\Field\FieldType\PublicationDateItem.

Namespace

Drupal\publication_date\Plugin\Field\FieldType

File

src/Plugin/Field/FieldType/PublicationDateItem.php

<?php

/**
 * @file
 * Contains \Drupal\publication_date\Plugin\Field\FieldType\PublicationDateItem.
 */
namespace Drupal\publication_date\Plugin\Field\FieldType;

use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Field\Plugin\Field\FieldType\ChangedItem;
use Drupal\Core\TypedData\DataDefinition;

/**
 * Defines the 'published_at' entity field type.
 *
 * Based on a field of this type, entity types can easily implement the
 * EntityChangedInterface.
 *
 * @FieldType(
 *   id = "published_at",
 *   label = @Translation("Publication date"),
 *   description = @Translation("An entity field containing a UNIX timestamp of when the entity has been last updated."),
 *   no_ui = TRUE,
 *   default_widget = "datetime_default",
 *   default_formatter = "timestamp",
 *   list_class = "\Drupal\Core\Field\ChangedFieldItemList"
 * )
 *
 * @see \Drupal\Core\Entity\EntityChangedInterface
 */
class PublicationDateItem extends ChangedItem {

  /**
   * {@inheritdoc}
   */
  public function applyDefaultValue($notify = TRUE) {
    $value = $this
      ->isPublished() ? REQUEST_TIME : NULL;
    $published_at_or_now = isset($value) ? $value : REQUEST_TIME;
    $this
      ->setValue([
      'value' => $value,
      'published_at_or_now' => $published_at_or_now,
    ], $notify);
    return $this;
  }

  /**
   * @inheritDoc
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = parent::propertyDefinitions($field_definition);
    $properties['published_at_or_now'] = DataDefinition::create('timestamp')
      ->setLabel(t('Published at or now'))
      ->setComputed(TRUE);
    return $properties;
  }

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

    // If no publication date has been set and the entity is unpublished then
    // store the default publication date.
    if (!$this
      ->isPublished() && !$this->value) {
      $this->value = PUBLICATION_DATE_DEFAULT;
    }

    // Set the timestamp to request time if it is not set.
    if (!$this->value) {
      $this->value = REQUEST_TIME;
    }
  }
  protected function isPublished() {
    $entity = $this
      ->getEntity();
    if (!($entity instanceof FieldableEntityInterface && $entity
      ->hasField('status'))) {
      return FALSE;
    }
    return $entity
      ->get('status')->value;
  }

  /**
   * @inheritDoc
   */
  public function isEmpty() {
    if (isset($this->value) || isset($this->published_at_or_now)) {
      return FALSE;
    }
    return TRUE;
  }

}

Classes

Name	Description
PublicationDateItem	Defines the 'published_at' entity field type.