appserver-io / collections

src/AppserverIo/Collections/TreeMap.php

<?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 <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @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 <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @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())

This method seems to be duplicated in your project.

    {
        // 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)) {

This code seems to be duplicated across your project.

            // 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)) {

This code seems to be duplicated across your project.

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