interface ItemStorageInterface

Same name in other branches
  1. 8.9.x core/modules/aggregator/src/ItemStorageInterface.php \Drupal\aggregator\ItemStorageInterface

Defines an interface for aggregator item entity storage classes.

Hierarchy

Expanded class hierarchy of ItemStorageInterface

All classes that implement ItemStorageInterface

2 files declare their use of ItemStorageInterface
AggregatorFeedBlock.php in core/modules/aggregator/src/Plugin/Block/AggregatorFeedBlock.php
DefaultProcessor.php in core/modules/aggregator/src/Plugin/aggregator/processor/DefaultProcessor.php

File

core/modules/aggregator/src/ItemStorageInterface.php, line 10

Namespace

Drupal\aggregator
View source 
interface ItemStorageInterface extends ContentEntityStorageInterface {
    
    /**
     * Returns the count of the items in a feed.
     *
     * @param \Drupal\aggregator\FeedInterface $feed
     *   The feed entity.
     *
     * @return int
     *   The count of items associated with a feed.
     */
    public function getItemCount(FeedInterface $feed);
    
    /**
     * Loads feed items from all feeds.
     *
     * @param int $limit
     *   (optional) The number of items to return. Defaults to unlimited.
     *
     * @return \Drupal\aggregator\ItemInterface[]
     *   An array of the feed items.
     */
    public function loadAll($limit = NULL);
    
    /**
     * Loads feed items filtered by a feed.
     *
     * @param int $fid
     *   The feed ID to filter by.
     * @param int $limit
     *   (optional) The number of items to return. Defaults to unlimited.
     *
     * @return \Drupal\aggregator\ItemInterface[]
     *   An array of the feed items.
     */
    public function loadByFeed($fid, $limit = NULL);

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ContentEntityStorageInterface::createWithSampleValues public function Creates an entity with sample field values. 2
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
EntityStorageInterface::deleteRevision public function Delete a specific entity revision. 4
EntityStorageInterface::FIELD_LOAD_CURRENT constant Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION constant Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery public function Gets an aggregated query instance. 1
EntityStorageInterface::getEntityClass public function Retrieves the class name used to create the entity. 1
EntityStorageInterface::getEntityType public function Gets the entity type definition. 1
EntityStorageInterface::getEntityTypeId public function Gets the entity type ID. 1
EntityStorageInterface::getQuery public function Gets an entity query instance. 1
EntityStorageInterface::hasData public function Determines if the storage contains any data. 1
EntityStorageInterface::load public function Loads one entity. 1
EntityStorageInterface::loadByProperties public function Load entities by their property values without any access checks. 1
EntityStorageInterface::loadMultiple public function Loads one or more entities. 1
EntityStorageInterface::loadRevision public function Load a specific entity revision. 4
EntityStorageInterface::loadUnchanged public function Loads an unchanged entity from the database. 1
EntityStorageInterface::resetCache public function Resets the internal entity cache. 1
EntityStorageInterface::restore public function Restores a previously saved entity. 1
EntityStorageInterface::save public function Saves the entity permanently. 1
ItemStorageInterface::getItemCount public function Returns the count of the items in a feed. 1
ItemStorageInterface::loadAll public function Loads feed items from all feeds. 1
ItemStorageInterface::loadByFeed public function Loads feed items filtered by a feed. 1
RevisionableStorageInterface::getLatestRevisionId public function Returns the latest revision identifier for an entity. 2
RevisionableStorageInterface::loadMultipleRevisions public function Loads multiple entity revisions. 2
TranslatableRevisionableStorageInterface::createRevision public function Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision 2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId public function Returns the latest revision affecting the specified translation. 2
TranslatableStorageInterface::createTranslation public function Constructs a new entity translation object, without permanently saving it. 2

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