Class: Doctrine_Record_Abstract

Source Location: /Doctrine/Record/Abstract.php

Class Doctrine_Record_Abstract

Class Overview

Doctrine_Record_Abstract

Located in /Doctrine/Record/Abstract.php [line 33]

Doctrine_Object
   |
   --Doctrine_Access
      |
      --Doctrine_Record_Abstract
Author(s): API Tags:
Abstract:  

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

Properties

Methods

[ Top ]
Direct descendents
Child Class Description
Doctrine_Record Doctrine_Record All record classes should inherit this super class
Doctrine_Template Doctrine_Template

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Object

Doctrine_Object::$_null

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   $_table  

[ Top ]
Method Summary
void   actAs()   actAs loads a given plugin
Doctrine_Record   addListener()   addListener
mixed   attribute()   attribute sets or retrieves an option
Doctrine_Record   check()   check adds a check constraint
Doctrine_EventListener_Interface|Doctrine_Overloadable   getListener()   getListener
void   hasColumn()   hasColumn sets a column definition
void   hasColumns()  
Doctrine_Record   hasMany()   hasMany binds One-to-Many / Many-to-Many aggregate relation
Doctrine_Record   hasOne()   hasOne binds One-to-One aggregate relation
mixed   index()   index
void   loadTemplate()   loadTemplate
mixed   option()   option sets or retrieves an option
Doctrine_Record   ownsMany()   ownsMany binds One-to-Many / Many-to-Many composite relation
Doctrine_Record   ownsOne()   ownsOne binds One-to-One composite relation
void   setAttribute()  
void   setInheritanceMap()  
Doctrine_Record   setListener()   setListener
void   setSubclasses()  
void   setTableName()  

[ Top ]
Properties
mixed   $_table [line 38]
API Tags:
Access:  protected


[ Top ]
Methods
actAs  [line 264]

  void actAs( mixed $tpl, [ $options = array()]  )

actAs loads a given plugin

Parameters:
mixed   $tpl: 
array   $options: 

API Tags:
Access:  public


[ Top ]
addListener  [line 45]

  Doctrine_Record addListener( Doctrine_EventListener_Interface|Doctrine_Overloadable $listener, [ $name = null]  )

addListener

Parameters:
Doctrine_EventListener_Interface|Doctrine_Overloadable   $listener: 
   $name: 

API Tags:
Access:  public


[ Top ]
attribute  [line 126]

  mixed attribute( mixed $attr, mixed $value  )

attribute sets or retrieves an option

Parameters:
mixed   $attr: 
mixed   $value: 

API Tags:
See:  Doctrine::ATTR_* constants availible attributes
Access:  public


[ Top ]
check  [line 303]

  Doctrine_Record check( mixed $constraint, [string $name = null]  )

check adds a check constraint

Parameters:
mixed   $constraint:  either a SQL constraint portion or an array of CHECK constraints
string   $name:  optional constraint name

API Tags:
Return:  this object
Access:  public


[ Top ]
getListener  [line 56]

getListener


API Tags:
Access:  public


[ Top ]
hasColumn  [line 232]

  void hasColumn( string $name, string $type, [integer $length = 2147483647], [mixed $options = ""]  )

hasColumn sets a column definition

Parameters:
string   $name: 
string   $type: 
integer   $length: 
mixed   $options: 

API Tags:
Access:  public


[ Top ]
hasColumns  [line 236]

  void hasColumns( $definitions  )

Parameters:
array   $definitions: 

API Tags:
Access:  public


[ Top ]
hasMany  [line 216]

  Doctrine_Record hasMany( string $componentName, string $options  )

hasMany binds One-to-Many / Many-to-Many aggregate relation

Parameters:
string   $componentName:  the name of the related component
string   $options:  relation options

API Tags:
Return:  this object
See:  Doctrine_Relation::_$definition
Access:  public


[ Top ]
hasOne  [line 201]

  Doctrine_Record hasOne( string $componentName, string $options  )

hasOne binds One-to-One aggregate relation

Parameters:
string   $componentName:  the name of the related component
string   $options:  relation options

API Tags:
Return:  this object
See:  Doctrine_Relation::_$definition
Access:  public


[ Top ]
index  [line 82]

  mixed index( string $name, [ $definition = array()]  )

index

defines or retrieves an index if the second parameter is set this method defines an index if not this method retrieves index named $name

Parameters:
string   $name:  the name of the index
array   $definition:  the definition array

API Tags:
Access:  public


[ Top ]
loadTemplate  [line 247]

  void loadTemplate( string $template, [ $options = array()]  )

loadTemplate

Parameters:
string   $template: 
array   $options: 

API Tags:
Access:  public


[ Top ]
option  [line 149]

  mixed option( mixed $name, [mixed $value = null]  )

option sets or retrieves an option

Parameters:
mixed   $name:  the name of the option
mixed   $value:  options value

API Tags:
See:  Doctrine_Table::$options availible options
Access:  public


[ Top ]
ownsMany  [line 187]

  Doctrine_Record ownsMany( string $componentName, string $options  )

ownsMany binds One-to-Many / Many-to-Many composite relation

Parameters:
string   $componentName:  the name of the related component
string   $options:  relation options

API Tags:
Return:  this object
See:  Doctrine_Relation::_$definition
Access:  public


[ Top ]
ownsOne  [line 172]

  Doctrine_Record ownsOne( string $componentName, string $options  )

ownsOne binds One-to-One composite relation

Parameters:
string   $componentName:  the name of the related component
string   $options:  relation options

API Tags:
Return:  this object
See:  Doctrine_Relation::_$definition
Access:  public


[ Top ]
setAttribute  [line 90]

  void setAttribute( $attr, $value  )

Parameters:
   $attr: 
   $value: 

API Tags:
Access:  public


[ Top ]
setInheritanceMap  [line 98]

  void setInheritanceMap( $map  )

Parameters:
   $map: 

API Tags:
Access:  public


[ Top ]
setListener  [line 66]

setListener

Parameters:
Doctrine_EventListener_Interface|Doctrine_Overloadable   $listener: 

API Tags:
Access:  public


[ Top ]
setSubclasses  [line 103]

  void setSubclasses( $map  )

Parameters:
   $map: 

API Tags:
Access:  public


[ Top ]
setTableName  [line 94]

  void setTableName( $tableName  )

Parameters:
   $tableName: 

API Tags:
Access:  public


[ Top ]