ApiKeySecurity::setUpProperties() - Code Metrics - Inspection of "Merge pull request #9 from swaggest/builder" - swaggest/php-json-schema - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 00c00f...dfb0dd )

by Viacheslav

created 2017-05-22 10:03 UTC

ApiKeySecurity::setUpProperties() A

↳ Parent: ApiKeySecurity

Complexity

Conditions	1
Paths	1

Size

Total Lines	23
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	9.0856
c	0
b	0
f	0
cc	1
eloc	18
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 as JsonBasicSchema;
use Swaggest\JsonSchema\Structure\ClassStructure;


class ApiKeySecurity extends ClassStructure {
	/** @var string */
	public $type;

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

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

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

	/**
	 * @param Properties|static $properties
	 * @param JsonBasicSchema $ownerSchema
	 */
	public static function setUpProperties($properties, JsonBasicSchema $ownerSchema)
	{
		$properties->type = JsonBasicSchema::string();
		$properties->type->enum = array (
		  0 => 'apiKey',
		);
		$properties->name = JsonBasicSchema::string();
		$properties->in = JsonBasicSchema::string();
		$properties->in->enum = array (
		  0 => 'header',
		  1 => 'query',
		);
		$properties->description = JsonBasicSchema::string();
		$ownerSchema->type = 'object';

		$ownerSchema->additionalProperties = false;
		$ownerSchema->patternProperties['^x-'] = new JsonBasicSchema();
		$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->required = array (
		  0 => 'type',
		  1 => 'name',
		  2 => 'in',
		);
	}
}



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 as JsonBasicSchema;
11			use Swaggest\JsonSchema\Structure\ClassStructure;
12
13
14			class ApiKeySecurity extends ClassStructure {
15			/** @var string */
16			public $type;
17
18			/** @var string */
19			public $name;
20
21			/** @var string */
22			public $in;
23
24			/** @var string */
25			public $description;
26
27			/**
28			* @param Properties\|static $properties
29			* @param JsonBasicSchema $ownerSchema
30			*/
31			public static function setUpProperties($properties, JsonBasicSchema $ownerSchema)
32			{
33			$properties->type = JsonBasicSchema::string();
34			$properties->type->enum = array (
35			0 => 'apiKey',
36			);
37			$properties->name = JsonBasicSchema::string();
38			$properties->in = JsonBasicSchema::string();
39			$properties->in->enum = array (
40			0 => 'header',
41			1 => 'query',
42			);
43			$properties->description = JsonBasicSchema::string();
44			$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...
45			$ownerSchema->additionalProperties = false;
46			$ownerSchema->patternProperties['^x-'] = new JsonBasicSchema();
47			$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...
48			$ownerSchema->required = array (
49			0 => 'type',
50			1 => 'name',
51			2 => 'in',
52			);
53			}
54			}
55
56

swaggest / php-json-schema

Push — master ( 00c00f...dfb0dd )

ApiKeySecurity::setUpProperties() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like