Comodojo\Dispatcher\Service\Service

Complexity

Total Complexity

58

Size/Duplication

Total Lines	693
Duplicated Lines	6.93 %

Coupling/Cohesion

Components	8
Dependencies	2

Importance

Changes	7
Bugs	1	Features	1

35 Methods

Rating	Name	Duplication	Size	Complexity
A	setup()	0	1	1
A	__construct()	0	21	1
A	expects()	0	10	1
A	likes()	0	10	1
A	setSupportedMethods()	0	18	2
A	setContentType()	0	7	1
A	getContentType()	0	5	1
A	setCharset()	0	7	1
A	getCharset()	0	5	1
A	setStatusCode()	9	9	2
A	getStatusCode()	0	5	1
A	getLogger()	0	5	1
A	getCacher()	0	5	1
A	setHeader()	0	7	1
A	unsetHeader()	13	13	2
A	getHeader()	0	7	2
A	setHeaders()	0	7	2
A	unsetHeaders()	0	7	1
A	getHeaders()	0	5	1
A	getSupportedMethods()	0	5	1
A	getImplementedMethods()	0	17	4
A	getCallableMethod()	0	7	2
B	getExpected()	13	13	5
B	getLiked()	13	13	5
A	setAttributes()	0	5	1
A	getAttributes()	0	5	1
A	getAttribute()	0	7	2
A	setRawParameters()	0	5	1
A	setParameters()	0	5	1
A	getParameters()	0	5	2
A	getParameter()	0	7	2
A	setRequestHeaders()	0	5	2
A	getRequestHeader()	0	7	2
A	getRequestHeaders()	0	5	1
A	methodsToArray()	0	13	2

<?php namespace Comodojo\Dispatcher\Service;

use \Comodojo\Exception\DispatcherException;
use \Comodojo\Exception\IOException;
use \Comodojo\Dispatcher\Serialization;
use \Comodojo\Dispatcher\Deserialization;

/**
 * The Service base class, feel free to extend
 *
 * @package     Comodojo dispatcher
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @license     GPL-3.0+
 *
 * LICENSE:
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

abstract class Service {

    //###### Things a service should define ######//

    /**
     * The content type that service will return.
     * Default content is "text/plain"; each service can override,
     * both in setup phase or in method declaration.
     *
     * @var     string
     */
    private $content_type = "text/plain";

    /**
     * St status code that service will return (in case of no exceptions).
     * Default content is 200 - OK; each service can override,
     * both in setup phase or in method declaration.
     *
     * @var     integer
     */
    private $status_code = 200;

    /**
     * An array of headers that will be returned. This value is initially populated
     * with headers declared in routing phase (if any).
     *
     * @var     array
     */
    private $headers = array();

    /**
     * Supported HTTP methods (comma separated, not spaced)
     *
     * @var     string
     * @see     dispatcher-config.php
     */
    private $supported_http_methods = DISPATCHER_SUPPORTED_METHODS;

    /**
     * Result charset
     *
     * @var     string
     * @see     dispatcher-config.php
     */
    private $charset = DISPATCHER_DEFAULT_ENCODING;

    //###### Things a service could use for free ######//

    /**
     * Request attributes, populated at runtime by dispatcher
     *
     * @var     array
     */
    private $attributes = array();

    /**
     * Request parameters, populated at runtime by dispatcher
     *
     * @var     array
     */
    private $parameters = array();

    /**
     * Request raw parameters (php://input), populated at runtime by dispatcher
     *
     * @var     array
     */
    private $raw_parameters = array();

    /**
     * Request headers, injected by dispatcher
     *
     * @var array
     */
    private $request_headers = array();

    /**
     * Logger, injected by dispatcher
     *
     * @var Object
     */
    private $logger = null;

    /**
     * Cacher, injected by dispatcher
     *
     * @var Object
     */
    private $cacher = null;

    /**
     * An instance of dispatcher serializer
     *
     * @var     Object
     */
    public $serialize = null;

    /**
     * An instance of dispatcher deserializer
     *
     * @var     Object
     */
    public $deserialize = null;

    //###### Things a service may define ######//

    // Expected attributes
    private $expected_attributes = null;

    // Expected parameters
    private $expected_parameters = null;

    // Liked attributes
    private $liked_attributes = null;

    // Liked parameters
    private $liked_parameters = null;

    //###### Things dedicated to internal use ######//

    /**
     * Supported success code (as defined in ObjectSuccess)
     *
     * @var     array
     */
    private $supported_success_codes = array(200,202,204);

    /*************** HTTP METHODS IMPLEMENTATIONS **************/

    /**
     * Implement this method if your service should support
     * HTTP-GET requests
     */
    //public function get() {}

60% of this comment could be valid code. Did you maybe forget this after debugging?

    /**
     * Implement this method if your service should support
     * HTTP-POST requests
     */
    // public function post() {}

55% of this comment could be valid code. Did you maybe forget this after debugging?

    /**
     * Implement this method if your service should support
     * HTTP-PUT requests
     */
    // public function put() {}

55% of this comment could be valid code. Did you maybe forget this after debugging?

    /**
     * Implement this method if your service should support
     * HTTP-DELETE requests
     */
    // public function delete() {}

55% of this comment could be valid code. Did you maybe forget this after debugging?

    /**
     * Implement this method if your service should support
     * any HTTP requests (it's quite a wildcard, please be careful...)
     */
    // public function any() {}

55% of this comment could be valid code. Did you maybe forget this after debugging?

    /*************** HTTP METHODS IMPLEMENTATIONS **************/

    /******************* OVERRIDABLE METHODS *******************/

    /**
     * Service setup.
     *
     * It is the first method that dispatcher will call and could be used
     * to define service parameters in global scope, such as contentType or
     * success HTTP code.
     *
     * PLEASE REMEMBER: setting same parameters in method declaration will
     * override first ones.
     *
     * @return null
     */
    public function setup() { }

    /**
     * Service constructor.
     *
     * Currently, only for init serialized/deserialized but can be extended to
     * do anything service needs.
     *
     * PLEASE REMEMBER to call parent::__construct() at the end of your method
     *
     * @return null

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($logger, $cacher) {

        $this->logger = $logger;

        $this->cacher = $cacher;

        $methods_to_array = $this->methodsToArray();

        $this->expected_attributes = $methods_to_array;

        $this->expected_parameters = $methods_to_array;

        $this->liked_attributes = $methods_to_array;

        $this->liked_parameters = $methods_to_array;

        $this->serialize = new Serialization();

        $this->deserialize = new Deserialization();

    }

    /******************* OVERRIDABLE METHODS *******************/

    /**
     * Expected attributes (i.e. ones that will build the URI)
     *
     * @param   string  $method     HTTP method for punctual attributes rematch or ANY
     * @param   array   $attributes array og attributes that service expects
     * @param   array   $parameters array of parameters that service expects
     *
     * @return  Object  $this
     */
    final public function expects($method, $attributes, $parameters=array()) {

        $method = strtoupper($method);

        $this->expected_attributes[$method] = $attributes;
        $this->expected_parameters[$method] = $parameters;

        return $this;

    }

    /**
     * Liked (optional) attributes
     *
     * @param   string  $method     HTTP method for punctual attributes rematch or ANY
     * @param   array   $attributes array og attributes that service likes
     * @param   array   $parameters array of parameters that service likes
     *
     * @return  Object  $this
     */
    final public function likes($method, $attributes, $parameters=array()) {

        $method = strtoupper($method);

        $this->liked_attributes[$method] = $attributes;
        $this->liked_parameters[$method] = $parameters;

        return $this;

    }

    /**
     * Set methods service will support.
     *
     * In can be misleading, but supported HTTP methods and implemented HTTP methods
     * are not the same thing.
     *
     * - If method is not SUPPORTED, service will not be initiated and a 405 - Not Allowed
     *   error will be returned.
     * - If method is not IMPLEMENTED - i.e. get() method is not defined - service will not
     *   be initiated and a 501 - Not Implemented error will be returned
     *
     * @param   string  $methods     HTTP methods, comma separated
     *
     * @return  Object  $this
     */
    final public function setSupportedMethods($methods) {

        $methods = preg_replace('/\s+/', '', $methods);
        $methods = explode(",", $methods);

        $supported_methods = array();

        foreach ($methods as $method) {

            array_push($supported_methods, strtoupper($method));

        }

        $this->supported_http_methods = implode(",", $supported_methods);

        return $this;

    }

    /**
     * Set service content type
     *
     * @param   string  $type   Content Type
     * @return  Object  $this
     */
    final public function setContentType($type) {

        $this->content_type = $type;

        return $this;

    }

    /**
     * Get service declared content type
     *
     * @return  string  Content Type
     */
    final public function getContentType() {

        return $this->content_type;

    }

    /**
     * Set service charset
     *
     * @param   string  $charset   Charset
     *
     * @return  Object  $this
     */
    final public function setCharset($charset) {

        $this->charset = $charset;

        return $this;

    }

    /**
     * Get service declared charset
     *
     * @return  string  Charset
     */
    final public function getCharset() {

        return $this->charset;

    }

    /**
     * Set success status code
     *
     * @param   integer $code   HTTP status code (in case of success)
     * @return  Object  $this
     */
    final public function setStatusCode($code) {

This method seems to be duplicated in your project.

        $code = filter_var($code, FILTER_VALIDATE_INT);

        $this->status_code = in_array($code, $this->supported_success_codes) ? $code : $this->status_code;

        return $this;

    }

    /**
     * Get service-defined status code
     *
     * @return  integer     HTTP status code (in case of success)
     */
    final public function getStatusCode() {

        return $this->status_code;

    }

    /**
     * Get dispatcher logger
     *
     * @return  Object
     */
    final public function getLogger() {

        return $this->logger;

    }

    /**
     * Get dispatcher cacher
     *
     * @return  Object
     */
    final public function getCacher() {

        return $this->cacher;

    }

    /**
     * Set header component
     *
     * @param   string  $header     Header name
     * @param   string  $value      Header content (optional)
     *
     * @return  Object  $this
     */
    final public function setHeader($header, $value=null) {

        $this->headers[$header] = $value;

        return $this;

    }

    /**
     * Unset header component
     *
     * @param   string  $header     Header name
     *
     * @return  bool
     */
    final public function unsetHeader($header) {

This method seems to be duplicated in your project.

        if ( isset($this->headers[$header]) ) {

            unset($this->headers[$header]);

            return true;

        }

        return false;

    }

    /**
     * Get header component
     *
     * @param   string  $header     Header name
     *
     * @return  string  Header component in case of success, false otherwise
     */
    final public function getHeader($header) {

        if ( isset($this->headers[$header]) ) return $this->headers[$header];

        return null;

    }

    /**
     * Set headers
     *
     * @param   array   $headers    Headers array
     *
     * @return  Object  $this
     */
    final public function setHeaders($headers) {

        $this->headers = is_array($headers) ? $headers : $this->headers;

        return $this;

    }

    /**
     * Unset headers
     *
     * @return  Object  $this
     */
    final public function unsetHeaders() {

        $this->headers = array();

        return $this;

    }

    /**
     * Get headers
     *
     * @return  array   Headers array
     */
    final public function getHeaders() {

        return $this->headers;

    }

    /**
     * Get service-supported HTTP methods
     *
     * @return  array   Headers array
     */
    final public function getSupportedMethods() {

        return $this->supported_http_methods;

    }

    /**
     * Get service-implemented HTTP methods
     *
     * @return  array   Headers array
     */
    final public function getImplementedMethods() {

        if ( method_exists($this, 'any') ) return explode(",",$this->supported_http_methods);

        $supported_methods = explode(',',$this->supported_http_methods);

        $implemented_methods = array();

        foreach ( $supported_methods as $method ) {

            if ( method_exists($this, strtolower($method)) ) array_push($implemented_methods,$method);

        }

        return $implemented_methods;

    }

    /**
     * Return the callable class method that reflect the requested one
     *
     * @return  array   Headers array
     */
    final public function getCallableMethod($method) {

        if ( method_exists($this, strtolower($method)) ) return strtolower($method);

        else return "any";

    }

    /**
     * Get attributes and parameters that service expects
     *
     * @return  array
     */
    final public function getExpected($method) {

This method seems to be duplicated in your project.

        $method = strtoupper($method);

        return array(

            ( sizeof($this->expected_attributes[$method]) == 0 AND sizeof($this->expected_attributes["ANY"]) != 0 ) ? $this->expected_attributes["ANY"] : $this->expected_attributes[$method],

Using logical operators such as and instead of && is generally not recommended.

            ( sizeof($this->expected_parameters[$method]) == 0 AND sizeof($this->expected_parameters["ANY"]) != 0 ) ? $this->expected_parameters["ANY"] : $this->expected_parameters[$method]

Using logical operators such as and instead of && is generally not recommended.

        );

    }

    /**
     * Get attributes and parameters that service likes
     *
     * @return  array
     */
    final public function getLiked($method) {

This method seems to be duplicated in your project.

        $method = strtoupper($method);

        return array(

            ( sizeof($this->liked_attributes[$method]) == 0 AND sizeof($this->liked_attributes["ANY"]) != 0 ) ? $this->liked_attributes["ANY"] : $this->liked_attributes[$method],

Using logical operators such as and instead of && is generally not recommended.

            ( sizeof($this->liked_parameters[$method]) == 0 AND sizeof($this->liked_parameters["ANY"]) != 0 ) ? $this->liked_parameters["ANY"] : $this->liked_parameters[$method]

Using logical operators such as and instead of && is generally not recommended.

            );

    }

    /**
     * Set request attributes (used by dispatcher)
     *
     */
    final public function setAttributes($attributes) {

        $this->attributes = $attributes;

    }

    /**
     * Get request attributes, populated by dispatcher
     *
     * @return  array
     */
    final public function getAttributes() {

        return $this->attributes;

    }

    /**
     * Get request attribute, populated by dispatcher
     *
     * @param   string  $attribute  Attribute to search for
     *
     * @return  mixed
     */
    final public function getAttribute($attribute) {

        if ( isset($this->attributes[$attribute]) ) return $this->attributes[$attribute];

        return null;

    }

    /**
     * Set raw parameters  (used by dispatcher)
     *
     */
    final public function setRawParameters($raw_parameters) {

        $this->raw_parameters = $raw_parameters;

    }

    /**
     * Set request parameters (used by dispatcher)
     *
     */
    final public function setParameters($parameters) {

        $this->parameters = $parameters;

    }

    /**
     * Get request parameters, populated by dispatcher
     *
     * @return  array
     */
    final public function getParameters($raw=false) {

        return $raw ? $this->raw_parameters : $this->parameters;

    }

    /**
     * Get request parameter, populated by dispatcher
     *
     * @param   string  $parameter  Parameter to search for
     *
     * @return  array
     */
    final public function getParameter($parameter) {

        if ( isset($this->parameters[$parameter]) ) return $this->parameters[$parameter];

        return null;

    }

    /**
     * Get request parameters, populated by dispatcher
     *
     */
    final public function setRequestHeaders($headers) {

        $this->request_headers = is_array($headers) ? $headers : array();

    }

    /**
     * Get request header component
     *
     * @param   string  $header     Header to search for
     *
     * @return  string              Header component in case of success, null otherwise
     */
    final public function getRequestHeader($header) {

        if ( isset($this->request_headers[$header]) ) return $this->request_headers[$header];

        return null;

    }
    /**
     * Get headers
     *
     * @return  array   Headers array
     */
    final public function getRequestHeaders() {

        return $this->request_headers;

    }

    private function methodsToArray() {

        $methods = explode(",",$this->supported_http_methods);

        $methods_array = array();

        foreach ($methods as $method) $methods_array[$method] = array();

        $methods_array['ANY'] = array();

        return $methods_array;

    }

}