PHP Класс RestContext

Наследование: extends Behat\Behat\Context\BehatContext
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$access_token string Client access_token
$associative boolean Specifies if the response data should be an associative array or a nested stdClass object hierarchy.
$client Buzz\Browser
$collectedData string Data collected from steps
$headers array Headers
$locations array Locations collected from steps
$requestMethod string
$requestUrl string Used for debugging purpose only.
$response Buzz\Message\Response
$responseData mixed Data decoded from HTTP response.
$responseDecodeException Exception
$responseIsJson boolean

Открытые методы

Метод Описание
__construct ( array $parameters ) Initializes context.
authenitcatedAsWithClient ( string $username, string $password, string $client, $secret ) : void
authenitcatedWith ( $client, $secret ) : void
checkItemsOrder ( string $order ) : void
collectData ( $dataKey, Behat\Gherkin\Node\TableNode $data ) : void
collectFakeData ( string $dataKey, Behat\Gherkin\Node\TableNode $data ) : boolean
collectHeaders ( $key, $value ) : void
collectLocations ( $locationIndex ) : boolean
echoLastResponse ( ) : void
fieldIsOfTypeWithValue ( string $fieldName, string $type, string $fieldValue ) : void
getResponse ( ) : Guzzle\Http\Message\Response Return the response object.
getResponseData ( ) : mixed Return the response data.
iRequest ( string $pageUrl ) : void
iSubmitDataTo ( $dataKey, string $pageUrl ) : void
processPageUrl ( $pageUrl )
processResponse ( Buzz\Message\Response $response = null, boolean $asJson = true ) : void This public method is also for other context(s) to process REST API call and inject response into this context.
saveFieldValueUnderLocation ( string $fieldName, string $locationIndex ) : Behat\Behat\Context\Step\Then | void
thatIWantToDelete ( ) : void
thatIWantToFind ( ) : void
thatIWantToLink ( ) : void
thatIWantToMakeANew ( ) : void
thatIWantToUnlink ( ) : void
thatIWantToUpdate ( ) : void
theResponseHasAField ( string $name ) : void
theResponseIsJson ( string $notJson = '' ) : void
theResponseShouldBe ( string $string ) : void
theResponseShouldContain ( string $str ) : void
theResponseShouldNotHaveAField ( string $name ) : void
theResponseStatusCodeShouldBe ( integer $httpStatus ) : void
valueOfTheFieldEquals ( string $fieldName, string $fieldValue ) : void

Защищенные методы

Метод Описание
decodeJson ( string $string ) : mixed Decode JSON string.
processResponseBody ( string $jsonData, boolean $asJson = true ) : void Process response body. This method may also be used by other context(s) to process REST API call and inject response body into this context by using 2nd parameter $asJson.

Приватные методы

Метод Описание
extractValueByGivenLocation ( $fieldValue )

Описание методов

__construct() публичный Метод

Every scenario gets it's own context object.
public __construct ( array $parameters )
$parameters array Context parameters (set them up through behat.yml)

authenitcatedAsWithClient() публичный Метод

public authenitcatedAsWithClient ( string $username, string $password, string $client, $secret ) : void
$username string
$password string
$client string
Результат void

authenitcatedWith() публичный Метод

public authenitcatedWith ( $client, $secret ) : void
Результат void

checkItemsOrder() публичный Метод

public checkItemsOrder ( string $order ) : void
$order string
Результат void

collectData() публичный Метод

public collectData ( $dataKey, Behat\Gherkin\Node\TableNode $data ) : void
$data Behat\Gherkin\Node\TableNode
Результат void

collectFakeData() публичный Метод

public collectFakeData ( string $dataKey, Behat\Gherkin\Node\TableNode $data ) : boolean
$dataKey string
$data Behat\Gherkin\Node\TableNode
Результат boolean

collectHeaders() публичный Метод

public collectHeaders ( $key, $value ) : void
Результат void

collectLocations() публичный Метод

public collectLocations ( $locationIndex ) : boolean
Результат boolean

decodeJson() защищенный Метод

Decode JSON string.
См. также: http://www.php.net/json_last_error
protected decodeJson ( string $string ) : mixed
$string string A JSON string.
Результат mixed

echoLastResponse() публичный Метод

public echoLastResponse ( ) : void
Результат void

fieldIsOfTypeWithValue() публичный Метод

public fieldIsOfTypeWithValue ( string $fieldName, string $type, string $fieldValue ) : void
$fieldName string
$type string
$fieldValue string
Результат void

getResponse() публичный Метод

This public method is also for other context(s) to get and process REST API response.
public getResponse ( ) : Guzzle\Http\Message\Response
Результат Guzzle\Http\Message\Response

getResponseData() публичный Метод

This public method is also for other context(s) to get and process REST API response.
public getResponseData ( ) : mixed
Результат mixed

iRequest() публичный Метод

public iRequest ( string $pageUrl ) : void
$pageUrl string
Результат void

iSubmitDataTo() публичный Метод

public iSubmitDataTo ( $dataKey, string $pageUrl ) : void
$pageUrl string
Результат void

processPageUrl() публичный Метод

public processPageUrl ( $pageUrl )

processResponse() публичный Метод

This public method is also for other context(s) to process REST API call and inject response into this context.
public processResponse ( Buzz\Message\Response $response = null, boolean $asJson = true ) : void
$response Buzz\Message\Response
$asJson boolean Process the response as JSON or not.
Результат void

processResponseBody() защищенный Метод

Process response body. This method may also be used by other context(s) to process REST API call and inject response body into this context by using 2nd parameter $asJson.
protected processResponseBody ( string $jsonData, boolean $asJson = true ) : void
$jsonData string
$asJson boolean
Результат void

saveFieldValueUnderLocation() публичный Метод

public saveFieldValueUnderLocation ( string $fieldName, string $locationIndex ) : Behat\Behat\Context\Step\Then | void
$fieldName string
$locationIndex string
Результат Behat\Behat\Context\Step\Then | void

thatIWantToDelete() публичный Метод

public thatIWantToDelete ( ) : void
Результат void

thatIWantToFind() публичный Метод

public thatIWantToFind ( ) : void
Результат void

thatIWantToMakeANew() публичный Метод

public thatIWantToMakeANew ( ) : void
Результат void

thatIWantToUpdate() публичный Метод

public thatIWantToUpdate ( ) : void
Результат void

theResponseHasAField() публичный Метод

public theResponseHasAField ( string $name ) : void
$name string
Результат void

theResponseIsJson() публичный Метод

public theResponseIsJson ( string $notJson = '' ) : void
$notJson string
Результат void

theResponseShouldBe() публичный Метод

public theResponseShouldBe ( string $string ) : void
$string string
Результат void

theResponseShouldContain() публичный Метод

public theResponseShouldContain ( string $str ) : void
$str string
Результат void

theResponseShouldNotHaveAField() публичный Метод

public theResponseShouldNotHaveAField ( string $name ) : void
$name string
Результат void

theResponseStatusCodeShouldBe() публичный Метод

public theResponseStatusCodeShouldBe ( integer $httpStatus ) : void
$httpStatus integer
Результат void

valueOfTheFieldEquals() публичный Метод

public valueOfTheFieldEquals ( string $fieldName, string $fieldValue ) : void
$fieldName string
$fieldValue string
Результат void

Описание свойств

$access_token защищенное свойство

Client access_token
protected string $access_token
Результат string

$associative защищенное свойство

Specifies if the response data should be an associative array or a nested stdClass object hierarchy.
protected bool $associative
Результат boolean

$client защищенное свойство

protected Browser,Buzz $client
Результат Buzz\Browser

$collectedData защищенное свойство

Data collected from steps
protected string $collectedData
Результат string

$headers защищенное свойство

Headers
protected array $headers
Результат array

$locations защищенное свойство

Locations collected from steps
protected array $locations
Результат array

$requestMethod защищенное свойство

protected string $requestMethod
Результат string

$requestUrl защищенное свойство

Used for debugging purpose only.
protected string $requestUrl
Результат string

$response защищенное свойство

protected Response,Buzz\Message $response
Результат Buzz\Message\Response

$responseData защищенное свойство

Data decoded from HTTP response.
protected mixed $responseData
Результат mixed

$responseDecodeException защищенное свойство

protected Exception $responseDecodeException
Результат Exception

$responseIsJson защищенное свойство

protected bool $responseIsJson
Результат boolean