interface ClientsConnectionTestingInterface in Web Service Clients 7.3

Interface for testing handlers.

Hierarchy

• interface \ClientsConnectionTestingInterface

File

includes/clients.connection.admin.inc, line 31

clients.connection.admin.inc Page callbacks relating to client connection admin.

interface ClientsConnectionTestingInterface {

  /**
   * The labels for the test.
   *
   * (This is because it would seem you can't define class variables using
   * expressions.)
   *
   * @return
   *  An array of translated strings keyed as follows:
   *    - 'label': The label for the test fieldset.
   *    - 'description': The description for the test fieldset.
   *    - 'button': The text for the test button.
   */
  function testLabels();

  /**
   * Execute the test.
   *
   * Connection test handlers should return the raw data they got back from the
   * connection for display to the user.
   *
   * @param $connection
   *  The connection handler.
   * @param $button_form_values
   *  The form values for the test form element. The values for elements added
   *  to the form are in $button_form_values['params'].
   *
   * @return
   *  Data from the remote connection. This is output to the form as raw data.
   */
  function test($connection, &$button_form_values);

}

Members

Name	Modifiers	Type	Description	Overrides
ClientsConnectionTestingInterface::test		function	Execute the test.	7
ClientsConnectionTestingInterface::testLabels		function	The labels for the test.	7