Home | Classes | Modules | Annotated | Hierarchy | Functions | Files

KeyDef Class Reference

List of all members.

Public Member Functions

• __construct ()
• KeyDef addAttrib ( $name )
• boolean containsAttrib ( $name )
• string getAttrib ( $pos )
• int size ()

---

Member Function Documentation

KeyDef::__construct ( )

Construct a keydef. Accepts a variable number of arguments -- a list of coluns to use for keydef: $kd = new KeyDef('id'); // id col is pkey $kd = new KeyDef('key1', 'key2'); // multi-col pkey

KeyDef KeyDef::addAttrib ( $name )

Adds the named attribute to the KeyDef. Parameters string  $name Returns KeyDef The modified class.

boolean KeyDef::containsAttrib ( $name )

Determines if the KeyDef contains the requested Attribute. Parameters string  $name Returns boolean True if the attribute has been defined. false otherwise.

string KeyDef::getAttrib ( $pos )

getAttrib is 1 based. Setting pos to 0 will attempt to return pos 1. Parameters int  $pos 1-based position of attrib. Returns string Value of attribute at pos as String. null if value is not found.

int KeyDef::size ( )

Returns number of columns in KeyDef. Returns int The number of elements in the KeyDef that were set by addAttrib() See also addAttrib()

---

This file is part of the Creole[php5] library.