Files
business-data-fetcher/docs.md
Ismo Vuorinen aa6786981a feat: parser now writes, added missing fields
updated docs, example, extensive use of Traits with better handling.
valid level 9 phpstan codebase.
2024-08-18 18:23:05 +03:00

8.1 KiB

Table of contents


Class: \Ivuorinen\BusinessDataFetcher\BusinessDataFetcher

Fetches and returns business data from avoindata

Visibility Function
public __construct() : void
BusinessDataFetcher constructor.
public getBusinessInformation(\string $businessId) : array
Fetch Business Information.
public parseResponse(\Psr\Http\Message\ResponseInterface $response) : array
Parse the response from the API.

Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyName

Company Name

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyForm

Company Form

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyBusinessIdChange

Company Business Id Change

Visibility Function
public getChangeString() : string
Get the description string of the change.
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisAddress

Address

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyBusinessLine

Company Business Line

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyLanguage

Company Language

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyRegisteredEntry

Company Registered Entry

Visibility Function
public getAuthorityString() : string
Get the name of the authority.
public getLanguageString() : string
Get the language code as a string.
public getRegisterString() : string
Get the name of the register.

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyLiquidation

Company Liquidation

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyRegisteredOffice

Company Registered Office

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyDetails

Company Details

Visibility Function

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Dto\BisCompanyContactDetail

Company Contact Detail

Visibility Function
public getLanguageString() : string
Get the language code as a string.
public getSourceText() : string

This class extends \Spatie\DataTransferObject\DataTransferObject


Class: \Ivuorinen\BusinessDataFetcher\Exceptions\UnexpectedValueException

Visibility Function

This class extends \Exception

This class implements \Throwable, \Stringable


Class: \Ivuorinen\BusinessDataFetcher\Exceptions\ApiResponseErrorException

Visibility Function

This class extends \Exception

This class implements \Throwable, \Stringable