Meta::getContext() - Code Metrics - Inspection of "merge master" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — swp-252 ( bc0f1e )

by Rafał

created 2016-09-13 14:57 UTC

Meta::getContext() A

↳ Parent: Meta

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

/**
 * This file is part of the Superdesk Web Publisher Templates System.
 *
 * Copyright 2015 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2015 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Component\TemplatesSystem\Gimme\Meta;

use SWP\Component\TemplatesSystem\Gimme\Context\Context;

/**
 * Class Meta.
 */
class Meta implements MetaInterface
{
    /**
     * Original Meta values (json|array|object).
     *
     * @var mixed
     */
    protected $values;

    /**
     * @var Context
     */
    protected $context;

    /**
     * @var array
     */
    protected $configuration;

    /**
     * Create Meta class from provided configuration and values.
     *
     * @param Context             $context
     * @param string|array|object $values
     * @param array               $configuration
     */
    public function __construct(Context $context, $values, $configuration)
    {
        $this->context = $context;
        $this->values = $values;
        $this->configuration = $configuration;

        if (is_array($this->values)) {
            $this->fillFromArray($this->values, $this->configuration);
        } elseif (is_string($this->values) && $this->isJson($this->values)) {
            $this->fillFromArray(json_decode($this->values, true), $this->configuration);
        } elseif (is_object($this->values)) {
            $this->fillFromObject($this->values, $this->configuration);
        }

        $this->context->registerMeta($this);
    }

    /**
     * Use to_string property from configuration if provided, json with exposed properties otherwise.
     *
     * @return string
     */
    public function __toString()
    {
        if (array_key_exists('to_string', $this->configuration)) {
            $toStringProperty = $this->configuration['to_string'];

            if (isset($this->$toStringProperty)) {
                return $this->$toStringProperty;
            }
        }

        return gettype($this->values);
    }

    /**
     * @param string $name
     * @param mixed  $value
     */
    public function __set($name, $value)
    {
        if ($value instanceof \Traversable || is_array($value)) {
            $newValue = [];

            foreach ($value as $key => $item) {
                $newValue[$key] = $this->getValueOrMeta($item);
            }

            $this->$name = $newValue;

            return;
        }

        $this->$name = $this->getValueOrMeta($value);
    }

    private function getValueOrMeta($value)
    {
        if ($this->context->isSupported($value)) {
            return $this->context->getMetaForValue($value);
        }

        return $value;
    }

    /**
     * @return array|object|string
     */
    public function getValues()
    {
        return $this->values;
    }

    /**
     * @return array
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * @param array $configuration
     */
    public function setConfiguration($configuration)
    {
        $this->configuration = $configuration;
    }

    /**
     * @return Context
     */
    public function getContext()
    {
        return $this->context;
    }

    /**
     * Fill Meta from array. Array must have property names and keys.
     *
     * @param array $values        Array with properyy names as keys
     * @param array $configuration
     *
     * @return bool
     */
    private function fillFromArray(array $values, $configuration)
    {
        foreach ($this->getExposedProperties($values, $configuration) as $key => $propertyValue) {
            $this->$key = $propertyValue;
        }

        return true;
    }

    /**
     * Fill Meta from object. Object must have public getters for properties.
     *
     * @param mixed $values        Object with public getters for properties
     * @param       $configuration
     *
     * @return bool
     */
    private function fillFromObject($values, $configuration)
    {
        foreach ($configuration['properties'] as $key => $propertyValue) {
            $getterName = 'get'.ucfirst($key);
            if (method_exists($values, $getterName)) {
                $this->$key = $values->$getterName();
            }
        }

        return true;
    }

    /**
     * Get exposed properties (according to configuration) from provided values.
     *
     * @param array $values
     * @param       $configuration
     *
     * @return array
     */
    private function getExposedProperties(array $values = [], $configuration = [])
    {
        $exposedProperties = [];
        if (count($values) > 0 && isset($configuration['properties'])) {
            foreach ($values as $key => $propertyValue) {
                if (array_key_exists($key, $configuration['properties'])) {
                    $exposedProperties[$key] = $propertyValue;
                }
            }
        }

        return $exposedProperties;
    }

    /**
     * Check if string is JSON.
     *
     * @param  string
     *
     * @return bool
     */
    private function isJson($string)
    {
        json_decode($string);

        return json_last_error() == JSON_ERROR_NONE;
    }

    /**
     * Don't serialize values, context and configuration.
     *
     * @return array
     */
    public function __sleep()
    {
        unset($this->values);
        unset($this->context);
        unset($this->configuration);

        return array_keys(get_object_vars($this));
    }
}


1		<?php
2
3		/**
4		* This file is part of the Superdesk Web Publisher Templates System.
5		*
6		* Copyright 2015 Sourcefabric z.ú. and contributors.
7		*
8		* For the full copyright and license information, please see the
9		* AUTHORS and LICENSE files distributed with this source code.
10		*
11		* @copyright 2015 Sourcefabric z.ú
12		* @license http://www.superdesk.org/license
13		*/
14
15		namespace SWP\Component\TemplatesSystem\Gimme\Meta;
16
17		use SWP\Component\TemplatesSystem\Gimme\Context\Context;
18
19		/**
20		* Class Meta.
21		*/
22		class Meta implements MetaInterface
23		{
24		/**
25		* Original Meta values (json\|array\|object).
26		*
27		* @var mixed
28		*/
29		protected $values;
30
31		/**
32		* @var Context
33		*/
34		protected $context;
35
36		/**
37		* @var array
38		*/
39		protected $configuration;
40
41		/**
42		* Create Meta class from provided configuration and values.
43		*
44		* @param Context $context
45		* @param string\|array\|object $values
46		* @param array $configuration
47		*/
48	24	public function __construct(Context $context, $values, $configuration)
49		{
50	24	$this->context = $context;
51	24	$this->values = $values;
52	24	$this->configuration = $configuration;
53
54	24	if (is_array($this->values)) {
55	2	$this->fillFromArray($this->values, $this->configuration);
56	22	} elseif (is_string($this->values) && $this->isJson($this->values)) {
57		$this->fillFromArray(json_decode($this->values, true), $this->configuration);
58	22	} elseif (is_object($this->values)) {
59	22	$this->fillFromObject($this->values, $this->configuration);
60		}
61
62	24	$this->context->registerMeta($this);
63	24	}
64
65		/**
66		* Use to_string property from configuration if provided, json with exposed properties otherwise.
67		*
68		* @return string
69		*/
70	12	public function __toString()
71		{
72	12	if (array_key_exists('to_string', $this->configuration)) {
73	12	$toStringProperty = $this->configuration['to_string'];
74
75	12	if (isset($this->$toStringProperty)) {
76	8	return $this->$toStringProperty;
77		}
78		}
79
80	12	return gettype($this->values);
81		}
82
83		/**
84		* @param string $name
85		* @param mixed $value
86		*/
87	23	public function __set($name, $value)
88		{
89	23	if ($value instanceof \Traversable \|\| is_array($value)) {
90	4	$newValue = [];
91
92	4	foreach ($value as $key => $item) {
93	4	$newValue[$key] = $this->getValueOrMeta($item);
94		}
95
96	4	$this->$name = $newValue;
97
98	4	return;
99		}
100
101	23	$this->$name = $this->getValueOrMeta($value);
102	23	}
103
104	23	private function getValueOrMeta($value)
105		{
106	23	if ($this->context->isSupported($value)) {
107	14	return $this->context->getMetaForValue($value);
108		}
109
110	23	return $value;
111		}
112
113		/**
114		* @return array\|object\|string
115		*/
116	14	public function getValues()
117		{
118	14	return $this->values;
119		}
120
121		/**
122		* @return array
123		*/
124	24	public function getConfiguration()
125		{
126	24	return $this->configuration;
127		}
128
129		/**
130		* @param array $configuration
131		*/
132		public function setConfiguration($configuration)
133		{
134		$this->configuration = $configuration;
135		}
136
137		/**
138		* @return Context
139		*/
140	1	public function getContext()
141		{
142	1	return $this->context;
143		}
144
145		/**
146		* Fill Meta from array. Array must have property names and keys.
147		*
148		* @param array $values Array with properyy names as keys
149		* @param array $configuration
150		*
151		* @return bool
152		*/
153	2	private function fillFromArray(array $values, $configuration)
154		{
155	2	foreach ($this->getExposedProperties($values, $configuration) as $key => $propertyValue) {
156	2	$this->$key = $propertyValue;
157		}
158
159	2	return true;
160		}
161
162		/**
163		* Fill Meta from object. Object must have public getters for properties.
164		*
165		* @param mixed $values Object with public getters for properties
166		* @param $configuration
167		*
168		* @return bool
169		*/
170	22	private function fillFromObject($values, $configuration)
171		{
172	22	foreach ($configuration['properties'] as $key => $propertyValue) {
173	21	$getterName = 'get'.ucfirst($key);
174	21	if (method_exists($values, $getterName)) {
175	21	$this->$key = $values->$getterName();
176		}
177		}
178
179	22	return true;
180		}
181
182		/**
183		* Get exposed properties (according to configuration) from provided values.
184		*
185		* @param array $values
186		* @param $configuration
187		*
188		* @return array
189		*/
190	2	private function getExposedProperties(array $values = [], $configuration = [])
191		{
192	2	$exposedProperties = [];
193	2	if (count($values) > 0 && isset($configuration['properties'])) {
194	2	foreach ($values as $key => $propertyValue) {
195	2	if (array_key_exists($key, $configuration['properties'])) {
196	2	$exposedProperties[$key] = $propertyValue;
197		}
198		}
199		}
200
201	2	return $exposedProperties;
202		}
203
204		/**
205		* Check if string is JSON.
206		*
207		* @param string
208		*
209		* @return bool
210		*/
211		private function isJson($string)
212		{
213		json_decode($string);
214
215		return json_last_error() == JSON_ERROR_NONE;
216		}
217
218		/**
219		* Don't serialize values, context and configuration.
220		*
221		* @return array
222		*/
223		public function __sleep()
224		{
225		unset($this->values);
226		unset($this->context);
227		unset($this->configuration);
228
229		return array_keys(get_object_vars($this));
230		}
231		}
232

superdesk / web-publisher

Push — swp-252 ( bc0f1e )

Meta::getContext() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like