Docs For Class Dictionary

Description

Implements interfaces:

IteratorAggregate (internal interface)

Dictionary

Provides a basic dictionary functionality. Is this in SPL now?

author: Mark Brooks <markabrooks@users.sourceforge.net>
version: 0.8.2
copyright: 2004-2008 Mark Brooks <markabrooks@users.sourceforge.net>

Located in /Root/Dictionary.php (line 41)

PEAR
   |
   --Bio
      |
      --Dictionary

Direct descendents

Class	Description
NcbiTableDictionary	class NcbiTableData
RestrictionEnzymeDictionary	RestrictionEnzymeDictionary Contains definition of Restriction (restriction endonucleases) class.

Method Summary

Dictionary __construct ([ $array = NULL])

void addItem ([ $key = NULL], [ $value = NULL])

void clear ()

void exists ( $key)

$aData getData (none 0)

$value getItem ($key $key)

void getIterator ()

void getKeys ()

void length ()

void pop ()

void push ()

void removeItem ( $key)

void setData ($aData $aData)

Variables

Inherited Variables

Inherited from Bio

Bio::$bWarnings

Methods

Constructor __construct (line 61)

function __construct

access: public

Dictionary __construct ([ $array = NULL])

$array

Redefinition of:

Bio::__construct(): function Bio ()

Redefined in descendants as:

NcbiTableDictionary::__construct() : function __construct
RestrictionEnzymeDictionary::__construct() : function __construct

addItem (line 120)

function addItem

param $key mixed param $value mixed

access: public

void addItem ([ $key = NULL], [ $value = NULL])

$key
$value

clear (line 80)

function clear

access: public

void clear ()

exists (line 191)

function exists

param $key mixed

access: public

void exists ( $key)

$key

getData (line 261)

function getData

return: array
access: public

$aData getData (none 0)

none 0

getItem (line 279)

function getItem

return: mixed
access: public
uses: Get - a data item by key

$value getItem ($key $key)

$key $key: string

getIterator (line 223)

function getIterator

access: public

void getIterator ()

Implementation of:

IteratorAggregate::getIterator

getKeys (line 207)

function getKeys

access: public

void getKeys ()

length (line 295)

function length

access: public

void length ()

pop (line 172)

function pop

param none

access: public

void pop ()

push (line 149)

function push

param $arg1 mixed param $arg2 mixed param ... mixed

access: public

void push ()

removeItem (line 100)

function removeItem

param $key string

access: public

void removeItem ( $key)

$key

setData (line 240)

function setData

access: public

void setData ($aData $aData)

$aData $aData: array

Inherited Methods

Inherited From Bio

Bio::__construct()
Bio::printWithNl()

Class Constants

Inherited Constants

Inherited from Bio

Bio::NEWLINE