You are here

Home » API reference » Link checker 8 » LinkCheckerLinkInterface.php

interface LinkCheckerLinkInterface in Link checker 8

Provides an interface defining a LinkCheckerLink type entity.

Hierarchy

Expanded class hierarchy of LinkCheckerLinkInterface

All classes that implement LinkCheckerLinkInterface

14 files declare their use of LinkCheckerLinkInterface
linkchecker.module in ./linkchecker.module
This module periodically check links in given node types, blocks etc.
LinkCheckerAdminSettingsForm.php in src/Form/LinkCheckerAdminSettingsForm.php
LinkCheckerInterfaceTest.php in tests/src/Functional/LinkCheckerInterfaceTest.php
LinkCheckerLink.php in src/Entity/LinkCheckerLink.php
LinkCheckerLinkAccessTest.php in tests/src/Kernel/LinkCheckerLinkAccessTest.php

... See full list

File

src/LinkCheckerLinkInterface.php, line 12

Namespace

Drupal\linkchecker
View source 
interface LinkCheckerLinkInterface extends EntityPublishedInterface, ContentEntityInterface {
  const TYPE_ALL = 0;
  const TYPE_EXTERNAL = 1;
  const TYPE_INTERNAL = 2;

  /**
   * Generates a unique hash for identification purposes.
   *
   * @param string $uri
   *   URI string.
   *
   * @return string
   *   Base 64 hash.
   */
  public static function generateHash($uri);

  /**
   * Gets a URL hash.
   *
   * @return string
   *   The URL hash.
   */
  public function getHash();

  /**
   * Sets a URL hash.
   *
   * @param string $hash
   *   New hash.
   *
   * @return $this
   */
  public function setHash($hash);

  /**
   * Gets URL that was found.
   *
   * @return string
   *   Url.
   */
  public function getUrl();

  /**
   * Sets new URL.
   *
   * @param string $url
   *   The URL.
   *
   * @return $this
   */
  public function setUrl($url);

  /**
   * Gets a request method.
   *
   * @return string
   *   The method.
   */
  public function getRequestMethod();

  /**
   * Sets a request method.
   *
   * @param string $method
   *   The request method.
   *
   * @return $this
   */
  public function setRequestMethod($method);

  /**
   * Gets a response status code.
   *
   * -1 means the link was not checked.
   *
   * @return int
   *   The status code.
   */
  public function getStatusCode();

  /**
   * Sets a response status code.
   *
   * @param int $code
   *   The status code.
   *
   * @return $this
   */
  public function setStatusCode($code);

  /**
   * Gets a response error message.
   *
   * @return string
   *   The error message.
   */
  public function getErrorMessage();

  /**
   * Sets a response error message.
   *
   * @param string $message
   *   The error message.
   *
   * @return $this
   */
  public function setErrorMessage($message);

  /**
   * Gets a number of failed requests.
   *
   * @return int
   *   Number.
   */
  public function getFailCount();

  /**
   * Sets a number of failed requests.
   *
   * @param int $count
   *   New amount.
   *
   * @return $this
   */
  public function setFailCount($count);

  /**
   * Gets last time when the link was checked.
   *
   * @return int
   *   Timestamp.
   */
  public function getLastCheckTime();

  /**
   * Sets a last time the link was checked.
   *
   * @param int $time
   *   Timestamp.
   *
   * @return $this
   */
  public function setLastCheckTime($time);

  /**
   * Gets entity where the link was found.
   *
   * @return \Drupal\Core\Entity\FieldableEntityInterface
   *   Entity.
   */
  public function getParentEntity();

  /**
   * Sets a entity where the link was found.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   Entity.
   *
   * @return $this
   */
  public function setParentEntity(FieldableEntityInterface $entity);

  /**
   * Gets a field name where the link was found.
   *
   * @return string
   *   Field name.
   */
  public function getParentEntityFieldName();

  /**
   * Sets a field name where the link was found.
   *
   * @param string $fieldName
   *   Field name.
   *
   * @return $this
   */
  public function setParentEntityFieldName($fieldName);

  /**
   * Gets a langcode of entity translation where the link was found.
   *
   * @return string
   *   Langcode.
   */
  public function getParentEntityLangcode();

  /**
   * Sets a langcode of entity translation where the link was found.
   *
   * @param string $langcode
   *   Langcode.
   *
   * @return $this
   */
  public function setParentEntityLangcode($langcode);

  /**
   * Returns whether or not the link checking is enabled.
   *
   * @return bool
   *   TRUE if link checking is enabled, FALSE otherwise.
   */
  public function isLinkCheckStatus();

  /**
   * Enable link checking.
   *
   * @return $this
   */
  public function setEnableLinkCheck();

  /**
   * Disable link checking.
   *
   * @return $this
   */
  public function setDisableLinkCheck();

  /**
   * Checks if link was not removed from content.
   *
   * If link becomes blacklisted this method should return false.
   *
   * @return bool
   *   TRUE if link exists in a content.
   */
  public function isExists();

}

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::toArray public function Gets an array of all property values. 3
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
EntityPublishedInterface::isPublished public function Returns whether or not the entity is published.
EntityPublishedInterface::setPublished public function Sets the entity as published.
EntityPublishedInterface::setUnpublished public function Sets the entity as unpublished.
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::validate public function Validates the currently set values. 1
LinkCheckerLinkInterface::generateHash public static function Generates a unique hash for identification purposes. 1
LinkCheckerLinkInterface::getErrorMessage public function Gets a response error message. 1
LinkCheckerLinkInterface::getFailCount public function Gets a number of failed requests. 1
LinkCheckerLinkInterface::getHash public function Gets a URL hash. 1
LinkCheckerLinkInterface::getLastCheckTime public function Gets last time when the link was checked. 1
LinkCheckerLinkInterface::getParentEntity public function Gets entity where the link was found. 1
LinkCheckerLinkInterface::getParentEntityFieldName public function Gets a field name where the link was found. 1
LinkCheckerLinkInterface::getParentEntityLangcode public function Gets a langcode of entity translation where the link was found. 1
LinkCheckerLinkInterface::getRequestMethod public function Gets a request method. 1
LinkCheckerLinkInterface::getStatusCode public function Gets a response status code. 1
LinkCheckerLinkInterface::getUrl public function Gets URL that was found. 1
LinkCheckerLinkInterface::isExists public function Checks if link was not removed from content. 1
LinkCheckerLinkInterface::isLinkCheckStatus public function Returns whether or not the link checking is enabled. 1
LinkCheckerLinkInterface::setDisableLinkCheck public function Disable link checking. 1
LinkCheckerLinkInterface::setEnableLinkCheck public function Enable link checking. 1
LinkCheckerLinkInterface::setErrorMessage public function Sets a response error message. 1
LinkCheckerLinkInterface::setFailCount public function Sets a number of failed requests. 1
LinkCheckerLinkInterface::setHash public function Sets a URL hash. 1
LinkCheckerLinkInterface::setLastCheckTime public function Sets a last time the link was checked. 1
LinkCheckerLinkInterface::setParentEntity public function Sets a entity where the link was found. 1
LinkCheckerLinkInterface::setParentEntityFieldName public function Sets a field name where the link was found. 1
LinkCheckerLinkInterface::setParentEntityLangcode public function Sets a langcode of entity translation where the link was found. 1
LinkCheckerLinkInterface::setRequestMethod public function Sets a request method. 1
LinkCheckerLinkInterface::setStatusCode public function Sets a response status code. 1
LinkCheckerLinkInterface::setUrl public function Sets new URL. 1
LinkCheckerLinkInterface::TYPE_ALL constant
LinkCheckerLinkInterface::TYPE_EXTERNAL constant
LinkCheckerLinkInterface::TYPE_INTERNAL constant
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
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