Class Overview

Doctrine_Relation_Parser

Located in /Doctrine/Relation/Parser.php [line 32]

Author(s):

Konsta Vesterinen <kvesteri@cc.hut.fi>

Information Tags:

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

Properties

Methods

[ Top ]

Property Summary

array	$_pending
array	$_relations
Doctrine_Table	$_table

[ Top ]

Method Summary

Doctrine_Relation_Parser	__construct()	constructor
void	bind()	binds a relation
array	completeAssocDefinition()	Completes the given association definition
array	completeDefinition()	Completes the given definition
void	getIdentifiers()	getIdentifiers gives a list of identifiers from given table
void	getImpl()	getImpl
array	getPendingRelation()	getPendingRelation
void	getRelation()	getRelation
array	getRelations()	getRelations returns an array containing all relation objects
Doctrine_Table	getTable()	getTable
array	guessColumns()	guessColumns
void	hasRelation()

[ Top ]

Properties

array $_pending = array() [line 45]

API Tags:

Access:

protected

[ Top ]

array $_relations = array() [line 41]

API Tags:

Access:

protected

[ Top ]

Doctrine_Table $_table [line 37]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 51]

Doctrine_Relation_Parser __construct(
Doctrine_Table
$table 
)

constructor

Parameters:

Doctrine_Table

$table:

the table object this parser belongs to

API Tags:

Access:

public

[ Top ]

bind [line 93]

void bind(
string
$name, [
$options = array()], string
$field 
)

binds a relation

Parameters:

string	$name:
string	$field:
	$options:

API Tags:

Access:

public

[ Top ]

completeAssocDefinition [line 241]

array completeAssocDefinition(
array
$def 
)

Completes the given association definition

Parameters:

array

$def:

definition array to be completed

API Tags:

Return:	completed definition array
Access:	public

[ Top ]

completeDefinition [line 350]

array completeDefinition(
array
$def 
)

Completes the given definition

Parameters:

array

$def:

definition array to be completed

API Tags:

Return:	completed definition array
Access:	public

[ Top ]

getIdentifiers [line 292]

void getIdentifiers(
Doctrine_Table
$table 
)

getIdentifiers gives a list of identifiers from given table

the identifiers are in format: [componentName].[identifier]

Parameters:

Doctrine_Table

$table:

table object to retrieve identifiers from

API Tags:

Access:

public

[ Top ]

getImpl [line 219]

void getImpl(
string
$template 
)

getImpl

returns the table class of the concrete implementation for given template if the given template is not a template then this method just returns the table class for the given record

Parameters:

string

$template:

API Tags:

Access:

public

[ Top ]

getPendingRelation [line 69]

array getPendingRelation(

$name 
)

getPendingRelation

Parameters:

$name:

API Tags:

Return:	an array defining a pending relation
Access:	public

[ Top ]

getRelation [line 131]

void getRelation(
string
$alias, [
$recursive = true] 
)

getRelation

Parameters:

string	$alias:	relation alias
	$recursive:

API Tags:

Access:

public

[ Top ]

getRelations [line 203]

array getRelations(
)

getRelations returns an array containing all relation objects

API Tags:

Return:	an array of Doctrine_Relation objects
Access:	public

[ Top ]

getTable [line 60]

Doctrine_Table getTable(
)

getTable

API Tags:

Return:	the table object this parser belongs to
Access:	public

[ Top ]

guessColumns [line 314]

array guessColumns(

$classes, Doctrine_Table
$foreignTable 
)

guessColumns

Parameters:

array	$classes:	an array of class names
Doctrine_Table	$foreignTable:	foreign table object

API Tags:

Return:	an array of column names
Access:	public

[ Top ]

hasRelation [line 78]

void hasRelation(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

Class: Doctrine_Relation_Parser

Class Doctrine_Relation_Parser