POData\Writers\Json\JsonWriter

Complexity

Total Complexity

43

Size/Duplication

Total Lines	284
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	writeDataArrayName()	0	4	1
A	writeName()	0	15	4
A	getJsonOutput()	0	3	1
C	writeValue()	0	59	17
A	endScope()	0	13	2
A	_startScope()	0	25	5
A	_quoteJScriptString()	0	9	1
A	clear()	0	3	1
A	startArrayScope()	0	4	1
A	startObjectScope()	0	4	1
B	_writeCore()	0	20	8

<?php

namespace POData\Writers\Json;


use POData\Writers\Json\IndentedTextWriter;

/**
 * Class JsonWriter
 * @package POData\Writers\Json
 */
class JsonWriter
{
    /**
     * Json datetime format.
     *
     */
    private $_jsonDateTimeFormat = "\/Date(%s)\/";

The private property $_jsonDateTimeFormat is not used, and could be removed.

    /**
     * Writer to write text into
     *
     */
    private $_writer;

    /**
     * scope of the json text - object, array, etc
     *
     */
    private $_scopes = array();

    /**
     * Various scope types for Json writer
     *
     */
    private $_scopeType = array('Array' => 0, 'Object' => 1);

    /**
     * Creates a new instance of Json writer
     *
     * @param string $writer writer to which text needs to be written
     */
    public function __construct($writer)
    {
        $this->_writer = new IndentedTextWriter($writer);

    }

    public function clear()
    {
        $this->_writer->clear();
    }

    /**
     * End the current scope
     *
     * @return JsonWriter
     */
    public function endScope()
    {
        $this->_writer
            ->writeLine()
            ->decreaseIndent();

        if (array_pop($this->_scopes)->type == $this->_scopeType['Array']) {
            $this->_writer->writeValue("]");
        } else {
            $this->_writer->writeValue("}");
        }

        return $this;

    }

    /**
     * Start the array scope
     *
     * @return JsonWriter
     */
    public function startArrayScope()
    {
        $this->_startScope($this->_scopeType['Array']);
        return $this;
    }


    /**
     * Write the "results" header for the data array
     *
     * @return JsonWriter
     */
    public function writeDataArrayName()
    {
        $this->writeName($this->dataArrayName);

The property dataArrayName does not exist on POData\Writers\Json\JsonWriter. Did you maybe forget to declare it?

        return $this;
    }

    /**
     * Start the object scope
     *
     * @return JsonWriter
     */
    public function startObjectScope()
    {
        $this->_startScope($this->_scopeType['Object']);
        return $this;
    }

    /**
     * Write the name for the object property
     *
     * @param string $name name of the object property
     *
     * @return JsonWriter
     */
    public function writeName($name)
    {
        $currentScope = end($this->_scopes);
        if ($currentScope && $currentScope->type == $this->_scopeType['Object']) {
            if ($currentScope->objectCount != 0) {
                $this->_writer->writeTrimmed(", ");
            }

            $currentScope->objectCount++;
        }

        $this->_writeCore($name, true /*quotes*/);

true of type true is incompatible with the type string expected by parameter $quotes of POData\Writers\Json\JsonWriter::_writeCore().

        $this->_writer->writeTrimmed(": ");

        return $this;
    }

    /**
     * JSON write a basic data type (string, number, boolean, null)
     *
     * @param mixed  $value value to be written
     * @param string $type  data type of the value
     *
     * @return JsonWriter
     */
    public function writeValue($value, $type = null)
    {
        switch ($type) {
            case 'Edm.Boolean':
            case 'Edm.Int16':
            case 'Edm.Int32':
            case 'Edm.Byte':
            case 'Edm.SByte':
                $this->_writeCore($value, /* quotes */ false);

false of type false is incompatible with the type string expected by parameter $quotes of POData\Writers\Json\JsonWriter::_writeCore().

                break;


            case 'Edm.Int64':
            case 'Edm.Guid':
            case 'Edm.Decimal':
            case 'Edm.Binary':
                $this->_writeCore($value, /* quotes */ true);

true of type true is incompatible with the type string expected by parameter $quotes of POData\Writers\Json\JsonWriter::_writeCore().

                break;

            case 'Edm.Single':
            case 'Edm.Double':
                if (is_infinite($value) || is_nan($value)) {
                    $this->_writeCore("null", /* quotes */ true);
                } else {
                    $this->_writeCore($value, /* quotes */ false);
                }

                break;


            case 'Edm.DateTime':
                $dateTime = new \DateTime($value, new \DateTimeZone('UTC'));
                $formattedDateTime = $dateTime->format('Y-m-d\TH:i:s');
                $this->_writeCore($formattedDateTime, /* quotes */ true);
                break;


            case 'Edm.String':
                if (is_null($value)) {
                    $this->_writeCore("null", /* quotes */ false);
                } else {
                    $jsonEncoded = json_encode($value);
                    //json_encode always escapes a solidus (forward slash, %x2F),
                    //this will be a problem when encoding urls
                    //JSON_UNESCAPED_SLASHES not available in earlier versions of php 5.3
                    //So removing escaping forward slashes manually
                    $jsonEncoded = str_replace('\\/', '/', $jsonEncoded);
                    //since json_encode is already appending chords
                    //there is no need to set it again
                    $this->_writeCore($jsonEncoded, /* quotes */ false);
                }
                break;


            default:
                $this->_writeCore($this->_quoteJScriptString($value), /* quotes */ true);
        }

        return $this;
    }

    /**
     * Returns the string value with special characters escaped
     *
     * @param string $string input string value
     *
     * Returns the string value with special characters escaped.
     *
     * @return string
     */
    private function _quoteJScriptString($string)
    {
        // Escape ( " \ / \n \r \t \b \f) characters with a backslash.
        $search  = array('\\', "\n", "\t", "\r", "\b", "\f", '"');
        $replace = array('\\\\', '\\n', '\\t', '\\r', '\\b', '\\f', '\"');
        $processedString = str_replace($search, $replace, $string);
        // Escape some ASCII characters(0x08, 0x0c)
        $processedString = str_replace(array(chr(0x08), chr(0x0C)), array('\b', '\f'), $processedString);
        return $processedString;
    }

    /**
     * Write the string value with/without quotes
     *
     * @param string $text   value to be written
     * @param string $quotes put quotes around the value if this value is true
     *
     * @return void
     */
    private function _writeCore($text, $quotes)
    {
        if (count($this->_scopes) != 0) {
            $currentScope = end($this->_scopes);
            if ($currentScope->type == $this->_scopeType['Array']) {
                if ($currentScope->objectCount != 0) {
                    $this->_writer->writeTrimmed(", ");
                }

                $currentScope->objectCount++;
            }
        }

        if ($quotes && $text !== 'null') {
            $this->_writer->writeValue('"');
        }

        $this->_writer->writeValue($text);
        if ($quotes && $text !== 'null') {
            $this->_writer->writeValue('"');
        }
    }

    /**
     * Start the scope given the scope type
     *
     * @param int $type scope type
     *
     * @return void
     */
    private function _startScope($type)
    {
        if (count($this->_scopes) != 0) {
            $currentScope = end($this->_scopes);
            if (($currentScope->type == $this->_scopeType['Array'])
                && ($currentScope->objectCount != 0)
            ) {
                $this->_writer->writeTrimmed(", ");
            }

            $currentScope->objectCount++;
        }

        $scope = new Scope($type);
        array_push($this->_scopes, $scope);

        if ($type == $this->_scopeType['Array']) {
            $this->_writer->writeValue("[");
        } else {
            $this->_writer->writeValue("{");
        }

        $this->_writer
            ->increaseIndent()
            ->writeLine();
    }

    /**
     * return the indented result
     *
     * @return string
     */
    public function getJsonOutput()
    {
        return $this->_writer->getResult();
    }
}



/**
 * class representing scope information
*
 */
class Scope
{
    /**
     * keeps the count of the nested scopes
     *
     */
    public $objectCount;

    /**
     *  keeps the type of the scope
     *
     */
    public $type;

    /**
     * Creates a new instance of scope type
     *
     * @param int $type type of the scope
     */
    public function __construct($type)
    {
        $this->type = $type;
        $this->objectCount = 0;
    }

}