SchemaModel::getRecordOriginModifiable() - Code Metrics - Inspection of "add more information to the schema in regard to th..." - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/EVO-6307-record-origin... ( 2c1fcb )

by Narcotic

created 2016-07-21 07:44 UTC

SchemaModel::getRecordOriginModifiable() A

↳ Parent: SchemaModel

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
dl	0
loc	7
rs	9.4285
c	1
b	0
f	1
cc	2
eloc	4
nc	2
nop	0

<?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)) {
            // 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			public function __construct()
34			{
35			list(, $bundle, , $model) = explode('\\', get_called_class());
36			$file = __DIR__ . '/../../' . $bundle . '/Resources/config/schema/' . $model . '.json';
37
38			if (!file_exists($file)) {
39			// fallback try on model property (this should be available on some generated classes)
40			if (isset($this->_modelPath)) {
41			// try to find schema.json relative to the model involved..
42			$file = dirname($this->_modelPath) . '/../Resources/config/schema/' . $model . '.json';
43			}
44
45			if (!file_exists($file)) {
46			throw new \LogicException('Please create the schema file ' . $file);
47			}
48			}
49
50			$this->schema = \json_decode(file_get_contents($file));
51
52			if (is_null($this->schema)) {
53			throw new \LogicException('The file ' . $file . ' doe not contain valid json');
54			}
55			}
56
57			/**
58			* inject container
59			*
60			* @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...
61			*
62			* @return self
63			*/
64			public function setContainer(ContainerInterface $container = null)
65			{
66			$this->container = $container;
67
68			return $this;
69			}
70
71			/**
72			* get Title
73			*
74			* @return string
75			*/
76			public function getTitle()
77			{
78			return $this->schema->title;
79			}
80
81			/**
82			* get description
83			*
84			* @return string Description
85			*/
86			public function getDescription()
87			{
88			return $this->schema->description;
89			}
90
91			/**
92			* get recordOriginModifiable
93			*
94			* @return bool
95			*/
96			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...
97			{
98			if (isset($this->schema->recordOriginModifiable)) {
99			return $this->schema->recordOriginModifiable;
100			}
101			return true;
102			}
103
104			/**
105			* Returns the bare schema
106			*
107			* @return \stdClass Schema
108			*/
109			public function getSchema()
110			{
111			return $this->schema;
112			}
113
114			/**
115			* get title for a given field
116			*
117			* @param string $field field name
118			*
119			* @return string
120			*/
121			public function getTitleOfField($field)
122			{
123			return $this->getSchemaField($field, 'title');
124			}
125
126			/**
127			* get description for a given field
128			*
129			* @param string $field field name
130			*
131			* @return string
132			*/
133			public function getDescriptionOfField($field)
134			{
135			return $this->getSchemaField($field, 'description');
136			}
137
138			/**
139			* get property model for embedded field
140			*
141			* @param string $mapping name of mapping class
142			*
143			* @return $this
144			*/
145			public function manyPropertyModelForTarget($mapping)
146			{
147			// @todo refactor to get rid of container dependency (maybe remove from here)
148			list($app, $bundle, , $document) = explode('\\', $mapping);
149			$app = strtolower($app);
150			$bundle = strtolower(substr($bundle, 0, -6));
151			$document = strtolower($document);
152			$propertyService = implode('.', array($app, $bundle, 'model', $document));
153			$propertyModel = $this->container->get($propertyService);
154
155			return $propertyModel;
156			}
157
158			/**
159			* get required fields for this object
160			*
161			* @return string[]
162			*/
163			public function getRequiredFields()
164			{
165			return $this->schema->required;
166			}
167
168			/**
169			* get a collection of service names that can extref refer to
170			*
171			* @param string $field field name
172			*
173			* @return array
174			*/
175			public function getRefCollectionOfField($field)
176			{
177			return $this->getSchemaField($field, 'collection', array());
178			}
179
180			/**
181			* get readOnly flag for a given field
182			*
183			* @param string $field field name
184			*
185			* @return boolean the readOnly flag
186			*/
187			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...
188			{
189			return $this->getSchemaField($field, 'readOnly', false);
190			}
191
192			/**
193			* get readOnly flag for a given field
194			*
195			* @param string $field field name
196			*
197			* @return boolean the readOnly flag
198			*/
199			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...
200			{
201			return $this->getSchemaField($field, 'recordOriginException', false);
202			}
203
204			/**
205			* get searchable flag for a given field, weight based.
206			*
207			* @param string $field field name
208			*
209			* @return integer the searchable flag
210			*/
211			public function getSearchableOfField($field)
212			{
213			return (int) $this->getSchemaField($field, 'searchable', 0);
214			}
215
216			/**
217			* tell us if a model what to be exposed using a key as field
218			*
219			* @param string $field field that we check for dynamic-key spec
220			*
221			* @return boolean
222			*/
223			public function hasDynamicKey($field)
224			{
225			return $this->getSchemaField($field, 'x-dynamic-key', false) !== false;
226			}
227
228			/**
229			* Get field used for setting stringy key value
230			*
231			* @param string $field field that we get dynamic-key spec from
232			*
233			* @return object
234			*/
235			public function getDynamicKeySpec($field)
236			{
237			return $this->getSchemaField($field, 'x-dynamic-key');
238			}
239
240			/**
241			* Gets the defined document class in shortform from schema
242			*
243			* @return string\|false either the document class or false it not given
244			*/
245			public function getDocumentClass()
246			{
247			$documentClass = false;
248			if (isset($this->schema->{'x-documentClass'})) {
249			$documentClass = $this->schema->{'x-documentClass'};
250			}
251			return $documentClass;
252			}
253
254			/**
255			* Get defined constraints on this field (if any)
256			*
257			* @param string $field field that we get constraints spec from
258			*
259			* @return object
260			*/
261			public function getConstraints($field)
262			{
263			return $this->getSchemaField($field, 'x-constraints', false);
264			}
265
266			/**
267			* Tells us if in this model, the ID can be given on a POST request or not (in the payload).
268			* This basically depends on if the "id" property is given in the JSON definition or not.
269			*
270			* @return bool true if yes, false otherwise
271			*/
272			public function isIdInPostAllowed()
273			{
274			$isAllowed = true;
275			if (isset($this->schema->{'x-id-in-post-allowed'})) {
276			$isAllowed = $this->schema->{'x-id-in-post-allowed'};
277			}
278			return $isAllowed;
279			}
280
281			/**
282			* get schema field value
283			*
284			* @param string $field field name
285			* @param string $property property name
286			* @param mixed $fallbackValue fallback value if property isn't set
287			*
288			* @return mixed
289			*/
290			private function getSchemaField($field, $property, $fallbackValue = '')
291			{
292			if (isset($this->schema->properties->$field->$property)) {
293			$fallbackValue = $this->schema->properties->$field->$property;
294			}
295
296			return $fallbackValue;
297			}
298
299			/**
300			* get searchable fields for this object
301			*
302			* @return string[]
303			*/
304			public function getSearchableFields()
305			{
306			return $this->schema->searchable;
307			}
308			}
309

libgraviton / graviton

Push — feature/EVO-6307-record-origin... ( 2c1fcb )

SchemaModel::getRecordOriginModifiable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like