ClassStructureTrait::jsonSerialize() - Code Metrics - Inspection of "Merge pull request #19 from swaggest/tweaks" - swaggest/php-json-schema - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (bd1396)

by Viacheslav

created 2018-02-14 11:28 UTC

ClassStructureTrait::jsonSerialize() B

↳ Parent: ClassStructureTrait

Complexity

Conditions	7
Paths	12

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	7

Importance

Changes

Metric	Value
dl	0
loc	21
c	0
b	0
f	0
ccs	13
cts	13
cp	1
rs	7.551
cc	7
eloc	12
nc	12
nop	0
crap	7

<?php

namespace Swaggest\JsonSchema\Structure;

use Swaggest\JsonSchema\Constraint\Properties;
use Swaggest\JsonSchema\Context;
use Swaggest\JsonSchema\NameMirror;

trait ClassStructureTrait
{
    use ObjectItemTrait;

    /**
     * @return ClassSchema
     */
    public static function schema()
    {
        static $schemas = array();
        $className = get_called_class();
        $schema = &$schemas[$className];

        if (null === $schema) {
            $schema = new ClassSchema();
            $properties = new Properties();
            $schema->properties = $properties;
            $schema->objectItemClass = $className;
            static::setUpProperties($properties, $schema);
        }

        return $schema;
    }

    /**
     * @return Properties|static
     */
    public static function properties()
    {
        return static::schema()->properties;

    }

    /**
     * @param mixed $data
     * @param Context $options
     * @return static
     * @throws \Exception
     * @throws \Swaggest\JsonSchema\Exception
     * @throws \Swaggest\JsonSchema\InvalidValue
     */
    public static function import($data, Context $options = null)
    {
        return static::schema()->in($data, $options);
    }

    /**
     * @param mixed $data
     * @param Context $options
     * @return mixed
     * @throws \Swaggest\JsonSchema\InvalidValue
     * @throws \Exception
     */
    public static function export($data, Context $options = null)
    {
        return static::schema()->out($data, $options);
    }

    /**
     * @param ObjectItemContract $objectItem
     * @return static
     */
    public static function pick(ObjectItemContract $objectItem)
    {
        $className = get_called_class();
        return $objectItem->getNestedObject($className);
    }

    /**
     * @return static
     */
    public static function create()
    {
        return new static;
    }

    protected $__validateOnSet = true; // todo skip validation during import

    public function jsonSerialize()
    {
        $result = new \stdClass();
        $properties = static::schema()->properties;
        foreach ($properties->toArray() as $name => $schema) {
            $value = $this->$name;
            if ((null !== $value) || array_key_exists($name, $this->__arrayOfData)) {
                $result->$name = $value;
            }
        }
        foreach ($properties->nestedPropertyNames as $name) {

            /** @var ObjectItem $nested */
            $nested = $this->$name;
            if (null !== $nested) {
                foreach ((array)$nested->jsonSerialize() as $key => $value) {
                    $result->$key = $value;
                }
            }
        }

        return $result;
    }

    /**
     * @return static|NameMirror
     */
    public static function names()
    {
        static $nameflector = null;
        if (null === $nameflector) {
            $nameflector = new NameMirror();
        }
        return $nameflector;
    }

    public function __set($name, $column) // todo nested schemas
    {
        if ($this->__validateOnSet) {
            if ($property = static::schema()->properties[$name]) {
                $property->out($column);
            }
        }
        $this->__arrayOfData[$name] = $column;

        return $this;
    }

    public static function className()
    {
        return get_called_class();
    }

    /**
     * @throws \Exception
     * @throws \Swaggest\JsonSchema\InvalidValue
     */
    public function validate()
    {
        static::schema()->out($this);
    }
}

1		<?php
2
3		namespace Swaggest\JsonSchema\Structure;
4
5		use Swaggest\JsonSchema\Constraint\Properties;
6		use Swaggest\JsonSchema\Context;
7		use Swaggest\JsonSchema\NameMirror;
8
9		trait ClassStructureTrait
10		{
11		use ObjectItemTrait;
12
13		/**
14		* @return ClassSchema
15		*/
16	3117	public static function schema()
17		{
18	3117	static $schemas = array();
19	3117	$className = get_called_class();
20	3117	$schema = &$schemas[$className];
21
22	3117	if (null === $schema) {
23	7	$schema = new ClassSchema();
24	7	$properties = new Properties();
25	7	$schema->properties = $properties;
26	7	$schema->objectItemClass = $className;
27	7	static::setUpProperties($properties, $schema);
28		}
29
30	3117	return $schema;
31		}
32
33		/**
34		* @return Properties\|static
35		*/
36	2	public static function properties()
37		{
38	2	return static::schema()->properties;
		0 ignored issues – show Bug Best Practice introduced 2018-02-14 11:36 UTC by Report Bug Copy Issue Report The expression `return static::schema()->properties` also could return the type `Swaggest\JsonSchema\Schema[]` which is incompatible with the documented return type `Swaggest\JsonSchema\Cons...ure\ClassStructureTrait`. Loading history...
39		}
40
41		/**
42		* @param mixed $data
43		* @param Context $options
44		* @return static
45		* @throws \Exception
46		* @throws \Swaggest\JsonSchema\Exception
47		* @throws \Swaggest\JsonSchema\InvalidValue
48		*/
49	3105	public static function import($data, Context $options = null)
50		{
51	3105	return static::schema()->in($data, $options);
52		}
53
54		/**
55		* @param mixed $data
56		* @param Context $options
57		* @return mixed
58		* @throws \Swaggest\JsonSchema\InvalidValue
59		* @throws \Exception
60		*/
61	10	public static function export($data, Context $options = null)
62		{
63	10	return static::schema()->out($data, $options);
64		}
65
66		/**
67		* @param ObjectItemContract $objectItem
68		* @return static
69		*/
70	2	public static function pick(ObjectItemContract $objectItem)
71		{
72	2	$className = get_called_class();
73	2	return $objectItem->getNestedObject($className);
74		}
75
76		/**
77		* @return static
78		*/
79	6	public static function create()
80		{
81	6	return new static;
82		}
83
84		protected $__validateOnSet = true; // todo skip validation during import
85
86	31	public function jsonSerialize()
87		{
88	31	$result = new \stdClass();
89	31	$properties = static::schema()->properties;
90	31	foreach ($properties->toArray() as $name => $schema) {
91	31	$value = $this->$name;
92	31	if ((null !== $value) \|\| array_key_exists($name, $this->__arrayOfData)) {
93	31	$result->$name = $value;
94		}
95		}
96	31	foreach ($properties->nestedPropertyNames as $name) {
		0 ignored issues – show Bug Best Practice introduced 2018-02-14 11:36 UTC by Report Bug Copy Issue Report The property `nestedPropertyNames` does not exist on `Swaggest\JsonSchema\Schema`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
97		/** @var ObjectItem $nested */
98	4	$nested = $this->$name;
99	4	if (null !== $nested) {
100	2	foreach ((array)$nested->jsonSerialize() as $key => $value) {
101	4	$result->$key = $value;
102		}
103		}
104		}
105
106	31	return $result;
107		}
108
109		/**
110		* @return static\|NameMirror
111		*/
112	3	public static function names()
113		{
114	3	static $nameflector = null;
115	3	if (null === $nameflector) {
116	2	$nameflector = new NameMirror();
117		}
118	3	return $nameflector;
119		}
120
121	247	public function __set($name, $column) // todo nested schemas
122		{
123	247	if ($this->__validateOnSet) {
124	4	if ($property = static::schema()->properties[$name]) {
125	4	$property->out($column);
126		}
127		}
128	246	$this->__arrayOfData[$name] = $column;
		0 ignored issues – show Bug Best Practice introduced 2018-02-14 11:36 UTC by Report Bug Copy Issue Report The property `__arrayOfData` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
129	246	return $this;
130		}
131
132		public static function className()
133		{
134		return get_called_class();
135		}
136
137		/**
138		* @throws \Exception
139		* @throws \Swaggest\JsonSchema\InvalidValue
140		*/
141		public function validate()
142		{
143		static::schema()->out($this);
144		}
145		}

swaggest / php-json-schema

Branch — master (bd1396)

ClassStructureTrait::jsonSerialize() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like