You are here

abstract class WSEncoderBase in Web Service Data 2.0.x

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

Base class for Web Service Encoder plugins.

Hierarchy

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\Plugin
View 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

Namesort descending 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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
WSEncoderBase::encode abstract public function Encode data into format just sending it off. Overrides WSEncoderInterface::encode 2
WSEncoderBase::isCacheable public function Returns whether or not the result on the encoder are cacheable.