You are currently viewing the 0.10 branch api documentation. Switch to 1.0 or 1.1

0.10 Doctrine_Configurable

Doctrine Configurable

Doctrine_Configurable the base for Doctrine_Table, Doctrine_Manager and Doctrine_Connection

Direct Sub-Classes

Method Summary

Returns Name Description
mixed addListener
mixed addRecordListener
mixed getAttribute
getAttributeFromString Will accept the name of an attribute and return the attribute value Example: ->getAttributeFromString('portability') will be converted to Doctrine::ATTR_PORTABILITY and returned
array getAttributes
getAttributeValueFromString Will get the value for an attribute by the string name Example: ->getAttributeFromString('portability', 'all') will return Doctrine::PORTABILITY_ALL
string getImpl
getListener
getParam
getParamNamespaces
getParams
getParent
getRecordListener
hasImpl
setAttribute 

setAttribute(Doctrine::ATTR_PORTABILITY, Doctrine::PORTABILITY_ALL);

 // or

 $manager->setAttribute('portability', Doctrine::PORTABILITY_ALL);

 // or

 $manager->setAttribute('portability', 'all');]]>
setEventListener
setImpl this method is the base of Doctrine dependency injection
setListener
setParam
setParent
setRecordListener

Method Details

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

    Doctrine_Configurable


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

    Doctrine_Configurable


  • (mixed) getAttribute($attribute)

    returns the value of an attribute


  • getAttributeFromString($stringAttributeName)

    Will accept the name of an attribute and return the attribute value Example: ->getAttributeFromString('portability') will be converted to Doctrine::ATTR_PORTABILITY and returned


  • (array) getAttributes()

    getAttributes returns all attributes as an array


  • getAttributeValueFromString($stringAttributeName, $stringAttributeValueName)

    Will get the value for an attribute by the string name Example: ->getAttributeFromString('portability', 'all') will return Doctrine::PORTABILITY_ALL


  • (string) getImpl($template)

    getImpl returns the implementation for given class

    Doctrine_Configurable


  • getListener()


  • getParam($name, $namespace = null)


  • getParamNamespaces()


  • getParams($namespace = null)


  • getParent()

    getParent returns the parent of this component


  • getRecordListener()

    getListener


  • hasImpl($template)


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

    setAttribute($attribute, $value)

    setAttribute sets a given attribute

    

    setAttribute(Doctrine::ATTR_PORTABILITY, Doctrine::PORTABILITY_ALL);
    


     // or
    


     $manager->setAttribute('portability', Doctrine::PORTABILITY_ALL);
    


     // or
    


     $manager->setAttribute('portability', 'all');]]>

    throws Doctrine_Exception if the value is invalid


  • setEventListener((Doctrine_EventListener) $listener)


  • $template name of the class template
    $class name of the class to be bound

    setImpl($template, $class)

    setImpl binds given class to given template name

    this method is the base of Doctrine dependency injection

    Doctrine_Configurable


  • setListener((Doctrine_EventListener_Interface|Doctrine_Overloadable) $listener)

    Doctrine_Configurable


  • setParam($name, $value, $namespace = null)


  • setParent(( ) $component)

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


  • setRecordListener((Doctrine_EventListener_Interface|Doctrine_Overloadable) $listener)

    setListener

    Doctrine_Configurable