TreeMap::sort() - Code Metrics - appserver-io/collections - Measure and Improve Code Quality continuously with Scrutinizer

TreeMap::sort() A
last analyzed 2017-06-07 07:48 UTC

↳ Parent: TreeMap

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

/**
 * \AppserverIo\Collections\TreeMap
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/collections
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Collections;

use AppserverIo\Lang\Strng;
use AppserverIo\Lang\Integer;
use AppserverIo\Lang\Flt;
use AppserverIo\Lang\Boolean;
use AppserverIo\Lang\ClassCastException;
use AppserverIo\Lang\NullPointerException;

/**
 * This class is the implementation of a sorted HashMap.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/collections
 * @link      http://www.appserver.io
 */
class TreeMap extends AbstractMap implements SortedMapInterface
{

    /**
     * Holds the comparator to sort the internal array.
     *
     * @var \AppserverIo\Collections\ComparatorInterface
     */
    protected $comparator = null;

    /**
     * Standard constructor that adds the array passed
     * as parameter to the internal member variable.
     *
     * Be careful when using a comparator, because sorting
     * a large map can take much processor time and memory.
     *
     * @param \AppserverIo\Collections\ComparatorInterface $comparator Holds the comparator to use
     * @param array                                        $items      An array to initialize the TreeMap
     *
     * @throws \AppserverIo\Lang\ClassCastException Is thrown if the parameter items is not of type array
     */
    public function __construct(ComparatorInterface $comparator = null, $items = array())

    {
        // parent constructor to ensure property preset
        parent::__construct();

        // set the comparator
        $this->comparator = $comparator;
        // check if NULL is passed, is yes, to nothing
        if (is_null($items)) {
            return;
        }
        // check if an array is passed
        if (is_array($items)) {
            // initialize the TreeMap with the values of the passed array
            foreach ($items as $key => $item) {
                $this->add($key, $item);
            }
            return;
        }
        // if not a array is passed throw an exception
        throw new ClassCastException('Passed object is not an array');
    }

    /**
     * This method adds the passed object with the passed key
     * to the TreeMap.
     *
     * @param mixed $key    The key to add the passed value under
     * @param mixed $object The object to add to the TreeMap
     *
     * @return \AppserverIo\Collections\TreeMap
     * @throws \AppserverIo\Collections\InvalidKeyException Is thrown if the passed key is NOT an primitive datatype
     * @throws \AppserverIo\Lang\NullPointerException Is thrown if the passed key is null or not a flat datatype like Integer, Strng, Double or Boolean
     */
    public function add($key, $object)
    {
        if (is_null($key)) {
            throw new NullPointerException('Passed key is null');
        }
        // check if a primitive datatype is passed
        if (is_integer($key) || is_string($key) || is_double($key) || is_bool($key)) {

            // add the passed object to the internal array
            $this->items[$key] = $object;
            // sort the instance
            $this->sort();
            // return the instance
            return $this;
        }
        // check if an object is passed
        if (is_object($key)) {

            if ($key instanceof Strng) {
                $newKey = $key->stringValue();
            } elseif ($key instanceof Flt) {
                $newKey = $key->floatValue();
            } elseif ($key instanceof Integer) {
                $newKey = $key->intValue();
            } elseif ($key instanceof Boolean) {
                $newKey = $key->booleanValue();
            } elseif (method_exists($key, '__toString')) {
                $newKey = $key->__toString();
            } else {
                throw new InvalidKeyException('Passed key has to be a primitive datatype or has to implement the __toString() method');
            }
            // add the passed object to the internal array
            $this->items[$newKey] = $object;
            // sort the instance
            $this->sort();
            // return the instance
            return $this;
        }
        throw new InvalidKeyException('Passed key has to be a primitive datatype or has to implement the __toString() method');
    }

    /**
     * Sorts the instance with the given comparator
     * or the PHP ksort() function.
     *
     * @return boolean|null Returns TRUE if the instance was sorted successfully
     */
    protected function sort()
    {
        // if no comparator is passed sort the internal array
        // by its keys, else use the comparator
        if ($this->comparator == null) {
            return ksort($this->items);
        } else {
            return CollectionUtils::sort($this, $this->comparator);
        }
    }

    /**
     * This method returns a new TreeMap initialized with the
     * passed array.
     *
     * @param array $array Holds the array to initialize the new TreeMap
     *
     * @return \AppserverIo\Collections\TreeMap Returns a TreeMap initialized with the passed array
     * @throws \AppserverIo\Lang\ClassCastException Is thrown if the passed object is not an array
     */
    public static function fromArray($array)
    {
        // check if the passed object is an array and set it
        if (is_array($array)) {
            return new TreeMap(null, $array);
        }
        // throw an exception if the passed object is not an array
        throw new ClassCastException('Passed object is not an array');
    }

    /**
     * This method returns the comparator passed
     * with the constructor.
     *
     * @return \AppserverIo\Collections\ComparatorInterface Holds the comparator passed with the constructor
     * @see \AppserverIo\Collections\SortedMap::comparator()
     */
    public function comparator()
    {
        return $this->comparator;
    }
}


1			<?php
2
3			/**
4			* \AppserverIo\Collections\TreeMap
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2015 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/appserver-io/collections
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\Collections;
22
23			use AppserverIo\Lang\Strng;
24			use AppserverIo\Lang\Integer;
25			use AppserverIo\Lang\Flt;
26			use AppserverIo\Lang\Boolean;
27			use AppserverIo\Lang\ClassCastException;
28			use AppserverIo\Lang\NullPointerException;
29
30			/**
31			* This class is the implementation of a sorted HashMap.
32			*
33			* @author Tim Wagner <[email protected]>
34			* @copyright 2015 TechDivision GmbH <[email protected]>
35			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
36			* @link https://github.com/appserver-io/collections
37			* @link http://www.appserver.io
38			*/
39			class TreeMap extends AbstractMap implements SortedMapInterface
40			{
41
42			/**
43			* Holds the comparator to sort the internal array.
44			*
45			* @var \AppserverIo\Collections\ComparatorInterface
46			*/
47			protected $comparator = null;
48
49			/**
50			* Standard constructor that adds the array passed
51			* as parameter to the internal member variable.
52			*
53			* Be careful when using a comparator, because sorting
54			* a large map can take much processor time and memory.
55			*
56			* @param \AppserverIo\Collections\ComparatorInterface $comparator Holds the comparator to use
57			* @param array $items An array to initialize the TreeMap
58			*
59			* @throws \AppserverIo\Lang\ClassCastException Is thrown if the parameter items is not of type array
60			*/
61	7	View Code Duplication	public function __construct(ComparatorInterface $comparator = null, $items = array())
			0 ignored issues – show Duplication introduced 2016-05-04 15:55 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
62			{
63			// parent constructor to ensure property preset
64	7		parent::__construct();
65
66			// set the comparator
67	7		$this->comparator = $comparator;
68			// check if NULL is passed, is yes, to nothing
69	7		if (is_null($items)) {
70			return;
71			}
72			// check if an array is passed
73	7		if (is_array($items)) {
74			// initialize the TreeMap with the values of the passed array
75	7		foreach ($items as $key => $item) {
76			$this->add($key, $item);
77	7		}
78	7		return;
79			}
80			// if not a array is passed throw an exception
81			throw new ClassCastException('Passed object is not an array');
82			}
83
84			/**
85			* This method adds the passed object with the passed key
86			* to the TreeMap.
87			*
88			* @param mixed $key The key to add the passed value under
89			* @param mixed $object The object to add to the TreeMap
90			*
91			* @return \AppserverIo\Collections\TreeMap
92			* @throws \AppserverIo\Collections\InvalidKeyException Is thrown if the passed key is NOT an primitive datatype
93			* @throws \AppserverIo\Lang\NullPointerException Is thrown if the passed key is null or not a flat datatype like Integer, Strng, Double or Boolean
94			*/
95	5		public function add($key, $object)
96			{
97	5		if (is_null($key)) {
98			throw new NullPointerException('Passed key is null');
99			}
100			// check if a primitive datatype is passed
101	5	View Code Duplication	if (is_integer($key) \|\| is_string($key) \|\| is_double($key) \|\| is_bool($key)) {
			0 ignored issues – show Duplication introduced 2016-05-04 15:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
102			// add the passed object to the internal array
103	5		$this->items[$key] = $object;
104			// sort the instance
105	5		$this->sort();
106			// return the instance
107	5		return $this;
108			}
109			// check if an object is passed
110		View Code Duplication	if (is_object($key)) {
			0 ignored issues – show Duplication introduced 2016-05-04 15:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
111			if ($key instanceof Strng) {
112			$newKey = $key->stringValue();
113			} elseif ($key instanceof Flt) {
114			$newKey = $key->floatValue();
115			} elseif ($key instanceof Integer) {
116			$newKey = $key->intValue();
117			} elseif ($key instanceof Boolean) {
118			$newKey = $key->booleanValue();
119			} elseif (method_exists($key, '__toString')) {
120			$newKey = $key->__toString();
121			} else {
122			throw new InvalidKeyException('Passed key has to be a primitive datatype or has to implement the __toString() method');
123			}
124			// add the passed object to the internal array
125			$this->items[$newKey] = $object;
126			// sort the instance
127			$this->sort();
128			// return the instance
129			return $this;
130			}
131			throw new InvalidKeyException('Passed key has to be a primitive datatype or has to implement the __toString() method');
132			}
133
134			/**
135			* Sorts the instance with the given comparator
136			* or the PHP ksort() function.
137			*
138			* @return boolean\|null Returns TRUE if the instance was sorted successfully
139			*/
140	5		protected function sort()
141			{
142			// if no comparator is passed sort the internal array
143			// by its keys, else use the comparator
144	5		if ($this->comparator == null) {
145	4		return ksort($this->items);
146			} else {
147	1		return CollectionUtils::sort($this, $this->comparator);
148			}
149			}
150
151			/**
152			* This method returns a new TreeMap initialized with the
153			* passed array.
154			*
155			* @param array $array Holds the array to initialize the new TreeMap
156			*
157			* @return \AppserverIo\Collections\TreeMap Returns a TreeMap initialized with the passed array
158			* @throws \AppserverIo\Lang\ClassCastException Is thrown if the passed object is not an array
159			*/
160			public static function fromArray($array)
161			{
162			// check if the passed object is an array and set it
163			if (is_array($array)) {
164			return new TreeMap(null, $array);
165			}
166			// throw an exception if the passed object is not an array
167			throw new ClassCastException('Passed object is not an array');
168			}
169
170			/**
171			* This method returns the comparator passed
172			* with the constructor.
173			*
174			* @return \AppserverIo\Collections\ComparatorInterface Holds the comparator passed with the constructor
175			* @see \AppserverIo\Collections\SortedMap::comparator()
176			*/
177			public function comparator()
178			{
179			return $this->comparator;
180			}
181			}
182

appserver-io / collections

TreeMap::sort() A last analyzed 2017-06-07 07:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

TreeMap::sort() A
last analyzed 2017-06-07 07:48 UTC