Home | Classes | Modules | Annotated | Functions | Files

KeyDef Class Reference

List of all members.

Public Member Functions

• KeyDef ()
• & addAttrib ($name)
• containsAttrib ($name)
• getAttrib ($pos)
• size ()

Public Attributes

• array Array of key column
  names var $cols
• $size

---

Constructor & Destructor Documentation

KeyDef::KeyDef ()

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

---

Member Function Documentation

& KeyDef::addAttrib ( $  name)

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

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.

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.

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()

---

Member Data Documentation

array Array of key column names var KeyDef::$cols

KeyDef::$size

Number of columns.

---

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