class RestfulManager in RESTful 7.2

Hierarchy

• class \Drupal\restful\RestfulManager

3 files declare their use of RestfulManager

AuthenticationManager.php in src/Authentication/AuthenticationManager.php

Contains \Drupal\restful\Authentication\AuthenticationManager

CookieAuthentication.php in src/Plugin/authentication/CookieAuthentication.php

Contains \Drupal\restful\Plugin\authentication\CookieAuthentication

restful.module in ./restful.module

File

src/RestfulManager.php, line 23

Contains \Drupal\restful\RestfulManager.

Namespace

Drupal\restful

class RestfulManager {

  /**
   * The front controller callback function.
   */
  const FRONT_CONTROLLER_CALLBACK = 'restful_menu_process_callback';

  /**
   * The front controller access callback function.
   */
  const FRONT_CONTROLLER_ACCESS_CALLBACK = 'restful_menu_access_callback';

  /**
   * The request object.
   *
   * @var RequestInterface
   */
  protected $request;

  /**
   * The response object.
   *
   * @var ResponseInterface
   */
  protected $response;

  /**
   * The resource manager.
   *
   * @var ResourceManagerInterface
   */
  protected $resourceManager;

  /**
   * The formatter manager.
   *
   * @var FormatterManagerInterface
   */
  protected $formatterManager;

  /**
   * The persistable cache global.
   *
   * @var PersistableCacheInterface
   */
  protected $persistableCache;

  /**
   * Accessor for the request.
   *
   * @return RequestInterface
   *   The request object.
   */
  public function getRequest() {
    return clone $this->request;
  }

  /**
   * Mutator for the request.
   *
   * @param RequestInterface $request
   *   The request object.
   */
  public function setRequest(RequestInterface $request) {
    $this->request = $request;
  }

  /**
   * Accessor for the response.
   *
   * @return ResponseInterface
   *   The response object.
   */
  public function getResponse() {
    return clone $this->response;
  }

  /**
   * Mutator for the response.
   *
   * @param ResponseInterface $response
   *   The response object.
   */
  public function setResponse(ResponseInterface $response) {
    $this->response = $response;
  }

  /**
   * Accessor for the resource manager.
   *
   * @return ResourceManagerInterface
   */
  public function getResourceManager() {
    return clone $this->resourceManager;
  }

  /**
   * Mutator for the resource manager.
   *
   * @param ResourceManagerInterface $resource_manager
   */
  public function setResourceManager(ResourceManagerInterface $resource_manager) {
    $this->resourceManager = $resource_manager;
  }

  /**
   * Accessor for the formatter manager.
   *
   * @return FormatterManagerInterface
   */
  public function getFormatterManager() {
    return clone $this->formatterManager;
  }

  /**
   * Mutator for the formatter manager.
   *
   * @param FormatterManagerInterface $formatter_manager
   */
  public function setFormatterManager(FormatterManagerInterface $formatter_manager) {
    $this->formatterManager = $formatter_manager;
  }

  /**
   * @return PersistableCacheInterface
   */
  public function getPersistableCache() {
    return $this->persistableCache;
  }

  /**
   * @param PersistableCacheInterface $persistable_cache
   */
  public function setPersistableCache($persistable_cache) {
    $this->persistableCache = $persistable_cache;
  }

  /**
   * Constructor.
   */
  public function __construct(RequestInterface $request, ResponseInterface $response, ResourceManagerInterface $resource_manager, FormatterManagerInterface $formatter_manager, PersistableCacheInterface $persistable_cache) {

    // Init the properties.
    $this->request = $request;
    $this->response = $response;
    $this->resourceManager = $resource_manager;
    $this->formatterManager = $formatter_manager;
    $this->persistableCache = $persistable_cache;
  }

  /**
   * Factory method.
   *
   * @return RestfulManager
   *   The newly created manager.
   */
  public static function createFromGlobals() {
    $request = Request::createFromGlobals();
    $response = Response::create();
    $resource_manager = new ResourceManager($request);
    $formatter_manager = new FormatterManager();
    $persistable_cache = new PersistableCache(RenderCache::CACHE_BIN);
    return new static($request, $response, $resource_manager, $formatter_manager, $persistable_cache);
  }

  /**
   * Processes the request to produce a response.
   *
   * @return Response
   *   The response being sent back to the consumer via the menu callback.
   */
  public function process() {

    // Gets the appropriate resource plugin (based on the request object). That
    // plugin processes the request according to the REST principles.
    $data = $this->resourceManager
      ->process();

    // Formats the data based on the negotiatied output format. It accesses to
    // the request information via the service container.
    $body = $this->formatterManager
      ->format($data);

    // Prepares the body for the response. At this point all headers have been
    // added to the response.
    $this->response
      ->setContent($body);

    // The menu callback function is in charge of adding all the headers and
    // returning the body.
    return $this->response;
  }

  /**
   * Checks if the passed in request belongs to RESTful.
   *
   * @param RequestInterface $request
   *   The path to check.
   *
   * @return bool
   *   TRUE if the path belongs to RESTful.
   */
  public static function isRestfulPath(RequestInterface $request) {
    return ResourceManager::getPageCallback($request
      ->getPath(FALSE)) == static::FRONT_CONTROLLER_CALLBACK;
  }

  /**
   * Helper function to echo static strings.
   *
   * @param DataInterpreterInterface $value
   *   The resource value.
   * @param mixed $message
   *   The string to relay.
   *
   * @return mixed
   *   Returns $message
   */
  public static function echoMessage(DataInterpreterInterface $value, $message) {
    return $message;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RestfulManager::$formatterManager	protected	property	The formatter manager.
RestfulManager::$persistableCache	protected	property	The persistable cache global.
RestfulManager::$request	protected	property	The request object.
RestfulManager::$resourceManager	protected	property	The resource manager.
RestfulManager::$response	protected	property	The response object.
RestfulManager::createFromGlobals	public static	function	Factory method.
RestfulManager::echoMessage	public static	function	Helper function to echo static strings.
RestfulManager::FRONT_CONTROLLER_ACCESS_CALLBACK		constant	The front controller access callback function.
RestfulManager::FRONT_CONTROLLER_CALLBACK		constant	The front controller callback function.
RestfulManager::getFormatterManager	public	function	Accessor for the formatter manager.
RestfulManager::getPersistableCache	public	function
RestfulManager::getRequest	public	function	Accessor for the request.
RestfulManager::getResourceManager	public	function	Accessor for the resource manager.
RestfulManager::getResponse	public	function	Accessor for the response.
RestfulManager::isRestfulPath	public static	function	Checks if the passed in request belongs to RESTful.
RestfulManager::process	public	function	Processes the request to produce a response.
RestfulManager::setFormatterManager	public	function	Mutator for the formatter manager.
RestfulManager::setPersistableCache	public	function
RestfulManager::setRequest	public	function	Mutator for the request.
RestfulManager::setResourceManager	public	function	Mutator for the resource manager.
RestfulManager::setResponse	public	function	Mutator for the response.
RestfulManager::__construct	public	function	Constructor.