Skip to content

Box DataObjectCollection

Travis edited this page Mar 13, 2014 · 9 revisions

Box\DataObjectCollection

DataObjectCollection

  • Class name: DataObjectCollection
  • Namespace: Box
  • This class implements: IteratorAggregate, Countable

Properties

$_dataObjects

private \Box\DataObjectInterface[] $_dataObjects = array()
  • Visibility: private

$_type

private \Box\DataObjectInterface $_type
  • Visibility: private

Methods

\Box\DataObjectCollection::__construct()

mixed Box\DataObjectCollection::\Box\DataObjectCollection::__construct()(\Box\DataObjectInterface $type, \Box\DataObjectInterface[] $dataObjects)

Constructor.

  • Visibility: public

Arguments

  • $type Box\DataObjectInterface - <p>Type of data objects this collection may contain.</p>
  • $dataObjects Box\DataObjectInterface[]

\Box\DataObjectCollection::getType()

\Box\DataObjectInterface Box\DataObjectCollection::\Box\DataObjectCollection::getType()()

Get the type of data objects this collection contains.

  • Visibility: public

\Box\DataObjectCollection::getIds()

integer[] Box\DataObjectCollection::\Box\DataObjectCollection::getIds()()

Get ids in this collection. Null ids will be left out.

  • Visibility: public

\Box\DataObjectCollection::add()

\Box\DataObjectCollection Box\DataObjectCollection::\Box\DataObjectCollection::add()(\Box\DataObjectInterface $dataObject)

Add a data object.

  • Visibility: public

Arguments

\Box\DataObjectCollection::addAll()

\Box\DataObjectCollection Box\DataObjectCollection::\Box\DataObjectCollection::addAll()(\Box\DataObjectInterface[] $dataObjects)

Add an array of data objects.

  • Visibility: public

Arguments

  • $dataObjects Box\DataObjectInterface[]

\Box\DataObjectCollection::get()

\Box\DataObjectInterface|null Box\DataObjectCollection::\Box\DataObjectCollection::get()(integer $index)

Get a data object.

  • Visibility: public

Arguments

  • $index integer

\Box\DataObjectCollection::getAll()

\Box\DataObjectInterface[] Box\DataObjectCollection::\Box\DataObjectCollection::getAll()()

Get all data objects.

  • Visibility: public

\Box\DataObjectCollection::getIterator()

\ArrayIterator Box\DataObjectCollection::\Box\DataObjectCollection::getIterator()()

Get an iterator.

  • Visibility: public

\Box\DataObjectCollection::count()

integer Box\DataObjectCollection::\Box\DataObjectCollection::count()()

Count data objects.

  • Visibility: public

Clone this wiki locally