IQRF Repository integration
\
Iqrf
Repository
DI
Entities
Enums
Exceptions
Models
Utils

\Iqrf\Repository\ModelsCompanyManager

Company manager

Summary

Methods
Properties
Constants
list()
get()
__construct()
No public properties found
PATH
No protected methods found
$apiClient
N/A
No private methods found
No private properties found
N/A

Constants

PATH

PATH = 'companies'

Companies path

Properties

$apiClient

$apiClient : \Iqrf\Repository\Utils\ApiClient

Type

\Iqrf\Repository\Utils\ApiClient

Methods

list()

list() : \Iqrf\Repository\Entities\Company[]

Lists all companies

Throws

\Iqrf\Repository\Exceptions\CorruptedData

Corrupted data in the API response

\Iqrf\Repository\Exceptions\ServiceUnavailable

IQRF Repository API is unavailable

Returns

\Iqrf\Repository\Entities\Company[] —

All companies

get()

get(int  $id) : \Iqrf\Repository\Entities\Company

Returns the company by its ID

Parameters

int $id

Company ID

Throws

\Iqrf\Repository\Exceptions\CorruptedData

Corrupted data in the API response

\Iqrf\Repository\Exceptions\CompanyNotFound

Requested company not found

\Iqrf\Repository\Exceptions\ServiceUnavailable

IQRF Repository API is unavailable

Returns

\Iqrf\Repository\Entities\Company —

Company

__construct()

__construct(\Iqrf\Repository\Utils\ApiClient  $apiClient) : mixed

Constructor

Parameters

\Iqrf\Repository\Utils\ApiClient $apiClient

JSON API client

Returns

mixed —