BMLT PHP Query Client

BmltQueryClient
in package

Main entry point for the BMLT PHP Query Client

This class provides factory methods and easy access to the main functionality

Table of Contents

Methods

create()  : BmltClient
Create a new BMLT client instance
createGeocodingService()  : GeocodingService
Create a geocoding service instance
getInfo()  : array<string|int, mixed>
Get library information
getVersion()  : string
Get version information
normalizeRootServerUrl()  : string
Normalize a root server URL
validateRootServerUrl()  : bool
Validate a root server URL

Methods

create()

Create a new BMLT client instance

public static create(string $rootServerUrl[, BmltDataFormat $defaultFormat = BmltDataFormat::JSON ][, int $timeout = 30 ][, string $userAgent = 'bmlt-php-query-client/1.0.0' ][, bool $enableGeocoding = true ][, GeocodingService|null $geocodingService = null ]) : BmltClient
Parameters
$rootServerUrl : string
$defaultFormat : BmltDataFormat = BmltDataFormat::JSON
$timeout : int = 30
$userAgent : string = 'bmlt-php-query-client/1.0.0'
$enableGeocoding : bool = true
$geocodingService : GeocodingService|null = null
Return values
BmltClient

createGeocodingService()

Create a geocoding service instance

public static createGeocodingService([int $timeout = 10 ][, int $retryCount = 3 ][, string $userAgent = 'bmlt-php-query-client/1.0.0' ][, string|null $countryCode = null ][, array<string|int, mixed>|null $viewbox = null ][, bool $bounded = false ]) : GeocodingService
Parameters
$timeout : int = 10
$retryCount : int = 3
$userAgent : string = 'bmlt-php-query-client/1.0.0'
$countryCode : string|null = null
$viewbox : array<string|int, mixed>|null = null
$bounded : bool = false
Return values
GeocodingService

getInfo()

Get library information

public static getInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>

getVersion()

Get version information

public static getVersion() : string
Return values
string

normalizeRootServerUrl()

Normalize a root server URL

public static normalizeRootServerUrl(string $url) : string
Parameters
$url : string
Return values
string

validateRootServerUrl()

Validate a root server URL

public static validateRootServerUrl(string $url) : bool
Parameters
$url : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results