class ClientsConnectionDrupalRESTTestGeneric in Web Service Clients 7.3

Test a generic REST request.

Hierarchy

• class \ClientsConnectionDrupalRESTTestGeneric implements ClientsConnectionTestingInterface

1 string reference to 'ClientsConnectionDrupalRESTTestGeneric'

clients_drupal_rest_clients_connection_type_info in connections/clients_drupal_rest/clients_drupal_rest.module

Implements hook_clients_connection_type_info().

File

connections/clients_drupal_rest/clients_drupal_rest.testing.inc, line 280

Contains classes for Client connection testing.

class ClientsConnectionDrupalRESTTestGeneric implements ClientsConnectionTestingInterface {

  /**
   * The labels for the test.
   */
  function testLabels() {
    return array(
      'label' => t('Test a generic request'),
      'description' => t('Test a generic request by specifying the method, service, and resource.'),
      'button' => t('Execute'),
    );
  }

  /**
   * Creates the form element for the test.
   *
   * This gets a form element with the basics in place. If your test needs input
   * parameters, add form elements here.
   *
   * @param $element
   *  A form element for the test's settings and button.
   *
   * @return
   *  The form element with the test's additions.
   */
  function testForm($element) {
    $element['params']['method'] = array(
      '#type' => 'select',
      '#title' => t('Method'),
      '#options' => drupal_map_assoc(array(
        'GET',
        'POST',
        'PUT',
      )),
      '#required' => TRUE,
    );
    $entity_types = array_keys(entity_get_info());
    sort($entity_types);
    $entity_type_options = drupal_map_assoc($entity_types);
    $entity_type_options['_text'] = t('- Other -');
    $element['params']['entity'] = array(
      '#type' => 'select',
      '#title' => t('Entity type'),
      '#description' => t('The entity type to act on; i.e., the resource.'),
      '#options' => $entity_type_options,
      '#required' => FALSE,
    );
    $element['params']['entity_text'] = array(
      '#type' => 'textfield',
      '#title' => t('Entity type'),
      '#description' => t('The entity type to act on, if not in the list above.'),
      '#required' => FALSE,
    );
    $element['params']['entity_prefix'] = array(
      '#type' => 'checkbox',
      '#title' => t('Prefix entity type for Services Entity resource'),
      '#description' => t("Add the 'entity_' prefix to the entity type, for use with entity resources defined by Services Entity module."),
      '#required' => FALSE,
    );
    $element['params']['path'] = array(
      '#type' => 'textfield',
      '#title' => t('Path suffix'),
      '#description' => t('The remainder of the path, e.g., the entity ID, the entity ID and the action, etc.'),
    );
    $element['params']['data'] = array(
      '#type' => 'textarea',
      '#title' => t('Data'),
      '#description' => t('The POST or PUT data to pass, as a JSON array.'),
    );
    $element['params']['data_type'] = array(
      '#type' => 'radios',
      '#title' => t('Data type'),
      '#description' => t('The type of the data.'),
      '#options' => array(
        'json' => 'JSON',
        'php' => 'PHP array',
      ),
    );
    return $element;
  }

  /**
   * 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) {
    if (!empty($button_form_values['params']['entity_text'])) {
      $entity_type = $button_form_values['params']['entity_text'];
    }
    else {
      $entity_type = $button_form_values['params']['entity'];
    }
    if ($button_form_values['params']['entity_prefix']) {
      $resource = 'entity_' . $entity_type;
    }
    else {
      $resource = $entity_type;
    }
    if (!empty($button_form_values['params']['path'])) {
      $path = $resource . '/' . $button_form_values['params']['path'];
    }
    else {
      $path = $resource;
    }
    $method = $button_form_values['params']['method'];
    if (!empty($button_form_values['params']['data'])) {
      if ($button_form_values['params']['data_type'] == 'json') {
        $data = drupal_json_decode($button_form_values['params']['data']);
      }
      else {
        eval('$data = ' . $button_form_values['params']['data'] . ';');
      }
    }
    else {
      $data = array();
    }
    drupal_set_message(t("Making @method request to @path.", array(
      '@method' => $method,
      '@path' => $path,
    )));
    if (module_exists('devel')) {
      dpm($data, 'Data');
      $json_error = json_last_error();
      if ($json_error != JSON_ERROR_NONE) {
        dpm($json_error, 'JSON error');
      }
    }
    try {
      $result = $connection
        ->makeRequest($path, $method, $data);
    } catch (Exception $e) {
      drupal_set_message(t('Could not access the remote site, got error message "@message".', array(
        '@message' => $e
          ->getMessage(),
      )), 'warning');
      return;
    }
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClientsConnectionDrupalRESTTestGeneric::test		function	Execute the test. Overrides ClientsConnectionTestingInterface::test
ClientsConnectionDrupalRESTTestGeneric::testForm		function	Creates the form element for the test.
ClientsConnectionDrupalRESTTestGeneric::testLabels		function	The labels for the test. Overrides ClientsConnectionTestingInterface::testLabels