Gumbo_Map



Map Class

Author(s): Michael Luster <mluster79@yahoo.com>
License:New BSD License
Copyright:Copyright (c) 2007, iBayou, Michael Luster
Link:http://sourceforge.net/projects/phpgumbo
Version:0.0.1

Implements interfaces:

Class Variables

array $_keys = array () [line 38]

Class Methods

public void add ( string $source_key, string $foreign_key ) [line 50]

Adds a foreign key reference to the source key

Parameter(s):

  • (string) $source_key
  • (string) $foreign_key
  • postcondition:  removes all non-alphanumeric (except underscores) characters from the source key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Map::add()

[ Top ]
public array getAll ( ) [line 159]

Returns all the keys as an associative array where key=>source_key, val=>foreign_key

Implementation of:
Gumbo_Interface_Map::getAll()

[ Top ]
public string getForeignKey ( string $source_key ) [line 137]

Returns the foreign key reference to the source key

Parameter(s):

  • (string) $source_key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Map::getForeignKey()

[ Top ]
public string getKey ( string $foreign_key ) [line 107]

Returns the source key referenced by the foreign key

Parameter(s):

  • (string) $foreign_key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Map::getKey()

[ Top ]
public bool isForeignKey ( string $foreign_key ) [line 190]

Returns if the foreign key exists

Parameter(s):

  • (string) $foreign_key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Map::isForeignKey()

[ Top ]
public bool isKey ( string $source_key ) [line 169]

Returns if the source key exists

Parameter(s):

  • (string) $source_key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Map::isKey()

[ Top ]
public void remove ( string $source_key ) [line 73]

Removes the foreign key reference to the source key

Parameter(s):

  • (string) $source_key
  • throws:  Gumbo_Exception
Implementation of:
Gumbo_Interface_Map::remove()

[ Top ]
public void reset ( ) [line 94]

Resets all keys

  • postcondition:  empty key references
Implementation of:
Gumbo_Interface_Map::reset()

[ Top ]