FileSchema::setUpProperties() - Code Metrics - Inspection of "Builder" - swaggest/php-json-schema - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

by Viacheslav

created 2017-05-22 09:10 UTC

FileSchema::setUpProperties() B

↳ Parent: FileSchema

Complexity

Conditions	1
Paths	1

Size

Total Lines	27
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	23
nc	1
nop	2

<?php
/**
 * @file ATTENTION!!! The code below was carefully crafted by a mean machine.
 * Please consider to NOT put any emotional human-generated modifications as AI will throw them away with no mercy.
 */

namespace Swaggest\JsonSchema\SwaggerSchema;

use Swaggest\JsonSchema\Constraint\Properties;
use Swaggest\JsonSchema\Schema;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Swaggest\JsonSchema\Structure\ClassStructure;


class FileSchema extends ClassStructure {
	/** @var string */
	public $format;

	/** @var string */
	public $title;

	/** @var string */
	public $description;

	public $default;

	/** @var string[]|array */
	public $required;

	/** @var string */
	public $type;

	/** @var bool */
	public $readOnly;

	/** @var ExternalDocs information about external documentation */
	public $externalDocs;

	public $example;

	/**
	 * @param Properties|static $properties
	 * @param Schema $ownerSchema
	 */
	public static function setUpProperties($properties, Schema $ownerSchema)
	{
		$properties->format = Schema::string();
		$properties->title = Schema::string();
		$properties->description = Schema::string();
		$properties->default = new Schema();
		$properties->required = Schema::arr();
		$properties->required->items = Schema::string();
		$properties->required->minItems = 1;
		$properties->required->uniqueItems = true;
		$properties->type = Schema::string();
		$properties->type->enum = array (
		  0 => 'file',
		);
		$properties->readOnly = Schema::boolean();
		$properties->readOnly->default = false;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		$properties->externalDocs = ExternalDocs::schema();
		$properties->example = new Schema();
		$ownerSchema->type = 'object';

		$ownerSchema->additionalProperties = false;
		$ownerSchema->patternProperties['^x-'] = new Schema();
		$ownerSchema->patternProperties['^x-']->description = 'Any property starting with x- is valid.';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		$ownerSchema->description = 'A deterministic version of a JSON Schema object.';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
		$ownerSchema->required = array (
		  0 => 'type',
		);
	}
}



1			<?php
2			/**
3			* @file ATTENTION!!! The code below was carefully crafted by a mean machine.
4			* Please consider to NOT put any emotional human-generated modifications as AI will throw them away with no mercy.
5			*/
6
7			namespace Swaggest\JsonSchema\SwaggerSchema;
8
9			use Swaggest\JsonSchema\Constraint\Properties;
10			use Swaggest\JsonSchema\Schema;
			0 ignored issues – show Bug introduced 2017-05-22 09:50 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Swaggest\JsonSchema\SwaggerSchema\Schema`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
11			use Swaggest\JsonSchema\Structure\ClassStructure;
12
13
14			class FileSchema extends ClassStructure {
15			/** @var string */
16			public $format;
17
18			/** @var string */
19			public $title;
20
21			/** @var string */
22			public $description;
23
24			public $default;
25
26			/** @var string[]\|array */
27			public $required;
28
29			/** @var string */
30			public $type;
31
32			/** @var bool */
33			public $readOnly;
34
35			/** @var ExternalDocs information about external documentation */
36			public $externalDocs;
37
38			public $example;
39
40			/**
41			* @param Properties\|static $properties
42			* @param Schema $ownerSchema
43			*/
44			public static function setUpProperties($properties, Schema $ownerSchema)
45			{
46			$properties->format = Schema::string();
47			$properties->title = Schema::string();
48			$properties->description = Schema::string();
49			$properties->default = new Schema();
50			$properties->required = Schema::arr();
51			$properties->required->items = Schema::string();
52			$properties->required->minItems = 1;
53			$properties->required->uniqueItems = true;
54			$properties->type = Schema::string();
55			$properties->type->enum = array (
56			0 => 'file',
57			);
58			$properties->readOnly = Schema::boolean();
59			$properties->readOnly->default = false;
			0 ignored issues – show Documentation introduced 2017-05-22 09:50 UTC by Report Bug Copy Issue Report The property `default` does not exist on `object<Swaggest\JsonSchema\Schema>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
60			$properties->externalDocs = ExternalDocs::schema();
61			$properties->example = new Schema();
62			$ownerSchema->type = 'object';
			0 ignored issues – show Documentation Bug introduced 2017-05-22 09:50 UTC by Report Bug Copy Issue Report It seems like `'object'` of type `string` is incompatible with the declared type `object<Swaggest\JsonSchema\Constraint\Type>` of property `$type`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
63			$ownerSchema->additionalProperties = false;
64			$ownerSchema->patternProperties['^x-'] = new Schema();
65			$ownerSchema->patternProperties['^x-']->description = 'Any property starting with x- is valid.';
			0 ignored issues – show Documentation introduced 2017-05-22 09:50 UTC by Report Bug Copy Issue Report The property `description` does not exist on `object<Swaggest\JsonSchema\Schema>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
66			$ownerSchema->description = 'A deterministic version of a JSON Schema object.';
			0 ignored issues – show Documentation introduced 2017-05-22 09:50 UTC by Report Bug Copy Issue Report The property `description` does not exist on `object<Swaggest\JsonSchema\Schema>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67			$ownerSchema->required = array (
68			0 => 'type',
69			);
70			}
71			}
72
73

swaggest / php-json-schema

Pull Request — master (#9)

FileSchema::setUpProperties() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like