SchemaModel::getSearchableOfField() - Code Metrics - Inspection of "Added Searchable" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/OPTIONS_4_sf28_update ( b60ed0...30bad3 )

unknown

created 2016-03-29 14:08 UTC

SchemaModel::getSearchableOfField() A

↳ Parent: SchemaModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	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)) {
            // 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';
class MyClass { }

$x = new MyClass();
$x->foo = true;
            }

            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;
    }

    /**
     * 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 searchable flag for a given field
     *
     * @param string $field field name
     *
     * @return boolean the searchable flag
     */
    public function getSearchableOfField($field)

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

    /**
     * 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');
    }

    /**
     * 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';
			0 ignored issues – show Bug introduced 2015-11-23 08:02 UTC by Report Bug Copy Issue Report The property `_modelPath` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
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
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			* Returns the bare schema
93			*
94			* @return \stdClass Schema
95			*/
96			public function getSchema()
97			{
98			return $this->schema;
99			}
100
101			/**
102			* get title for a given field
103			*
104			* @param string $field field name
105			*
106			* @return string
107			*/
108			public function getTitleOfField($field)
109			{
110			return $this->getSchemaField($field, 'title');
111			}
112
113			/**
114			* get description for a given field
115			*
116			* @param string $field field name
117			*
118			* @return string
119			*/
120			public function getDescriptionOfField($field)
121			{
122			return $this->getSchemaField($field, 'description');
123			}
124
125			/**
126			* get property model for embedded field
127			*
128			* @param string $mapping name of mapping class
129			*
130			* @return $this
131			*/
132			public function manyPropertyModelForTarget($mapping)
133			{
134			// @todo refactor to get rid of container dependency (maybe remove from here)
135			list($app, $bundle, , $document) = explode('\\', $mapping);
136			$app = strtolower($app);
137			$bundle = strtolower(substr($bundle, 0, -6));
138			$document = strtolower($document);
139			$propertyService = implode('.', array($app, $bundle, 'model', $document));
140			$propertyModel = $this->container->get($propertyService);
141
142			return $propertyModel;
143			}
144
145			/**
146			* get required fields for this object
147			*
148			* @return string[]
149			*/
150			public function getRequiredFields()
151			{
152			return $this->schema->required;
153			}
154
155			/**
156			* get a collection of service names that can extref refer to
157			*
158			* @param string $field field name
159			*
160			* @return array
161			*/
162			public function getRefCollectionOfField($field)
163			{
164			return $this->getSchemaField($field, 'collection', array());
165			}
166
167			/**
168			* get readOnly flag for a given field
169			*
170			* @param string $field field name
171			*
172			* @return boolean the readOnly flag
173			*/
174			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...
175			{
176			return $this->getSchemaField($field, 'readOnly', false);
177			}
178
179			/**
180			* get searchable flag for a given field
181			*
182			* @param string $field field name
183			*
184			* @return boolean the searchable flag
185			*/
186			public function getSearchableOfField($field)
			0 ignored issues – show Coding Style introduced 2016-03-14 17:16 UTC by Report Bug Copy Issue Report `function getSearchableOfField()` 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...
187			{
188			return $this->getSchemaField($field, 'searchable', false);
189			}
190
191			/**
192			* tell us if a model what to be exposed using a key as field
193			*
194			* @param string $field field that we check for dynamic-key spec
195			*
196			* @return boolean
197			*/
198			public function hasDynamicKey($field)
199			{
200			return $this->getSchemaField($field, 'x-dynamic-key', false) !== false;
201			}
202
203			/**
204			* Get field used for setting stringy key value
205			*
206			* @param string $field field that we get dynamic-key spec from
207			*
208			* @return object
209			*/
210			public function getDynamicKeySpec($field)
211			{
212			return $this->getSchemaField($field, 'x-dynamic-key');
213			}
214
215			/**
216			* get schema field value
217			*
218			* @param string $field field name
219			* @param string $property property name
220			* @param mixed $fallbackValue fallback value if property isn't set
221			*
222			* @return mixed
223			*/
224			private function getSchemaField($field, $property, $fallbackValue = '')
225			{
226			if (isset($this->schema->properties->$field->$property)) {
227			$fallbackValue = $this->schema->properties->$field->$property;
228			}
229
230			return $fallbackValue;
231			}
232
233			/**
234			* get searchable fields for this object
235			*
236			* @return string[]
237			*/
238			public function getSearchableFields()
239			{
240			return $this->schema->searchable;
241			}
242			}
243

libgraviton / graviton

Push — feature/OPTIONS_4_sf28_update ( b60ed0...30bad3 )

SchemaModel::getSearchableOfField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like