Class: GalleryRemoteProperties

Source Location: /modules/remote/classes/GalleryRemoteProperties.class

Class GalleryRemoteProperties

Class Overview

This class partially mirrors the functionality of the java class java.util.Properties.

Located in /modules/remote/classes/GalleryRemoteProperties.class [line 33]

Properties

$_map

Methods

[ Top ]

Property Summary

mixed

$_map

Our internal hash map

[ Top ]

Method Summary

GalleryRemoteProperties	GalleryRemoteProperties()
mixed	getProperty()	Retrieve a property, or null/given default if it doesn't exist
boolean	hasProperty()	Return true if the key exists in the properties map
string	listProperties()	Export the properties according to the Gallery Remote Protocol 2.0 data format
void	setProperty()	Store a key/value property. Overwrite any existing property by the same name. Ignore null keys. Normalize and escape line endings (\n, \r\n and \r all become \\n)

[ Top ]

Properties

mixed $_map [line 38]

Our internal hash map

API Tags:

Access:

private

[ Top ]

Methods

Constructor GalleryRemoteProperties [line 40]

GalleryRemoteProperties GalleryRemoteProperties(
)

[ Top ]

getProperty [line 50]

mixed getProperty(
string
$key, [mixed
$defaultValue = null] 
)

Retrieve a property, or null/given default if it doesn't exist

Parameters:

string	$key:
mixed	$defaultValue:

API Tags:

Return:

the actual value

[ Top ]

hasProperty [line 63]

boolean hasProperty(
string
$key 
)

Return true if the key exists in the properties map

Parameters:

string

$key:

API Tags:

Return:

true if it exists

[ Top ]

listProperties [line 72]

string listProperties(
)

Export the properties according to the Gallery Remote Protocol 2.0 data format

API Tags:

Return:

the exported properties

[ Top ]

setProperty [line 89]

void setProperty(
string
$key, string
$value 
)

Store a key/value property. Overwrite any existing property by the same name. Ignore null keys. Normalize and escape line endings (\n, \r\n and \r all become \\n)

Parameters:

string	$key:
string	$value:

[ Top ]

Documentation generated on Sat, 21 Nov 2009 04:49:01 -0800 by phpDocumentor 1.3.0RC6

	Remote Classes

[ class tree: Remote ] [ index: Remote ] [ all elements ]