1
0
mirror of synced 2024-12-14 15:16:04 +03:00
doctrine2/api_documentation/trunk/Doctrine/Doctrine_Collection.html

2449 lines
109 KiB
HTML
Raw Normal View History

<div id="right">
<b>Classes:</b><br />
<div class="package">
<a href="../Doctrine/Doctrine.html">Doctrine</a> <br />
<a href="../Doctrine/Doctrine_Access.html">Doctrine_Access</a> <br />
<a href="../Doctrine/Doctrine_Adapter.html">Doctrine_Adapter</a> <br />
<a href="../Doctrine/Doctrine_Adapter_Db2_Exception.html">Doctrine_Adapter_Db2_Exception</a> <br />
<a href="../Doctrine/Doctrine_Adapter_Exception.html">Doctrine_Adapter_Exception</a> <br />
<a href="../Doctrine/Doctrine_Adapter_Statement.html">Doctrine_Adapter_Statement</a> <br />
<a href="../Doctrine/Doctrine_AuditLog.html">Doctrine_AuditLog</a> <br />
<a href="../Doctrine/Doctrine_AuditLog_Listener.html">Doctrine_AuditLog_Listener</a> <br />
<a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> <br />
<a href="../Doctrine/Doctrine_Collection_Exception.html">Doctrine_Collection_Exception</a> <br />
<a href="../Doctrine/Doctrine_Collection_Iterator.html">Doctrine_Collection_Iterator</a> <br />
<a href="../Doctrine/Doctrine_Collection_Iterator_Expandable.html">Doctrine_Collection_Iterator_Expandable</a> <br />
<a href="../Doctrine/Doctrine_Collection_Iterator_Normal.html">Doctrine_Collection_Iterator_Normal</a> <br />
<a href="../Doctrine/Doctrine_Collection_Iterator_Offset.html">Doctrine_Collection_Iterator_Offset</a> <br />
<a href="../Doctrine/Doctrine_Collection_Offset.html">Doctrine_Collection_Offset</a> <br />
<a href="../Doctrine/Doctrine_Column.html">Doctrine_Column</a> <br />
<a href="../Doctrine/Doctrine_Compiler.html">Doctrine_Compiler</a> <br />
<a href="../Doctrine/Doctrine_Compiler_Exception.html">Doctrine_Compiler_Exception</a> <br />
<a href="../Doctrine/Doctrine_Configurable.html">Doctrine_Configurable</a> <br />
<a href="../Doctrine/Doctrine_Connection.html">Doctrine_Connection</a> <br />
<a href="../Doctrine/Doctrine_Connection_Common.html">Doctrine_Connection_Common</a> <br />
<a href="../Doctrine/Doctrine_Connection_Db2.html">Doctrine_Connection_Db2</a> <br />
<a href="../Doctrine/Doctrine_Connection_Exception.html">Doctrine_Connection_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Firebird.html">Doctrine_Connection_Firebird</a> <br />
<a href="../Doctrine/Doctrine_Connection_Firebird_Exception.html">Doctrine_Connection_Firebird_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Informix.html">Doctrine_Connection_Informix</a> <br />
<a href="../Doctrine/Doctrine_Connection_Informix_Exception.html">Doctrine_Connection_Informix_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Mock.html">Doctrine_Connection_Mock</a> <br />
<a href="../Doctrine/Doctrine_Connection_Module.html">Doctrine_Connection_Module</a> <br />
<a href="../Doctrine/Doctrine_Connection_Mssql.html">Doctrine_Connection_Mssql</a> <br />
<a href="../Doctrine/Doctrine_Connection_Mssql_Exception.html">Doctrine_Connection_Mssql_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Mysql.html">Doctrine_Connection_Mysql</a> <br />
<a href="../Doctrine/Doctrine_Connection_Mysql_Exception.html">Doctrine_Connection_Mysql_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Oracle.html">Doctrine_Connection_Oracle</a> <br />
<a href="../Doctrine/Doctrine_Connection_Oracle_Exception.html">Doctrine_Connection_Oracle_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Pgsql.html">Doctrine_Connection_Pgsql</a> <br />
<a href="../Doctrine/Doctrine_Connection_Pgsql_Exception.html">Doctrine_Connection_Pgsql_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Profiler.html">Doctrine_Connection_Profiler</a> <br />
<a href="../Doctrine/Doctrine_Connection_Profiler_Exception.html">Doctrine_Connection_Profiler_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Sqlite.html">Doctrine_Connection_Sqlite</a> <br />
<a href="../Doctrine/Doctrine_Connection_Sqlite_Exception.html">Doctrine_Connection_Sqlite_Exception</a> <br />
<a href="../Doctrine/Doctrine_Connection_Statement.html">Doctrine_Connection_Statement</a> <br />
<a href="../Doctrine/Doctrine_Connection_UnitOfWork.html">Doctrine_Connection_UnitOfWork</a> <br />
<a href="../Doctrine/Doctrine_DataDict.html">Doctrine_DataDict</a> <br />
<a href="../Doctrine/Doctrine_DataDict_Exception.html">Doctrine_DataDict_Exception</a> <br />
<a href="../Doctrine/Doctrine_DataDict_Informix.html">Doctrine_DataDict_Informix</a> <br />
<a href="../Doctrine/Doctrine_DataType.html">Doctrine_DataType</a> <br />
<a href="../Doctrine/Doctrine_Db.html">Doctrine_Db</a> <br />
<a href="../Doctrine/Doctrine_Event.html">Doctrine_Event</a> <br />
<a href="../Doctrine/Doctrine_EventListener.html">Doctrine_EventListener</a> <br />
<a href="../Doctrine/Doctrine_EventListener_Chain.html">Doctrine_EventListener_Chain</a> <br />
<a href="../Doctrine/Doctrine_EventListener_Exception.html">Doctrine_EventListener_Exception</a> <br />
<a href="../Doctrine/Doctrine_Exception.html">Doctrine_Exception</a> <br />
<a href="../Doctrine/Doctrine_Export.html">Doctrine_Export</a> <br />
<a href="../Doctrine/Doctrine_Export_Exception.html">Doctrine_Export_Exception</a> <br />
<a href="../Doctrine/Doctrine_Export_Firebird.html">Doctrine_Export_Firebird</a> <br />
<a href="../Doctrine/Doctrine_Export_Frontbase.html">Doctrine_Export_Frontbase</a> <br />
<a href="../Doctrine/Doctrine_Export_Mssql.html">Doctrine_Export_Mssql</a> <br />
<a href="../Doctrine/Doctrine_Export_Mysql.html">Doctrine_Export_Mysql</a> <br />
<a href="../Doctrine/Doctrine_Export_Oracle.html">Doctrine_Export_Oracle</a> <br />
<a href="../Doctrine/Doctrine_Export_Pgsql.html">Doctrine_Export_Pgsql</a> <br />
<a href="../Doctrine/Doctrine_Export_Reporter.html">Doctrine_Export_Reporter</a> <br />
<a href="../Doctrine/Doctrine_Export_Schema.html">Doctrine_Export_Schema</a> <br />
<a href="../Doctrine/Doctrine_Export_Schema_Xml.html">Doctrine_Export_Schema_Xml</a> <br />
<a href="../Doctrine/Doctrine_Export_Schema_Yml.html">Doctrine_Export_Schema_Yml</a> <br />
<a href="../Doctrine/Doctrine_Export_Sqlite.html">Doctrine_Export_Sqlite</a> <br />
<a href="../Doctrine/Doctrine_Expression.html">Doctrine_Expression</a> <br />
<a href="../Doctrine/Doctrine_Expression_Driver.html">Doctrine_Expression_Driver</a> <br />
<a href="../Doctrine/Doctrine_Expression_Exception.html">Doctrine_Expression_Exception</a> <br />
<a href="../Doctrine/Doctrine_Expression_Firebird.html">Doctrine_Expression_Firebird</a> <br />
<a href="../Doctrine/Doctrine_Expression_Informix.html">Doctrine_Expression_Informix</a> <br />
<a href="../Doctrine/Doctrine_Expression_Mock.html">Doctrine_Expression_Mock</a> <br />
<a href="../Doctrine/Doctrine_Expression_Mssql.html">Doctrine_Expression_Mssql</a> <br />
<a href="../Doctrine/Doctrine_Expression_Mysql.html">Doctrine_Expression_Mysql</a> <br />
<a href="../Doctrine/Doctrine_Expression_Oracle.html">Doctrine_Expression_Oracle</a> <br />
<a href="../Doctrine/Doctrine_Expression_Pgsql.html">Doctrine_Expression_Pgsql</a> <br />
<a href="../Doctrine/Doctrine_Expression_Sqlite.html">Doctrine_Expression_Sqlite</a> <br />
<a href="../Doctrine/Doctrine_File.html">Doctrine_File</a> <br />
<a href="../Doctrine/Doctrine_File_Index.html">Doctrine_File_Index</a> <br />
<a href="../Doctrine/Doctrine_Formatter.html">Doctrine_Formatter</a> <br />
<a href="../Doctrine/Doctrine_Hook.html">Doctrine_Hook</a> <br />
<a href="../Doctrine/Doctrine_Hook_Equal.html">Doctrine_Hook_Equal</a> <br />
<a href="../Doctrine/Doctrine_Hook_Integer.html">Doctrine_Hook_Integer</a> <br />
<a href="../Doctrine/Doctrine_Hook_Parser.html">Doctrine_Hook_Parser</a> <br />
<a href="../Doctrine/Doctrine_Hook_Parser_Complex.html">Doctrine_Hook_Parser_Complex</a> <br />
<a href="../Doctrine/Doctrine_Hook_WordLike.html">Doctrine_Hook_WordLike</a> <br />
<a href="../Doctrine/Doctrine_Hydrate.html">Doctrine_Hydrate</a> <br />
<a href="../Doctrine/Doctrine_Hydrate_Array.html">Doctrine_Hydrate_Array</a> <br />
<a href="../Doctrine/Doctrine_Hydrate_Exception.html">Doctrine_Hydrate_Exception</a> <br />
<a href="../Doctrine/Doctrine_Hydrate_Record.html">Doctrine_Hydrate_Record</a> <br />
<a href="../Doctrine/Doctrine_Import.html">Doctrine_Import</a> <br />
<a href="../Doctrine/Doctrine_Import_Builder.html">Doctrine_Import_Builder</a> <br />
<a href="../Doctrine/Doctrine_Import_Builder_BaseClass.html">Doctrine_Import_Builder_BaseClass</a> <br />
<a href="../Doctrine/Doctrine_Import_Builder_Exception.html">Doctrine_Import_Builder_Exception</a> <br />
<a href="../Doctrine/Doctrine_Import_Exception.html">Doctrine_Import_Exception</a> <br />
<a href="../Doctrine/Doctrine_Import_Firebird.html">Doctrine_Import_Firebird</a> <br />
<a href="../Doctrine/Doctrine_Import_Informix.html">Doctrine_Import_Informix</a> <br />
<a href="../Doctrine/Doctrine_Import_Mssql.html">Doctrine_Import_Mssql</a> <br />
<a href="../Doctrine/Doctrine_Import_Mysql.html">Doctrine_Import_Mysql</a> <br />
<a href="../Doctrine/Doctrine_Import_Oracle.html">Doctrine_Import_Oracle</a> <br />
<a href="../Doctrine/Doctrine_Import_Pgsql.html">Doctrine_Import_Pgsql</a> <br />
<a href="../Doctrine/Doctrine_Import_Reader.html">Doctrine_Import_Reader</a> <br />
<a href="../Doctrine/Doctrine_Import_Reader_Db.html">Doctrine_Import_Reader_Db</a> <br />
<a href="../Doctrine/Doctrine_Import_Reader_Exception.html">Doctrine_Import_Reader_Exception</a> <br />
<a href="../Doctrine/Doctrine_Import_Reader_Xml_Propel.html">Doctrine_Import_Reader_Xml_Propel</a> <br />
<a href="../Doctrine/Doctrine_Import_Schema.html">Doctrine_Import_Schema</a> <br />
<a href="../Doctrine/Doctrine_Import_Schema_Xml.html">Doctrine_Import_Schema_Xml</a> <br />
<a href="../Doctrine/Doctrine_Import_Schema_Yml.html">Doctrine_Import_Schema_Yml</a> <br />
<a href="../Doctrine/Doctrine_Import_Sqlite.html">Doctrine_Import_Sqlite</a> <br />
<a href="../Doctrine/Doctrine_IntegrityMapper.html">Doctrine_IntegrityMapper</a> <br />
<a href="../Doctrine/Doctrine_Lib.html">Doctrine_Lib</a> <br />
<a href="../Doctrine/Doctrine_Locking_Exception.html">Doctrine_Locking_Exception</a> <br />
<a href="../Doctrine/Doctrine_Locking_Manager_Pessimistic.html">Doctrine_Locking_Manager_Pessimistic</a> <br />
<a href="../Doctrine/Doctrine_Manager.html">Doctrine_Manager</a> <br />
<a href="../Doctrine/Doctrine_Manager_Exception.html">Doctrine_Manager_Exception</a> <br />
<a href="../Doctrine/Doctrine_Node.html">Doctrine_Node</a> <br />
<a href="../Doctrine/Doctrine_Node_AdjacencyList.html">Doctrine_Node_AdjacencyList</a> <br />
<a href="../Doctrine/Doctrine_Node_AdjacencyList_LevelOrderIterator.html">Doctrine_Node_AdjacencyList_LevelOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_AdjacencyList_PostOrderIterator.html">Doctrine_Node_AdjacencyList_PostOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_AdjacencyList_PreOrderIterator.html">Doctrine_Node_AdjacencyList_PreOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_Exception.html">Doctrine_Node_Exception</a> <br />
<a href="../Doctrine/Doctrine_Node_MaterializedPath.html">Doctrine_Node_MaterializedPath</a> <br />
<a href="../Doctrine/Doctrine_Node_MaterializedPath_LevelOrderIterator.html">Doctrine_Node_MaterializedPath_LevelOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_MaterializedPath_PostOrderIterator.html">Doctrine_Node_MaterializedPath_PostOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_MaterializedPath_PreOrderIterator.html">Doctrine_Node_MaterializedPath_PreOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_NestedSet.html">Doctrine_Node_NestedSet</a> <br />
<a href="../Doctrine/Doctrine_Node_NestedSet_LevelOrderIterator.html">Doctrine_Node_NestedSet_LevelOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_NestedSet_PostOrderIterator.html">Doctrine_Node_NestedSet_PostOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Node_NestedSet_PreOrderIterator.html">Doctrine_Node_NestedSet_PreOrderIterator</a> <br />
<a href="../Doctrine/Doctrine_Null.html">Doctrine_Null</a> <br />
<a href="../Doctrine/Doctrine_Object.html">Doctrine_Object</a> <br />
<a href="../Doctrine/Doctrine_Plugin.html">Doctrine_Plugin</a> <br />
<a href="../Doctrine/Doctrine_Query.html">Doctrine_Query</a> <br />
<a href="../Doctrine/Doctrine_Query_Abstract.html">Doctrine_Query_Abstract</a> <br />
<a href="../Doctrine/Doctrine_Query_Check.html">Doctrine_Query_Check</a> <br />
<a href="../Doctrine/Doctrine_Query_Condition.html">Doctrine_Query_Condition</a> <br />
<a href="../Doctrine/Doctrine_Query_Exception.html">Doctrine_Query_Exception</a> <br />
<a href="../Doctrine/Doctrine_Query_Filter.html">Doctrine_Query_Filter</a> <br />
<a href="../Doctrine/Doctrine_Query_Filter_Chain.html">Doctrine_Query_Filter_Chain</a> <br />
<a href="../Doctrine/Doctrine_Query_From.html">Doctrine_Query_From</a> <br />
<a href="../Doctrine/Doctrine_Query_Groupby.html">Doctrine_Query_Groupby</a> <br />
<a href="../Doctrine/Doctrine_Query_Having.html">Doctrine_Query_Having</a> <br />
<a href="../Doctrine/Doctrine_Query_JoinCondition.html">Doctrine_Query_JoinCondition</a> <br />
<a href="../Doctrine/Doctrine_Query_Limit.html">Doctrine_Query_Limit</a> <br />
<a href="../Doctrine/Doctrine_Query_Offset.html">Doctrine_Query_Offset</a> <br />
<a href="../Doctrine/Doctrine_Query_Orderby.html">Doctrine_Query_Orderby</a> <br />
<a href="../Doctrine/Doctrine_Query_Parser.html">Doctrine_Query_Parser</a> <br />
<a href="../Doctrine/Doctrine_Query_Part.html">Doctrine_Query_Part</a> <br />
<a href="../Doctrine/Doctrine_Query_Select.html">Doctrine_Query_Select</a> <br />
<a href="../Doctrine/Doctrine_Query_Set.html">Doctrine_Query_Set</a> <br />
<a href="../Doctrine/Doctrine_Query_Where.html">Doctrine_Query_Where</a> <br />
<a href="../Doctrine/Doctrine_RawSql.html">Doctrine_RawSql</a> <br />
<a href="../Doctrine/Doctrine_RawSql_Exception.html">Doctrine_RawSql_Exception</a> <br />
<a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a> <br />
<a href="../Doctrine/Doctrine_Record_Abstract.html">Doctrine_Record_Abstract</a> <br />
<a href="../Doctrine/Doctrine_Record_Exception.html">Doctrine_Record_Exception</a> <br />
<a href="../Doctrine/Doctrine_Record_Filter.html">Doctrine_Record_Filter</a> <br />
<a href="../Doctrine/Doctrine_Record_Iterator.html">Doctrine_Record_Iterator</a> <br />
<a href="../Doctrine/Doctrine_Record_Listener.html">Doctrine_Record_Listener</a> <br />
<a href="../Doctrine/Doctrine_Record_Listener_Chain.html">Doctrine_Record_Listener_Chain</a> <br />
<a href="../Doctrine/Doctrine_Record_State_Exception.html">Doctrine_Record_State_Exception</a> <br />
<a href="../Doctrine/Doctrine_Relation.html">Doctrine_Relation</a> <br />
<a href="../Doctrine/Doctrine_Relation_Association.html">Doctrine_Relation_Association</a> <br />
<a href="../Doctrine/Doctrine_Relation_Association_Self.html">Doctrine_Relation_Association_Self</a> <br />
<a href="../Doctrine/Doctrine_Relation_Exception.html">Doctrine_Relation_Exception</a> <br />
<a href="../Doctrine/Doctrine_Relation_ForeignKey.html">Doctrine_Relation_ForeignKey</a> <br />
<a href="../Doctrine/Doctrine_Relation_LocalKey.html">Doctrine_Relation_LocalKey</a> <br />
<a href="../Doctrine/Doctrine_Relation_Nest.html">Doctrine_Relation_Nest</a> <br />
<a href="../Doctrine/Doctrine_Relation_Parser.html">Doctrine_Relation_Parser</a> <br />
<a href="../Doctrine/Doctrine_Relation_Parser_Exception.html">Doctrine_Relation_Parser_Exception</a> <br />
<a href="../Doctrine/Doctrine_Schema.html">Doctrine_Schema</a> <br />
<a href="../Doctrine/Doctrine_Schema_Column.html">Doctrine_Schema_Column</a> <br />
<a href="../Doctrine/Doctrine_Schema_Database.html">Doctrine_Schema_Database</a> <br />
<a href="../Doctrine/Doctrine_Schema_Exception.html">Doctrine_Schema_Exception</a> <br />
<a href="../Doctrine/Doctrine_Schema_Object.html">Doctrine_Schema_Object</a> <br />
<a href="../Doctrine/Doctrine_Schema_Relation.html">Doctrine_Schema_Relation</a> <br />
<a href="../Doctrine/Doctrine_Schema_Table.html">Doctrine_Schema_Table</a> <br />
<a href="../Doctrine/Doctrine_Search.html">Doctrine_Search</a> <br />
<a href="../Doctrine/Doctrine_Search_Analyzer.html">Doctrine_Search_Analyzer</a> <br />
<a href="../Doctrine/Doctrine_Search_Analyzer_Exception.html">Doctrine_Search_Analyzer_Exception</a> <br />
<a href="../Doctrine/Doctrine_Search_Analyzer_Standard.html">Doctrine_Search_Analyzer_Standard</a> <br />
<a href="../Doctrine/Doctrine_Search_Exception.html">Doctrine_Search_Exception</a> <br />
<a href="../Doctrine/Doctrine_Search_Indexer.html">Doctrine_Search_Indexer</a> <br />
<a href="../Doctrine/Doctrine_Search_Indexer_Dir.html">Doctrine_Search_Indexer_Dir</a> <br />
<a href="../Doctrine/Doctrine_Search_Indexer_Exception.html">Doctrine_Search_Indexer_Exception</a> <br />
<a href="../Doctrine/Doctrine_Search_Listener.html">Doctrine_Search_Listener</a> <br />
<a href="../Doctrine/Doctrine_Search_Parser.html">Doctrine_Search_Parser</a> <br />
<a href="../Doctrine/Doctrine_Search_Query.html">Doctrine_Search_Query</a> <br />
<a href="../Doctrine/Doctrine_Search_Record.html">Doctrine_Search_Record</a> <br />
<a href="../Doctrine/Doctrine_Search_Scorer.html">Doctrine_Search_Scorer</a> <br />
<a href="../Doctrine/Doctrine_Search_Template.html">Doctrine_Search_Template</a> <br />
<a href="../Doctrine/Doctrine_Sequence.html">Doctrine_Sequence</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Db2.html">Doctrine_Sequence_Db2</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Exception.html">Doctrine_Sequence_Exception</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Firebird.html">Doctrine_Sequence_Firebird</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Informix.html">Doctrine_Sequence_Informix</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Mssql.html">Doctrine_Sequence_Mssql</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Mysql.html">Doctrine_Sequence_Mysql</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Oracle.html">Doctrine_Sequence_Oracle</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Pgsql.html">Doctrine_Sequence_Pgsql</a> <br />
<a href="../Doctrine/Doctrine_Sequence_Sqlite.html">Doctrine_Sequence_Sqlite</a> <br />
<a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a> <br />
<a href="../Doctrine/Doctrine_Table_Exception.html">Doctrine_Table_Exception</a> <br />
<a href="../Doctrine/Doctrine_Table_Repository.html">Doctrine_Table_Repository</a> <br />
<a href="../Doctrine/Doctrine_Table_Repository_Exception.html">Doctrine_Table_Repository_Exception</a> <br />
<a href="../Doctrine/Doctrine_Template.html">Doctrine_Template</a> <br />
<a href="../Doctrine/Doctrine_Template_NestedSet.html">Doctrine_Template_NestedSet</a> <br />
<a href="../Doctrine/Doctrine_Template_Searchable.html">Doctrine_Template_Searchable</a> <br />
<a href="../Doctrine/Doctrine_Template_Taggable.html">Doctrine_Template_Taggable</a> <br />
<a href="../Doctrine/Doctrine_Template_Versionable.html">Doctrine_Template_Versionable</a> <br />
<a href="../Doctrine/Doctrine_Tokenizer.html">Doctrine_Tokenizer</a> <br />
<a href="../Doctrine/Doctrine_Transaction.html">Doctrine_Transaction</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Exception.html">Doctrine_Transaction_Exception</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Firebird.html">Doctrine_Transaction_Firebird</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Informix.html">Doctrine_Transaction_Informix</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Mock.html">Doctrine_Transaction_Mock</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Mssql.html">Doctrine_Transaction_Mssql</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Mysql.html">Doctrine_Transaction_Mysql</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Oracle.html">Doctrine_Transaction_Oracle</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Pgsql.html">Doctrine_Transaction_Pgsql</a> <br />
<a href="../Doctrine/Doctrine_Transaction_Sqlite.html">Doctrine_Transaction_Sqlite</a> <br />
<a href="../Doctrine/Doctrine_Tree.html">Doctrine_Tree</a> <br />
<a href="../Doctrine/Doctrine_Tree_AdjacencyList.html">Doctrine_Tree_AdjacencyList</a> <br />
<a href="../Doctrine/Doctrine_Tree_Exception.html">Doctrine_Tree_Exception</a> <br />
<a href="../Doctrine/Doctrine_Tree_MaterializedPath.html">Doctrine_Tree_MaterializedPath</a> <br />
<a href="../Doctrine/Doctrine_Tree_NestedSet.html">Doctrine_Tree_NestedSet</a> <br />
<a href="../Doctrine/Doctrine_Util.html">Doctrine_Util</a> <br />
<a href="../Doctrine/Doctrine_Validator.html">Doctrine_Validator</a> <br />
<a href="../Doctrine/Doctrine_Validator_Country.html">Doctrine_Validator_Country</a> <br />
<a href="../Doctrine/Doctrine_Validator_Creditcard.html">Doctrine_Validator_Creditcard</a> <br />
<a href="../Doctrine/Doctrine_Validator_Date.html">Doctrine_Validator_Date</a> <br />
<a href="../Doctrine/Doctrine_Validator_Email.html">Doctrine_Validator_Email</a> <br />
<a href="../Doctrine/Doctrine_Validator_Enum.html">Doctrine_Validator_Enum</a> <br />
<a href="../Doctrine/Doctrine_Validator_ErrorStack.html">Doctrine_Validator_ErrorStack</a> <br />
<a href="../Doctrine/Doctrine_Validator_Exception.html">Doctrine_Validator_Exception</a> <br />
<a href="../Doctrine/Doctrine_Validator_HtmlColor.html">Doctrine_Validator_HtmlColor</a> <br />
<a href="../Doctrine/Doctrine_Validator_Ip.html">Doctrine_Validator_Ip</a> <br />
<a href="../Doctrine/Doctrine_Validator_Minlength.html">Doctrine_Validator_Minlength</a> <br />
<a href="../Doctrine/Doctrine_Validator_Nospace.html">Doctrine_Validator_Nospace</a> <br />
<a href="../Doctrine/Doctrine_Validator_Notblank.html">Doctrine_Validator_Notblank</a> <br />
<a href="../Doctrine/Doctrine_Validator_Notnull.html">Doctrine_Validator_Notnull</a> <br />
<a href="../Doctrine/Doctrine_Validator_Range.html">Doctrine_Validator_Range</a> <br />
<a href="../Doctrine/Doctrine_Validator_Regexp.html">Doctrine_Validator_Regexp</a> <br />
<a href="../Doctrine/Doctrine_Validator_Unique.html">Doctrine_Validator_Unique</a> <br />
<a href="../Doctrine/Doctrine_Validator_Unsigned.html">Doctrine_Validator_Unsigned</a> <br />
<a href="../Doctrine/Doctrine_Validator_Usstate.html">Doctrine_Validator_Usstate</a> <br />
<a href="../Doctrine/Doctrine_View.html">Doctrine_View</a> <br />
<a href="../Doctrine/Doctrine_View_Exception.html">Doctrine_View_Exception</a> <br />
</div>
<div class="package">
Doctrine_Cache<br /> <span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache.html">Doctrine_Cache</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache_Apc.html">Doctrine_Cache_Apc</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache_Array.html">Doctrine_Cache_Array</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache_Db.html">Doctrine_Cache_Db</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache_Driver.html">Doctrine_Cache_Driver</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache_Exception.html">Doctrine_Cache_Exception</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Cache/Doctrine_Cache_Memcache.html">Doctrine_Cache_Memcache</a> </span> <br />
</div>
<div class="package">
Doctrine_Adapter<br /> <span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Adapter/Doctrine_Adapter_Db2.html">Doctrine_Adapter_Db2</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Adapter/Doctrine_Adapter_Mock.html">Doctrine_Adapter_Mock</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Adapter/Doctrine_Adapter_Mysqli.html">Doctrine_Adapter_Mysqli</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Adapter/Doctrine_Adapter_Oracle.html">Doctrine_Adapter_Oracle</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_Adapter/Doctrine_Adapter_Statement_Mock.html">Doctrine_Adapter_Statement_Mock</a> </span> <br />
</div>
<div class="package">
Doctrine_DataDict<br /> <span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_DataDict/Doctrine_DataDict_Firebird.html">Doctrine_DataDict_Firebird</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_DataDict/Doctrine_DataDict_Mssql.html">Doctrine_DataDict_Mssql</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_DataDict/Doctrine_DataDict_Mysql.html">Doctrine_DataDict_Mysql</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_DataDict/Doctrine_DataDict_Oracle.html">Doctrine_DataDict_Oracle</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_DataDict/Doctrine_DataDict_Pgsql.html">Doctrine_DataDict_Pgsql</a> </span> <br />
<span style="padding-left: 1em;"> <a href="../Doctrine/Doctrine_DataDict/Doctrine_DataDict_Sqlite.html">Doctrine_DataDict_Sqlite</a> </span> <br />
</div>
</div>
<div id="content">
<h1>Class: Doctrine_Collection</h1>
Source Location: /Doctrine/Collection.php<br /><br />
<h2 class="class-name">Class Doctrine_Collection</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Class Overview</div>
<div class="nav-bar">
<span class="disabled">Class Overview</span> |
<a href="#sec-descendents">Descendants</a>
|
<a href="#sec-inherited">Inherited Properties, Constants, and Methods</a>
| <a href="#sec-var-summary">Properties Summary</a> | <a href="#sec-vars">Properties Detail</a>
| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
</div>
<div class="info-box-body">
<table width="100%" border="0">
<tr><td valign="top" width="60%" class="class-overview">
<p class="implements">
Implements interfaces:
<ul>
<li>Countable (internal interface)</li><li>IteratorAggregate (internal interface)</li><li>Serializable (internal interface)</li> </ul>
</p>
<p align="center" class="short-description"><strong>Doctrine_Collection Collection of Doctrine_Record objects.
</strong></p>
<p class="notes">
Located in <a class="field" href="_Doctrine---Collection.php.html">/Doctrine/Collection.php</a> [<span class="field">line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a34">34</a></span>]
</p>
<pre><a href="../Doctrine/Doctrine_Object.html">Doctrine_Object</a>
|
--<a href="../Doctrine/Doctrine_Access.html">Doctrine_Access</a>
|
--Doctrine_Collection</pre>
<strong>Author(s):</strong>
<ul>
<li>Konsta Vesterinen &lt;<a href="mailto:kvesteri@cc.hut.fi">kvesteri@cc.hut.fi</a>&gt;</li>
</ul>
<strong>Information Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td><strong>Version:</strong>&nbsp;&nbsp;</td><td>$Revision: 2282 $</td></tr>
<tr><td><strong>Link:</strong>&nbsp;&nbsp;</td><td>www.phpdoctrine.com</td></tr>
<tr><td><strong>Since:</strong>&nbsp;&nbsp;</td><td>1.0</td></tr>
<tr><td><strong>License:</strong>&nbsp;&nbsp;</td><td><a href="http://www.opensource.org/licenses/lgpl-license.php">LGPL</a></td></tr>
</table>
</td>
<td valign="top" width="20%" class="class-overview">
<p align="center" class="short-description"><strong><a href="#sec_vars">Properties</a></strong></p>
<ul>
<li><a href="../Doctrine/Doctrine_Collection.html#var$data">$data</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$keyColumn">$keyColumn</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$null">$null</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$reference">$reference</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$referenceField">$referenceField</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$relation">$relation</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$_snapshot">$_snapshot</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#var$_table">$_table</a></li>
</ul>
</td>
<td valign="top" width="20%" class="class-overview">
<p align="center" class="short-description"><strong><a href="#sec_methods">Methods</a></strong></p>
<ul>
<li><a href="../Doctrine/Doctrine_Collection.html#method__construct">__construct</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodadd">add</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodcontains">contains</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodcount">count</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methoddelete">delete</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodget">get</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetData">getData</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetDeleteDiff">getDeleteDiff</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetFirst">getFirst</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetInsertDiff">getInsertDiff</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetIterator">getIterator</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetKeyColumn">getKeyColumn</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetKeys">getKeys</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetLast">getLast</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetNormalIterator">getNormalIterator</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetPrimaryKeys">getPrimaryKeys</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetReference">getReference</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetSnapshot">getSnapshot</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodgetTable">getTable</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodinitNullObject">initNullObject</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodloadRelated">loadRelated</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodpopulateRelated">populateRelated</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodprocessDiff">processDiff</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodremove">remove</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodsave">save</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodsearch">search</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodserialize">serialize</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodset">set</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodsetData">setData</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodsetKeyColumn">setKeyColumn</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodsetReference">setReference</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodtakeSnapshot">takeSnapshot</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodtoArray">toArray</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#methodunserialize">unserialize</a></li>
<li><a href="../Doctrine/Doctrine_Collection.html#method__toString">__toString</a></li>
</ul>
</td>
</tr></table>
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Class Overview</a> |
<a href="#sec-descendents">Descendents</a>
| <a href="#sec-inherited">Inherited Properties and Methods</a>
| <a href="#sec-var-summary">Properties Summary</a> | <a href="#sec-vars">Properties Detail</a>
| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Child Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../Doctrine/Doctrine_Collection_Offset.html">Doctrine_Collection_Offset</a></td>
<td>
Doctrine_Collection_Offset Collection of Doctrine_Record objects.
</td>
</tr>
</table>
<br /><div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
<a name="sec-inherited"></a>
<div class="info-box">
<div class="info-box-title">Inherited Properties, Constants, and Methods</div>
<div class="nav-bar">
<a href="#sec-description">Class Overview</a> |
<a href="#sec-descendents">Descendants</a> |
| <span class="disabled">Inherited Properties, Constants, and Methods</span>
| <a href="#sec-var-summary">Properties Summary</a> | <a href="#sec-vars">Properties Detail</a>
| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header" width="30%">Inherited Properties</th>
<th class="class-table-header" width="40%">Inherited Methods</th>
<th class="class-table-header" width="30%">Inherited Constants</th>
</tr>
<tr>
<td width="30%">
<p>Inherited From <span class="classname"><a href="../Doctrine/Doctrine_Object.html">Doctrine_Object</a></span></p>
<blockquote>
<dl>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Object.html#var$_null">Doctrine_Object::$_null</a></span>
</dt>
<dd>
<span class="method-definition"></span>
</dd>
</dl>
</blockquote>
</td>
<td width="40%">
<p>Inherited From <span class="classname"><a href="../Doctrine/Doctrine_Access.html">Doctrine_Access</a></span></p>
<blockquote>
<dl>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#methodoffsetExists">Doctrine_Access::offsetExists()</a></span>
</dt>
<dd>
<span class="method-definition"></span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#methodoffsetGet">Doctrine_Access::offsetGet()</a></span>
</dt>
<dd>
<span class="method-definition">offsetGet an alias of get()</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#methodoffsetSet">Doctrine_Access::offsetSet()</a></span>
</dt>
<dd>
<span class="method-definition">sets $offset to $value</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#methodoffsetUnset">Doctrine_Access::offsetUnset()</a></span>
</dt>
<dd>
<span class="method-definition">unset a given offset</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#methodsetArray">Doctrine_Access::setArray()</a></span>
</dt>
<dd>
<span class="method-definition">setArray</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#method__get">Doctrine_Access::__get()</a></span>
</dt>
<dd>
<span class="method-definition">__get -- an alias of get()</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#method__isset">Doctrine_Access::__isset()</a></span>
</dt>
<dd>
<span class="method-definition">__isset()</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#method__set">Doctrine_Access::__set()</a></span>
</dt>
<dd>
<span class="method-definition">__set an alias of set()</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Access.html#method__unset">Doctrine_Access::__unset()</a></span>
</dt>
<dd>
<span class="method-definition">__unset()</span>
</dd>
</dl>
</blockquote>
<p>Inherited From <span class="classname"><a href="../Doctrine/Doctrine_Object.html">Doctrine_Object</a></span></p>
<blockquote>
<dl>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Object.html#methodgetNullObject">Doctrine_Object::getNullObject()</a></span>
</dt>
<dd>
<span class="method-definition">getNullObject returns the null object associated with this object</span>
</dd>
<dt>
<span class="method-definition"><a href="../Doctrine/Doctrine_Object.html#methodinitNullObject">Doctrine_Object::initNullObject()</a></span>
</dt>
<dd>
<span class="method-definition">initNullObject initializes the null object</span>
</dd>
</dl>
</blockquote>
</td>
<td width="30%">
</td>
</tr>
</table>
<br /><div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Property Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Class Overview</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-inherited">Inherited Properties and Methods</a>
| <span class="disabled">Property Summary</span> | <a href="#sec-vars">Properties Detail</a>
<a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
</div>
<div class="info-box-body">
<div class="var-summary">
<table border="0" cellspacing="0" cellpadding="0" class="var-summary">
<div class="var-title">
<tr><td class="var-title">static <span class="var-type-summary"><a href="../Doctrine/Doctrine_Null.html">Doctrine_Null</a></span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$null" title="details" class="var-name-summary">$null</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary">array</span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$data" title="details" class="var-name-summary">$data</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$keyColumn" title="details" class="var-name-summary">$keyColumn</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$reference" title="details" class="var-name-summary">$reference</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$referenceField" title="details" class="var-name-summary">$referenceField</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary"><a href="../Doctrine/Doctrine_Relation.html">Doctrine_Relation</a></span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$relation" title="details" class="var-name-summary">$relation</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary">array</span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$_snapshot" title="details" class="var-name-summary">$_snapshot</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
<div class="var-title">
<tr><td class="var-title"><span class="var-type-summary"><a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a></span>&nbsp;&nbsp;</td>
<td class="var-title"><a href="#$_table" title="details" class="var-name-summary">$_table</a>&nbsp;&nbsp;</td>
<td class="var-summary-description"></td></tr>
</div>
</table>
</div>
<br /><div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Class Overview</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-inherited">Inherited Properties and Methods</a>
| <a href="#sec-var-summary">Properties Summary</a> | <a href="#sec-vars">Properties Detail</a>
<span class="disabled">Method Summary</span> | <a href="#sec-methods">Methods Detail</a>
</div>
<div class="info-box-body">
<div class="method-summary">
<table border="0" cellspacing="0" cellpadding="0" class="method-summary">
<div class="method-definition">
<tr><td class="method-definition">static
<span class="method-result">void</span>&nbsp;&nbsp;
</td>
<td class="method-definition"><a href="#initNullObject" title="details" class="method-name">initNullObject</a>()&nbsp;&nbsp;</td>
<td class="method-definition">initNullObject initializes the null object for this collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">Doctrine_Collection</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#__construct" title="details" class="method-name">__construct</a>()&nbsp;&nbsp;</td>
<td class="method-definition">constructor</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#add" title="details" class="method-name">add</a>()&nbsp;&nbsp;</td>
<td class="method-definition">adds a record to collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#contains" title="details" class="method-name">contains</a>()&nbsp;&nbsp;</td>
<td class="method-definition">contains whether or not this collection contains a specified element</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">integer</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#count" title="details" class="method-name">count</a>()&nbsp;&nbsp;</td>
<td class="method-definition">count this class implements interface countable returns the number of records in this collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#delete" title="details" class="method-name">delete</a>()&nbsp;&nbsp;</td>
<td class="method-definition">delete</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#get" title="details" class="method-name">get</a>()&nbsp;&nbsp;</td>
<td class="method-definition">get returns a record for given key</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">array</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getData" title="details" class="method-name">getData</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getData returns all the records as an array</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getDeleteDiff" title="details" class="method-name">getDeleteDiff</a>()&nbsp;&nbsp;</td>
<td class="method-definition"></td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">mixed</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getFirst" title="details" class="method-name">getFirst</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getFirst returns the first record in the collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getInsertDiff" title="details" class="method-name">getInsertDiff</a>()&nbsp;&nbsp;</td>
<td class="method-definition"></td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">object ArrayIterator</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getIterator" title="details" class="method-name">getIterator</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getIterator</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">string</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getKeyColumn" title="details" class="method-name">getKeyColumn</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getKeyColumn returns the name of the key column</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">array</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getKeys" title="details" class="method-name">getKeys</a>()&nbsp;&nbsp;</td>
<td class="method-definition">returns all keys</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">mixed</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getLast" title="details" class="method-name">getLast</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getLast returns the last record in the collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">Doctrine_Iterator_Normal</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getNormalIterator" title="details" class="method-name">getNormalIterator</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getNormalIterator returns normal iterator - an iterator that will not expand this collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">array</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getPrimaryKeys" title="details" class="method-name">getPrimaryKeys</a>()&nbsp;&nbsp;</td>
<td class="method-definition"></td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">mixed</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getReference" title="details" class="method-name">getReference</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getReference</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">array</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getSnapshot" title="details" class="method-name">getSnapshot</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getSnapshot returns the data of the last snapshot</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#getTable" title="details" class="method-name">getTable</a>()&nbsp;&nbsp;</td>
<td class="method-definition">getTable returns the table this collection belongs to</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#loadRelated" title="details" class="method-name">loadRelated</a>()&nbsp;&nbsp;</td>
<td class="method-definition">loadRelated</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#populateRelated" title="details" class="method-name">populateRelated</a>()&nbsp;&nbsp;</td>
<td class="method-definition">populateRelated</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#processDiff" title="details" class="method-name">processDiff</a>()&nbsp;&nbsp;</td>
<td class="method-definition">processDiff processes the difference of the last snapshot and the current data</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">boolean</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#remove" title="details" class="method-name">remove</a>()&nbsp;&nbsp;</td>
<td class="method-definition">remove removes a specified collection element</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#save" title="details" class="method-name">save</a>()&nbsp;&nbsp;</td>
<td class="method-definition">save saves all records of this collection and processes the difference of the last snapshot and the current data</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#search" title="details" class="method-name">search</a>()&nbsp;&nbsp;</td>
<td class="method-definition"></td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">array</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#serialize" title="details" class="method-name">serialize</a>()&nbsp;&nbsp;</td>
<td class="method-definition">this method is automatically called when this Doctrine_Collection is serialized</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#set" title="details" class="method-name">set</a>()&nbsp;&nbsp;</td>
<td class="method-definition">set</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#setData" title="details" class="method-name">setData</a>()&nbsp;&nbsp;</td>
<td class="method-definition">setData</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#setKeyColumn" title="details" class="method-name">setKeyColumn</a>()&nbsp;&nbsp;</td>
<td class="method-definition">setKeyColumn sets the key column for this collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#setReference" title="details" class="method-name">setReference</a>()&nbsp;&nbsp;</td>
<td class="method-definition">setReference sets a reference pointer</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#takeSnapshot" title="details" class="method-name">takeSnapshot</a>()&nbsp;&nbsp;</td>
<td class="method-definition">takeSnapshot takes a snapshot from this collection</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#toArray" title="details" class="method-name">toArray</a>()&nbsp;&nbsp;</td>
<td class="method-definition">toArray Mimics the result of a $query-&gt;execute(array(), Doctrine::FETCH_ARRAY);</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#unserialize" title="details" class="method-name">unserialize</a>()&nbsp;&nbsp;</td>
<td class="method-definition">unseralize this method is automatically called everytime a Doctrine_Collection object is unserialized</td></tr>
</div>
<div class="method-definition">
<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
<td class="method-definition"><a href="#__toString" title="details" class="method-name">__toString</a>()&nbsp;&nbsp;</td>
<td class="method-definition">returns a string representation of this object</td></tr>
</div>
</table>
</div>
<br /><div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Properties</div>
<div class="nav-bar">
<a href="#sec-description">Class Overview</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-inherited">Inherited Properties and Methods</a>
| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
|
<a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
</div>
<div class="info-box-body">
<a name="var$null" id="$null"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type"><a href="../Doctrine/Doctrine_Null.html">Doctrine_Null</a></span>&nbsp;&nbsp;
<span class="var-name">$null</span>
<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a67">67</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$data" id="$data"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>&nbsp;&nbsp;
<span class="var-name">$data</span>
= <span class="var-default">array()</span> <span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a39">39</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$keyColumn" id="$keyColumn"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>&nbsp;&nbsp;
<span class="var-name">$keyColumn</span>
<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a63">63</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$reference" id="$reference"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;
<span class="var-name">$reference</span>
<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a51">51</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$referenceField" id="$referenceField"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>&nbsp;&nbsp;
<span class="var-name">$referenceField</span>
<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a55">55</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$relation" id="$relation"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../Doctrine/Doctrine_Relation.html">Doctrine_Relation</a></span>&nbsp;&nbsp;
<span class="var-name">$relation</span>
<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a59">59</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$_snapshot" id="$_snapshot"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array</span>&nbsp;&nbsp;
<span class="var-name">$_snapshot</span>
= <span class="var-default">array()</span> <span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a47">47</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$_table" id="$_table"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type"><a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a></span>&nbsp;&nbsp;
<span class="var-name">$_table</span>
<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a43">43</a>]</span>
</span>
</div>
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Class Overview</a> |
<a href="#sec-descendents">Descendents</a>
<a href="#sec-inherited">Inherited Properties and Methods</a>
| |
<a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
| <a href="#sec-method-summary">Method Summary</a> | <span class="disabled">Methods Detail</span>
</div>
<div class="info-box-body">
<a name='method_detail'></a>
<a name="methodinitNullObject" id="initNullObject"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method initNullObject</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a94">94</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>static void initNullObject(
<a href="../Doctrine/Doctrine_Null.html">Doctrine_Null</a>
$null&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>initNullObject initializes the null object for this collection
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Null.html">Doctrine_Null</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$null:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Doctrine/Doctrine_Object.html#methodinitNullObject">Doctrine_Object::initNullObject()</a></dt>
<dd>initNullObject initializes the null object</dd>
</dl>
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a75">75</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>Doctrine_Collection __construct(
<a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a>|string
$table&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>constructor
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a>|string</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$table:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../Doctrine/Doctrine_Collection_Offset.html#method__construct">Doctrine_Collection_Offset::__construct()</a>
</li>
</ul>
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodadd" id="add"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">add</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a380">380</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>boolean add(
<a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a>
$record, [string
$key = null]&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>adds a record to collection
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$record:&nbsp;</span></td>
<td>
<span class="var-description"> record to be added</span> </td></tr>
<tr><td class="indent">
<span class="var-type">string</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$key:&nbsp;</span></td>
<td>
<span class="var-description"> optional key for the record</span> </td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodcontains" id="contains"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">contains</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a276">276</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>boolean contains(
mixed
$key&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>contains whether or not this collection contains a specified element
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">mixed</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$key:&nbsp;</span></td>
<td>
<span class="var-description"> the key of the element</span> </td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodcount" id="count"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">count</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a356">356</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>integer count(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>count this class implements interface countable returns the number of records in this collection
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt>Countable::count</dt>
</dl>
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methoddelete" id="delete"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">delete</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a645">645</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> delete(
[<a href="../Doctrine/Doctrine_Connection.html">Doctrine_Connection</a>
$conn = null]&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>delete
</strong></p>
<span class="description"><p>single shot delete deletes all records from this collection and uses only one database query to perform this operation</p></span>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Connection.html">Doctrine_Connection</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$conn:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodget" id="get"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">get</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a301">301</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a> get(
mixed
$key&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>get returns a record for given key
</strong></p>
<span class="description"><p>There are two special cases:</p><p><ol><li>if null is given as a key a new record is created and attached</li></ol> at the end of the collection</p><p>2. if given key does not exist, then a new record is create and attached to the given key</p><p>Collection also maps referential information to newly created records</p></span>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">mixed</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$key:&nbsp;</span></td>
<td>
<span class="var-description"> the key of the element</span> </td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>return a specified record</td>
</tr>
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetData" id="getData"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getData</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a192">192</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>array getData(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getData returns all the records as an array
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetDeleteDiff" id="getDeleteDiff"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getDeleteDiff</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a603">603</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void getDeleteDiff(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetFirst" id="getFirst"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getFirst</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a202">202</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>mixed getFirst(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getFirst returns the first record in the collection
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetInsertDiff" id="getInsertDiff"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getInsertDiff</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a607">607</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void getInsertDiff(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetIterator" id="getIterator"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getIterator</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a668">668</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>object ArrayIterator getIterator(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getIterator
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt>IteratorAggregate::getIterator</dt>
</dl>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../Doctrine/Doctrine_Collection_Offset.html#methodgetIterator">Doctrine_Collection_Offset::getIterator()</a>
</li>
</ul>
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetKeyColumn" id="getKeyColumn"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getKeyColumn</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a182">182</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>string getKeyColumn(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getKeyColumn returns the name of the key column
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetKeys" id="getKeys"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getKeys</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a345">345</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>array getKeys(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>returns all keys
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetLast" id="getLast"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getLast</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a212">212</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>mixed getLast(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getLast returns the last record in the collection
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetNormalIterator" id="getNormalIterator"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getNormalIterator</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a530">530</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>Doctrine_Iterator_Normal getNormalIterator(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getNormalIterator returns normal iterator - an iterator that will not expand this collection
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetPrimaryKeys" id="getPrimaryKeys"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getPrimaryKeys</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a327">327</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>array getPrimaryKeys(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>an array containing all primary keys</td>
</tr>
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetReference" id="getReference"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getReference</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a251">251</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>mixed getReference(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getReference
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetSnapshot" id="getSnapshot"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getSnapshot</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a559">559</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>array getSnapshot(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getSnapshot returns the data of the last snapshot
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Return:</strong>&nbsp;&nbsp;</td><td>returns the data in last snapshot</td>
</tr>
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetTable" id="getTable"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getTable</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a104">104</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Table.html">Doctrine_Table</a> getTable(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>getTable returns the table this collection belongs to
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodloadRelated" id="loadRelated"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">loadRelated</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a427">427</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>boolean loadRelated(
[mixed
$name = null]&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>loadRelated
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">mixed</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$name:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodpopulateRelated" id="populateRelated"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">populateRelated</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a473">473</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void populateRelated(
string
$name, <a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a>
$coll&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>populateRelated
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">string</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$name:&nbsp;</span></td>
<td>
</td></tr>
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$coll:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodprocessDiff" id="processDiff"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">processDiff</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a575">575</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> processDiff(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>processDiff processes the difference of the last snapshot and the current data
</strong></p>
<span class="description"><p>an example: Snapshot with the objects 1, 2 and 4 Current data with objects 2, 3 and 5</p><p>The process would remove object 4</p></span>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodremove" id="remove"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">remove</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a262">262</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>boolean remove(
mixed
$key&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>remove removes a specified collection element
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">mixed</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$key:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsave" id="save"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">save</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a619">619</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> save(
[<a href="../Doctrine/Doctrine_Connection.html">Doctrine_Connection</a>
$conn = null]&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>save saves all records of this collection and processes the difference of the last snapshot and the current data
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Connection.html">Doctrine_Connection</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$conn:&nbsp;</span></td>
<td>
<span class="var-description"> optional connection parameter</span> </td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsearch" id="search"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">search</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a280">280</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void search(
<a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a>
$record&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$record:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodserialize" id="serialize"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">serialize</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a123">123</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>array serialize(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>this method is automatically called when this Doctrine_Collection is serialized
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt>Serializable::serialize</dt>
</dl>
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodset" id="set"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">set</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a366">366</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void set(
integer
$key, <a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a>
$record&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>set
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">integer</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$key:&nbsp;</span></td>
<td>
</td></tr>
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$record:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetData" id="setData"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setData</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a114">114</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> setData(
$data&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>setData
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">array</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$data:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetKeyColumn" id="setKeyColumn"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setKeyColumn</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a170">170</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> setKeyColumn(
string
$column&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>setKeyColumn sets the key column for this collection
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">string</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$column:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodsetReference" id="setReference"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setReference</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a222">222</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void setReference(
<a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a>
$record, <a href="../Doctrine/Doctrine_Relation.html">Doctrine_Relation</a>
$relation&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>setReference sets a reference pointer
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Record.html">Doctrine_Record</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$record:&nbsp;</span></td>
<td>
</td></tr>
<tr><td class="indent">
<span class="var-type"><a href="../Doctrine/Doctrine_Relation.html">Doctrine_Relation</a></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$relation:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodtakeSnapshot" id="takeSnapshot"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">takeSnapshot</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a547">547</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code><a href="../Doctrine/Doctrine_Collection.html">Doctrine_Collection</a> takeSnapshot(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>takeSnapshot takes a snapshot from this collection
</strong></p>
<span class="description"><p>snapshots are used for diff processing, for example when a fetched collection has three elements, then two of those are being removed the diff would contain one element</p><p>Doctrine_Collection::save() attaches the diff with the help of last snapshot.</p></span>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodtoArray" id="toArray"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">toArray</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a589">589</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void toArray(
[boolean
$deep = false]&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>toArray Mimics the result of a $query-&gt;execute(array(), Doctrine::FETCH_ARRAY);
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type">boolean</span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$deep:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodunserialize" id="unserialize"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">unserialize</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a144">144</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void unserialize(
$serialized&nbsp;
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>unseralize this method is automatically called everytime a Doctrine_Collection object is unserialized
</strong></p>
<strong>Parameters:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr><td class="indent">
<span class="var-type"></span>&nbsp;&nbsp;</td>
<td>
<span class="var-name">$serialized:&nbsp;</span></td>
<td>
</td></tr>
</table>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt>Serializable::unserialize</dt>
</dl>
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">__toString</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Doctrine__DoctrineCollection.php.html#a676">676</a>]</span>
</div>
<br />
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
<code>void __toString(
)</code>
</td></tr></table>
</td></tr></table><br /></div>
<p align="center" class="short-description"><strong>returns a string representation of this object
</strong></p>
<br />
<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
</tr>
</table>
<br />
<br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div>
</div>
</div>