Documentation

PutTrait

Trait PutTrait

Table of Contents

Methods

createApiKey()  : string
Create an API key
buildPropertyMapArray()  : array<string|int, mixed>
Using the passed propertyMap, recursively build array
request()  : ResponseInterface
Request the URI with options
uri()  : string
Construct URI with version number
put()  : string
Execute a PUT request via REST client

Methods

createApiKey()

Create an API key

public createApiKey() : string
Return values
string

buildPropertyMapArray()

Using the passed propertyMap, recursively build array

protected abstract buildPropertyMapArray(array<string|int, mixed> $array, AbstractPropertyMap $propertyMap) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>

Array

$propertyMap : AbstractPropertyMap

PropertyMap

Return values
array<string|int, mixed>

request()

Request the URI with options

protected abstract request(string $method, string $uri, array<string|int, mixed> $options) : ResponseInterface
Parameters
$method : string

HTTP method

$uri : string

URI

$options : array<string|int, mixed>

Options

Return values
ResponseInterface

uri()

Construct URI with version number

protected abstract uri(string $uri) : string
Parameters
$uri : string

URI

Return values
string

put()

Execute a PUT request via REST client

private put(string $uri[, array<string|int, array<string|int, mixed>> $query = [] ][, mixed $json = '' ][, int $statusCode = 0 ]) : string
Parameters
$uri : string

URI

$query : array<string|int, array<string|int, mixed>> = []

Query

$json : mixed = ''

JSON

$statusCode : int = 0

Required HTTP status code for response

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results