Class: Doctrine_Schema_Relation

Source Location: /Doctrine/Schema/Relation.php

Class Doctrine_Schema_Relation

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties Summary | Properties Detail | Method Summary | Methods Detail

class Doctrine_Schema_Relation Holds information on a foreign key relation.

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

Doctrine_Object
   |
   --Doctrine_Access
      |
      --Doctrine_Schema_Object
         |
         --Doctrine_Schema_Relation
Author(s): Information Tags:
Version:  $Revision: 1080 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Properties

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | | Inherited Properties, Constants, and Methods | Properties Summary | Properties Detail | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Schema_Object

Doctrine_Schema_Object::$children
Doctrine_Schema_Object::$definition

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
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail Method Summary | Methods Detail
static mixed   $ACTION_CASCADE   ON UPDATE or ON DELETE action
static mixed   $ACTION_NO_ACTION   ON UPDATE or ON DELETE action
static mixed   $ACTION_RESTRICT   ON UPDATE or ON DELETE action
static mixed   $ACTION_SET_DEFAULT   ON UPDATE or ON DELETE action
static mixed   $ACTION_SET_NULL   ON UPDATE or ON DELETE action
mixed   $referencedColumn   Column that is referred from another table
mixed   $referencedTable   Table where the referred column lives
mixed   $referencingColumn   Column that refers to another table

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Properties Summary | Properties Detail Method Summary | Methods Detail
bool   isValid()  
void   setRelationBetween()  
string   __toString()  

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
static mixed   $ACTION_CASCADE = 3 [line 81]

ON UPDATE or ON DELETE action

API Tags:
Access:  public


[ Top ]
static mixed   $ACTION_NO_ACTION = 4 [line 88]

ON UPDATE or ON DELETE action

API Tags:
Access:  public


[ Top ]
static mixed   $ACTION_RESTRICT = 1 [line 67]

ON UPDATE or ON DELETE action

API Tags:
Access:  public


[ Top ]
static mixed   $ACTION_SET_DEFAULT = 5 [line 95]

ON UPDATE or ON DELETE action

API Tags:
Access:  public


[ Top ]
static mixed   $ACTION_SET_NULL = 2 [line 74]

ON UPDATE or ON DELETE action

API Tags:
Access:  public


[ Top ]
mixed   $referencedColumn [line 53]

Column that is referred from another table

API Tags:
Access:  public


[ Top ]
mixed   $referencedTable [line 60]

Table where the referred column lives

API Tags:
Access:  public


[ Top ]
mixed   $referencingColumn [line 47]

Column that refers to another table

API Tags:
Access:  public


[ Top ]
Methods
Class Overview | Inherited Properties and Methods | | Property Summary | Properties Detail | Method Summary | Methods Detail
isValid  [line 122]

  bool isValid( )


API Tags:
Access:  public


[ Top ]
setRelationBetween  [line 105]

  void setRelationBetween( Doctrine_Schema_Column $referencingColumn, Doctrine_Schema_Table $referencedTable, Doctrine_Schema_Column $referencedColumn  )

Parameters:
Doctrine_Schema_Column   $referencingColumn:  referencing
Doctrine_Schema_Table   $referencedTable:  referencedtable
Doctrine_Schema_Column   $referencedColumn:  referencedColumn

API Tags:
Access:  public


[ Top ]
__toString  [line 114]

  string __toString( )


API Tags:
Access:  public


[ Top ]