interface PrintableFormatInterface in Printer and PDF versions for Drupal 8+ 8

Defines an interface for printable format plugins.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurablePluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\printable\Plugin\PrintableFormatInterface

File

src/Plugin/PrintableFormatInterface.php, line 11

Namespace

Drupal\printable\Plugin

interface PrintableFormatInterface extends ConfigurablePluginInterface, 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

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	1
ConfigurablePluginInterface::getConfiguration	public	function	Gets this plugin's configuration.	1
ConfigurablePluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	1
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
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