PhpOffice\PhpSpreadsheet\HashTable Class Reference

@template T of IComparable More...

Collaboration diagram for PhpOffice\PhpSpreadsheet\HashTable:

Public Member Functions
	__construct ($pSource=null)
	Create a new \PhpOffice\PhpSpreadsheet\HashTable. More...
	addFromSource (?array $pSource=null)
	Add HashTable items from source. More...
	add (IComparable $pSource)
	Add HashTable item. More...
	remove (IComparable $pSource)
	Remove HashTable item. More...
	clear ()
	Clear HashTable. More...
	count ()
	Count. More...
	getIndexForHashCode ($pHashCode)
	Get index for hash code. More...
	getByIndex ($pIndex)
	Get by index. More...
	getByHashCode ($pHashCode)
	Get by hashcode. More...
	toArray ()
	HashTable to array. More...
	__clone ()
	Implement PHP __clone to create a deep clone, not just a shallow copy. More...

Protected Attributes
	$items = []
	$keyMap = []

Detailed Description

@template T of IComparable

Definition at line 8 of file HashTable.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\HashTable::__construct

(

$pSource = null

)

Create a new \PhpOffice\PhpSpreadsheet\HashTable.

Parameters

T[]

$pSource

Optional source array to create HashTable from

Definition at line 29 of file HashTable.php.

    {
        if ($pSource !== null) {
            // Create HashTable
            $this->addFromSource($pSource);
        }
    }

References PhpOffice\PhpSpreadsheet\HashTable\addFromSource().

Here is the call graph for this function:

Member Function Documentation

__clone()

PhpOffice\PhpSpreadsheet\HashTable::__clone

(

)

Implement PHP __clone to create a deep clone, not just a shallow copy.

Definition at line 169 of file HashTable.php.

    {
        $vars = get_object_vars($this);
        foreach ($vars as $key => $value) {
            // each member of this class is an array
            if (is_array($value)) {
                $array1 = $value;
                foreach ($array1 as $key1 => $value1) {
                    if (is_object($value1)) {
                        $array1[$key1] = clone $value1;
                    }
                }
                $this->$key = $array1;
            }
        }
    }

References $key.

add()

PhpOffice\PhpSpreadsheet\HashTable::add

(

IComparable

$pSource

)

Add HashTable item.

Parameters

T

$pSource

Item to add

Definition at line 59 of file HashTable.php.

                                             : void
    {
        $hash = $pSource->getHashCode();
        if (!isset($this->items[$hash])) {
            $this->items[$hash] = $pSource;
            $this->keyMap[count($this->items) - 1] = $hash;
        }
    }

References PhpOffice\PhpSpreadsheet\HashTable\count(), and PhpOffice\PhpSpreadsheet\IComparable\getHashCode().

Referenced by PhpOffice\PhpSpreadsheet\HashTable\addFromSource().

Here is the call graph for this function:

Here is the caller graph for this function:

addFromSource()

PhpOffice\PhpSpreadsheet\HashTable::addFromSource

(

?array

$pSource = null

)

Add HashTable items from source.

Parameters

T[]

$pSource

Source array to create HashTable from

Definition at line 42 of file HashTable.php.

                                                         : void
    {
        // Check if an array was passed
        if ($pSource == null) {
            return;
        }
 
        foreach ($pSource as $item) {
            $this->add($item);
        }
    }

References PhpOffice\PhpSpreadsheet\HashTable\add().

Referenced by PhpOffice\PhpSpreadsheet\HashTable\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

PhpOffice\PhpSpreadsheet\HashTable::clear

(

)

Clear HashTable.

Definition at line 96 of file HashTable.php.

                           : void
    {
        $this->items = [];
        $this->keyMap = [];
    }

count()

PhpOffice\PhpSpreadsheet\HashTable::count

(

)

Count.

Returns

int

Definition at line 107 of file HashTable.php.

    {
        return count($this->items);
    }

References PhpOffice\PhpSpreadsheet\HashTable\count().

Referenced by PhpOffice\PhpSpreadsheet\HashTable\add(), PhpOffice\PhpSpreadsheet\HashTable\count(), and PhpOffice\PhpSpreadsheet\HashTable\remove().

Here is the call graph for this function:

Here is the caller graph for this function:

getByHashCode()

PhpOffice\PhpSpreadsheet\HashTable::getByHashCode

(

$pHashCode

)

Get by hashcode.

Parameters

string

$pHashCode

Returns

null|T

Definition at line 147 of file HashTable.php.

    {
        if (isset($this->items[$pHashCode])) {
            return $this->items[$pHashCode];
        }
 
        return null;
    }

Referenced by PhpOffice\PhpSpreadsheet\HashTable\getByIndex().

Here is the caller graph for this function:

getByIndex()

PhpOffice\PhpSpreadsheet\HashTable::getByIndex

(

$pIndex

)

Get by index.

Parameters

int

$pIndex

Returns

null|T

Definition at line 131 of file HashTable.php.

    {
        if (isset($this->keyMap[$pIndex])) {
            return $this->getByHashCode($this->keyMap[$pIndex]);
        }
 
        return null;
    }

References PhpOffice\PhpSpreadsheet\HashTable\getByHashCode().

Here is the call graph for this function:

getIndexForHashCode()

PhpOffice\PhpSpreadsheet\HashTable::getIndexForHashCode

(

$pHashCode

)

Get index for hash code.

Parameters

string

$pHashCode

Returns

int Index

Definition at line 119 of file HashTable.php.

    {
        return array_search($pHashCode, $this->keyMap);
    }

remove()

PhpOffice\PhpSpreadsheet\HashTable::remove

(

IComparable

$pSource

)

Remove HashTable item.

Parameters

T

$pSource

Item to remove

Definition at line 73 of file HashTable.php.

                                                : void
    {
        $hash = $pSource->getHashCode();
        if (isset($this->items[$hash])) {
            unset($this->items[$hash]);
 
            $deleteKey = -1;
            foreach ($this->keyMap as $key => $value) {
                if ($deleteKey >= 0) {
                    $this->keyMap[$key - 1] = $value;
                }
 
                if ($value == $hash) {
                    $deleteKey = $key;
                }
            }
            unset($this->keyMap[count($this->keyMap) - 1]);
        }
    }

References $key, PhpOffice\PhpSpreadsheet\HashTable\count(), and PhpOffice\PhpSpreadsheet\IComparable\getHashCode().

Here is the call graph for this function:

toArray()

PhpOffice\PhpSpreadsheet\HashTable::toArray

(

)

HashTable to array.

Returns

T[]

Definition at line 161 of file HashTable.php.

    {
        return $this->items;
    }

References PhpOffice\PhpSpreadsheet\HashTable\$items.

Field Documentation

$items

PhpOffice\PhpSpreadsheet\HashTable::$items = []

protected

Definition at line 15 of file HashTable.php.

Referenced by PhpOffice\PhpSpreadsheet\HashTable\toArray().

$keyMap

PhpOffice\PhpSpreadsheet\HashTable::$keyMap = []

protected

Definition at line 22 of file HashTable.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/HashTable.php