interface FileSchemeHandlerInterface in Acquia Content Hub 8.2

The interface for file scheme handlers.

@package Drupal\acquia_contenthub\Plugin\FileSchemeHandler

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\acquia_contenthub\Plugin\FileSchemeHandler\FileSchemeHandlerInterface

1 file declares its use of FileSchemeHandlerInterface

S3FileSchemeHandler.php in modules/acquia_contenthub_s3/src/Plugin/FileSchemeHandler/S3FileSchemeHandler.php

File

src/Plugin/FileSchemeHandler/FileSchemeHandlerInterface.php, line 14

Namespace

Drupal\acquia_contenthub\Plugin\FileSchemeHandler

interface FileSchemeHandlerInterface extends PluginInspectionInterface {

  /**
   * Add attributes to the CDF to support import of a file by this scheme.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $object
   *   The CDF Object.
   * @param \Drupal\file\FileInterface $file
   *   The file to add to the CDF Object.
   */
  public function addAttributes(CDFObject $object, FileInterface $file);

  /**
   * Makes file available to Drupal through the correct stream wrapper.
   *
   * This does not return the file, but will save it with the appropriate
   * stream wrapper for Drupal to utilize.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $object
   *   The CDFObject from which to extract details about getting the file.
   *
   * @return bool
   *   Whether the file successfully saved or not.
   */
  public function getFile(CDFObject $object);

}

Members

Name	Modifiers	Type	Description	Overrides
FileSchemeHandlerInterface::addAttributes	public	function	Add attributes to the CDF to support import of a file by this scheme.	6
FileSchemeHandlerInterface::getFile	public	function	Makes file available to Drupal through the correct stream wrapper.	6
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