stackforge/openstack-sdk-php
Code Issues Proposed changes

Updated code documentation.

Browse Source
This commit is contained in:
Matt Butcher
2012-01-11 11:09:31 -06:00
parent ffd57ff5ba
commit 3d5b3d8185
3 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/HPCloud/Storage/ObjectStorage.php
View File

@@ -43,6 +43,11 @@ use HPCloud\Storage\ObjectStorage\Container;
*/ */
class ObjectStorage { class ObjectStorage {
const ACL_PRIVATE = 'private';
const ACL_PUBLIC_READ = 'public-read';
const ACL_PUBLIC_WRITE = 'public-write';
const ACL_PUBLIC_READ_WRITE = 'public-read-write';
/** /**
* Create a new instance after getting an authenitcation token. * Create a new instance after getting an authenitcation token.

2
src/HPCloud/Storage/ObjectStorage/Container.php
View File

@@ -47,6 +47,8 @@ namespace HPCloud\Storage\ObjectStorage;
* *
* Once you have a Container, you manipulate objects inside of the * Once you have a Container, you manipulate objects inside of the
* container. * container.
*
* @todo Add support for container metadata.
*/ */
class Container implements \Countable, \IteratorAggregate { class Container implements \Countable, \IteratorAggregate {
/** /**

20
src/HPCloud/Storage/ObjectStorage/Object.php
View File

@@ -97,17 +97,25 @@ class Object {
* OpenStack normalizes the name to begin with uppercase, it is * OpenStack normalizes the name to begin with uppercase, it is
* suggested that you follow this convetion: Foo, not foo. Or you * suggested that you follow this convetion: Foo, not foo. Or you
* can do your own normalizing (such as converting all to lowercase. * can do your own normalizing (such as converting all to lowercase.
* OpenStack limits the name length to 126 unicode chars.
* - values must be encoded if they contain newlines or binary data. * - values must be encoded if they contain newlines or binary data.
* While the exact encoding is up to you, Base-64 encoding is probably * While the exact encoding is up to you, Base-64 encoding is probably
* your best bet. * your best bet. OpenStack limits the value to 256 unicode chars.
*
* (The docs are ambiguous -- they say chars, but they may mean
* bytes.)
* *
* This library does only minimal processing of metadata, and does no * This library does only minimal processing of metadata, and does no
* error checking, escaping, etc. This is up to the implementor. * error checking, escaping, etc. This is up to the implementor. The
* OpenStack Swift implementation does not dictate what encoding is
* used, though it suggests url encoding of both name and values.
* *
* IMPORTANT: Current versions of OpenStack Swift see the names FOO, * Currently, no length checking is performed in the library, nor is
* Foo, foo, and fOo as the same. This is not to say that it is case * any encoding of the data performed.
* insensitive; only that it normalizes strings according to its own *
* rules. * IMPORTANT: Current versions of OpenStack Swift normalize metadata
* names so that the name is always given an initial capital leter.
* That is, `foo` becomes `Foo`.
* *
* @param array $array * @param array $array
* An associative array of metadata names to values. * An associative array of metadata names to values.