Class DB_dbfield

Description

Class describing a database field of a Postgres table.

Located in /pg-schema-defs.php (line 426)

SchemaObject
   |
   --dbfield
      |
      --DB_dbfield
Variable Summary
 mixed $isarray
Method Summary
 DB_dbfield DB_dbfield (mixed &$schema, mixed $name, mixed $num, mixed $type, [mixed $defaultval = ""], [mixed $notnull = false], [mixed $ispkey = false], [mixed $isarray = false])
 void dump ()
 void generic_type ()
 void is_serial_class ()
Variables
mixed $isarray = false (line 428)

Whether this field is an array of values

Inherited Variables

Inherited from dbfield

dbfield::$constraints
dbfield::$defaultval
dbfield::$ispkey
dbfield::$notnull
dbfield::$num
dbfield::$type

Inherited from SchemaObject

SchemaObject::$name
SchemaObject::$schema
Methods
Constructor DB_dbfield (line 430)
DB_dbfield DB_dbfield (mixed &$schema, mixed $name, mixed $num, mixed $type, [mixed $defaultval = ""], [mixed $notnull = false], [mixed $ispkey = false], [mixed $isarray = false])
dump (line 439)

Dump field description to stdout.

void dump ()

Redefinition of:
dbfield::dump()
Dump field description to stdout.
generic_type (line 460)

Return the generic type of the field. The generic types are as

follows: text Fixed or varying length strings numeric Integers, real numbers or money datetime Times, dates date-times logical Boolean or bit field (true/false)

You should override this method to return the appropriate generic field types from this list, for your database type. NB: Override this function to get schema info per DB type.

void generic_type ()

Redefinition of:
dbfield::generic_type()
Return the generic type of the field. The generic types are as
is_integer_class (line 486)

Return true if the field is of an integer class. We exclude the serial types due to the initial purpose of this method - to determine fields which are standalone integer types, without attached sequences.

NB: Override this function to get schema info per DB type.

void is_integer_class ()

Redefinition of:
dbfield::is_integer_class()
Return true if the field is of an integer class.
is_serial_class (line 497)

Return true if the field is of a 'serial' class. This is a pseudo class of types which encapsulates integer fields which are able to auto-increment themselves when records are inserted.

NB: Override this function to get schema info per DB type.

void is_serial_class ()

Redefinition of:
dbfield::is_serial_class()
Return true if the field is of a 'serial' class. This is a pseudo class of types which encapsulates integer fields which are able to auto-increment themselves when records are inserted.

Inherited Methods

Inherited From dbfield

 dbfield::dbfield()
 dbfield::constraints_match()
 dbfield::create()
 dbfield::create_constraints()
 dbfield::drop()
 dbfield::dump()
 dbfield::generic_type()
 dbfield::is_integer_class()
 dbfield::is_serial_class()

Inherited From SchemaObject

 SchemaObject::SchemaObject()

Documentation generated by phpDocumentor 1.3.0RC3