You are here

interface FeedInterface in Zircon Profile 8

Same name in this branch
  1. 8 core/modules/aggregator/src/FeedInterface.php \Drupal\aggregator\FeedInterface
  2. 8 vendor/zendframework/zend-feed/src/Reader/Feed/FeedInterface.php \Zend\Feed\Reader\Feed\FeedInterface
Same name and namespace in other branches
  1. 8.0 core/modules/aggregator/src/FeedInterface.php \Drupal\aggregator\FeedInterface

Provides an interface defining an aggregator feed entity.

Hierarchy

Expanded class hierarchy of FeedInterface

All classes that implement FeedInterface

13 files declare their use of FeedInterface
AggregatorController.php in core/modules/aggregator/src/Controller/AggregatorController.php
Contains \Drupal\aggregator\Controller\AggregatorController.
AggregatorRefresh.php in core/modules/aggregator/src/Plugin/QueueWorker/AggregatorRefresh.php
Contains \Drupal\aggregator\Plugin\QueueWorker\AggregatorRefresh.
AggregatorTestBase.php in core/modules/aggregator/src/Tests/AggregatorTestBase.php
Contains \Drupal\aggregator\Tests\AggregatorTestBase.
DefaultFetcher.php in core/modules/aggregator/src/Plugin/aggregator/fetcher/DefaultFetcher.php
Contains \Drupal\aggregator\Plugin\aggregator\fetcher\DefaultFetcher.
DefaultParser.php in core/modules/aggregator/src/Plugin/aggregator/parser/DefaultParser.php
Contains \Drupal\aggregator\Plugin\aggregator\parser\DefaultParser.

... See full list

File

core/modules/aggregator/src/FeedInterface.php, line 15
Contains \Drupal\aggregator\FeedInterface.

Namespace

Drupal\aggregator
View source
interface FeedInterface extends ContentEntityInterface {

  /**
   * Sets the title of the feed.
   *
   * @param string $title
   *   The short title of the feed.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setTitle($title);

  /**
   * Returns the url to the feed.
   *
   * @return string
   *   The url to the feed.
   */
  public function getUrl();

  /**
   * Sets the url to the feed.
   *
   * @param string $url
   *   A string containing the url of the feed.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setUrl($url);

  /**
   * Returns the refresh rate of the feed in seconds.
   *
   * @return int
   *   The refresh rate of the feed in seconds.
   */
  public function getRefreshRate();

  /**
   * Sets the refresh rate of the feed in seconds.
   *
   * @param int $refresh
   *   The refresh rate of the feed in seconds.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setRefreshRate($refresh);

  /**
   * Returns the last time where the feed was checked for new items.
   *
   * @return int
   *   The timestamp when new items were last checked for.
   */
  public function getLastCheckedTime();

  /**
   * Sets the time when this feed was queued for refresh, 0 if not queued.
   *
   * @param int $checked
   *   The timestamp of the last refresh.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setLastCheckedTime($checked);

  /**
   * Returns the time when this feed was queued for refresh, 0 if not queued.
   *
   * @return int
   *   The timestamp of the last refresh.
   */
  public function getQueuedTime();

  /**
   * Sets the time when this feed was queued for refresh, 0 if not queued.
   *
   * @param int $queued
   *   The timestamp of the last refresh.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setQueuedTime($queued);

  /**
   * Returns the parent website of the feed.
   *
   * @return string
   *   The parent website of the feed.
   */
  public function getWebsiteUrl();

  /**
   * Sets the parent website of the feed.
   *
   * @param string $link
   *   A string containing the parent website of the feed.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setWebsiteUrl($link);

  /**
   * Returns the description of the feed.
   *
   * @return string
   *   The description of the feed.
   */
  public function getDescription();

  /**
   * Sets the description of the feed.
   *
   * @param string $description
   *   The description of the feed.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setDescription($description);

  /**
   * Returns the primary image attached to the feed.
   *
   * @return string
   *   The URL of the primary image attached to the feed.
   */
  public function getImage();

  /**
   * Sets the primary image attached to the feed.
   *
   * @param string $image
   *   An image URL.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setImage($image);

  /**
   * Returns the calculated hash of the feed data, used for validating cache.
   *
   * @return string
   *   The calculated hash of the feed data.
   */
  public function getHash();

  /**
   * Sets the calculated hash of the feed data, used for validating cache.
   *
   * @param string $hash
   *   A string containing the calculated hash of the feed. Must contain
   *   US ASCII characters only.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setHash($hash);

  /**
   * Returns the entity tag HTTP response header, used for validating cache.
   *
   * @return string
   *   The entity tag HTTP response header.
   */
  public function getEtag();

  /**
   * Sets the entity tag HTTP response header, used for validating cache.
   *
   * @param string $etag
   *   A string containing the entity tag HTTP response header.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setEtag($etag);

  /**
   * Return when the feed was modified last time.
   *
   * @return int
   *   The timestamp of the last time the feed was modified.
   */
  public function getLastModified();

  /**
   * Sets the last modification of the feed.
   *
   * @param int $modified
   *   The timestamp when the feed was modified.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   */
  public function setLastModified($modified);

  /**
   * Deletes all items from a feed.
   *
   * This will also reset the last checked and modified time of the feed and
   * save it.
   *
   * @return \Drupal\aggregator\FeedInterface
   *   The class instance that this method is called on.
   *
   * @see \Drupal\aggregator\ItemsImporterInterface::delete()
   */
  public function deleteItems();

  /**
   * Updates the feed items by triggering the import process.
   *
   * This will also update the last checked time of the feed and save it.
   *
   * @return bool
   *   TRUE if there is new content for the feed FALSE otherwise.
   *
   * @see \Drupal\aggregator\ItemsImporterInterface::refresh()
   */
  public function refreshItems();

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 5
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 26
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 26
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 19
ContentEntityInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 1
ContentEntityInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
ContentEntityInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on an entity after it is created but before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
FeedInterface::deleteItems public function Deletes all items from a feed. 1
FeedInterface::getDescription public function Returns the description of the feed. 3
FeedInterface::getEtag public function Returns the entity tag HTTP response header, used for validating cache. 1
FeedInterface::getHash public function Returns the calculated hash of the feed data, used for validating cache. 1
FeedInterface::getImage public function Returns the primary image attached to the feed. 1
FeedInterface::getLastCheckedTime public function Returns the last time where the feed was checked for new items. 1
FeedInterface::getLastModified public function Return when the feed was modified last time. 1
FeedInterface::getQueuedTime public function Returns the time when this feed was queued for refresh, 0 if not queued. 1
FeedInterface::getRefreshRate public function Returns the refresh rate of the feed in seconds. 1
FeedInterface::getUrl public function Returns the url to the feed. 1
FeedInterface::getWebsiteUrl public function Returns the parent website of the feed. 1
FeedInterface::refreshItems public function Updates the feed items by triggering the import process. 1
FeedInterface::setDescription public function Sets the description of the feed. 1
FeedInterface::setEtag public function Sets the entity tag HTTP response header, used for validating cache. 1
FeedInterface::setHash public function Sets the calculated hash of the feed data, used for validating cache. 1
FeedInterface::setImage public function Sets the primary image attached to the feed. 1
FeedInterface::setLastCheckedTime public function Sets the time when this feed was queued for refresh, 0 if not queued. 1
FeedInterface::setLastModified public function Sets the last modification of the feed. 1
FeedInterface::setQueuedTime public function Sets the time when this feed was queued for refresh, 0 if not queued. 1
FeedInterface::setRefreshRate public function Sets the refresh rate of the feed in seconds. 1
FeedInterface::setTitle public function Sets the title of the feed. 1
FeedInterface::setUrl public function Sets the url to the feed. 1
FeedInterface::setWebsiteUrl public function Sets the parent website of the feed. 1
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 14
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle. 2
FieldableEntityInterface::get public function Gets a field item list. 1
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field. 1
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields. 1
FieldableEntityInterface::getFields public function Gets an array of all field item lists. 1
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields. 1
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name. 1
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity. 1
FieldableEntityInterface::onChange public function Reacts to changes to a field. 1
FieldableEntityInterface::set public function Sets a field value. 1
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity. 1
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity. 1
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision. 1
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save. 1
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved. 1
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 1
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object. 1
TranslatableInterface::getTranslation public function Gets a translation of the data. 1
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 1
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language. 1
TranslatableInterface::hasTranslation public function Returns TRUE there is a translation for the given language code. 1
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one. 1
TranslatableInterface::isNewTranslation public function Checks whether the translation is new. 1
TranslatableInterface::isTranslatable public function Returns the translation support status. 1
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code. 1