PathItem::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

PathItem::setUpProperties() B

↳ Parent: PathItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	33
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	33
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	30
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 PathItem extends ClassStructure {
	/** @var string */
	public $ref;

	/** @var Operation */
	public $get;

	/** @var Operation */
	public $put;

	/** @var Operation */
	public $post;

	/** @var Operation */
	public $delete;

	/** @var Operation */
	public $options;

	/** @var Operation */
	public $head;

	/** @var Operation */
	public $patch;

	/** @var BodyParameter[]|HeaderParameterSubSchema[]|FormDataParameterSubSchema[]|QueryParameterSubSchema[]|PathParameterSubSchema[]|JsonReference[]|array The parameters needed to send a valid API call. */
	public $parameters;

	/**
	 * @param Properties|static $properties
	 * @param Schema $ownerSchema
	 */
	public static function setUpProperties($properties, Schema $ownerSchema)
	{
		$properties->ref = Schema::string();
		$ownerSchema->addPropertyMapping('$ref', self::names()->ref);
<?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->get = Operation::schema();
		$properties->put = Operation::schema();
		$properties->post = Operation::schema();
		$properties->delete = Operation::schema();
		$properties->options = Operation::schema();
		$properties->head = Operation::schema();
		$properties->patch = Operation::schema();
		$properties->parameters = Schema::arr();
		$properties->parameters->items = new Schema();
		$properties->parameters->items->oneOf[0] = new Schema();
		$properties->parameters->items->oneOf[0]->oneOf[0] = BodyParameter::schema();
		$properties->parameters->items->oneOf[0]->oneOf[1] = Schema::object();
		$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[0] = HeaderParameterSubSchema::schema();
		$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[1] = FormDataParameterSubSchema::schema();
		$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[2] = QueryParameterSubSchema::schema();
		$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[3] = PathParameterSubSchema::schema();
		$properties->parameters->items->oneOf[0]->oneOf[1]->required = array (
		  0 => 'name',
		  1 => 'in',
		  2 => 'type',
		);
		$properties->parameters->items->oneOf[1] = JsonReference::schema();
		$properties->parameters->description = 'The parameters needed to send a valid API call.';
<?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->parameters->uniqueItems = true;
		$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.");
        }
    }

}
	}
}



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 PathItem extends ClassStructure {
15			/** @var string */
16			public $ref;
17
18			/** @var Operation */
19			public $get;
20
21			/** @var Operation */
22			public $put;
23
24			/** @var Operation */
25			public $post;
26
27			/** @var Operation */
28			public $delete;
29
30			/** @var Operation */
31			public $options;
32
33			/** @var Operation */
34			public $head;
35
36			/** @var Operation */
37			public $patch;
38
39			/** @var BodyParameter[]\|HeaderParameterSubSchema[]\|FormDataParameterSubSchema[]\|QueryParameterSubSchema[]\|PathParameterSubSchema[]\|JsonReference[]\|array The parameters needed to send a valid API call. */
40			public $parameters;
41
42			/**
43			* @param Properties\|static $properties
44			* @param Schema $ownerSchema
45			*/
46			public static function setUpProperties($properties, Schema $ownerSchema)
47			{
48			$properties->ref = Schema::string();
49			$ownerSchema->addPropertyMapping('$ref', self::names()->ref);
			0 ignored issues – show Documentation introduced 2017-05-22 09:50 UTC by Report Bug Copy Issue Report The property `ref` does not exist on `object<Swaggest\JsonSchema\NameMirror>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
50			$properties->get = Operation::schema();
51			$properties->put = Operation::schema();
52			$properties->post = Operation::schema();
53			$properties->delete = Operation::schema();
54			$properties->options = Operation::schema();
55			$properties->head = Operation::schema();
56			$properties->patch = Operation::schema();
57			$properties->parameters = Schema::arr();
58			$properties->parameters->items = new Schema();
59			$properties->parameters->items->oneOf[0] = new Schema();
60			$properties->parameters->items->oneOf[0]->oneOf[0] = BodyParameter::schema();
61			$properties->parameters->items->oneOf[0]->oneOf[1] = Schema::object();
62			$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[0] = HeaderParameterSubSchema::schema();
63			$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[1] = FormDataParameterSubSchema::schema();
64			$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[2] = QueryParameterSubSchema::schema();
65			$properties->parameters->items->oneOf[0]->oneOf[1]->oneOf[3] = PathParameterSubSchema::schema();
66			$properties->parameters->items->oneOf[0]->oneOf[1]->required = array (
67			0 => 'name',
68			1 => 'in',
69			2 => 'type',
70			);
71			$properties->parameters->items->oneOf[1] = JsonReference::schema();
72			$properties->parameters->description = 'The parameters needed to send a valid API call.';
			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...
73			$properties->parameters->uniqueItems = true;
74			$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...
75			$ownerSchema->additionalProperties = false;
76			$ownerSchema->patternProperties['^x-'] = new Schema();
77			$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...
78			}
79			}
80
81

swaggest / php-json-schema

Pull Request — master (#9)

PathItem::setUpProperties() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like