Ntb\RestAPI\NestedResourceRestController

Complexity

Total Complexity

3

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
	getRootResource()	0	1	?
A	beforeCallActionHandler()	0	13	3

<?php

namespace Ntb\RestAPI;

/**
 * The nested resource controller can help you to avoid some boilerplate in nested resources in you rest api.
 *
 * If you have a resource `user` and the endpoint `/users` then a nested resource could be the friends of a specific
 * user. `/users/1/friends` is a possible endpoint for that. In every method you first need to check if the user with the
 * id 1 is available in the system.
 *
 * The friends controller can extend the nested resource rest controller and is now able to handle request in an easier
 * way.
 *
 * @author Christian Blank <c.blank@notthatbad.net>
 */
abstract class NestedResourceRestController extends BaseRestController {
    /**
     * @var string the error message if no id was provided for the request
     */
    protected static $no_id_message = "No id provided.";
    /**
     * @var int the error code for a not provided id
     */
    protected static $no_id_error = 404;

    /**
     * Get called by the action handler of BaseRestController. Tries to fetch the root resource.
     *
     * @param \SS_HTTPRequest $request a http request
     * @param string $action the name of the action (eg. post, put, get, delete)
     * @return array the result of the action call
     * @throws RestSystemException
     * @throws RestUserException
     */
    public final function beforeCallActionHandler(\SS_HTTPRequest $request, $action) {
        $id = $request->param(\Config::inst()->get('NestedResourceRestController', 'root_resource_id_field'));
        if(!$id) {
            throw new RestUserException(static::$no_id_message, static::$no_id_message);
        }
        $resource = $this->getRootResource($id);
        if(!$resource) {
            \SS_Log::log("NoResourceError was not handled inside the controller", \SS_Log::WARN);
            throw new RestSystemException("NoResourceError was not handled inside the controller", 501);
        }
        // call the action and inject the root resource
        return $this->$action($request, $resource);
    }

    /**
     *
     * The result of this method will be injected in all method calls in the controller.
     *
     * @param string $id the `ID` param in the request
     * @return mixed
     */
    protected abstract function getRootResource($id);

}