class Item

Defines the aggregator item entity class.

Plugin annotation


@ContentEntityType(
  id = "aggregator_item",
  label = @Translation("Aggregator feed item"),
  label_collection = @Translation("Aggregator feed items"),
  label_singular = @Translation("aggregator feed item"),
  label_plural = @Translation("aggregator feed items"),
  label_count = @PluralTranslation(
    singular = "@count aggregator feed item",
    plural = "@count aggregator feed items",
  ),
  handlers = {
    "storage" = "Drupal\aggregator\ItemStorage",
    "storage_schema" = "Drupal\aggregator\ItemStorageSchema",
    "view_builder" = "Drupal\aggregator\ItemViewBuilder",
    "access" = "Drupal\aggregator\FeedAccessControlHandler",
    "views_data" = "Drupal\aggregator\AggregatorItemViewsData"
  },
  uri_callback = "Drupal\aggregator\Entity\Item::buildUri",
  base_table = "aggregator_item",
  render_cache = FALSE,
  list_cache_tags = { "aggregator_feed_list" },
  entity_keys = {
    "id" = "iid",
    "label" = "title",
    "langcode" = "langcode",
  }
)

Hierarchy

Expanded class hierarchy of Item

12 files declare their use of Item
AggregatorItemViewsFieldAccessTest.php in core/modules/aggregator/tests/src/Kernel/Views/AggregatorItemViewsFieldAccessTest.php
AggregatorTitleTest.php in core/modules/aggregator/tests/src/Kernel/AggregatorTitleTest.php
DefaultProcessor.php in core/modules/aggregator/src/Plugin/aggregator/processor/DefaultProcessor.php
FeedParserTest.php in core/modules/aggregator/tests/src/Functional/FeedParserTest.php
FeedProcessorPluginTest.php in core/modules/aggregator/tests/src/Functional/FeedProcessorPluginTest.php

... See full list

11 string references to 'Item'
config_test.schema.yml in core/modules/config/tests/config_test/config/schema/config_test.schema.yml
core/modules/config/tests/config_test/config/schema/config_test.schema.yml
ContentTranslationHandler::addTranslatabilityClue in core/modules/content_translation/src/ContentTranslationHandler.php
Adds a clue about the form element translatability.
FormBuilder::handleInputElement in core/lib/Drupal/Core/Form/FormBuilder.php
Adds the #name and #value properties of an input element before rendering.
FormHelper::processStates in core/lib/Drupal/Core/Form/FormHelper.php
Adds JavaScript to change the state of an element based on another element.
JsonApiDocumentTopLevelNormalizer::normalizeOmissionsLinks in core/modules/jsonapi/src/Normalizer/JsonApiDocumentTopLevelNormalizer.php
Normalizes omitted data into a set of omission links.

... See full list

File

core/modules/aggregator/src/Entity/Item.php, line 44

Namespace

Drupal\aggregator\Entity
View source
class Item extends ContentEntityBase implements ItemInterface {
  
  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->get('title')->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields['iid']->setLabel(t('Aggregator item ID'))
      ->setDescription(t('The ID of the feed item.'));
    $fields['langcode']->setLabel(t('Language code'))
      ->setDescription(t('The feed item language code.'));
    $fields['fid'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Source feed'))
      ->setRequired(TRUE)
      ->setDescription(t('The aggregator feed entity associated with this item.'))
      ->setSetting('target_type', 'aggregator_feed')
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'entity_reference_label',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['title'] = BaseFieldDefinition::create('string')->setLabel(t('Title'))
      ->setDescription(t('The title of the feed item.'));
    $fields['link'] = BaseFieldDefinition::create('uri')->setLabel(t('Link'))
      ->setDescription(t('The link of the feed item.'))
      ->setDisplayOptions('view', [
      'region' => 'hidden',
    ])
      ->setDisplayConfigurable('view', TRUE);
    $fields['author'] = BaseFieldDefinition::create('string')->setLabel(t('Author'))
      ->setDescription(t('The author of the feed item.'))
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'weight' => 3,
    ])
      ->setDisplayConfigurable('view', TRUE);
    $fields['description'] = BaseFieldDefinition::create('string_long')->setLabel(t('Description'))
      ->setDescription(t('The body of the feed item.'));
    $fields['timestamp'] = BaseFieldDefinition::create('created')->setLabel(t('Posted on'))
      ->setDescription(t('Posted date of the feed item, as a Unix timestamp.'))
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'type' => 'timestamp_ago',
      'weight' => 1,
    ])
      ->setDisplayConfigurable('view', TRUE);
    // @todo Convert to a real UUID field in
    //   https://www.drupal.org/node/2149851.
    $fields['guid'] = BaseFieldDefinition::create('string_long')->setLabel(t('GUID'))
      ->setDescription(t('Unique identifier for the feed item.'));
    return $fields;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFeedId() {
    return $this->get('fid')->target_id;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setFeedId($fid) {
    return $this->set('fid', $fid);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->get('title')->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setTitle($title) {
    return $this->set('title', $title);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getLink() {
    return $this->get('link')->value ?? '';
  }
  
  /**
   * {@inheritdoc}
   */
  public function setLink($link) {
    return $this->set('link', $link);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getAuthor() {
    return $this->get('author')->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setAuthor($author) {
    return $this->set('author', $author);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->get('description')->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    return $this->set('description', $description);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPostedTime() {
    return $this->get('timestamp')->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setPostedTime($timestamp) {
    return $this->set('timestamp', $timestamp);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getGuid() {
    return $this->get('guid')->value;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setGuid($guid) {
    return $this->set('guid', $guid);
  }
  
  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    // Entity::postSave() calls Entity::invalidateTagsOnSave(), which only
    // handles the regular cases. The Item entity has one special case: a newly
    // created Item is *also* associated with a Feed, so we must invalidate the
    // associated Feed's cache tag.
    if (!$update) {
      Cache::invalidateTags($this->getCacheTagsToInvalidate());
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheTagsToInvalidate() {
    return Feed::load($this->getFeedId())
      ->getCacheTags();
  }
  
  /**
   * Entity URI callback.
   */
  public static function buildUri(ItemInterface $item) {
    return Url::fromUri($item->getLink());
  }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ContentEntityBase::$activeLangcode protected property Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode protected property Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey protected property The default langcode entity key.
ContentEntityBase::$enforceRevisionTranslationAffected protected property Whether the revision translation affected flag has been enforced.
ContentEntityBase::$entityKeys protected property Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions protected property Local cache for field definitions.
ContentEntityBase::$fields protected property The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck protected static property Local cache for fields to skip from the checking for translation changes.
ContentEntityBase::$isDefaultRevision protected property Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey protected property The language entity key.
ContentEntityBase::$languages protected property Local cache for the available language objects.
ContentEntityBase::$loadedRevisionId protected property The loaded revision ID before the new revision was set.
ContentEntityBase::$newRevision protected property Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$revisionTranslationAffectedKey protected property The revision translation affected entity key.
ContentEntityBase::$translatableEntityKeys protected property Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize protected property A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations protected property An array of entity translation metadata.
ContentEntityBase::$validated protected property Whether entity validation was performed.
ContentEntityBase::$validationRequired protected property Whether entity validation is required before saving the entity.
ContentEntityBase::$values protected property The plain data values of the contained fields.
ContentEntityBase::access public function Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle public function Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function Overrides FieldableEntityInterface::bundleFieldDefinitions 4
ContentEntityBase::clearTranslationCache protected function Clear entity translation object cache to remove stale references.
ContentEntityBase::create public static function Overrides EntityBase::create
ContentEntityBase::createDuplicate public function Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions public function Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields public function Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. 1
ContentEntityBase::getIterator public function #[\ReturnTypeWillChange]
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId public function Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields public function Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages public function Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus public function Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField public function Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation public function Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges public function Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id public function Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation public function Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly public function Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision public function Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision public function Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision public function Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation public function Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected public function Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced public function Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable public function Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired public function Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::language public function Overrides EntityBase::language
ContentEntityBase::onChange public function Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate public function Overrides EntityBase::postCreate 1
ContentEntityBase::preSave public function Overrides EntityBase::preSave 8
ContentEntityBase::preSaveRevision public function Overrides RevisionableInterface::preSaveRevision 3
ContentEntityBase::referencedEntities public function Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set public function Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode protected function Populates the local cache for the default language code.
ContentEntityBase::setNewRevision public function Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected public function Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced public function Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired public function Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray public function Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Overrides EntityBase::uuid
ContentEntityBase::validate public function Overrides FieldableEntityInterface::validate 1
ContentEntityBase::wasDefaultRevision public function Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for unset().
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 Aliased as: traitSleep 2
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange] 2
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::delete public function Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Overrides EntityInterface::getConfigTarget 1
EntityBase::getEntityType public function Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getOriginalId public function Overrides EntityInterface::getOriginalId 1
EntityBase::getTypedData public function Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Overrides EntityInterface::hasLinkTemplate
EntityBase::invalidateTagsOnDelete protected static function Invalidates an entity's cache tags upon delete. 1
EntityBase::invalidateTagsOnSave protected function Invalidates an entity's cache tags upon save. 2
EntityBase::isNew public function Overrides EntityInterface::isNew 2
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Overrides EntityInterface::load
EntityBase::loadMultiple public static function Overrides EntityInterface::loadMultiple
EntityBase::postDelete public static function Overrides EntityInterface::postDelete 19
EntityBase::postLoad public static function Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Overrides EntityInterface::preCreate 7
EntityBase::preDelete public static function Overrides EntityInterface::preDelete 8
EntityBase::save public function Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Overrides EntityInterface::toLink
EntityBase::toUrl public function Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuidGenerator protected function Gets the UUID generator.
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip when checking for changes. Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck
Item::baseFieldDefinitions public static function Overrides ContentEntityBase::baseFieldDefinitions
Item::buildUri public static function Entity URI callback.
Item::getAuthor public function Overrides ItemInterface::getAuthor
Item::getCacheTagsToInvalidate public function Overrides EntityBase::getCacheTagsToInvalidate
Item::getDescription public function Overrides ItemInterface::getDescription
Item::getFeedId public function Overrides ItemInterface::getFeedId
Item::getGuid public function Overrides ItemInterface::getGuid
Item::getLink public function Overrides ItemInterface::getLink
Item::getPostedTime public function Overrides ItemInterface::getPostedTime
Item::getTitle public function Overrides ItemInterface::getTitle
Item::label public function Overrides ContentEntityBase::label
Item::postSave public function Overrides ContentEntityBase::postSave
Item::setAuthor public function Overrides ItemInterface::setAuthor
Item::setDescription public function Overrides ItemInterface::setDescription
Item::setFeedId public function Overrides ItemInterface::setFeedId
Item::setGuid public function Overrides ItemInterface::setGuid
Item::setLink public function Overrides ItemInterface::setLink
Item::setPostedTime public function Overrides ItemInterface::setPostedTime
Item::setTitle public function Overrides ItemInterface::setTitle
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
TranslationStatusInterface::TRANSLATION_CREATED constant Status code identifying a newly created translation.
TranslationStatusInterface::TRANSLATION_EXISTING constant Status code identifying an existing translation.
TranslationStatusInterface::TRANSLATION_REMOVED constant Status code identifying a removed translation.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.