UNB Components Code Reference

UnbDatabase::AddKeylistKey method

Adds a new key to a key list.

public function UnbDatabase::AddKeylistKey ($tableName, $columnName, $idColumn, $idValue, $key);

Parameters

tableName
(string) Table in which the key list is referenced
columnName
(string) Column which contains the key list ID reference
idColumn
(string) Identifier column (primary key) of the table
idValue
(int/string) Identifier value of the table, describing the record that references the key list
key
(int) Key to be added to the key list

Remarks

This function reads the currently assigned key list ID from tableName.columnName where idColumn is idValue and adds the new key to this key list. If the value is null (i.e. no key list is assigned), a new one is created and assigned to tableName.columnName.

Exceptions thrown

InvalidArgumentException On invalid argument type or value.
UnbDatabaseException No description available.

Member of class: UnbDatabase

Implementation file: database.class.php, line 799

© 2010 Yves Goergen. UNB Components Homepage. Reference generated on 2010-03-07.