You are here

interface WSClientEndpointInterface in Web service client 7

Interface for remote endpoints. In case of any errors the implementing classes should throw exceptions.

Hierarchy

Expanded class hierarchy of WSClientEndpointInterface

All classes that implement WSClientEndpointInterface

File

./wsclient.inc, line 174
Web service client - include file.

View source
interface WSClientEndpointInterface {
  public function __construct(WSClientServiceDescription $service);

  /**
   * Connect to the remote web service and call an operation.
   *
   * @param string $operation
   *   The name of the operation.
   * @param $arguments
   *   The arguments needed for the operation.
   *
   * @return
   *   The response of the web service call.
   */
  public function call($operation, $arguments);

  /**
   * An array of info about data types used by the provided events/actions
   * being not entities.
   */
  public function dataTypes();

  /**
   * Allows altering the configuration form of web service definitions, such
   * that the form can include endpoint type specific configuration settings.
   */
  public function formAlter(&$form, &$form_state);

  /**
   * Clear any caches the endpoint maintains.
   */
  public function clearCache();

}

Members

Namesort descending Modifiers Type Description Overrides
WSClientEndpointInterface::call public function Connect to the remote web service and call an operation. 1
WSClientEndpointInterface::clearCache public function Clear any caches the endpoint maintains. 1
WSClientEndpointInterface::dataTypes public function An array of info about data types used by the provided events/actions being not entities. 1
WSClientEndpointInterface::formAlter public function Allows altering the configuration form of web service definitions, such that the form can include endpoint type specific configuration settings. 1
WSClientEndpointInterface::__construct public function 1