eZPublishCommunityProject  2012.12
eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator Class Reference

Authenticator used in integration tests. More...

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

Public Member Functions

 __construct (HttpClient $innerClient, $userId=14)
 Creates a new Integration Test Authenticator. More...
 
 request ($method, $path, Message $message=null)
 Execute a HTTP request to the remote server. More...
 
 setSession ($id)
 Set the session ID to use. More...
 
 setUserId ($userId)
 Sets the user ID submitted to the server. More...
 

Protected Attributes

 $innerClient
 
 $sessionId
 
 $userId
 

Detailed Description

Authenticator used in integration tests.

Note: DO NOT USE THIS IN PRODUCTION.

Constructor & Destructor Documentation

eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator::__construct ( HttpClient  $innerClient,
  $userId = 14 
)

Creates a new Integration Test Authenticator.

Parameters
\eZ\Publish\Core\REST\Client\HttpClient$innerClient
mixed$userId

Member Function Documentation

eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator::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.

eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator::setSession (   $id)

Set the session ID to use.

Parameters
string$id

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

eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator::setUserId (   $userId)

Sets the user ID submitted to the server.

Parameters
mixed$userId

Member Data Documentation

eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator::$innerClient
protected
eZ\Publish\Core\REST\Client\HttpClient\Authentication\IntegrationTestAuthenticator::$sessionId
protected

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