Class SimpleEncoding

Description

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

Located in /encoding.php (line 191)


	
			
Direct descendents
Class Description
 class SimpleGetEncoding Bundle of GET parameters. Can include repeated parameters.
 class SimpleEntityEncoding Bundles an entity-body for transporting a raw content payload with the request.
Method Summary
 SimpleEncoding __construct ([array $query = false])
 void add (string $key, string/array $value)
 void addPair (string $key, string/array $value)
 void attach (string $key, string $content, hash $filename)
 void clear ()
 string encode ()
 array getAll ()
 string/array getValue ( $key)
 void merge (array/SimpleQueryString $query)
Methods
Constructor __construct (line 201)

Starts empty.

  • access: public
SimpleEncoding __construct ([array $query = false])
  • array $query: Hash of parameters. Multiple values are as lists on a single key.

Redefined in descendants as:
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.
addPair (line 242)

Adds a new value into the request.

  • access: protected
void addPair (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 ()
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:
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.

Documentation generated on Sun, 31 Oct 2010 16:31:20 -0500 by phpDocumentor 1.4.3