UNB Components Code Reference

UnbDatabase::RemoveKeylistKey method

Removes a key from a key list.

public function UnbDatabase::RemoveKeylistKey ($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/UnbUser) Key to be removed from the key list

Remarks

This function reads the currently assigned key list ID from tableName.columnName where idColumn is idValue and removes the key from this key list. If the key list is then empty, the reference is deleted (set to null) in 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 1067

© 2011 Yves Goergen. UNB Components Homepage. Reference generated on 2011-02-22.