You are here

interface PrintableFormatInterface in Printer and PDF versions for Drupal 8+ 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/PrintableFormatInterface.php \Drupal\printable\Plugin\PrintableFormatInterface

Defines an interface for printable format plugins.

Hierarchy

Expanded class hierarchy of PrintableFormatInterface

All classes that implement PrintableFormatInterface

File

src/Plugin/PrintableFormatInterface.php, line 12

Namespace

Drupal\printable\Plugin
View source
interface PrintableFormatInterface extends ConfigurableInterface, DependentPluginInterface, PluginFormInterface {

  /**
   * Returns the administrative label for this format plugin.
   *
   * @return string
   *   The label of plugin.
   */
  public function getLabel();

  /**
   * Returns the administrative description for this format plugin.
   *
   * @return string
   *   The description of plugin.
   */
  public function getDescription();

  /**
   * Set the content for the printable response.
   *
   * @param array $content
   *   A render array of the content to be output by the printable format.
   */
  public function setContent(array $content);

  /**
   * Returns the response object for this format plugin.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function getResponse();

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 14
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 15
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 15
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 20
PluginFormInterface::buildConfigurationForm public function Form constructor. 37
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
PrintableFormatInterface::getDescription public function Returns the administrative description for this format plugin. 1
PrintableFormatInterface::getLabel public function Returns the administrative label for this format plugin. 1
PrintableFormatInterface::getResponse public function Returns the response object for this format plugin. 1
PrintableFormatInterface::setContent public function Set the content for the printable response. 1