interface BibCiteProcessorInterface in Bibliography & Citation 8

Defines an interface for Processor plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\bibcite\Plugin\BibCiteProcessorInterface

3 files declare their use of BibCiteProcessorInterface

CitationStyler.php in src/CitationStyler.php

CitationStylerInterface.php in src/CitationStylerInterface.php

CiteprocPhp.php in src/Plugin/BibCiteProcessor/CiteprocPhp.php

File

src/Plugin/BibCiteProcessorInterface.php, line 10

Namespace

Drupal\bibcite\Plugin

interface BibCiteProcessorInterface extends PluginInspectionInterface {

  /**
   * Render citation string from CSL values array.
   *
   * @param array|\stdClass $data
   *   CSL values array or object.
   * @param string $csl
   *   Citation style (CSL) content.
   * @param string $lang
   *   Citation language.
   *
   * @return string
   *   Rendered citation.
   */
  public function render($data, $csl, $lang);

  /**
   * Get plugin description markup.
   *
   * @return mixed
   *   Description markup.
   */
  public function getDescription();

  /**
   * Get plugin label markup.
   *
   * @return mixed
   *   Label markup.
   */
  public function getPluginLabel();

}

Members

Name	Modifiers	Type	Description	Overrides
BibCiteProcessorInterface::getDescription	public	function	Get plugin description markup.	1
BibCiteProcessorInterface::getPluginLabel	public	function	Get plugin label markup.	1
BibCiteProcessorInterface::render	public	function	Render citation string from CSL values array.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2