Class: Services_Amazon_S3_Prefix

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

Class Overview

Services_Amazon_S3_Prefix represents a key prefix used for listing a subset of objects in a bucket.

Author(s):

Christian Schmidt <chsc at peytz.dk>

Version:

Release: @release-version@

Copyright:

2008 Peytz & Co. A/S

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 67]
Services_Amazon_S3_Prefix represents a key prefix used for listing a subset of objects in a bucket.

Author: Christian Schmidt <chsc@peytz.dk>
Version: Release: @release-version@
Copyright: 2008 Peytz & Co. A/S
Link: http://pear.php.net/package/Services_Amazon_S3
License: BSD

[ Top ]

Class Variables

$bucket =

[line 75]

The bucket containing this prefix.

Access: public

Type:

Services_Amazon_S3

[ Top ]

$delimiter = false

[line 88]

This delimiter used when listing objects, or false if no delimiter is used.

Access: public

Type:

string|bool

[ Top ]

$prefix =

[line 81]

This common prefix used by this

Var: UTF-8 encoded prefix
Access: public

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 100]

Services_Amazon_S3_Prefix __construct(
Services_Amazon_S3_Resource_Bucket
$bucket, string
$prefix)

Constructor.

Access: public

Parameters:

Services_Amazon_S3_Resource_Bucket	`$bucket`	—	the bucket containing this prefix
string	`$prefix`	—	the prefix string (UTF-8)

[ Top ]

getObjects [line 117]

Services_Amazon_S3_ObjectIterator getObjects(
)

Returns an iterator over objects whose key starting with this common prefix.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]