You are here

Home » API reference » Bibliography & Citation 8 » ContributorInterface.php

interface ContributorInterface in Bibliography & Citation 8

Same name and namespace in other branches
  1. 2.0.x modules/bibcite_entity/src/Entity/ContributorInterface.php \Drupal\bibcite_entity\Entity\ContributorInterface

Provides an interface for defining Contributor entities.

Hierarchy

Expanded class hierarchy of ContributorInterface

All classes that implement ContributorInterface

File

modules/bibcite_entity/src/Entity/ContributorInterface.php, line 13

Namespace

Drupal\bibcite_entity\Entity
View source 
interface ContributorInterface extends ContentEntityInterface, EntityChangedInterface {

  /**
   * List machine names of entity fields which contain name parts.
   *
   * @return string[]
   *   List of fields machine names.
   */
  public static function getNameParts();

  /**
   * Gets the Contributor name.
   *
   * @return string
   *   Name of the Contributor.
   */
  public function getName();

  /**
   * Get the Contributor first name.
   *
   * @return string
   *   First name of Contributor.
   */
  public function getFirstName();

  /**
   * Get the Contributor middle name.
   *
   * @return string
   *   Middle name of Contributor.
   */
  public function getMiddleName();

  /**
   * Get the Contributor last name.
   *
   * @return string
   *   Last name of Contributor.
   */
  public function getLastName();

  /**
   * Get the Contributor nickname.
   *
   * @return string
   *   Nickname of Contributor.
   */
  public function getNickName();

  /**
   * Get the Contributor suffix.
   *
   * @return string
   *   Suffix of Contributor.
   */
  public function getSuffix();

  /**
   * Get the Contributor prefix.
   *
   * @return string
   *   Prefix of Contributor.
   */
  public function getPrefix();

  /**
   * Get the Contributor leading initial.
   *
   * @return string
   *   Leading initial of Contributor.
   */
  public function getLeadingInitial();

  /**
   * Sets the Contributor full name.
   *
   * Full name string will be parsed and another fields will be changed.
   *
   * @param string $name
   *   Full name sting.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setName($name);

  /**
   * Sets the Contributor first name.
   *
   * @param string $first_name
   *   The Contributor first name.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setFirstName($first_name);

  /**
   * Sets the Contributor middle name.
   *
   * @param string $middle_name
   *   The Contributor middle name.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setMiddleName($middle_name);

  /**
   * Sets the Contributor last name.
   *
   * @param string $last_name
   *   The Contributor last name.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setLastName($last_name);

  /**
   * Sets the Contributor nickname.
   *
   * @param string $nick
   *   The Contributor nickname.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setNickName($nick);

  /**
   * Sets the Contributor suffix.
   *
   * @param string $suffix
   *   The Contributor suffix.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setSuffix($suffix);

  /**
   * Sets the Contributor prefix.
   *
   * @param string $prefix
   *   The Contributor prefix.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setPrefix($prefix);

  /**
   * Sets the Contributor leading initial.
   *
   * @param string $leading
   *   The Contributor leading initial.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setLeadingInitial($leading);

  /**
   * Gets the Contributor creation timestamp.
   *
   * @return int
   *   Creation timestamp of the Contributor.
   */
  public function getCreatedTime();

  /**
   * Sets the Contributor creation timestamp.
   *
   * @param int $timestamp
   *   The Contributor creation timestamp.
   *
   * @return \Drupal\bibcite_entity\Entity\ContributorInterface
   *   The called Contributor entity.
   */
  public function setCreatedTime($timestamp);

}

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
ContributorInterface::getCreatedTime public function Gets the Contributor creation timestamp. 1
ContributorInterface::getFirstName public function Get the Contributor first name. 1
ContributorInterface::getLastName public function Get the Contributor last name. 1
ContributorInterface::getLeadingInitial public function Get the Contributor leading initial. 1
ContributorInterface::getMiddleName public function Get the Contributor middle name. 1
ContributorInterface::getName public function Gets the Contributor name. 1
ContributorInterface::getNameParts public static function List machine names of entity fields which contain name parts. 1
ContributorInterface::getNickName public function Get the Contributor nickname. 1
ContributorInterface::getPrefix public function Get the Contributor prefix. 1
ContributorInterface::getSuffix public function Get the Contributor suffix. 1
ContributorInterface::setCreatedTime public function Sets the Contributor creation timestamp. 1
ContributorInterface::setFirstName public function Sets the Contributor first name. 1
ContributorInterface::setLastName public function Sets the Contributor last name. 1
ContributorInterface::setLeadingInitial public function Sets the Contributor leading initial. 1
ContributorInterface::setMiddleName public function Sets the Contributor middle name. 1
ContributorInterface::setName public function Sets the Contributor full name. 1
ContributorInterface::setNickName public function Sets the Contributor nickname. 1
ContributorInterface::setPrefix public function Sets the Contributor prefix. 1
ContributorInterface::setSuffix public function Sets the Contributor suffix. 1
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
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
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