Issues in ServiceHandler.php - Fixed Issues - Inspection of "Fix Sensiolabs violations" - byjg/restserver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 94b286...8ac024 )

by Joao

created 2016-02-04 17:41 UTC

src/ServiceHandler.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace ByJG\RestServer;

use ByJG\AnyDataset\Model\ObjectHandler;
use ByJG\Util\XmlUtil;

class ServiceHandler implements HandlerInterface
{

    protected $output = Output::JSON;

    public function getOutput()
    {
        return $this->output;
    }

    public function setOutput($output)
    {
        // Check if output is set
        if ($output != Output::JSON && $output != Output::XML && $output != Output::CSV && $output != Output::RDF) {
            throw new \Exception('Invalid output format. Valid are XML, JSON or CSV');
        }

        $this->output = $output;
    }

    public function setHeader()
    {
        switch ($this->getOutput()) {
            case Output::JSON:
                header('Content-Type: application/json');
                break;

            case Output::RDF:
                header('Content-Type: application/rdf+xml');
                break;

            case Output::XML:
                header('Content-Type: text/xml');
                break;

            default:
                header('Content-Type: text/plain');
                break;
        }
    }

    /**
     * CORS - Better do that in your http server, but you can enable calling this
     */
    public function setHeaderCors()
    {
        header('Access-Control-Allow-Origin: *');
        header("Access-Control-Allow-Headers: X-API-KEY, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method");
        header("Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE");
        $method = $_SERVER['REQUEST_METHOD'];
        if ($method == "OPTIONS") {
            return false;
        }
        return true;
    }

    public function execute(ServiceAbstract $instance)
    {
        $root = null;
        $annotationPrefix = 'object';
        if ($this->getOutput() == Output::RDF) {
            $xmlDoc = XmlUtil::CreateXmlDocument();
            $root = XmlUtil::CreateChild($xmlDoc, "rdf:RDF", "", "http://www.w3.org/1999/02/22-rdf-syntax-ns#");
            XmlUtil::AddNamespaceToDocument($root, "rdfs", "http://www.w3.org/2000/01/rdf-schema#");
            $annotationPrefix = 'rdf';
        }

        $dom = $instance->getResponse()->getResponseBag()->process($root, $annotationPrefix);

        switch ($this->getOutput()) {
            case Output::JSON:
                return ObjectHandler::xml2json($dom);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

            case Output::XML:
            case Output::RDF:
                return $dom->saveXML();

            case Output::CSV:
                $array = XmlUtil::xml2Array($dom);

                $return = "";
                foreach ((array) $array as $line) {
                    foreach ((array) $line as $field) {
                        $return .= "\"" . str_replace('"', '\\"', (is_array($field) ? json_encode($field) : $field)) . "\";";
                    }
                    $return .= "\n";
                }
                return $return;
        }
    }
}


1			<?php
2
3			namespace ByJG\RestServer;
4
5			use ByJG\AnyDataset\Model\ObjectHandler;
6			use ByJG\Util\XmlUtil;
7
8			class ServiceHandler implements HandlerInterface
9			{
10
11			protected $output = Output::JSON;
12
13			public function getOutput()
14			{
15			return $this->output;
16			}
17
18			public function setOutput($output)
19			{
20			// Check if output is set
21			if ($output != Output::JSON && $output != Output::XML && $output != Output::CSV && $output != Output::RDF) {
22			throw new \Exception('Invalid output format. Valid are XML, JSON or CSV');
23			}
24
25			$this->output = $output;
26			}
27
28			public function setHeader()
29			{
30			switch ($this->getOutput()) {
31			case Output::JSON:
32			header('Content-Type: application/json');
33			break;
34
35			case Output::RDF:
36			header('Content-Type: application/rdf+xml');
37			break;
38
39			case Output::XML:
40			header('Content-Type: text/xml');
41			break;
42
43			default:
44			header('Content-Type: text/plain');
45			break;
46			}
47			}
48
49			/**
50			* CORS - Better do that in your http server, but you can enable calling this
51			*/
52			public function setHeaderCors()
53			{
54			header('Access-Control-Allow-Origin: *');
55			header("Access-Control-Allow-Headers: X-API-KEY, Origin, X-Requested-With, Content-Type, Accept, Access-Control-Request-Method");
56			header("Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE");
57			$method = $_SERVER['REQUEST_METHOD'];
58			if ($method == "OPTIONS") {
59			return false;
60			}
61			return true;
62			}
63
64			public function execute(ServiceAbstract $instance)
65			{
66			$root = null;
67			$annotationPrefix = 'object';
68			if ($this->getOutput() == Output::RDF) {
69			$xmlDoc = XmlUtil::CreateXmlDocument();
70			$root = XmlUtil::CreateChild($xmlDoc, "rdf:RDF", "", "http://www.w3.org/1999/02/22-rdf-syntax-ns#");
71			XmlUtil::AddNamespaceToDocument($root, "rdfs", "http://www.w3.org/2000/01/rdf-schema#");
72			$annotationPrefix = 'rdf';
73			}
74
75			$dom = $instance->getResponse()->getResponseBag()->process($root, $annotationPrefix);
76
77			switch ($this->getOutput()) {
78			case Output::JSON:
79			return ObjectHandler::xml2json($dom);
			0 ignored issues – show Bug introduced 2016-01-20 19:14 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$dom` defined by `$instance->getResponse()...oot, $annotationPrefix)` on line `75` can be `null`; however, `ByJG\AnyDataset\Model\ObjectHandler::xml2json()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
80
81			case Output::XML:
82			case Output::RDF:
83			return $dom->saveXML();
84
85			case Output::CSV:
86			$array = XmlUtil::xml2Array($dom);
87
88			$return = "";
89			foreach ((array) $array as $line) {
90			foreach ((array) $line as $field) {
91			$return .= "\"" . str_replace('"', '\\"', (is_array($field) ? json_encode($field) : $field)) . "\";";
92			}
93			$return .= "\n";
94			}
95			return $return;
96			}
97			}
98			}
99

byjg / restserver

Push — master ( 94b286...8ac024 )

src/ServiceHandler.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like