Body::getContent() - Code Metrics - Inspection of "Http module improvements" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#303)

by Arman
created 2025-07-19 09:08 UTC
Body::getContent() A

↳ Parent: Body
Complexity

Conditions	2
Paths	2
Size

Total Lines	11
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	5
nc	2
nop	0
dl	0
loc	11
rs	10
c	1
b	0
f	0
<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.8
 */

namespace Quantum\Http\Traits\Response;

use Quantum\Http\Exceptions\HttpException;
use Quantum\App\Constants\ReservedKeys;
use Quantum\Http\Constants\ContentType;
use SimpleXMLElement;
use DOMDocument;
use Exception;

/**
 * Trait Body
 * @package Quantum\Http\Response
 */
trait Body
{

    /**
     * Response
     * @var array
     */
    private static $__response = [];

    /**
     * @var string[]
     */
    private static $formatters = [
        ContentType::HTML => 'formatHtml',
        ContentType::XML => 'formatXml',
        ContentType::JSON => 'formatJson',
        ContentType::JSONP => 'formatJsonp',
    ];

    /**
     * Checks if response contains a data by given key
     * @param string $key
     * @return bool
     */
    public static function has(string $key): bool
    {
        return isset(self::$__response[$key]);
    }

    /**
     * Gets the data from response by given key
     * @param string $key
     * @param string|null $default
     * @return mixed
     */
    public static function get(string $key, string $default = null)
    {
        return self::has($key) ? self::$__response[$key] : $default;
    }

    /**
     * Sets new key/value pair into response
     * @param string $key
     * @param mixed $value
     */
    public static function set(string $key, $value)
    {
        self::$__response[$key] = $value;
    }

    /**
     * Gets all response parameters
     * @return array
     */
    public static function all(): array
    {
        return self::$__response;
    }

    /**
     * Deletes the element from response by given key
     * @param string $key
     */
    public static function delete(string $key)
    {
        if (self::has($key)) {
            unset(self::$__response[$key]);
        }
    }

    /**
     * Prepares the JSON response
     * @param array|null $data
     * @param int|null $code
     */
    public static function json(array $data = null, int $code = null)
    {
        self::setContentType(ContentType::JSON);

        if (!is_null($code)) {
            self::setStatusCode($code);
        }

        if ($data) {
            self::$__response = array_merge(self::$__response, $data);
        }
    }

    /**
     * Prepares the JSONP response
     * @param string $callback
     * @param array|null $data
     * @param int|null $code
     */
    public static function jsonp(string $callback, ?array $data = null, int $code = null)
    {
        self::setContentType(ContentType::JSONP);

        self::$callbackFunction = $callback;


        if (!is_null($code)) {
            self::setStatusCode($code);
        }

        if ($data) {
            self::$__response = array_merge(self::$__response, $data);
        }
    }

    /**
     * Returns response with function
     * @param array $data
     * @return string
     */
    public static function getJsonPData(array $data): string
    {
        return self::$callbackFunction . '(' . json_encode($data) . ")";
    }

    /**
     * Prepares the XML response
     * @param array|null $data
     * @param int|null $code
     */
    public static function xml(array $data = null, $root = '<data></data>', int $code = null)
    {
        self::setContentType(ContentType::XML);

        if (!is_null($code)) {
            self::setStatusCode($code);
        }

        self::$xmlRoot = $root;


        if ($data) {
            self::$__response = array_merge(self::$__response, $data);
        }
    }

    /**
     * Prepares the HTML content
     * @param string $html
     * @param int|null $code
     */
    public static function html(string $html, int $code = null)
    {
        self::setContentType(ContentType::HTML);

        if (!is_null($code)) {
            self::setStatusCode($code);
        }

        self::$__response[ReservedKeys::RENDERED_VIEW] = $html;
    }

    /**
     * Gets the response content
     * @return string
     * @throws HttpException
     */
    public static function getContent(): string
    {
        $contentType = self::getContentType();
        $contentType = self::getContentType();

        if (!isset(self::$formatters[$contentType])) {
            throw new HttpException("Unsupported content type: {$contentType}");
        }

        $formatterMethod = self::$formatters[$contentType];

        return self::$formatterMethod();
    }

    /**
     * Transforms array to XML
     * @param array $arr
     * @return string
     * @throws Exception
     */
    private static function arrayToXML(array $arr): string
    {
        $simpleXML = new SimpleXMLElement(self::$xmlRoot);
        self::composeXML($arr, $simpleXML);

        $dom = new DOMDocument();
        $dom->loadXML($simpleXML->asXML());
        $dom->formatOutput = true;
        return $dom->saveXML();
    }

    /**
     * Compose XML
     * @param array $arr
     * @param SimpleXMLElement $simpleXML
     */
    private static function composeXML(array $arr, SimpleXMLElement &$simpleXML)
    {
        foreach ($arr as $key => $value) {
            if (is_numeric($key)) {
                $key = 'item' . $key;
            }

            $tag = $key;
            $attributes = null;

            if (strpos($key, '@') !== false) {
                list($tag, $attributes) = explode('@', $key);
                $attributes = json_decode($attributes);
            }

            if (is_array($value)) {
                $child = $simpleXML->addChild($tag);
                if ($attributes) {
                    foreach ($attributes as $attrKey => $attrVal) {
                        $child->addAttribute($attrKey, $attrVal);
                    }
                }

                self::composeXML($value, $child);
            } else {
                $child = $simpleXML->addChild($tag, htmlspecialchars($value));

                if ($attributes) {
                    foreach ($attributes as $attrKey => $attrVal) {
                        $child->addAttribute($attrKey, $attrVal);
                    }
                }
            }
        }
    }

    /**
     * Formats data as JSON
     * @return string
     */
    private static function formatJson(): string
    {
        return json_encode(self::all(), JSON_UNESCAPED_UNICODE);
    }

    /**
     * Formats data as XML
     * @return string
     * @throws Exception
     */
    private static function formatXml(): string
    {
        return self::arrayToXml(self::all());
    }

    /**
     * Formats data as HTML
     * @return string
     */
    private static function formatHtml(): string
    {
        return self::get(ReservedKeys::RENDERED_VIEW) ?? '';
    }

    /**
     * Formats data as JSONP
     * @return string
     */
    private static function formatJsonp(): string
    {
        return self::getJsonPData(self::all());
    }
}
softberg / quantum-php-core

Pull Request — master (#303)

Body::getContent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
