JaegerApp\Platforms\View\Rest

Complexity

Total Complexity

13

Size/Duplication

Total Lines	116
Duplicated Lines	17.24 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setSystemErrors()	0	5	1
A	getSystemErrors()	0	4	1
A	getHal()	0	4	1
A	getApiProblem()	0	4	1
B	renderOutput()	10	23	5
B	renderError()	10	24	4

<?php
/**
 * Jaeger
 *
 * @copyright	Copyright (c) 2015-2016, mithra62
 * @link		http://jaeger-app.com
 * @version		1.0
 * @filesource 	./Platforms/View/Rest.php
 */
namespace JaegerApp\Platforms\View;

use Nocarrier\Hal;
use Crell\ApiProblem\ApiProblem;

/**
 * Jaeger - Rest View Object
 *
 * Contains the view helpers for Rest Requests
 *
 * @package Rest\View
 * @author Eric Lamb <eric@mithra62.com>
 */
class Rest extends AbstractView
{
    /**
     * The Platform object
     * @var \mithra62\Platforms\AbstractPlatform
     */
    protected $platform = null;
    
    /**
     * The System errors 
     * @var array
     */
    protected $system_errors = array();
    
    public function setSystemErrors(array $errors = array())
    {
        $this->system_errors = $errors;
        return $this;
    }
    
    /**
     * Returns any set system errors
     * @return array
     */
    public function getSystemErrors()
    {
        return $this->system_errors;
    }
    
    /**
     * Returns an instance of the Hal object for use
     * @param string $route
     * @return Hal
     */
    public function getHal($route, array $item = array())
    {
        return new Hal($route, $item);
    }
    
    /**
     * Returns an instance of ApiProblem object
     * @param string $title
     * @param string $type
     * @return \Crell\ApiProblem\ApiProblem
     */
    public function getApiProblem($title, $type)
    {
        return new ApiProblem($this->m62Lang($title), $type);
    }


    /**
     * Returns the data for output and sets the appropriate headers
     * @param \Nocarrier\Hal $hal
     * @return string
     */
    public function renderOutput(\Nocarrier\Hal $hal)

renderOutput uses the super-global variable $_SERVER which is generally not recommended.

    {
        $this->sendHeaders();

The method sendHeaders() does not seem to exist on object<JaegerApp\Platforms\View\Rest>.

        if($this->getSystemErrors())
        {
            $system_errors = array();
            foreach($this->getSystemErrors() As $key => $value) {
                $system_errors[$key] = $this->m62Lang($key);
            }
            $hal->setData($hal->getData() + array('_system_errors' => $system_errors));
    
        }
        if(isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos(strtolower($_SERVER['HTTP_ACCEPT_ENCODING']), 'xml') !== false)

This code seems to be duplicated across your project.

        {
            header('Content-Type: application/hal+xml');
            return $hal->asXml(true);
        }
        else
        {
            header('Content-Type: application/hal+json');
            return $hal->asJson(true);
        }
    }
    
    /**
     * Wrapper to handle error output
     *
     * Note that $detail should be a key for language translation
     *
     * @param int $code The HTTP response code to send
     * @param string $title The title to display
     * @param array $errors Any errors to explain what went wrong
     * @param string $detail A human readable explanation of what happened
     * @param string $type A URI resource to deaper explanations on what happened
     */
    public function renderError($code, $title, array $errors = array(), $detail = null, $type = null)

renderError uses the super-global variable $_SERVER which is generally not recommended.

    {
        http_response_code($code);
    
        $problem = $this->getApiProblem($title, $type);
        $problem->setStatus($code);
        $problem->setDetail($detail);
        if($errors)

The expression $errors of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

        {
            $problem['errors'] = $errors;
        }
    
        $this->sendHeaders();

The method sendHeaders() does not seem to exist on object<JaegerApp\Platforms\View\Rest>.

        if(isset($_SERVER['HTTP_ACCEPT_ENCODING']) && strpos(strtolower($_SERVER['HTTP_ACCEPT_ENCODING']), 'xml') !== false)

This code seems to be duplicated across your project.

        {
            header('Content-Type: application/problem+xml');
            return $problem->asXml(true);
        }
        else
        {
            header('Content-Type: application/problem+json');
            return $problem->asJson(true);
        }
    }
}