phpDocumentor

BatixService
in package

Table of Contents

DID_BATTERIES  = '134CBB4D101'
DID_IMPRINT  = '1293C20B491'
DID_PAYMENT_AND_SHIPPING_B2B  = '1419BEA3135'
DID_PAYMENT_AND_SHIPPING_B2C  = '12766C58F26'
DID_PRIVACY  = '160DEDA9674'
DID_TOS_B2B  = '14196AFA8F0'
DID_TOS_B2C  = '12766C46A8A'
DID_WITHDRAWAL  = '12766C53647'
DID_WITHDRAWAL_DIGITAL_GOODS  = '1452C24576D'
DID_WITHDRAWAL_SERVICES  = '1463C5DBF05'
ENDPOINT_BATIX_CACHE_DEVELOP  = 'https://develop.legaltext-cache.outlaws.dev-hb.de/cache'
ENDPOINT_BATIX_CACHE_PRODUCTIVE  = 'https://legaltext-cache.haendlerbund.de/cache'
ENDPOINT_BATIX_DEVELOP  = 'https://dev-hb-intern.haendlerbund.de/www/hbm/api/live_rechtstexte.htm'
ENDPOINT_BATIX_PRODUCTIVE  = 'https://www.hb-intern.de/www/hbm/api/live_rechtstexte.htm'
$client  : mixed
$haendlerbundConfigurationFinder  : HaendlerbundConfigurationFinder
__construct()  : mixed
checkDocumentAvailability()  : bool
getApiKey()  : string
getAvailableLanguages()  : array<string|int, mixed>
Returns languages available for a DID.
getDocumentClasses()  : string
getDocumentDefault()  : string
getDocumentHtml()  : string
getDocumentMD5()  : string
getDocumentPlain()  : string
getDocuments()  : array<string|int, mixed>
getDocument()  : string
getEndpoint()  : string
performRequest()  : ResponseInterface

Constants

DID_BATTERIES

public mixed DID_BATTERIES = '134CBB4D101'

DID_PAYMENT_AND_SHIPPING_B2B

public mixed DID_PAYMENT_AND_SHIPPING_B2B = '1419BEA3135'

DID_PAYMENT_AND_SHIPPING_B2C

public mixed DID_PAYMENT_AND_SHIPPING_B2C = '12766C58F26'

DID_WITHDRAWAL

public mixed DID_WITHDRAWAL = '12766C53647'

DID_WITHDRAWAL_DIGITAL_GOODS

public mixed DID_WITHDRAWAL_DIGITAL_GOODS = '1452C24576D'

DID_WITHDRAWAL_SERVICES

public mixed DID_WITHDRAWAL_SERVICES = '1463C5DBF05'

ENDPOINT_BATIX_CACHE_DEVELOP

protected mixed ENDPOINT_BATIX_CACHE_DEVELOP = 'https://develop.legaltext-cache.outlaws.dev-hb.de/cache'

ENDPOINT_BATIX_CACHE_PRODUCTIVE

protected mixed ENDPOINT_BATIX_CACHE_PRODUCTIVE = 'https://legaltext-cache.haendlerbund.de/cache'

ENDPOINT_BATIX_DEVELOP

protected mixed ENDPOINT_BATIX_DEVELOP = 'https://dev-hb-intern.haendlerbund.de/www/hbm/api/live_rechtstexte.htm'

ENDPOINT_BATIX_PRODUCTIVE

protected mixed ENDPOINT_BATIX_PRODUCTIVE = 'https://www.hb-intern.de/www/hbm/api/live_rechtstexte.htm'

Properties

Methods

checkDocumentAvailability()

public checkDocumentAvailability(string $did) : bool
Parameters
$did : string
Tags
throws
BatixServiceException
Return values
bool

getApiKey()

public getApiKey() : string
Return values
string

getAvailableLanguages()

Returns languages available for a DID.

public getAvailableLanguages(string $did) : array<string|int, mixed>

Note that, by convention, German (de) is always available.

Parameters
$did : string
Tags
throws
BatixServiceException
Return values
array<string|int, mixed>

getDocumentClasses()

public getDocumentClasses(string $did[, string $language = 'de' ]) : string
Parameters
$did : string
$language : string = 'de'
Return values
string

getDocumentDefault()

public getDocumentDefault(string $did[, string $language = 'de' ]) : string
Parameters
$did : string
$language : string = 'de'
Return values
string

getDocumentHtml()

public getDocumentHtml(string $did[, string $language = 'de' ]) : string
Parameters
$did : string
$language : string = 'de'
Return values
string

getDocumentMD5()

public getDocumentMD5(string $did[, string $language = 'de' ]) : string
Parameters
$did : string
$language : string = 'de'
Return values
string

getDocumentPlain()

public getDocumentPlain(string $did[, string $language = 'de' ]) : string
Parameters
$did : string
$language : string = 'de'
Return values
string

getDocuments()

public getDocuments([string $language = 'de' ]) : array<string|int, mixed>
Parameters
$language : string = 'de'
Tags
throws
BatixServiceException
Return values
array<string|int, mixed>

getDocument()

protected getDocument(string $did[, string $type = 'default' ][, string $language = 'de' ]) : string
Parameters
$did : string
$type : string = 'default'
$language : string = 'de'
Tags
throws
BatixServiceException
Return values
string

getEndpoint()

protected getEndpoint() : string
Return values
string

performRequest()

protected performRequest(string $mode, string $did[, string $lang = 'de' ]) : ResponseInterface
Parameters
$mode : string
$did : string
$lang : string = 'de'
Tags
throws
BatixServiceException
Return values
ResponseInterface

Search results