interface PrintableFormatInterface in Printer and PDF versions for Drupal 8+ 2.x
Same name and namespace in other branches
- 8 src/Plugin/PrintableFormatInterface.php \Drupal\printable\Plugin\PrintableFormatInterface
Defines an interface for printable format plugins.
Hierarchy
- interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
- interface \Drupal\printable\Plugin\PrintableFormatInterface
Expanded class hierarchy of PrintableFormatInterface
All classes that implement PrintableFormatInterface
File
- src/
Plugin/ PrintableFormatInterface.php, line 12
Namespace
Drupal\printable\PluginView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigurableInterface:: |
public | function | Gets default configuration for this plugin. | 14 |
ConfigurableInterface:: |
public | function | Gets this plugin's configuration. | 15 |
ConfigurableInterface:: |
public | function | Sets the configuration for this plugin instance. | 15 |
DependentPluginInterface:: |
public | function | Calculates dependencies for the configured plugin. | 20 |
PluginFormInterface:: |
public | function | Form constructor. | 37 |
PluginFormInterface:: |
public | function | Form submission handler. | 32 |
PluginFormInterface:: |
public | function | Form validation handler. | 18 |
PrintableFormatInterface:: |
public | function | Returns the administrative description for this format plugin. | 1 |
PrintableFormatInterface:: |
public | function | Returns the administrative label for this format plugin. | 1 |
PrintableFormatInterface:: |
public | function | Returns the response object for this format plugin. | 1 |
PrintableFormatInterface:: |
public | function | Set the content for the printable response. | 1 |