interface WSDecoderInterface in Web Service Data 2.0.x

Defines an interface for Wsdecoder plugin plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\wsdata\Plugin\WSDecoderInterface

File

src/Plugin/WSDecoderInterface.php, line 10

Namespace

Drupal\wsdata\Plugin

interface WSDecoderInterface extends PluginInspectionInterface {

  /**
   * Returns a list of the data/encoding formats support by this decoder.
   */
  public function accepts();

  /**
   * Returns the error from the last parse the decoder ran.
   */
  public function getError();

  /**
   * Return the data element at the location given.
   */
  public function getData($key = NULL, $lang = NULL);

  /**
   * Add raw data to be parsed.
   */
  public function addData($data, $lang = NULL, $context = []);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
WSDecoderInterface::accepts	public	function	Returns a list of the data/encoding formats support by this decoder.	1
WSDecoderInterface::addData	public	function	Add raw data to be parsed.	1
WSDecoderInterface::getData	public	function	Return the data element at the location given.	1
WSDecoderInterface::getError	public	function	Returns the error from the last parse the decoder ran.	1