CollectionSnapshot::__construct() - Code Metrics - Taluu/Totem - Measure and Improve Code Quality continuously with Scrutinizer

CollectionSnapshot::__construct() C
last analyzed 2015-12-27 11:11 UTC

↳ Parent: CollectionSnapshot

Complexity

Conditions	11
Paths	12

Size

Total Lines	45
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	5

Metric	Value
c	7
b	0
f	5
dl	0
loc	45
rs	5.2653
cc	11
eloc	24
nc	12
nop	3

How to fix Complexity

<?php
/**
 * This file is part of the Totem package
 *
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 *
 * @copyright Baptiste Clavié <[email protected]>
 * @license   http://www.opensource.org/licenses/MIT-License MIT License
 */

namespace Totem\Snapshot;

use Traversable;
use ReflectionClass;
use InvalidArgumentException;

use Symfony\Component\PropertyAccess\PropertyPath;
use Symfony\Component\PropertyAccess\PropertyAccess;

use Totem\AbstractSnapshot;

/**
 * Represents a snapshot of a collection
 *
 * A collection is an array of numerical indexes of array elements
 *
 * BE CAREFUL, as this collection is _not_ recursive. Its elements will be
 * translated as either an ArraySnapshot, or an ObjectSnapshot if it fits, but
 * none of its child will be translated as a new CollectionSnapshot.
 *
 * @author Baptiste Clavié <[email protected]>
 */
class CollectionSnapshot extends AbstractSnapshot
{
    /**
     * Collection of the new keys (extracted from the primary key) => old keys
     *
     * @var integer[]
     */
    private $link = [];

    /**
     * Construct the snapshot
     *
     * The following options are taken into account :
     * - snapshotClass : snapshot class to use for each elements. If none are
     *                   given, the normalize() method will transform this into
     *                   either an ArraySnapshot or an ObjectSnapshot, depending
     *                   on the situation.
     *
     * @param mixed $data    Either an array or a traversable, data to take a snapshot of
     * @param mixed $primary Property path compatible value to use to get the primary key of each elements
     * @param array $options Array of options
     *
     * @throws InvalidArgumentException the $data is not an array or a Traversable
     * @throws InvalidArgumentException the $data is not an at least 2 dimensional array
     * @throws InvalidArgumentException the snapshotClass in the options is not loadable
     * @throws InvalidArgumentException the snapshotClass in the options is not a valid snapshot class
     * @throws InvalidArgumentException one of the elements of the collection does not have a $primary key
     */
    public function __construct($data, $primary, array $options = [])
    {
        $this->data = [];
        $this->raw  = $data;

        $primary = new PropertyPath($primary);

        $snapshot = null;
        $accessor = PropertyAccess::createPropertyAccessorBuilder()->enableExceptionOnInvalidIndex()->getPropertyAccessor();

        if (isset($options['snapshotClass'])) {
            if (!class_exists($options['snapshotClass'])) {
                throw new InvalidArgumentException(sprintf('The snapshot class "%s" does not seem to be loadable', $options['snapshotClass']));
            }

            $refl = new ReflectionClass($options['snapshotClass']);

            if (!$refl->isInstantiable() || !$refl->isSubclassOf('Totem\\AbstractSnapshot')) {
                throw new InvalidArgumentException('A Snapshot Class should be instantiable and extends abstract class Totem\\AbstractSnapshot');
            }

            $snapshot = $options['snapshotClass'];
        }

        if (!is_array($data) && !$data instanceof Traversable) {
            throw new InvalidArgumentException(sprintf('An array or a Traversable was expected to take a snapshot of a collection, "%s" given', is_object($data) ? get_class($data) : gettype($data)));
        }

        foreach ($data as $key => $value) {
            if (!is_int($key)) {
                throw new InvalidArgumentException('The given array / Traversable is not a collection as it contains non numeric keys');
            }

            if (!$accessor->isReadable($value, $primary)) {
                throw new InvalidArgumentException(sprintf('The key "%s" is not defined or readable in one of the elements of the collection', $primary));
            }

            $primaryKey = $accessor->getValue($value, $primary);

            $this->link[$primaryKey] = $key;
            $this->data[$primaryKey] = $this->snapshot($value, $snapshot);
        }

        parent::normalize();
    }

    /**
     * Snapshots a value
     *
     * If the value is already a snapshot, it won't be snapshotted ; otherwise,
     * if the class is null, then the value will be left as is.
     *
     * @param mixed  $value Value to snapshot
     * @param string $class Class to use to snapshot the value
     *
     * @return mixed A snapshot if the value was snapshotted, the original value otherwise
     */
    private function snapshot($value, $class = null)
    {
        if (null === $class || $value instanceof AbstractSnapshot) {
            return $value;
        }

        return new $class($value);
    }

    /**
     * Returns the original key for the primary key $primary
     *
     * @param mixed $primary Primary key to search
     *
     * @return integer original key
     * @throws InvalidArgumentException primary key not found
     */
    public function getOriginalKey($primary) {
        if (!isset($this->link[$primary])) {
            throw new InvalidArgumentException(sprintf('The primary key "%s" is not in the computed dataset', $primary));
        }

        return $this->link[$primary];
    }
}



1			<?php
2			/**
3			* This file is part of the Totem package
4			*
5			* For the full copyright and license information, please view the LICENSE file
6			* that was distributed with this source code.
7			*
8			* @copyright Baptiste Clavié <[email protected]>
9			* @license http://www.opensource.org/licenses/MIT-License MIT License
10			*/
11
12			namespace Totem\Snapshot;
13
14			use Traversable;
15			use ReflectionClass;
16			use InvalidArgumentException;
17
18			use Symfony\Component\PropertyAccess\PropertyPath;
19			use Symfony\Component\PropertyAccess\PropertyAccess;
20
21			use Totem\AbstractSnapshot;
22
23			/**
24			* Represents a snapshot of a collection
25			*
26			* A collection is an array of numerical indexes of array elements
27			*
28			* BE CAREFUL, as this collection is _not_ recursive. Its elements will be
29			* translated as either an ArraySnapshot, or an ObjectSnapshot if it fits, but
30			* none of its child will be translated as a new CollectionSnapshot.
31			*
32			* @author Baptiste Clavié <[email protected]>
33			*/
34			class CollectionSnapshot extends AbstractSnapshot
35			{
36			/**
37			* Collection of the new keys (extracted from the primary key) => old keys
38			*
39			* @var integer[]
40			*/
41			private $link = [];
42
43			/**
44			* Construct the snapshot
45			*
46			* The following options are taken into account :
47			* - snapshotClass : snapshot class to use for each elements. If none are
48			* given, the normalize() method will transform this into
49			* either an ArraySnapshot or an ObjectSnapshot, depending
50			* on the situation.
51			*
52			* @param mixed $data Either an array or a traversable, data to take a snapshot of
53			* @param mixed $primary Property path compatible value to use to get the primary key of each elements
54			* @param array $options Array of options
55			*
56			* @throws InvalidArgumentException the $data is not an array or a Traversable
57			* @throws InvalidArgumentException the $data is not an at least 2 dimensional array
58			* @throws InvalidArgumentException the snapshotClass in the options is not loadable
59			* @throws InvalidArgumentException the snapshotClass in the options is not a valid snapshot class
60			* @throws InvalidArgumentException one of the elements of the collection does not have a $primary key
61			*/
62			public function __construct($data, $primary, array $options = [])
63			{
64			$this->data = [];
65			$this->raw = $data;
66
67			$primary = new PropertyPath($primary);
68
69			$snapshot = null;
70			$accessor = PropertyAccess::createPropertyAccessorBuilder()->enableExceptionOnInvalidIndex()->getPropertyAccessor();
71
72			if (isset($options['snapshotClass'])) {
73			if (!class_exists($options['snapshotClass'])) {
74			throw new InvalidArgumentException(sprintf('The snapshot class "%s" does not seem to be loadable', $options['snapshotClass']));
75			}
76
77			$refl = new ReflectionClass($options['snapshotClass']);
78
79			if (!$refl->isInstantiable() \|\| !$refl->isSubclassOf('Totem\\AbstractSnapshot')) {
80			throw new InvalidArgumentException('A Snapshot Class should be instantiable and extends abstract class Totem\\AbstractSnapshot');
81			}
82
83			$snapshot = $options['snapshotClass'];
84			}
85
86			if (!is_array($data) && !$data instanceof Traversable) {
87			throw new InvalidArgumentException(sprintf('An array or a Traversable was expected to take a snapshot of a collection, "%s" given', is_object($data) ? get_class($data) : gettype($data)));
88			}
89
90			foreach ($data as $key => $value) {
91			if (!is_int($key)) {
92			throw new InvalidArgumentException('The given array / Traversable is not a collection as it contains non numeric keys');
93			}
94
95			if (!$accessor->isReadable($value, $primary)) {
96			throw new InvalidArgumentException(sprintf('The key "%s" is not defined or readable in one of the elements of the collection', $primary));
97			}
98
99			$primaryKey = $accessor->getValue($value, $primary);
100
101			$this->link[$primaryKey] = $key;
102			$this->data[$primaryKey] = $this->snapshot($value, $snapshot);
103			}
104
105			parent::normalize();
106			}
107
108			/**
109			* Snapshots a value
110			*
111			* If the value is already a snapshot, it won't be snapshotted ; otherwise,
112			* if the class is null, then the value will be left as is.
113			*
114			* @param mixed $value Value to snapshot
115			* @param string $class Class to use to snapshot the value
116			*
117			* @return mixed A snapshot if the value was snapshotted, the original value otherwise
118			*/
119			private function snapshot($value, $class = null)
120			{
121			if (null === $class \|\| $value instanceof AbstractSnapshot) {
122			return $value;
123			}
124
125			return new $class($value);
126			}
127
128			/**
129			* Returns the original key for the primary key $primary
130			*
131			* @param mixed $primary Primary key to search
132			*
133			* @return integer original key
134			* @throws InvalidArgumentException primary key not found
135			*/
136			public function getOriginalKey($primary) {
137			if (!isset($this->link[$primary])) {
138			throw new InvalidArgumentException(sprintf('The primary key "%s" is not in the computed dataset', $primary));
139			}
140
141			return $this->link[$primary];
142			}
143			}
144
145

Taluu / Totem

CollectionSnapshot::__construct() C last analyzed 2015-12-27 11:11 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

CollectionSnapshot::__construct() C
last analyzed 2015-12-27 11:11 UTC