HashTable.php

Go to the documentation of this file.

<?php
if (!defined('PHPEXCEL_ROOT')) {
        define('PHPEXCEL_ROOT', dirname(__FILE__) . '/../');
}

require_once PHPEXCEL_ROOT . 'PHPExcel/IComparable.php';


class PHPExcel_HashTable
{
    public $_items = array();
    
    public $_keyMap = array();
        
    public function __construct($pSource = null)
    {
        if (!is_null($pSource)) {
                // Create HashTable
                $this->addFromSource($pSource);
        }
    }
    
    public function addFromSource($pSource = null) {
        // Check if an array was passed
        if ($pSource == null) {
            return;
        } else if (!is_array($pSource)) {
            throw new Exception('Invalid array parameter passed.');
        }
        
        foreach ($pSource as $item) {
            $this->add($item);
        }
    }

    public function add(PHPExcel_IComparable $pSource = null) {
            // Determine hashcode
        $hashCode       = null;
            $hashIndex = $pSource->getHashIndex();
            if ( is_null ( $hashIndex ) ) {
                $hashCode = $pSource->getHashCode();
            } else if ( isset ( $this->_keyMap[$hashIndex] ) ) {
                $hashCode = $this->_keyMap[$hashIndex];
            } else {
                $hashCode = $pSource->getHashCode();
            }
                
            // Add value      
                if (!isset($this->_items[ $hashCode ])) {
            $this->_items[ $hashCode ] = $pSource;
            $index = count($this->_items) - 1;
            $this->_keyMap[ $index  ] = $hashCode;
            $pSource->setHashIndex( $index );
                } else {
            $pSource->setHashIndex( $this->_items[ $hashCode ]->getHashIndex() );
                }
    }
    
    public function remove(PHPExcel_IComparable $pSource = null) {
        if (isset($this->_items[  $pSource->getHashCode()  ])) {
                        unset($this->_items[  $pSource->getHashCode()  ]);
                        
                        $deleteKey = -1;
                        foreach ($this->_keyMap as $key => $value) {                            
                                if ($deleteKey >= 0) {
                                        $this->_keyMap[$key - 1] = $value;
                                }
                                
                                if ($value == $pSource->getHashCode()) {
                                        $deleteKey = $key;
                                }
                        }
                        unset($this->_keyMap[ count($this->_keyMap) - 1 ]);   
        }         
    }
    
    public function clear() {
        $this->_items = array();
        $this->_keyMap = array();
    }
    
    public function count() {
        return count($this->_items);
    }
    
    public function getIndexForHashCode($pHashCode = '') {
        return array_search($pHashCode, $this->_keyMap);
    }
    
    public function getByIndex($pIndex = 0) {
        if (isset($this->_keyMap[$pIndex])) {
                return $this->getByHashCode( $this->_keyMap[$pIndex] );
        }
        
        return null;
    }
    
    public function getByHashCode($pHashCode = '') {
        if (isset($this->_items[$pHashCode])) {
                return $this->_items[$pHashCode];
        }
        
        return null;
    }
    
    public function toArray() {
        return $this->_items;
    }
        
        public function __clone() {
                $vars = get_object_vars($this);
                foreach ($vars as $key => $value) {
                        if (is_object($value)) {
                                $this->$key = clone $value;
                        }
                }
        }
}