\Iqrf\Repository\ModelsCompanyManager

Company manager

Summary

Methods
Properties
Constants
__construct()
list()
get()
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

ApiClient — JSON API client

Methods

__construct()

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

Constructor

Parameters

\Iqrf\Repository\Utils\ApiClient $apiClient

JSON API client

Returns

mixed —

list()

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

Lists all companies

Throws

\Iqrf\Repository\Exceptions\CorruptedData
\Iqrf\Repository\Exceptions\ServiceUnavailable

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\CompanyNotFound
\Iqrf\Repository\Exceptions\CorruptedData
\Iqrf\Repository\Exceptions\ServiceUnavailable

Returns

\Iqrf\Repository\Entities\Company —

Company