SchemaModel::setContainer() - Code Metrics - Inspection of "Load bundle from vendor graviton lib." - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/EVO-7278-security-and-... ( e30f5a...fbbb1a )

unknown

created 2016-09-22 11:57 UTC

SchemaModel::setContainer() A

↳ Parent: SchemaModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php
/**
 * Model based on Graviton\RestBundle\Model\DocumentModel.
 */

namespace Graviton\SchemaBundle\Model;

use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Model based on Graviton\RestBundle\Model\DocumentModel.
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class SchemaModel implements ContainerAwareInterface
{
    /**
     * object
     */
    private $schema;

    /**
     * @var ContainerInterface
     */
    private $container;

    /**
     * load some schema info for the model
     */
    public function __construct()
    {
        list(, $bundle, , $model) = explode('\\', get_called_class());
        $file = __DIR__ . '/../../' . $bundle . '/Resources/config/schema/' . $model . '.json';

        if (!file_exists($file)) {
            $reflection = new \ReflectionClass($this);
            $file = dirname($reflection->getFileName()).'/../Resources/config/schema/' . $model . '.json';
        }

        if (!file_exists($file)) {
            // fallback try on model property (this should be available on some generated classes)
            if (isset($this->_modelPath)) {
                // try to find schema.json relative to the model involved..
                $file = dirname($this->_modelPath) . '/../Resources/config/schema/' . $model . '.json';
            }

            if (!file_exists($file)) {
                throw new \LogicException('Please create the schema file ' . $file);
            }
        }

        $this->schema = \json_decode(file_get_contents($file));

        if (is_null($this->schema)) {
            throw new \LogicException('The file ' . $file . ' doe not contain valid json');
        }
    }

    /**
     * inject container
     *
     * @param ContainerInterface $container service container

     *
     * @return self
     */
    public function setContainer(ContainerInterface $container = null)
    {
        $this->container = $container;

        return $this;
    }

    /**
     * get Title
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->schema->title;
    }

    /**
     * get description
     *
     * @return string Description
     */
    public function getDescription()
    {
        return $this->schema->description;
    }

    /**
     * get recordOriginModifiable
     *
     * @return bool
     */
    public function getRecordOriginModifiable()

    {
        if (isset($this->schema->recordOriginModifiable)) {
            return $this->schema->recordOriginModifiable;
        }
        return true;
    }

    /**
     * Returns the bare schema
     *
     * @return \stdClass Schema
     */
    public function getSchema()
    {
        return $this->schema;
    }

    /**
     * get title for a given field
     *
     * @param string $field field name
     *
     * @return string
     */
    public function getTitleOfField($field)
    {
        return $this->getSchemaField($field, 'title');
    }

    /**
     * get description for a given field
     *
     * @param string $field field name
     *
     * @return string
     */
    public function getDescriptionOfField($field)
    {
        return $this->getSchemaField($field, 'description');
    }

    /**
     * get property model for embedded field
     *
     * @param string $mapping name of mapping class
     *
     * @return $this
     */
    public function manyPropertyModelForTarget($mapping)
    {
        // @todo refactor to get rid of container dependency (maybe remove from here)
        list($app, $bundle, , $document) = explode('\\', $mapping);
        $app = strtolower($app);
        $bundle = strtolower(substr($bundle, 0, -6));
        $document = strtolower($document);
        $propertyService = implode('.', array($app, $bundle, 'model', $document));
        $propertyModel = $this->container->get($propertyService);

        return $propertyModel;
    }

    /**
     * get required fields for this object
     *
     * @return string[]
     */
    public function getRequiredFields()
    {
        return $this->schema->required;
    }

    /**
     * get a collection of service names that can extref refer to
     *
     * @param string $field field name
     *
     * @return array
     */
    public function getRefCollectionOfField($field)
    {
        return $this->getSchemaField($field, 'collection', array());
    }

    /**
     * get readOnly flag for a given field
     *
     * @param string $field field name
     *
     * @return boolean the readOnly flag
     */
    public function getReadOnlyOfField($field)

    {
        return $this->getSchemaField($field, 'readOnly', false);
    }

    /**
     * get readOnly flag for a given field
     *
     * @param string $field field name
     *
     * @return boolean the readOnly flag
     */
    public function getRecordOriginExceptionOfField($field)

    {
        return $this->getSchemaField($field, 'recordOriginException', false);
    }

    /**
     * get searchable flag for a given field, weight based.
     *
     * @param string $field field name
     *
     * @return integer the searchable flag
     */
    public function getSearchableOfField($field)
    {
        return (int) $this->getSchemaField($field, 'searchable', 0);
    }

    /**
     * tell us if a model what to be exposed using a key as field
     *
     * @param string $field field that we check for dynamic-key spec
     *
     * @return boolean
     */
    public function hasDynamicKey($field)
    {
        return $this->getSchemaField($field, 'x-dynamic-key', false) !== false;
    }

    /**
     * Get field used for setting stringy key value
     *
     * @param string $field field that we get dynamic-key spec from
     *
     * @return object
     */
    public function getDynamicKeySpec($field)
    {
        return $this->getSchemaField($field, 'x-dynamic-key');
    }

    /**
     * Gets the defined document class in shortform from schema
     *
     * @return string|false either the document class or false it not given
     */
    public function getDocumentClass()
    {
        $documentClass = false;
        if (isset($this->schema->{'x-documentClass'})) {
            $documentClass = $this->schema->{'x-documentClass'};
        }
        return $documentClass;
    }

    /**
     * Get defined constraints on this field (if any)
     *
     * @param string $field field that we get constraints spec from
     *
     * @return object
     */
    public function getConstraints($field)
    {
        return $this->getSchemaField($field, 'x-constraints', false);
    }

    /**
     * Tells us if in this model, the ID can be given on a POST request or not (in the payload).
     * This basically depends on if the "id" property is given in the JSON definition or not.
     *
     * @return bool true if yes, false otherwise
     */
    public function isIdInPostAllowed()
    {
        $isAllowed = true;
        if (isset($this->schema->{'x-id-in-post-allowed'})) {
            $isAllowed = $this->schema->{'x-id-in-post-allowed'};
        }
        return $isAllowed;
    }

    /**
     * get schema field value
     *
     * @param string $field         field name
     * @param string $property      property name
     * @param mixed  $fallbackValue fallback value if property isn't set
     *
     * @return mixed
     */
    private function getSchemaField($field, $property, $fallbackValue = '')
    {
        if (isset($this->schema->properties->$field->$property)) {
            $fallbackValue = $this->schema->properties->$field->$property;
        }

        return $fallbackValue;
    }

    /**
     * get searchable fields for this object
     *
     * @return string[]
     */
    public function getSearchableFields()
    {
        return $this->schema->searchable;
    }
}


1		<?php
2		/**
3		* Model based on Graviton\RestBundle\Model\DocumentModel.
4		*/
5
6		namespace Graviton\SchemaBundle\Model;
7
8		use Symfony\Component\DependencyInjection\ContainerAwareInterface;
9		use Symfony\Component\DependencyInjection\ContainerInterface;
10
11		/**
12		* Model based on Graviton\RestBundle\Model\DocumentModel.
13		*
14		* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
15		* @license http://opensource.org/licenses/gpl-license.php GNU Public License
16		* @link http://swisscom.ch
17		*/
18		class SchemaModel implements ContainerAwareInterface
19		{
20		/**
21		* object
22		*/
23		private $schema;
24
25		/**
26		* @var ContainerInterface
27		*/
28		private $container;
29
30		/**
31		* load some schema info for the model
32		*/
33	4	public function __construct()
34		{
35	4	list(, $bundle, , $model) = explode('\\', get_called_class());
36	4	$file = __DIR__ . '/../../' . $bundle . '/Resources/config/schema/' . $model . '.json';
37
38	4	if (!file_exists($file)) {
39		$reflection = new \ReflectionClass($this);
40		$file = dirname($reflection->getFileName()).'/../Resources/config/schema/' . $model . '.json';
41		}
42
43	4	if (!file_exists($file)) {
44		// fallback try on model property (this should be available on some generated classes)
45		if (isset($this->_modelPath)) {
46		// try to find schema.json relative to the model involved..
47		$file = dirname($this->_modelPath) . '/../Resources/config/schema/' . $model . '.json';
48		}
49
50		if (!file_exists($file)) {
51		throw new \LogicException('Please create the schema file ' . $file);
52		}
53		}
54
55	4	$this->schema = \json_decode(file_get_contents($file));
56
57	4	if (is_null($this->schema)) {
58		throw new \LogicException('The file ' . $file . ' doe not contain valid json');
59		}
60	4	}
61
62		/**
63		* inject container
64		*
65		* @param ContainerInterface $container service container
		0 ignored issues – show Documentation introduced 2016-03-30 09:55 UTC by Report Bug Copy Issue Report Should the type for parameter `$container` not be `null\|ContainerInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
66		*
67		* @return self
68		*/
69	4	public function setContainer(ContainerInterface $container = null)
70		{
71	4	$this->container = $container;
72
73	4	return $this;
74		}
75
76		/**
77		* get Title
78		*
79		* @return string
80		*/
81		public function getTitle()
82		{
83		return $this->schema->title;
84		}
85
86		/**
87		* get description
88		*
89		* @return string Description
90		*/
91		public function getDescription()
92		{
93		return $this->schema->description;
94		}
95
96		/**
97		* get recordOriginModifiable
98		*
99		* @return bool
100		*/
101		public function getRecordOriginModifiable()
		0 ignored issues – show Coding Style introduced 2016-07-21 08:46 UTC by Report Bug Copy Issue Report `function getRecordOriginModifiable()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
102		{
103		if (isset($this->schema->recordOriginModifiable)) {
104		return $this->schema->recordOriginModifiable;
105		}
106		return true;
107		}
108
109		/**
110		* Returns the bare schema
111		*
112		* @return \stdClass Schema
113		*/
114		public function getSchema()
115		{
116		return $this->schema;
117		}
118
119		/**
120		* get title for a given field
121		*
122		* @param string $field field name
123		*
124		* @return string
125		*/
126		public function getTitleOfField($field)
127		{
128		return $this->getSchemaField($field, 'title');
129		}
130
131		/**
132		* get description for a given field
133		*
134		* @param string $field field name
135		*
136		* @return string
137		*/
138		public function getDescriptionOfField($field)
139		{
140		return $this->getSchemaField($field, 'description');
141		}
142
143		/**
144		* get property model for embedded field
145		*
146		* @param string $mapping name of mapping class
147		*
148		* @return $this
149		*/
150		public function manyPropertyModelForTarget($mapping)
151		{
152		// @todo refactor to get rid of container dependency (maybe remove from here)
153		list($app, $bundle, , $document) = explode('\\', $mapping);
154		$app = strtolower($app);
155		$bundle = strtolower(substr($bundle, 0, -6));
156		$document = strtolower($document);
157		$propertyService = implode('.', array($app, $bundle, 'model', $document));
158		$propertyModel = $this->container->get($propertyService);
159
160		return $propertyModel;
161		}
162
163		/**
164		* get required fields for this object
165		*
166		* @return string[]
167		*/
168		public function getRequiredFields()
169		{
170		return $this->schema->required;
171		}
172
173		/**
174		* get a collection of service names that can extref refer to
175		*
176		* @param string $field field name
177		*
178		* @return array
179		*/
180		public function getRefCollectionOfField($field)
181		{
182		return $this->getSchemaField($field, 'collection', array());
183		}
184
185		/**
186		* get readOnly flag for a given field
187		*
188		* @param string $field field name
189		*
190		* @return boolean the readOnly flag
191		*/
192		public function getReadOnlyOfField($field)
		0 ignored issues – show Coding Style introduced 2015-11-23 08:02 UTC by Report Bug Copy Issue Report `function getReadOnlyOfField()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
193		{
194		return $this->getSchemaField($field, 'readOnly', false);
195		}
196
197		/**
198		* get readOnly flag for a given field
199		*
200		* @param string $field field name
201		*
202		* @return boolean the readOnly flag
203		*/
204		public function getRecordOriginExceptionOfField($field)
		0 ignored issues – show Coding Style introduced 2016-07-21 08:46 UTC by Report Bug Copy Issue Report `function getRecordOriginExceptionOfField()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
205		{
206		return $this->getSchemaField($field, 'recordOriginException', false);
207		}
208
209		/**
210		* get searchable flag for a given field, weight based.
211		*
212		* @param string $field field name
213		*
214		* @return integer the searchable flag
215		*/
216		public function getSearchableOfField($field)
217		{
218		return (int) $this->getSchemaField($field, 'searchable', 0);
219		}
220
221		/**
222		* tell us if a model what to be exposed using a key as field
223		*
224		* @param string $field field that we check for dynamic-key spec
225		*
226		* @return boolean
227		*/
228		public function hasDynamicKey($field)
229		{
230		return $this->getSchemaField($field, 'x-dynamic-key', false) !== false;
231		}
232
233		/**
234		* Get field used for setting stringy key value
235		*
236		* @param string $field field that we get dynamic-key spec from
237		*
238		* @return object
239		*/
240		public function getDynamicKeySpec($field)
241		{
242		return $this->getSchemaField($field, 'x-dynamic-key');
243		}
244
245		/**
246		* Gets the defined document class in shortform from schema
247		*
248		* @return string\|false either the document class or false it not given
249		*/
250		public function getDocumentClass()
251		{
252		$documentClass = false;
253		if (isset($this->schema->{'x-documentClass'})) {
254		$documentClass = $this->schema->{'x-documentClass'};
255		}
256		return $documentClass;
257		}
258
259		/**
260		* Get defined constraints on this field (if any)
261		*
262		* @param string $field field that we get constraints spec from
263		*
264		* @return object
265		*/
266		public function getConstraints($field)
267		{
268		return $this->getSchemaField($field, 'x-constraints', false);
269		}
270
271		/**
272		* Tells us if in this model, the ID can be given on a POST request or not (in the payload).
273		* This basically depends on if the "id" property is given in the JSON definition or not.
274		*
275		* @return bool true if yes, false otherwise
276		*/
277		public function isIdInPostAllowed()
278		{
279		$isAllowed = true;
280		if (isset($this->schema->{'x-id-in-post-allowed'})) {
281		$isAllowed = $this->schema->{'x-id-in-post-allowed'};
282		}
283		return $isAllowed;
284		}
285
286		/**
287		* get schema field value
288		*
289		* @param string $field field name
290		* @param string $property property name
291		* @param mixed $fallbackValue fallback value if property isn't set
292		*
293		* @return mixed
294		*/
295		private function getSchemaField($field, $property, $fallbackValue = '')
296		{
297		if (isset($this->schema->properties->$field->$property)) {
298		$fallbackValue = $this->schema->properties->$field->$property;
299		}
300
301		return $fallbackValue;
302		}
303
304		/**
305		* get searchable fields for this object
306		*
307		* @return string[]
308		*/
309		public function getSearchableFields()
310		{
311		return $this->schema->searchable;
312		}
313		}
314

libgraviton / graviton

Push — feature/EVO-7278-security-and-... ( e30f5a...fbbb1a )

SchemaModel::setContainer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like