Docs For Class Column

Description

The Column class contains information on a table column

Primarily used by the Table class.

Located in /phpfw.php (line 2575)

Variable Summary

string $external_name

bool $is_autoincrement

bool $is_key

bool $is_required

string $name

int $size

string $type

array $values

Method Summary

Column Column (string $name)

string get_external_name ()

bool get_is_autoincrement ()

bool get_is_key ()

bool get_is_required ()

string get_name ()

int get_size ()

string get_type ()

array get_values ()

void set_is_autoincrement (bool $is_autoincrement)

void set_is_key (bool $is_key)

void set_is_required (bool $is_required)

void set_size (int $size)

void set_type (string $type)

void set_values (array $values)

Variables

string $external_name (line 2586)

var:
External name of the column
Uses ucwords() and replaces _ with spaces

bool $is_autoincrement (line 2626)

var:
Set to true if column is autoincrementing (primary key)
Default: false

bool $is_key (line 2612)

var:
Set to true if column is a primary key
Default: false

bool $is_required (line 2619)

var:
Set to true if the column is a required field (not null)
Default: false

string $name (line 2579)

var: Name of the column

int $size (line 2605)

var:
Size of column (for varchar, int, etc.)
Default: 0

string $type (line 2591)

var: Type of variable

array $values (line 2598)

var:
Values in case type is enumeration
Default: array()

Methods

Constructor Column (line 2633)

Constructor for the Column class

Column Column (string $name)

string $name: The name of the column

get_external_name (line 2663)

Get the external column name

return: The external name string

string get_external_name ()

get_is_autoincrement (line 2762)

Get is_autoincrement

return: True if is autoinremented, else false

bool get_is_autoincrement ()

get_is_key (line 2726)

Get is_key

return: True if is a key, else false

bool get_is_key ()

get_is_required (line 2744)

Get is_required

return: True if is a required field, else false

bool get_is_required ()

get_name (line 2654)

Get the column name

return: The name string

string get_name ()

get_size (line 2708)

Get the column size

return: Size of column

int get_size ()

get_type (line 2672)

Get the column type

return: The type

string get_type ()

get_values (line 2690)

Get the column values (for enumeration)

return: Array of values

array get_values ()

set_is_autoincrement (line 2771)

Set is_autoincrement

void set_is_autoincrement (bool $is_autoincrement)

bool $is_autoincrement: True or false

set_is_key (line 2735)

Set is_key

void set_is_key (bool $is_key)

bool $is_key: True or false

set_is_required (line 2753)

Set is_required

void set_is_required (bool $is_required)

bool $is_required: True or false

set_size (line 2717)

Set the column size

void set_size (int $size)

int $size: Size to set

set_type (line 2681)

Set the column type

void set_type (string $type)

string $type: The type

set_values (line 2699)

Set the column values (for enumeration)

void set_values (array $values)

array $values: Array of values