\PHPExcel_HashTable

PHPExcel_HashTable

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
__construct()
addFromSource()
add()
remove()
clear()
count()
getIndexForHashCode()
getByIndex()
getByHashCode()
toArray()
__clone()
No public properties found
No constants found
No protected methods found
$items
$keyMap
N/A
No private methods found
No private properties found
N/A

Properties

$items

$items : array

HashTable elements

Type

array

$keyMap

$keyMap : array

HashTable key map

Type

array

Methods

__construct()

__construct(array<mixed,\PHPExcel_IComparable>  $pSource = null) 

Create a new PHPExcel_HashTable

Parameters

array<mixed,\PHPExcel_IComparable> $pSource

Optional source array to create HashTable from

Throws

\PHPExcel_Exception

addFromSource()

addFromSource(array<mixed,\PHPExcel_IComparable>  $pSource = null) 

Add HashTable items from source

Parameters

array<mixed,\PHPExcel_IComparable> $pSource

Source array to create HashTable from

Throws

\PHPExcel_Exception

add()

add(\PHPExcel_IComparable  $pSource = null) 

Add HashTable item

Parameters

\PHPExcel_IComparable $pSource

Item to add

Throws

\PHPExcel_Exception

remove()

remove(\PHPExcel_IComparable  $pSource = null) 

Remove HashTable item

Parameters

\PHPExcel_IComparable $pSource

Item to remove

Throws

\PHPExcel_Exception

clear()

clear() 

Clear HashTable

count()

count() : integer

Count

Returns

integer

getIndexForHashCode()

getIndexForHashCode(string  $pHashCode = '') : integer

Get index for hash code

Parameters

string $pHashCode

Returns

integer —

Index

getByIndex()

getByIndex(integer  $pIndex) : \PHPExcel_IComparable

Get by index

Parameters

integer $pIndex

Returns

\PHPExcel_IComparable

getByHashCode()

getByHashCode(string  $pHashCode = '') : \PHPExcel_IComparable

Get by hashcode

Parameters

string $pHashCode

Returns

\PHPExcel_IComparable

toArray()

toArray() : array<mixed,\PHPExcel_IComparable>

HashTable to array

Returns

array<mixed,\PHPExcel_IComparable>

__clone()

__clone() 

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