eZPublishCommunityProject  2013.4
eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth Class Reference

Interface for Http Client implementations. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth:
+ Collaboration diagram for eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth:

Public Member Functions

 __construct (HttpClient $innerClient, $username, $password)
 Creates a new Basic Auth HTTP client. More...
 
 request ($method, $path, Message $message=null)
 Execute a HTTP request to the remote server. More...
 

Protected Attributes

 $innerClient
 
 $password
 
 $username
 

Detailed Description

Interface for Http Client implementations.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth::__construct ( HttpClient  $innerClient,
  $username,
  $password 
)

Creates a new Basic Auth HTTP client.

Parameters
\eZ\Publish\Core\REST\Client\HttpClient$innerClient
string$username
string$password

Member Function Documentation

eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth::request (   $method,
  $path,
Message  $message = null 
)

Execute a HTTP request to the remote server.

Returns the result from the remote server. The client sets the correct headers for Basic Auth into the $message transmitted to the inner client.

Parameters
string$method
string$path
\eZ\Publish\Core\REST\Common\Message$message
Returns

Implements eZ\Publish\Core\REST\Client\HttpClient.

Member Data Documentation

eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth::$innerClient
protected
eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth::$password
protected
eZ\Publish\Core\REST\Client\HttpClient\Authentication\BasicAuth::$username
protected

The documentation for this class was generated from the following file: