interface CslStyleInterface in Bibliography & Citation 8

Provides an interface for defining CSL style entities.

Hierarchy

• interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityInterface
    • interface \Drupal\bibcite\Entity\CslStyleInterface

3 files declare their use of CslStyleInterface

Citation.php in modules/bibcite_entity/src/Plugin/views/field/Citation.php

CitationStyler.php in src/CitationStyler.php

CitationStylerInterface.php in src/CitationStylerInterface.php

File

src/Entity/CslStyleInterface.php, line 10

Namespace

Drupal\bibcite\Entity

interface CslStyleInterface extends ConfigEntityInterface {

  /**
   * Check if this style has a prent style.
   *
   * @return bool
   *   Boolean indicate the existence of parent.
   */
  public function hasParent();

  /**
   * Get parent style.
   *
   * @return \Drupal\bibcite\Entity\CslStyleInterface|null
   *   Parent style object or NULL.
   */
  public function getParent();

  /**
   * Set parent style.
   *
   * @param \Drupal\bibcite\Entity\CslStyleInterface|null $parent
   *   Parent style object or NULL if you want to delete relationship.
   *
   * @return $this
   */
  public function setParent($parent = NULL);

  /**
   * Get text of CSL style.
   *
   * @return string
   *   CSL text
   */
  public function getCslText();

  /**
   * Set text of CSL style.
   *
   * @param string $csl_text
   *   The new CSL text.
   *
   * @return $this
   */
  public function setCslText($csl_text);

  /**
   * Get date of the latest update.
   *
   * @return int
   *   Timestamp of the latest update.
   */
  public function getUpdatedTime();

  /**
   * Set a new updated time.
   *
   * @param int $timestamp
   *   Timestamp of updated time.
   *
   * @return $this
   */
  public function setUpdatedTime($timestamp);

  /**
   * Calculate hash from CSL text.
   *
   * @return string
   *   Hash string calculated from CSL text.
   */
  public function calculateHash();

  /**
   * Check if this CSL style is custom.
   *
   * @return bool
   *   TRUE if this CSL style marked as custom and FALSE if not.
   */
  public function isCustom();

  /**
   * Set custom flag for this CSL style.
   *
   * @param bool $custom
   *   The custom flag.
   *
   * @return $this
   */
  public function setCustom($custom);

  /**
   * Get the URL identifier of the style.
   *
   * @return string|null
   *   URL string or NULL.
   */
  public function getUrlId();

  /**
   * Set the URL identifier.
   *
   * @param string $url_id
   *   URL identifier string.
   *
   * @return $this
   */
  public function setUrlId($url_id);

}

Members

Name	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
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
CslStyleInterface::calculateHash	public	function	Calculate hash from CSL text.	1
CslStyleInterface::getCslText	public	function	Get text of CSL style.	1
CslStyleInterface::getParent	public	function	Get parent style.	1
CslStyleInterface::getUpdatedTime	public	function	Get date of the latest update.	1
CslStyleInterface::getUrlId	public	function	Get the URL identifier of the style.	1
CslStyleInterface::hasParent	public	function	Check if this style has a prent style.	1
CslStyleInterface::isCustom	public	function	Check if this CSL style is custom.	1
CslStyleInterface::setCslText	public	function	Set text of CSL style.	1
CslStyleInterface::setCustom	public	function	Set custom flag for this CSL style.	1
CslStyleInterface::setParent	public	function	Set parent style.	1
CslStyleInterface::setUpdatedTime	public	function	Set a new updated time.	1
CslStyleInterface::setUrlId	public	function	Set the URL identifier.	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 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
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
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
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5