Classes:
Doctrine
Doctrine_Access
Doctrine_Adapter
Doctrine_Adapter_Db2_Exception
Doctrine_Adapter_Exception
Doctrine_Adapter_Statement
Doctrine_AuditLog
Doctrine_AuditLog_Listener
Doctrine_Collection
Doctrine_Collection_Exception
Doctrine_Collection_Iterator
Doctrine_Collection_Iterator_Expandable
Doctrine_Collection_Iterator_Normal
Doctrine_Collection_Iterator_Offset
Doctrine_Collection_Offset
Doctrine_Column
Doctrine_Compiler
Doctrine_Compiler_Exception
Doctrine_Configurable
Doctrine_Connection
Doctrine_Connection_Common
Doctrine_Connection_Db2
Doctrine_Connection_Exception
Doctrine_Connection_Firebird
Doctrine_Connection_Firebird_Exception
Doctrine_Connection_Informix
Doctrine_Connection_Informix_Exception
Doctrine_Connection_Mock
Doctrine_Connection_Module
Doctrine_Connection_Mssql
Doctrine_Connection_Mssql_Exception
Doctrine_Connection_Mysql
Doctrine_Connection_Mysql_Exception
Doctrine_Connection_Oracle
Doctrine_Connection_Oracle_Exception
Doctrine_Connection_Pgsql
Doctrine_Connection_Pgsql_Exception
Doctrine_Connection_Profiler
Doctrine_Connection_Profiler_Exception
Doctrine_Connection_Sqlite
Doctrine_Connection_Sqlite_Exception
Doctrine_Connection_Statement
Doctrine_Connection_UnitOfWork
Doctrine_DataDict
Doctrine_DataDict_Exception
Doctrine_DataDict_Informix
Doctrine_DataType
Doctrine_Db
Doctrine_Event
Doctrine_EventListener
Doctrine_EventListener_Chain
Doctrine_EventListener_Exception
Doctrine_Exception
Doctrine_Export
Doctrine_Export_Exception
Doctrine_Export_Firebird
Doctrine_Export_Frontbase
Doctrine_Export_Mssql
Doctrine_Export_Mysql
Doctrine_Export_Oracle
Doctrine_Export_Pgsql
Doctrine_Export_Reporter
Doctrine_Export_Schema
Doctrine_Export_Schema_Xml
Doctrine_Export_Schema_Yml
Doctrine_Export_Sqlite
Doctrine_Expression
Doctrine_Expression_Driver
Doctrine_Expression_Exception
Doctrine_Expression_Firebird
Doctrine_Expression_Informix
Doctrine_Expression_Mock
Doctrine_Expression_Mssql
Doctrine_Expression_Mysql
Doctrine_Expression_Oracle
Doctrine_Expression_Pgsql
Doctrine_Expression_Sqlite
Doctrine_File
Doctrine_File_Index
Doctrine_Formatter
Doctrine_Hook
Doctrine_Hook_Equal
Doctrine_Hook_Integer
Doctrine_Hook_Parser
Doctrine_Hook_Parser_Complex
Doctrine_Hook_WordLike
Doctrine_Hydrate
Doctrine_Hydrate_Array
Doctrine_Hydrate_Exception
Doctrine_Hydrate_Record
Doctrine_Import
Doctrine_Import_Builder
Doctrine_Import_Builder_BaseClass
Doctrine_Import_Builder_Exception
Doctrine_Import_Exception
Doctrine_Import_Firebird
Doctrine_Import_Informix
Doctrine_Import_Mssql
Doctrine_Import_Mysql
Doctrine_Import_Oracle
Doctrine_Import_Pgsql
Doctrine_Import_Reader
Doctrine_Import_Reader_Db
Doctrine_Import_Reader_Exception
Doctrine_Import_Reader_Xml_Propel
Doctrine_Import_Schema
Doctrine_Import_Schema_Xml
Doctrine_Import_Schema_Yml
Doctrine_Import_Sqlite
Doctrine_IntegrityMapper
Doctrine_Lib
Doctrine_Locking_Exception
Doctrine_Locking_Manager_Pessimistic
Doctrine_Manager
Doctrine_Manager_Exception
Doctrine_Node
Doctrine_Node_AdjacencyList
Doctrine_Node_AdjacencyList_LevelOrderIterator
Doctrine_Node_AdjacencyList_PostOrderIterator
Doctrine_Node_AdjacencyList_PreOrderIterator
Doctrine_Node_Exception
Doctrine_Node_MaterializedPath
Doctrine_Node_MaterializedPath_LevelOrderIterator
Doctrine_Node_MaterializedPath_PostOrderIterator
Doctrine_Node_MaterializedPath_PreOrderIterator
Doctrine_Node_NestedSet
Doctrine_Node_NestedSet_LevelOrderIterator
Doctrine_Node_NestedSet_PostOrderIterator
Doctrine_Node_NestedSet_PreOrderIterator
Doctrine_Null
Doctrine_Object
Doctrine_Plugin
Doctrine_Query
Doctrine_Query_Abstract
Doctrine_Query_Check
Doctrine_Query_Condition
Doctrine_Query_Exception
Doctrine_Query_Filter
Doctrine_Query_Filter_Chain
Doctrine_Query_From
Doctrine_Query_Groupby
Doctrine_Query_Having
Doctrine_Query_JoinCondition
Doctrine_Query_Limit
Doctrine_Query_Offset
Doctrine_Query_Orderby
Doctrine_Query_Parser
Doctrine_Query_Part
Doctrine_Query_Select
Doctrine_Query_Set
Doctrine_Query_Where
Doctrine_RawSql
Doctrine_RawSql_Exception
Doctrine_Record
Doctrine_Record_Abstract
Doctrine_Record_Exception
Doctrine_Record_Filter
Doctrine_Record_Iterator
Doctrine_Record_Listener
Doctrine_Record_Listener_Chain
Doctrine_Record_State_Exception
Doctrine_Relation
Doctrine_Relation_Association
Doctrine_Relation_Association_Self
Doctrine_Relation_Exception
Doctrine_Relation_ForeignKey
Doctrine_Relation_LocalKey
Doctrine_Relation_Nest
Doctrine_Relation_Parser
Doctrine_Relation_Parser_Exception
Doctrine_Schema
Doctrine_Schema_Column
Doctrine_Schema_Database
Doctrine_Schema_Exception
Doctrine_Schema_Object
Doctrine_Schema_Relation
Doctrine_Schema_Table
Doctrine_Search
Doctrine_Search_Analyzer
Doctrine_Search_Analyzer_Exception
Doctrine_Search_Analyzer_Standard
Doctrine_Search_Exception
Doctrine_Search_Indexer
Doctrine_Search_Indexer_Dir
Doctrine_Search_Indexer_Exception
Doctrine_Search_Listener
Doctrine_Search_Parser
Doctrine_Search_Query
Doctrine_Search_Record
Doctrine_Search_Scorer
Doctrine_Search_Template
Doctrine_Sequence
Doctrine_Sequence_Db2
Doctrine_Sequence_Exception
Doctrine_Sequence_Firebird
Doctrine_Sequence_Informix
Doctrine_Sequence_Mssql
Doctrine_Sequence_Mysql
Doctrine_Sequence_Oracle
Doctrine_Sequence_Pgsql
Doctrine_Sequence_Sqlite
Doctrine_Table
Doctrine_Table_Exception
Doctrine_Table_Repository
Doctrine_Table_Repository_Exception
Doctrine_Template
Doctrine_Template_NestedSet
Doctrine_Template_Searchable
Doctrine_Template_Taggable
Doctrine_Template_Versionable
Doctrine_Tokenizer
Doctrine_Transaction
Doctrine_Transaction_Exception
Doctrine_Transaction_Firebird
Doctrine_Transaction_Informix
Doctrine_Transaction_Mock
Doctrine_Transaction_Mssql
Doctrine_Transaction_Mysql
Doctrine_Transaction_Oracle
Doctrine_Transaction_Pgsql
Doctrine_Transaction_Sqlite
Doctrine_Tree
Doctrine_Tree_AdjacencyList
Doctrine_Tree_Exception
Doctrine_Tree_MaterializedPath
Doctrine_Tree_NestedSet
Doctrine_Util
Doctrine_Validator
Doctrine_Validator_Country
Doctrine_Validator_Creditcard
Doctrine_Validator_Date
Doctrine_Validator_Email
Doctrine_Validator_Enum
Doctrine_Validator_ErrorStack
Doctrine_Validator_Exception
Doctrine_Validator_HtmlColor
Doctrine_Validator_Ip
Doctrine_Validator_Minlength
Doctrine_Validator_Nospace
Doctrine_Validator_Notblank
Doctrine_Validator_Notnull
Doctrine_Validator_Range
Doctrine_Validator_Regexp
Doctrine_Validator_Unique
Doctrine_Validator_Unsigned
Doctrine_Validator_Usstate
Doctrine_View
Doctrine_View_Exception
Doctrine_Cache
Doctrine_Cache
Doctrine_Cache_Apc
Doctrine_Cache_Array
Doctrine_Cache_Db
Doctrine_Cache_Driver
Doctrine_Cache_Exception
Doctrine_Cache_Memcache
Doctrine_Adapter
Doctrine_Adapter_Db2
Doctrine_Adapter_Mock
Doctrine_Adapter_Mysqli
Doctrine_Adapter_Oracle
Doctrine_Adapter_Statement_Mock
Doctrine_DataDict
Doctrine_DataDict_Firebird
Doctrine_DataDict_Mssql
Doctrine_DataDict_Mysql
Doctrine_DataDict_Oracle
Doctrine_DataDict_Pgsql
Doctrine_DataDict_Sqlite

# Class: Doctrine_File

Source Location: /Doctrine/File.php

## Class Doctrine_File

Class Overview

Doctrine_File Located in /Doctrine/File.php [line 33]
    Doctrine_Object
       |
       --Doctrine_Access
          |
          --Doctrine_Record_Abstract
             |
             --Doctrine_Record
                |
                --Doctrine_File
Author(s): Konsta Vesterinen <kvesteri@cc.hut.fi> Information Tags:
Version: | $Revision$
Link: | www.phpdoctrine.com
Since: | 1.0
License: | LGPL
| Methods get setTableDefinition setUp

[ 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 | get() |
void | setTableDefinition() |
void | setUp() |

[ Top ]
Properties
Methods
get [line 46]

`void get( $name, [ $load = true] )`

Parameters:

| $name: |
| $load: |

API Tags:

Access: | public

Redefinition of:

Doctrine_Record::get()
  get returns a value of a property or a related component

[ Top ]
setTableDefinition [line 35]

`void setTableDefinition( )`

API Tags:

Access: | public

[ Top ]
setUp [line 39]

`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 ]