interface BibciteFormatInterface in Bibliography & Citation 8

Defines interface for BibciteFormat wrapper.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\bibcite\Plugin\BibciteFormatInterface

4 files declare their use of BibciteFormatInterface

bibcite_export.batch.inc in modules/bibcite_export/bibcite_export.batch.inc

Batch callbacks.

bibcite_import.batch.inc in modules/bibcite_import/bibcite_import.batch.inc

Batch functions.

ExportController.php in modules/bibcite_export/src/Controller/ExportController.php

MappingForm.php in modules/bibcite_entity/src/Form/MappingForm.php

File

src/Plugin/BibciteFormatInterface.php, line 11

Namespace

Drupal\bibcite\Plugin

interface BibciteFormatInterface extends PluginInspectionInterface, DerivativeInspectionInterface {

  /**
   * Get list of format types.
   *
   * @return array
   *   List of format types.
   */
  public function getTypes();

  /**
   * Get list of format fields.
   *
   * @return array
   *   List of format fields.
   */
  public function getFields();

  /**
   * Get format label.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   Format label.
   */
  public function getLabel();

  /**
   * Get format file extension.
   *
   * @return string
   *   Format extension.
   */
  public function getExtension();

  /**
   * Check if current format is available for export.
   *
   * @return bool
   *   TRUE if format available for export, FALSE if not.
   */
  public function isExportFormat();

  /**
   * Check if current format is available for import.
   *
   * @return bool
   *   TRUE if format available for import, FALSE if not.
   */
  public function isImportFormat();

}

Members

Name	Modifiers	Type	Description	Overrides
BibciteFormatInterface::getExtension	public	function	Get format file extension.	1
BibciteFormatInterface::getFields	public	function	Get list of format fields.	1
BibciteFormatInterface::getLabel	public	function	Get format label.	1
BibciteFormatInterface::getTypes	public	function	Get list of format types.	1
BibciteFormatInterface::isExportFormat	public	function	Check if current format is available for export.	1
BibciteFormatInterface::isImportFormat	public	function	Check if current format is available for import.	1
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	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