Class Overview

Implements interfaces:

Countable (internal interface)
IteratorAggregate (internal interface)

class Doctrine_Schema_Table

Holds information on a database table

Located in /Doctrine/Schema/Table.php [line 40]

Doctrine_Object
   |
   --Doctrine_Access
      |
      --Doctrine_Schema_Object
         |
         --Doctrine_Schema_Table

Author(s):

Konsta Vesterinen <kvesteri@cc.hut.fi>

Information Tags:

Version:	$Revision: 1080 $
Link:	www.phpdoctrine.com
Since:	1.0
License:	LGPL

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From Doctrine_Schema_Object Doctrine_Schema_Object::$children Inherited From Doctrine_Object Doctrine_Object::$_null	Inherited From Doctrine_Schema_Object Doctrine_Schema_Object::__construct() Doctrine_Schema_Object::contains() Doctrine_Schema_Object::count() Doctrine_Schema_Object::get() Doctrine_Schema_Object::getIterator() getIterator Doctrine_Schema_Object::set() Doctrine_Schema_Object::toArray() Inherited From Doctrine_Access Doctrine_Access::offsetExists() Doctrine_Access::offsetGet() offsetGet an alias of get() Doctrine_Access::offsetSet() sets $offset to $value Doctrine_Access::offsetUnset() unset a given offset Doctrine_Access::setArray() setArray Doctrine_Access::__get() __get -- an alias of get() Doctrine_Access::__isset() __isset() Doctrine_Access::__set() __set an alias of set() Doctrine_Access::__unset() __unset() Inherited From Doctrine_Object Doctrine_Object::getNullObject() getNullObject returns the null object associated with this object Doctrine_Object::initNullObject() initNullObject initializes the null object

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Doctrine_Schema_Object

Doctrine_Schema_Object::$children

Inherited From Doctrine_Object

Doctrine_Object::$_null

Inherited From Doctrine_Schema_Object

Doctrine_Schema_Object::__construct()

Doctrine_Schema_Object::contains()

Doctrine_Schema_Object::count()

Doctrine_Schema_Object::get()

Doctrine_Schema_Object::getIterator()

getIterator

Doctrine_Schema_Object::set()

Doctrine_Schema_Object::toArray()

Inherited From Doctrine_Access

Doctrine_Access::offsetExists()

Doctrine_Access::offsetGet()

offsetGet an alias of get()

Doctrine_Access::offsetSet()

sets $offset to $value

Doctrine_Access::offsetUnset()

unset a given offset

Doctrine_Access::setArray()

setArray

Doctrine_Access::__get()

__get -- an alias of get()

Doctrine_Access::__isset()

__isset()

Doctrine_Access::__set()

__set an alias of set()

Doctrine_Access::__unset()

__unset()

Inherited From Doctrine_Object

Doctrine_Object::getNullObject()

getNullObject returns the null object associated with this object

Doctrine_Object::initNullObject()

initNullObject initializes the null object

[ Top ]

Property Summary

mixed	$definition
mixed	$relations	Relations this table has with others. An array of Doctrine_Schema_Relation

[ Top ]

Method Summary

Doctrine_Schema_Table	addColumn()
Doctrine_Schema_Column\|false	getColumn()
array	getColumns()	returns an array of Doctrine_Schema_Column objects
array	getRelations()	Return all the relations this table has with others
bool	isValid()
void	setRelation()	Adds a relation between a local column and a 2nd table / column

[ Top ]

Properties

mixed $definition = array('name' => '',
'check' => '',
'charset' => '',
'description' => '') [line 43]

API Tags:

Access:

protected

Redefinition of:

Doctrine_Schema_Object::$definition

[ Top ]

mixed $relations = array() [line 50]

Relations this table has with others. An array of Doctrine_Schema_Relation

API Tags:

Access:

private

[ Top ]

Methods

addColumn [line 85]

Doctrine_Schema_Table addColumn(
Doctrine_Schema_Column
$column 
)

Parameters:

Doctrine_Schema_Column

$column:

column

API Tags:

Access:

public

[ Top ]

getColumn [line 72]

Doctrine_Schema_Column|false getColumn(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

getColumns [line 65]

array getColumns(
)

returns an array of Doctrine_Schema_Column objects

API Tags:

Access:

public

[ Top ]

getRelations [line 107]

array getRelations(
)

Return all the relations this table has with others

API Tags:

Return:	Array of Doctrine_Schema_Relation
Access:	public

[ Top ]

isValid [line 56]

bool isValid(
)

API Tags:

Access:

public

[ Top ]

setRelation [line 99]

void setRelation(
Doctrine_Schema_Relation
$relation 
)

Adds a relation between a local column and a 2nd table / column

Parameters:

Doctrine_Schema_Relation

$relation:

Relation

API Tags:

Access:

public

[ Top ]

Class: Doctrine_Schema_Table

Class Doctrine_Schema_Table