Class: Doctrine_Collection_Offset

Source Location: /Doctrine/Collection/Offset.php

Class Doctrine_Collection_Offset

Class Overview

Doctrine_Collection_Offset Collection of Doctrine_Record objects.

Located in /Doctrine/Collection/Offset.php [line 34]

Doctrine_Object
   |
   --Doctrine_Access
      |
      --Doctrine_Collection
         |
         --Doctrine_Collection_Offset
Author(s): Information Tags:
Version:  $Revision: 1080 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Properties

Methods

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

Inherited From Doctrine_Collection

Doctrine_Collection::$data
Doctrine_Collection::$keyColumn
Doctrine_Collection::$null
Doctrine_Collection::$reference
Doctrine_Collection::$referenceField
Doctrine_Collection::$relation
Doctrine_Collection::$_snapshot
Doctrine_Collection::$_table

Inherited From Doctrine_Object

Doctrine_Object::$_null

Inherited From Doctrine_Collection

Doctrine_Collection::__construct()
constructor
Doctrine_Collection::add()
adds a record to collection
Doctrine_Collection::contains()
contains whether or not this collection contains a specified element
Doctrine_Collection::count()
count this class implements interface countable returns the number of records in this collection
Doctrine_Collection::delete()
delete
Doctrine_Collection::get()
get returns a record for given key
Doctrine_Collection::getData()
getData returns all the records as an array
Doctrine_Collection::getDeleteDiff()
Doctrine_Collection::getFirst()
getFirst returns the first record in the collection
Doctrine_Collection::getInsertDiff()
Doctrine_Collection::getIterator()
getIterator
Doctrine_Collection::getKeyColumn()
getKeyColumn returns the name of the key column
Doctrine_Collection::getKeys()
returns all keys
Doctrine_Collection::getLast()
getLast returns the last record in the collection
Doctrine_Collection::getNormalIterator()
getNormalIterator returns normal iterator - an iterator that will not expand this collection
Doctrine_Collection::getPrimaryKeys()
Doctrine_Collection::getReference()
getReference
Doctrine_Collection::getSnapshot()
getSnapshot returns the data of the last snapshot
Doctrine_Collection::getTable()
getTable returns the table this collection belongs to
Doctrine_Collection::initNullObject()
initNullObject initializes the null object for this collection
Doctrine_Collection::loadRelated()
loadRelated
Doctrine_Collection::populateRelated()
populateRelated
Doctrine_Collection::processDiff()
processDiff processes the difference of the last snapshot and the current data
Doctrine_Collection::remove()
remove removes a specified collection element
Doctrine_Collection::save()
save saves all records of this collection and processes the difference of the last snapshot and the current data
Doctrine_Collection::search()
Doctrine_Collection::serialize()
this method is automatically called when this Doctrine_Collection is serialized
Doctrine_Collection::set()
set
Doctrine_Collection::setData()
setData
Doctrine_Collection::setKeyColumn()
setKeyColumn sets the key column for this collection
Doctrine_Collection::setReference()
setReference sets a reference pointer
Doctrine_Collection::takeSnapshot()
takeSnapshot takes a snapshot from this collection
Doctrine_Collection::toArray()
toArray Mimics the result of a $query->execute(array(), Doctrine::FETCH_ARRAY);
Doctrine_Collection::unserialize()
unseralize this method is automatically called everytime a Doctrine_Collection object is unserialized
Doctrine_Collection::__toString()
returns a string representation of this object

Inherited From Doctrine_Access

Doctrine_Access::offsetExists()
Doctrine_Access::offsetGet()
offsetGet an alias of get()
Doctrine_Access::offsetSet()
sets $offset to $value
Doctrine_Access::offsetUnset()
unset a given offset
Doctrine_Access::setArray()
setArray
Doctrine_Access::__get()
__get -- an alias of get()
Doctrine_Access::__isset()
__isset()
Doctrine_Access::__set()
__set an alias of set()
Doctrine_Access::__unset()
__unset()

Inherited From Doctrine_Object

Doctrine_Object::getNullObject()
getNullObject returns the null object associated with this object
Doctrine_Object::initNullObject()
initNullObject initializes the null object

[ Top ]
Property Summary
integer   $limit  

[ Top ]
Method Summary
Doctrine_Collection_Offset   __construct()  
Doctrine_Collection_Iterator_Expandable   getIterator()  
integer   getLimit()  

[ Top ]
Properties
integer   $limit [line 39]
API Tags:
Access:  private


[ Top ]
Methods
Constructor __construct  [line 43]

  Doctrine_Collection_Offset __construct( Doctrine_Table $table  )

Parameters:
Doctrine_Table   $table: 

API Tags:
Access:  public


Redefinition of:
Doctrine_Collection::__construct()
constructor

[ Top ]
getIterator  [line 58]


API Tags:
Access:  public


Redefinition of:
Doctrine_Collection::getIterator()
getIterator

[ Top ]
getLimit  [line 51]

  integer getLimit( )


API Tags:
Access:  public


[ Top ]