Class: Doctrine_File_Index

Source Location: /Doctrine/File/Index.php

Class Doctrine_File_Index

Class Overview

Doctrine_File_Index

Located in /Doctrine/File/Index.php [line 33]

Doctrine_Object
   |
   --Doctrine_Access
      |
      --Doctrine_Record_Abstract
         |
         --Doctrine_Record
            |
            --Doctrine_File_Index
Author(s): Information Tags:
Version:  $Revision$
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Methods

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

Inherited From Doctrine_Record

Doctrine_Record::$_data
Doctrine_Record::$_errorStack
Doctrine_Record::$_filter
Doctrine_Record::$_id
Doctrine_Record::$_index
Doctrine_Record::$_modified
Doctrine_Record::$_node
Doctrine_Record::$_oid
Doctrine_Record::$_references
Doctrine_Record::$_state
Doctrine_Record::$_values

Inherited From Doctrine_Record_Abstract

Doctrine_Record_Abstract::$_table

Inherited From Doctrine_Object

Doctrine_Object::$_null

Inherited From Doctrine_Record

Doctrine_Record::__construct()
constructor
Doctrine_Record::assignDefaultValues()
setDefaultValues sets the default values for records internal data
Doctrine_Record::assignIdentifier()
assignIdentifier
Doctrine_Record::call()
call
Doctrine_Record::cleanData()
cleanData
Doctrine_Record::columnCount()
alias for count()
Doctrine_Record::construct()
construct Empty tempalte method to provide concrete Record classes with the possibility to hook into the constructor procedure
Doctrine_Record::contains()
contains
Doctrine_Record::copy()
copy returns a copy of this object
Doctrine_Record::copyDeep()
copyDeep returns a copy of this object and all its related objects
Doctrine_Record::coreSetRelated()
Doctrine_Record::count()
count this class implements countable interface
Doctrine_Record::delete()
deletes this data access object and all the related composites this operation is isolated by a transaction
Doctrine_Record::deleteNode()
used to delete node from tree - MUST BE USE TO DELETE RECORD IF TABLE ACTS AS TREE
Doctrine_Record::errorStack()
errorStack assigns / returns record errorStack
Doctrine_Record::exists()
exists returns true if this record is persistent, otherwise false
Doctrine_Record::get()
get returns a value of a property or a related component
Doctrine_Record::getData()
getData return all the internal data
Doctrine_Record::getErrorStack()
getErrorStack
Doctrine_Record::getIncremented()
returns the value of autoincremented primary key of this object (if any)
Doctrine_Record::getIterator()
getIterator
Doctrine_Record::getLast()
getLast
Doctrine_Record::getModified()
returns an array of modified fields and associated values
Doctrine_Record::getNode()
getter for node assciated with this record
Doctrine_Record::getOid()
getOid returns the object identifier
Doctrine_Record::getPrepared()
getPrepared
Doctrine_Record::getReferences()
getReferences
Doctrine_Record::getTable()
getTable returns the table object for this record
Doctrine_Record::hasReference()
hasRefence
Doctrine_Record::hasRelation()
method for checking existence of properties and Doctrine_Record references
Doctrine_Record::hydrate()
hydrate hydrates this object from given array
Doctrine_Record::identifier()
returns the primary keys of this object
Doctrine_Record::isModified()
isModified returns true if this record was modified, otherwise false
Doctrine_Record::isValid()
isValid
Doctrine_Record::load()
load loads all the unitialized properties from the database
Doctrine_Record::loadReference()
loadReference loads a related component
Doctrine_Record::mapValue()
mapValue This simple method is used for mapping values to $values property.
Doctrine_Record::merge()
merge merges this record with an array of values
Doctrine_Record::obtainReference()
obtainReference
Doctrine_Record::postDelete()
Empty template method to provide concrete Record classes with the possibility to hook into the deletion procedure.
Doctrine_Record::postInsert()
Empty template method to provide concrete Record classes with the possibility to hook into the saving procedure only when the record is going to be inserted into the data store the first time.
Doctrine_Record::postSave()
Empty template method to provide concrete Record classes with the possibility to hook into the saving procedure.
Doctrine_Record::postSerialize()
Empty template method to provide concrete Record classes with the possibility to hook into the serializing procedure.
Doctrine_Record::postUnserialize()
Empty template method to provide concrete Record classes with the possibility to hook into the serializing procedure.
Doctrine_Record::postUpdate()
Empty template method to provide concrete Record classes with the possibility to hook into the saving procedure only when the record is going to be updated.
Doctrine_Record::preDelete()
Empty template method to provide concrete Record classes with the possibility to hook into the deletion procedure.
Doctrine_Record::preInsert()
Empty template method to provide concrete Record classes with the possibility to hook into the saving procedure only when the record is going to be inserted into the data store the first time.
Doctrine_Record::prepareIdentifiers()
prepareIdentifiers prepares identifiers for later use
Doctrine_Record::preSave()
Empty template method to provide concrete Record classes with the possibility to hook into the saving procedure.
Doctrine_Record::preSerialize()
Empty template method to provide concrete Record classes with the possibility to hook into the serializing procedure.
Doctrine_Record::preUnserialize()
Empty template method to provide concrete Record classes with the possibility to hook into the serializing procedure.
Doctrine_Record::preUpdate()
Empty template method to provide concrete Record classes with the possibility to hook into the saving procedure only when the record is going to be updated.
Doctrine_Record::rawGet()
rawGet returns the value of a property, if the property is not yet loaded this method does NOT load it
Doctrine_Record::refresh()
refresh refresh internal data from the database
Doctrine_Record::refreshRelated()
refresh refres data of related objects from the database
Doctrine_Record::replace()
replace
Doctrine_Record::revert()
revert reverts this record to given version, this method only works if versioning plugin is enabled
Doctrine_Record::save()
applies the changes made to this object into database this method is smart enough to know if any changes are made and whether to use INSERT or UPDATE statement
Doctrine_Record::serialize()
serialize this method is automatically called when this Doctrine_Record is serialized
Doctrine_Record::set()
set method for altering properties and Doctrine_Record references if the load parameter is set to false this method will not try to load uninitialized record data
Doctrine_Record::setRelated()
setRelated
Doctrine_Record::setUp()
setUp this method is used for setting up relations and attributes it should be implemented by child classes
Doctrine_Record::state()
state returns / assigns the state of this record
Doctrine_Record::toArray()
toArray returns the record as an array
Doctrine_Record::toString()
Doctrine_Record::trySave()
Tries to save the object and all its related components.
Doctrine_Record::unlink()
removeLinks removes links from this record to given records
Doctrine_Record::unserialize()
unseralize this method is automatically called everytime a Doctrine_Record object is unserialized
Doctrine_Record::validate()
Empty template method to provide concrete Record classes with the possibility to hook into the validation procedure, doing any custom / specialized validations that are neccessary.
Doctrine_Record::validateOnInsert()
Empty template method to provide concrete Record classes with the possibility to hook into the validation procedure only when the record is going to be inserted into the data store the first time.
Doctrine_Record::validateOnUpdate()
Empty template method to provide concrete Record classes with the possibility to hook into the validation procedure only when the record is going to be updated.
Doctrine_Record::_index()
_index
Doctrine_Record::__call()
__call this method is a magic method that is being used for method overloading
Doctrine_Record::__toString()
returns a string representation of this object
Doctrine_Record::__unset()

Inherited From Doctrine_Record_Abstract

Doctrine_Record_Abstract::actAs()
actAs loads a given plugin
Doctrine_Record_Abstract::addListener()
addListener
Doctrine_Record_Abstract::attribute()
attribute sets or retrieves an option
Doctrine_Record_Abstract::check()
check adds a check constraint
Doctrine_Record_Abstract::getListener()
getListener
Doctrine_Record_Abstract::hasColumn()
hasColumn sets a column definition
Doctrine_Record_Abstract::hasColumns()
Doctrine_Record_Abstract::hasMany()
hasMany binds One-to-Many / Many-to-Many aggregate relation
Doctrine_Record_Abstract::hasOne()
hasOne binds One-to-One aggregate relation
Doctrine_Record_Abstract::index()
index
Doctrine_Record_Abstract::loadTemplate()
loadTemplate
Doctrine_Record_Abstract::option()
option sets or retrieves an option
Doctrine_Record_Abstract::ownsMany()
ownsMany binds One-to-Many / Many-to-Many composite relation
Doctrine_Record_Abstract::ownsOne()
ownsOne binds One-to-One composite relation
Doctrine_Record_Abstract::setAttribute()
Doctrine_Record_Abstract::setInheritanceMap()
Doctrine_Record_Abstract::setListener()
setListener
Doctrine_Record_Abstract::setSubclasses()
Doctrine_Record_Abstract::setTableName()

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

Inherited From Doctrine_Record

Doctrine_Record::STATE_CLEAN
Doctrine_Record::STATE_DIRTY
Doctrine_Record::STATE_LOCKED
Doctrine_Record::STATE_PROXY
Doctrine_Record::STATE_TCLEAN
Doctrine_Record::STATE_TDIRTY

[ Top ]
Method Summary
void   setTableDefinition()  
void   setUp()  

[ Top ]
Properties
Methods
setTableDefinition  [line 35]

  void setTableDefinition( )


API Tags:
Access:  public


[ Top ]
setUp  [line 49]

  void setUp( )


API Tags:
Access:  public


Redefinition of:
Doctrine_Record::setUp()
setUp this method is used for setting up relations and attributes it should be implemented by child classes

[ Top ]