You are here

Home » API reference » Feeds 8.3 » SubscriptionInterface.php

interface SubscriptionInterface in Feeds 8.3

Provides an interface defining a feeds_subscription entity.

Hierarchy

Expanded class hierarchy of SubscriptionInterface

All classes that implement SubscriptionInterface

3 files declare their use of SubscriptionInterface
PubSubHubbub.php in src/EventSubscriber/PubSubHubbub.php
Subscription.php in src/Entity/Subscription.php
SubscriptionController.php in src/Controller/SubscriptionController.php

File

src/SubscriptionInterface.php, line 10

Namespace

Drupal\feeds
View source 
interface SubscriptionInterface extends ContentEntityInterface {

  /**
   * Subscribes to a hub that supports pushing content.
   */
  public function subscribe();

  /**
   * Unsubscribes from a hub.
   */
  public function unsubscribe();

  /**
   * Returns a timestamp of when the subscription expires.
   *
   * @return int
   *   The UNIX timestamp when the subscription expires.
   */
  public function getExpire();

  /**
   * Returns the fully-qualified URL of the PuSH hub.
   *
   * @return string
   *   The fully-qualified URL of the PuSH hub.
   */
  public function getHub();

  /**
   * Returns the secret used to verify a request.
   *
   * @return string
   *   The secret used to verify a request.
   */
  public function getSecret();

  /**
   * Returns the feed URL.
   *
   * @return string
   *   The fully-qualified URL of the feed.
   */
  public function getTopic();

  /**
   * Returns the token that is used as part of the URL.
   *
   * @return string
   *   The token used as part of the URL.
   */
  public function getToken();

  /**
   * Returns the state of the subscription.
   *
   * The state of the subscription can be, for example:
   * - 'subscribed', which means that the subscription is active.
   *
   * @return string
   *   The state of the subscription.
   */
  public function getState();

  /**
   * Sets the state of the subscription.
   *
   * @param string $state
   *   The state to set.
   */
  public function setState($state);

  /**
   * Returns the number of seconds of the lease.
   *
   * The hub-determined number of seconds that the subscription will stay active
   * before expiring, measured from the time the verification request was made
   * from the hub to the subscriber.
   *
   * @return int
   *   The time, in seconds of the lease.
   */
  public function getLease();

  /**
   * Sets the number of seconds of the lease.
   *
   * Usually this value is retrieved from the hub where is being subscribed to
   * and then stored on the subscription entity.
   *
   * @param int $lease
   *   The time, in seconds of the lease.
   */
  public function setLease($lease);

  /**
   * Verifies that the content that was pushed comes from a verified source.
   *
   * @param string $sha1
   *   The HMAC signature from the hub.
   * @param string $data
   *   The data to hash and then compare to the hub's signature.
   *
   * @return bool
   *   True if the signature is valid, false otherwise.
   */
  public function checkSignature($sha1, $data);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
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 a created entity 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
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type. 2
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::getLoadedRevisionId public function Gets the loaded Revision ID of the entity. 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::isLatestRevision public function Checks if this entity is the latest 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
RevisionableInterface::updateLoadedRevisionId public function Updates the loaded Revision ID with the revision ID. 1
RevisionableInterface::wasDefaultRevision public function Checks whether the entity object was a default revision when it was saved. 1
SubscriptionInterface::checkSignature public function Verifies that the content that was pushed comes from a verified source. 1
SubscriptionInterface::getExpire public function Returns a timestamp of when the subscription expires. 1
SubscriptionInterface::getHub public function Returns the fully-qualified URL of the PuSH hub. 1
SubscriptionInterface::getLease public function Returns the number of seconds of the lease. 1
SubscriptionInterface::getSecret public function Returns the secret used to verify a request. 1
SubscriptionInterface::getState public function Returns the state of the subscription. 1
SubscriptionInterface::getToken public function Returns the token that is used as part of the URL. 1
SubscriptionInterface::getTopic public function Returns the feed URL. 1
SubscriptionInterface::setLease public function Sets the number of seconds of the lease. 1
SubscriptionInterface::setState public function Sets the state of the subscription. 1
SubscriptionInterface::subscribe public function Subscribes to a hub that supports pushing content. 1
SubscriptionInterface::unsubscribe public function Unsubscribes from a hub. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 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 Checks there is a translation for the given language code. 1
TranslatableInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes. 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
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly public function Checks if untranslatable fields should affect only the default translation. 1
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision public function Checks whether this is the latest revision affecting this translation. 1
TranslatableRevisionableInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision. 1
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced public function Checks if the revision translation affected flag value has been enforced. 1
TranslatableRevisionableInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected. 1
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced public function Enforces the revision translation affected flag value. 1