Documentation

VultrClient
in package

Table of Contents

Properties

$account  : AccountService
$applications  : ApplicationService
$backups  : BackupService
$baremetal  : BareMetalService
$billing  : BillingService
$blockstorage  : BlockStorageService
$dns  : DNSService
$firewall  : FirewallService
$instances  : InstanceService
$iso  : ISOService
$kubernetes  : KubernetesService
$loadbalancers  : LoadBalancerService
$objectstorage  : ObjectStorageService
$operating_system  : OperatingSystemService
$plans  : PlanService
$regions  : RegionService
$reserved_ip  : ReservedIPService
$snapshots  : SnapshotService
$ssh_keys  : SSHKeyService
$startup_scripts  : StartupScriptService
$users  : UserService
$vpc  : VPCService
$_account  : AccountService
$_applications  : ApplicationService
$_backups  : BackupService
$_baremetal  : BareMetalService
$_billing  : BillingService
$_blockstorage  : BlockStorageService
$_dns  : DNSService
$_firewall  : FirewallService
$_instances  : InstanceService
$_iso  : ISOService
$_kubernetes  : KubernetesService
$_loadbalancers  : LoadBalancerService
$_objectstorage  : ObjectStorageService
$_operating_system  : OperatingSystemService
$_plans  : PlanService
$_regions  : RegionService
$_reserved_ip  : ReservedIPService
$_snapshots  : SnapshotService
$_ssh_keys  : SSHKeyService
$_startup_scripts  : StartupScriptService
$_users  : UserService
$_vpc  : VPCService
$client  : VultrClientHandler
$service_props  : array<string|int, int>

Methods

__get()  : mixed
Magic method that allows interaction with readonly properties that house service handlers.
create()  : VultrClient
The entry point into using the client and all its related services.
setClient()  : void
setRequestFactory()  : void
setResponseFactory()  : void
setStreamFactory()  : void
setClientHandler()  : void
__construct()  : mixed

Properties

$service_props

private array<string|int, int> $service_props = []

Methods

__get()

Magic method that allows interaction with readonly properties that house service handlers.

public __get(string $name) : mixed

Client will return null if the service object does not exist.

Parameters
$name : string

create()

The entry point into using the client and all its related services.

public static create(string $API_KEY[, ClientInterface|null $http = null ][, RequestFactoryInterface|null $request = null ][, ResponseFactoryInterface|null $response = null ][, StreamFactoryInterface|null $stream = null ]) : VultrClient
Parameters
$API_KEY : string
$http : ClientInterface|null = null
$request : RequestFactoryInterface|null = null
$response : ResponseFactoryInterface|null = null
$stream : StreamFactoryInterface|null = null
Return values
VultrClient

setClient()

public setClient(ClientInterface $http) : void
Parameters
$http : ClientInterface

setRequestFactory()

public setRequestFactory(RequestFactoryInterface $request) : void
Parameters
$request : RequestFactoryInterface

setResponseFactory()

public setResponseFactory(ResponseFactoryInterface $response) : void
Parameters
$response : ResponseFactoryInterface

setStreamFactory()

public setStreamFactory(StreamFactoryInterface $stream) : void
Parameters
$stream : StreamFactoryInterface

setClientHandler()

protected setClientHandler(string $API_KEY[, ClientInterface|null $http = null ][, RequestFactoryInterface|null $request = null ][, ResponseFactoryInterface|null $response = null ][, StreamFactoryInterface|null $stream = null ]) : void
Parameters
$API_KEY : string
$http : ClientInterface|null = null
$request : RequestFactoryInterface|null = null
$response : ResponseFactoryInterface|null = null
$stream : StreamFactoryInterface|null = null

__construct()

private __construct(string $API_KEY[,  $http = null ][,  $request = null ][,  $response = null ][,  $stream = null ]) : mixed
Parameters
$API_KEY : string
$http : = null
  • PSR18 ClientInterface - https://www.php-fig.org/psr/psr-18/
$request : = null
  • PSR17 RequestFactoryInterface - https://www.php-fig.org/psr/psr-17/#21-requestfactoryinterface
$response : = null
  • PSR17 ResponseFactoryInterface - https://www.php-fig.org/psr/psr-17/#22-responsefactoryinterface
$stream : = null
  • PSR17 StreamFactoryInterface - https://www.php-fig.org/psr/psr-17/#22-responsefactoryinterface

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results