dmBridge PHP API
DMHTTPRepresentation Class Reference

Public Member Functions


Detailed Description


Member Function Documentation

DMHTTPRepresentation::__toString ( )
Returns:
string String representation of the representation body.

Definition at line 33 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::addFormData ( key,
value 
)

Adds form data (encoding it automatically) and sets the media type to application/x-www-form-urlencoded.

Multiple identical keys can be added.

Parameters:
stringkey
stringvalue
See also:
setFormData()

Definition at line 79 of file DMHTTPRepresentation.php.

Referenced by setFormData().

DMHTTPRepresentation::getBody ( )

Returns the body as its original type.

Returns:
mixed

Definition at line 42 of file DMHTTPRepresentation.php.

Referenced by __toString().

DMHTTPRepresentation::getCharacterSet ( )
Returns:
string

Definition at line 59 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::getFormData ( )
Returns:
Array of arrays with "key" and "value" keys
See also:
getFormValue()
getFormValues()
getFormDataAsString()

Definition at line 94 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::getFormDataAsString ( )
Returns:
string URL-encoded form data
See also:
getFormData()
getFormValue()
getFormValues()

Definition at line 124 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::getFormValue ( key)
Parameters:
stringkey
Returns:
string The first form value matching $key.
See also:
getFormValues()
getFormData()
getFormDataAsString()

Definition at line 139 of file DMHTTPRepresentation.php.

Referenced by DMTEObjectController::view().

DMHTTPRepresentation::getFormValues ( key)
Parameters:
stringkey
Returns:
array Array of all form values matching $key.
See also:
getFormValue()
getFormData()
getFormDataAsString()

Definition at line 155 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::getMediaType ( )
Returns:
DMMediaType
Since:
0.3

Definition at line 176 of file DMHTTPRepresentation.php.

Referenced by DMTEObjectController::compoundSearch(), and DMTEObjectController::view().

DMHTTPRepresentation::setBody ( body)

Sets the body.

To set a file on disk as the body, supply a DMFile. To set a shell command as the body, supply a DMShellCommand.

Parameters:
mixedbody

Definition at line 52 of file DMHTTPRepresentation.php.

Referenced by DMTEObjectController::compoundSearch(), and DMTEObjectController::view().

DMHTTPRepresentation::setCharacterSet ( character_set)
Parameters:
stringcharacter_set

Definition at line 66 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::setFormData ( key,
value 
)

Adds form data (encoding it automatically) and sets the media type to application/x-www-form-urlencoded.

Existing keys matching $key will be deleted and then $key and $value will be added as a a new key-value pair.

Parameters:
stringkey
stringvalue
See also:
addFormData()

Definition at line 108 of file DMHTTPRepresentation.php.

DMHTTPRepresentation::setMediaType ( DMMediaType type)
Parameters:
DMMediaTypetype
Since:
0.3

Definition at line 184 of file DMHTTPRepresentation.php.

Referenced by addFormData().


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables