abstract class WSEncoderBase in Web Service Data 2.0.x
Same name and namespace in other branches
- 8 src/Plugin/WSEncoderBase.php \Drupal\wsdata\Plugin\WSEncoderBase
Base class for Web Service Encoder plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\wsdata\Plugin\WSEncoderBase implements WSEncoderInterface
Expanded class hierarchy of WSEncoderBase
2 files declare their use of WSEncoderBase
- WSEncoderJSON.php in src/
Plugin/ WSEncoder/ WSEncoderJSON.php - WSEncoderString.php in src/
Plugin/ WSEncoder/ WSEncoderString.php
File
- src/
Plugin/ WSEncoderBase.php, line 10
Namespace
Drupal\wsdata\PluginView source
abstract class WSEncoderBase extends PluginBase implements WSEncoderInterface {
/**
* Encode data into format just sending it off.
*/
public abstract function encode(&$data, &$replacement, &$url);
/**
* Returns whether or not the result on the encoder are cacheable.
*/
public function isCacheable() {
return TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
WSEncoderBase:: |
abstract public | function |
Encode data into format just sending it off. Overrides WSEncoderInterface:: |
2 |
WSEncoderBase:: |
public | function | Returns whether or not the result on the encoder are cacheable. |