protected function RESTServer::resolveController in Services 7.3

Same name and namespace in other branches

1. 6.3 servers/rest_server/includes/RESTServer.inc \RESTServer::resolveController()

Determine controller.

Parameters

array $resource: Full definition of the resource.

string $operation: Type of operation ('index', 'retrieve' etc.). We are going to override this variable. Needed for applying version.

Return value

array Controller definition.

2 calls to RESTServer::resolveController()

MockRESTServer::protectedResolveController in servers/rest_server/tests/rest_server_mock_classes.inc

RESTServer::resolveControllerApplyVersion in servers/rest_server/includes/RESTServer.inc

Wrapper around resolveController() to apply version.

File

servers/rest_server/includes/RESTServer.inc, line 495

Class for handling REST calls.

Class

RESTServer

@file Class for handling REST calls.

Code

protected function resolveController($resource, &$operation) {
  $request_method = $this
    ->getRequestMethod();
  $canonical_path_array = $this
    ->getCanonicalPathArray();
  array_shift($canonical_path_array);
  $canon_path_count = count($canonical_path_array);
  $operation_type = NULL;
  $operation = NULL;

  // For any HEAD request return response "200 OK".
  if ($request_method == 'HEAD') {
    return services_error('OK', 200);
  }

  // For any OPTIONS request return only the headers.
  if ($request_method == 'OPTIONS') {
    exit;
  }

  // We do not group "if" conditions on purpose for better readability.
  // 'index' method.
  if ($request_method == 'GET' && isset($resource['operations']['index']) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['operations']['index'])) {
    $operation_type = 'operations';
    $operation = 'index';
  }

  // 'retrieve' method.
  // First path element should be not empty.
  if ($request_method == 'GET' && $canon_path_count >= 1 && isset($resource['operations']['retrieve']) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['operations']['retrieve']) && !empty($canonical_path_array[0])) {
    $operation_type = 'operations';
    $operation = 'retrieve';
  }

  // 'relationships'
  // First path element should be not empty,
  // second should be name of targeted action.
  if ($request_method == 'GET' && $canon_path_count >= 2 && isset($resource['relationships'][$canonical_path_array[1]]) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['relationships'][$canonical_path_array[1]], 1) && isset($canonical_path_array[0])) {
    $operation_type = 'relationships';
    $operation = $canonical_path_array[1];
  }

  // 'update'
  // First path element should be not empty.
  if ($request_method == 'PUT' && $canon_path_count >= 1 && isset($resource['operations']['update']) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['operations']['update']) && !empty($canonical_path_array[0])) {
    $operation_type = 'operations';
    $operation = 'update';
  }

  // 'delete'
  // First path element should be not empty.
  if ($request_method == 'DELETE' && $canon_path_count >= 1 && isset($resource['operations']['delete']) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['operations']['delete']) && !empty($canonical_path_array[0])) {
    $operation_type = 'operations';
    $operation = 'delete';
  }

  // 'create' method.
  // First path element should be not empty.
  if ($request_method == 'POST' && isset($resource['operations']['create']) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['operations']['create'])) {
    $operation_type = 'operations';
    $operation = 'create';
  }

  // 'actions'
  // First path element should be action name
  if ($request_method == 'POST' && $canon_path_count >= 1 && isset($resource['actions'][$canonical_path_array[0]]) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['actions'][$canonical_path_array[0]], 1)) {
    $operation_type = 'actions';
    $operation = $canonical_path_array[0];
  }

  // 'targeted_actions'
  // First path element should be not empty,
  // second should be name of targeted action.
  if ($request_method == 'POST' && $canon_path_count >= 2 && isset($resource['targeted_actions'][$canonical_path_array[1]]) && $this
    ->checkNumberOfArguments($canon_path_count, $resource['targeted_actions'][$canonical_path_array[1]], 1) && !empty($canonical_path_array[0])) {
    $operation_type = 'targeted_actions';
    $operation = $canonical_path_array[1];
  }
  if (empty($operation_type) || empty($operation) || empty($resource[$operation_type][$operation])) {
    return FALSE;
  }
  $controller = $resource[$operation_type][$operation];
  if (isset($resource['endpoint']['operations'][$operation]['settings'])) {

    // Add the endpoint's settings for the specified operation.
    $controller['endpoint'] = $resource['endpoint']['operations'][$operation]['settings'];
  }
  if (isset($resource['file']) && empty($controller['file'])) {
    $controller['file'] = $resource['file'];
  }
  return $controller;
}