Docs For Class SimpleEncoding

Description

Bundle of GET/POST parameters. Can include repeated parameters.

Direct descendents

Class	Description
SimpleGetEncoding	Bundle of GET parameters. Can include repeated parameters.
SimplePostEncoding	Bundle of POST parameters. Can include repeated parameters.

Variable Summary

mixed $_request

Method Summary

SimpleEncoding SimpleEncoding ([array $query = false])

void add (string $key, string/array $value)

void attach (string $key, string $content, hash $filename)

void clear ()

array getAll ()

string/array getValue ( $key)

void merge (array/SimpleQueryString $query)

string _encode ()

Variables

mixed $_request (line 192)

Methods

Constructor SimpleEncoding (line 201)

Starts empty.

access: public

SimpleEncoding SimpleEncoding ([array $query = false])

array $query: Hash of parameters. Multiple values are as lists on a single key.

add (line 223)

Adds a parameter to the query.

access: public

void add (string $key, string/array $value)

string $key: Key to add value to.
string/array $value: New data.

attach (line 254)

Adds a MIME part to the query. Does nothing for a form encoded packet.

access: public

void attach (string $key, string $content, hash $filename)

string $key: Key to add value to.
string $content: Raw data.
hash $filename: Original filename.

clear (line 213)

Empties the request of parameters.

access: public

void clear ()

getAll (line 302)

Accessor for listing of pairs.

return: All pair objects.
access: public

array getAll ()

getValue (line 281)

Accessor for single value.

return: False if missing, string if present and array if multiple entries.
access: public

string/array getValue ( $key)

$key

merge (line 264)

Adds a set of parameters to this query.

access: public

void merge (array/SimpleQueryString $query)

array/SimpleQueryString $query: Multiple values are as lists on a single key.

_encode (line 312)

Renders the query string as a URL encoded request part.

return: Part of URL.
access: protected

string _encode ()

Redefined in descendants as:

SimpleMultipartEncoding::_encode() : Renders the query string as a URL encoded request part.