Normeno\Gjson\Response

Complexity

Total Complexity

10

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

70.59%

Importance

Changes	5
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	error()	0	17	3
A	basicStructure()	0	7	1
A	success()	0	5	1
A	output()	0	16	4

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

/**
 * This file is part of the Gjson library.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * PHP Version 5, 7
 *
 * LICENSE: This source file is subject to the MIT license that is available
 * through the world-wide-web at the following URI:
 * http://opensource.org/licenses/mit-license.php
 *
 * @category Src
 * @package  Normeno\Gjson
 * @author   Nicolas Ormeno <ni.ormeno@gmail.com>
 * @license  http://opensource.org/licenses/mit-license.php MIT License
 * @link     https://github.com/normeno/gjson
 */

namespace Normeno\Gjson;

/**
 * Tests for Format
 *
 * @category Src
 * @package  Normeno\Gjson
 * @author   Nicolas Ormeno <ni.ormeno@gmail.com>
 * @license  http://opensource.org/licenses/mit-license.php MIT License
 * @link     https://github.com/normeno/gjson
 */
class Response
{
    /**
     * Api Version
     *
     * @var string number of version
     */
    private $apiVersion;

    /**
     * Api Context
     *
     * @var string name of context
     */
    private $context;

    /**
     * Output Format
     *
     * @var string json|array|object
     */
    private $format;

    /**
     * Response constructor.
     *
     * @param string $apiVersion number of version
     * @param string $context    name of context
     * @param string $format     json|array|object
     */
    public function __construct($apiVersion = '1.0', $context = 'api', $format = 'json')
    {
        $this->apiVersion  = $apiVersion;
        $this->context     = $context;
        $this->format      = $format;
    }

    /**
     * Generate error response
     *
     * @param integer $code  number of error
     * @param string  $msg   message to identify error
     * @param array   $extra extra data
     *
     * @return array|object|string
     */
    public function error($code, $msg, $extra = [])
    {
        $error = [
            'error' => [
                'code'      => $code,
                'message'   => $msg
            ]
        ];

        if (!empty($extra)) {
            $extraErrors = (array_key_exists('errors', $extra)) ? $extra['errors'] : $extra;
            $error['error']['errors'] = $extraErrors;
        }

        $response = $this->basicStructure() + $error;
        return $this->output($response);
    }

    /**
     * Generate success response
     *
     * @param array   $data data
     *
     * @return array|object|string
     */
    public function success($data)
    {
        $response = $this->basicStructure() + $data;
        return $this->output($response);
    }

    /**
     * Generate basic structure
     *
     * This structure is used in all the responses
     *
     * @return array
     */
    private function basicStructure()
    {
        return [
            'apiVersion'    => $this->apiVersion,
            'context'       => $this->context
        ];
    }

    /**
     * Generate output
     *
     * @param array|object $data output data
     *
     * @return array|object|string|false
     */
    private function output($data)
    {
        switch ($this->format) {
            case 'array':
                return (array)$data;
                break;

break is not strictly necessary here and could be removed.

            case 'object':
                return (object)$data;
                break;

break is not strictly necessary here and could be removed.

            case 'json':
                return json_encode($data);
                break;

break is not strictly necessary here and could be removed.

            default:
                return json_encode($data);
        }
    }
}