class WSDecoderString in Web Service Data 2.0.x

String Decoder.

Plugin annotation

@WSDecoder(
  id = "WSDecoderString",
  label = @Translation("String Decoder (Passes data as is)", context = "WSDecoder"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\wsdata\Plugin\WSDecoderBase implements WSDecoderInterface
    • class \Drupal\wsdata\Plugin\WSDecoder\WSDecoderString

File

src/Plugin/WSDecoder/WSDecoderString.php, line 15

Namespace

Drupal\wsdata\Plugin\WSDecoder

class WSDecoderString extends WSDecoderBase {

  /**
   * {@inheritdoc}
   *
   * Return data as is.
   */
  public function decode($data) {
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
WSDecoderBase::$data	public	property	Storage for decoded data.
WSDecoderBase::$error	protected	property	Storage for error information.
WSDecoderBase::$languages	protected	property	Languages which we have data for.
WSDecoderBase::accepts	public	function	Returns an array of the content type of the data this processor accepts. Overrides WSDecoderInterface::accepts	3
WSDecoderBase::addData	public	function	Add data to an empty object or replace all existing data. Overrides WSDecoderInterface::addData
WSDecoderBase::getData	public	function	Retrieve the value for the given data key. Overrides WSDecoderInterface::getData
WSDecoderBase::getError	public	function	Retrieve error message, if any. Overrides WSDecoderInterface::getError
WSDecoderBase::isCacheable	public	function	Returns whether or not the result on the decoder are cacheable.
WSDecoderBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
WSDecoderString::decode	public	function	Return data as is. Overrides WSDecoderBase::decode