Class: Services_Amazon_S3_ObjectIterator

Source Location: /Services_Amazon_S3-0.4.0/Services/Amazon/S3/ObjectIterator.php

Class Overview

Services_Amazon_S3_ObjectIterator is used for iterating over objects in a bucket. It implements Iterator and can thus be used in a foreach loop:

foreach ($bucket->getObjects() as $object) {

Author(s):

Christian Schmidt <services.amazon.s3 at chsc.dk>

Version:

Release: @release-version@

Copyright:

2008-2009 Peytz & Co. A/S

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 68]
Services_Amazon_S3_ObjectIterator is used for iterating over objects in a bucket. It implements Iterator and can thus be used in a foreach loop:

foreach ($bucket->getObjects() as $object) {

Author: Christian Schmidt <services.amazon.s3@chsc.dk>
Version: Release: @release-version@
Copyright: 2008-2009 Peytz & Co. A/S
See: Services_Amazon_S3_Resource_Bucket::getObjects()
Link: http://pear.php.net/package/Services_Amazon_S3
License: BSD

[ Top ]

Class Variables

$bucket =

[line 76]

The bucket to search.

Access: public

Type:

Services_Amazon_S3_Resource_Bucket

[ Top ]

$delimiter = false

[line 90]

If specified, keys that contain this string after the prefix are rolled up into a single Services_Amazon_S3_Prefix instance.

Var: a delimiter, or false
Access: public

Type:

string|bool

[ Top ]

$maxKeys =

[line 100]

Maximum number of keys to fetch per request. A low value will result in more requests to the server. This value is initialized from $this->s3->maxKeys.

Var: a positive integer, or false to let the server decide the limit
See: Services_Amazon_S3::$maxKeys
Access: public

Type:

int|false

[ Top ]

$prefix = false

[line 83]

If specified, only objects whose keys begin with this string are returned.

Var: a prefix, or false
Access: public

Type:

string|bool

[ Top ]

Method Detail

__construct (Constructor) [line 158]

Services_Amazon_S3_ObjectIterator __construct(
Services_Amazon_S3_Resource_Bucket
$bucket)

Constructor. This is called from Services_Amazon_S3_Resource_Bucket::getObjects().

Access: public

Parameters:

Services_Amazon_S3_Resource_Bucket $bucket — bucket to iterate over

[ Top ]

current [line 172]

Services_Amazon_S3_Resource_Object current(
)

Returns the current iterator value.

Access: public

[ Top ]

getChildren [line 219]

Services_Amazon_S3_ObjectIterator getChildren(
)

Returns an iterator over objects whose key starting with the common prefix represented by this iterator's current key.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

hasChildren [line 204]

string hasChildren(
)

Returns whether the current key represents a common prefix.

Access: public

[ Top ]

key [line 185]

string key(
)

Returns the key of the current iterator value.

Access: public

[ Top ]

next [line 272]

void next(
)

Advances the internal iterator pointer.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

rewind [line 235]

void rewind(
)

Resets the internal iterator pointer.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

valid [line 256]

bool valid(
)

Returns whether the internal iterator pointer points to an existing value.

Access: public

[ Top ]