PHP Class VCR\Cassette

Afficher le fichier Open project: php-vcr/php-vcr Class Usage Examples

Protected Properties

Свойство Type Description
$config Configuration VCR configuration.
$name string Casette name
$storage VCR\Storage\Storage Storage used to store records and request pairs.

Méthodes publiques

Méthode Description
__construct ( string $name, Configuration $config, VCR\Storage\Storage $storage ) Creates a new cassette.
getName ( ) : string Returns the name of the current cassette.
hasResponse ( Request $request ) : boolean Returns true if a response was recorded for specified request.
isNew ( ) : boolean Returns true if the cassette was created recently.
playback ( Request $request ) : Response | null Returns a response for given request or null if not found.
record ( Request $request, Response $response ) : void Records a request and response pair.

Méthodes protégées

Méthode Description
getRequestMatchers ( ) : array Returns a list of callbacks to configured request matchers.

Method Details

__construct() public méthode

Creates a new cassette.
public __construct ( string $name, Configuration $config, VCR\Storage\Storage $storage )
$name string Name of the cassette.
$config Configuration Configuration to use for this cassette.
$storage VCR\Storage\Storage Storage to use for requests and responses.

getName() public méthode

Returns the name of the current cassette.
public getName ( ) : string
Résultat string Current cassette name.

getRequestMatchers() protected méthode

Returns a list of callbacks to configured request matchers.
protected getRequestMatchers ( ) : array
Résultat array List of callbacks to configured request matchers.

hasResponse() public méthode

Returns true if a response was recorded for specified request.
public hasResponse ( Request $request ) : boolean
$request Request Request to check if it was recorded.
Résultat boolean True if a response was recorded for specified request.

isNew() public méthode

Returns true if the cassette was created recently.
public isNew ( ) : boolean
Résultat boolean

playback() public méthode

Returns a response for given request or null if not found.
public playback ( Request $request ) : Response | null
$request Request Request.
Résultat Response | null Response for specified request.

record() public méthode

Records a request and response pair.
public record ( Request $request, Response $response ) : void
$request Request Request to record.
$response Response Response to record.
Résultat void

Property Details

$config protected_oe property

VCR configuration.
protected Configuration,vcr $config
Résultat Configuration

$name protected_oe property

Casette name
protected string $name
Résultat string

$storage protected_oe property

Storage used to store records and request pairs.
protected Storage,VCR\Storage $storage
Résultat VCR\Storage\Storage