Class: Doctrine_Configurable

Source Location: /Doctrine/Configurable.php

Class Doctrine_Configurable

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

Doctrine_Configurable the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection

Located in /Doctrine/Configurable.php [line 34] 

Doctrine_Object
   |
   --Doctrine_Configurable
Author(s): API Tags:
Abstract:  

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

Properties

Methods
[ Top ]
Direct descendents
Class Overview | Descendents | Inherited Properties and Methods | Properties Summary | Properties Detail | Method Summary | Methods Detail
Child Class Description
Doctrine_Connection Doctrine_Connection
Doctrine_Manager Doctrine_Manager is the base component of all doctrine based projects.
Doctrine_Table Doctrine_Table represents a database table each Doctrine_Table holds the information of foreignKeys and associations

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

Inherited From Doctrine_Object

Doctrine_Object::$_null

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 | Descendents | Inherited Properties and Methods | Property Summary | Properties Detail Method Summary | Methods Detail
array   $attributes  
Doctrine_Configurable   $parent  
array   $_impl  

[ Top ]
Method Summary
Class Overview | Descendents | Inherited Properties and Methods | Properties Summary | Properties Detail Method Summary | Methods Detail
mixed   addListener()   addListener
mixed   addRecordListener()   addRecordListener
mixed   getAttribute()   returns the value of an attribute
array   getAttributes()   getAttributes returns all attributes as an array
Doctrine_Cache_Interface   getCacheDriver()   getCacheDriver
string   getImpl()   getImpl returns the implementation for given class
Doctrine_EventListener_Interface|Doctrine_Overloadable   getListener()   getListener
Doctrine_Configurable   getParent()   getParent returns the parent of this component
Doctrine_EventListener_Interface|Doctrine_Overloadable   getRecordListener()   getListener
void   setAttribute()   setAttribute sets a given attribute
void   setEventListener()  
Doctrine_Configurable   setImpl()   setImpl binds given class to given template name
Doctrine_Configurable   setListener()   setListener
void   setParent()   sets a parent for this configurable component the parent must be configurable component itself
Doctrine_Configurable   setRecordListener()   setListener

[ Top ]
Properties
Class Overview | Descendents | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
array   $attributes = array() [line 39]
API Tags:
Access:  protected


[ Top ]
Doctrine_Configurable   $parent [line 43]
API Tags:
Access:  protected


[ Top ]
array   $_impl = array() [line 49]
API Tags:
Access:  protected


[ Top ]
Methods
Class Overview | Descendents Inherited Properties and Methods | | Property Summary | Properties Detail | Method Summary | Methods Detail
addListener  [line 267]

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

addListener

Parameters:
Doctrine_EventListener_Interface|Doctrine_Overloadable   $listener: 
   $name: 

API Tags:
Return:  this object
Access:  public


[ Top ]
addRecordListener  [line 218]

  mixed addRecordListener( Doctrine_EventListener_Interface|Doctrine_Overloadable $listener, [ $name = null]  )

addRecordListener

Parameters:
Doctrine_EventListener_Interface|Doctrine_Overloadable   $listener: 
   $name: 

API Tags:
Return:  this object
Access:  public


[ Top ]
getAttribute  [line 316]

  mixed getAttribute( integer $attribute  )

returns the value of an attribute

Parameters:
integer   $attribute: 

API Tags:
Access:  public

Redefined in descendants as:

[ Top ]
getAttributes  [line 338]

  array getAttributes( )

getAttributes returns all attributes as an array


API Tags:
Access:  public


[ Top ]
getCacheDriver  [line 196]

  Doctrine_Cache_Interface getCacheDriver( )

getCacheDriver


API Tags:
Access:  public


[ Top ]
getImpl  [line 181]

  string getImpl( $template  )

getImpl returns the implementation for given class

Parameters:
   $template: 

API Tags:
Return:  name of the concrete implementation
Access:  public


[ Top ]
getListener  [line 283]

  Doctrine_EventListener_Interface|Doctrine_Overloadable getListener( )

getListener


API Tags:
Access:  public


[ Top ]
getParent  [line 359]

  Doctrine_Configurable getParent( )

getParent returns the parent of this component


API Tags:
Access:  public


[ Top ]
getRecordListener  [line 234]

  Doctrine_EventListener_Interface|Doctrine_Overloadable getRecordListener( )

getListener


API Tags:
Access:  public


[ Top ]
setAttribute  [line 69]

  void setAttribute( mixed $attribute, mixed $value  )

setAttribute sets a given attribute

  1.  $manager->setAttribute(Doctrine::ATTR_PORTABILITY, Doctrine::PORTABILITY_ALL);
  2.  
  3.  // or
  4.  
  5.  $manager->setAttribute('portability', Doctrine::PORTABILITY_ALL);

 Parameters:
mixed   $attribute:  either a Doctrine::ATTR_* integer constant or a string corresponding to a constant
mixed   $value:  the value of the attribute

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

Information Tags:
Throws:  Doctrine_Exception if the value is invalid
Redefined in descendants as:

[ Top ]
setEventListener  [line 208]

  void setEventListener( Doctrine_EventListener $listener  )

Parameters:
Doctrine_EventListener   $listener: 

API Tags:
Access:  public


[ Top ]
setImpl  [line 169]

  Doctrine_Configurable setImpl( string $template, string $class  )

setImpl binds given class to given template name

this method is the base of Doctrine dependency injection

 Parameters:
string   $template:  name of the class template
string   $class:  name of the class to be bound

API Tags:
Return:  this object
Access:  public


[ Top ]
setListener  [line 299]

  Doctrine_Configurable setListener( Doctrine_EventListener_Interface|Doctrine_Overloadable $listener  )

setListener

Parameters:
Doctrine_EventListener_Interface|Doctrine_Overloadable   $listener: 

API Tags:
Return:  this object
Access:  public


[ Top ]
setParent  [line 349]

  void setParent( Doctrine_Configurable $component  )

sets a parent for this configurable component the parent must be configurable component itself

Parameters:
Doctrine_Configurable   $component: 

API Tags:
Access:  public


[ Top ]
setRecordListener  [line 250]

  Doctrine_Configurable setRecordListener( Doctrine_EventListener_Interface|Doctrine_Overloadable $listener  )

setListener

Parameters:
Doctrine_EventListener_Interface|Doctrine_Overloadable   $listener: 

API Tags:
Return:  this object
Access:  public


[ Top ]