class Item
Same name in this branch
- 9 core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\Item
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\Item
- 10 core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\Item
- 8.9.x core/modules/aggregator/src/Entity/Item.php \Drupal\aggregator\Entity\Item
- 8.9.x core/lib/Drupal/Core/Render/Element/Item.php \Drupal\Core\Render\Element\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
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\aggregator\Entity\Item implements \Drupal\aggregator\ItemInterface extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
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
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.
File
-
core/
modules/ aggregator/ src/ Entity/ Item.php, line 44
Namespace
Drupal\aggregator\EntityView 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());
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.