App v1.0.0
Фасад библиотеки: init, Client, Cache, Requests discovery.
Описание: Фасад библиотеки: init, Client, Cache, Requests discovery.
Namespace: Devcraft\Webshare\Classes
С версии: 1.0.0
См. также:
Public константы
| Константа | Тип | Описание |
|---|---|---|
API_URL | const | Значение: 'https://proxy.webshare.io/api/'. |
API_VERSION | const | Значение: 'v2'. |
CACHE_LIFETIME | const | Значение: 3600. |
ITERATE_MAX_PAGES | const | Значение: 100. |
Public свойства
| Свойство | Тип | Описание |
|---|---|---|
$debug | bool | Вывод отладочной информации. По умолчанию: false. |
Методы
init(): void
Описание: Инициализация приложения с API ключом и env-конфигом.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$apiKey | ?string | API ключ. Если не указан — из API_KEY. По умолчанию: NULL. |
$force | bool | Принудительная повторная инициализация. По умолчанию: false. |
Возвращает: void
resetForTests(): void
Описание: Сброс singleton-состояния для PHPUnit. Не для production. @internal — только для тестов.
Возвращает: void
defineApiKey(): void
Описание: Переопределить API ключ без полного re-init.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$apiKey | string | API ключ. Если не указан — из API_KEY. |
Возвращает: void
Cache(): TagAwareCacheInterface
Описание: Tag-aware filesystem cache (Symfony Cache).
Возвращает: TagAwareCacheInterface
Client(): Client
Описание: Общий HTTP-клиент.
Возвращает: Client
newClient(): Client
Описание: Создать отдельный Client (например, с другой API version).
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$url | ?string | Base URL API. По умолчанию: NULL. |
$version | ?string | Версия API (v2 / v3). По умолчанию: NULL. |
$key | ?string | API ключ клиента или cache/download key — по контексту метода. По умолчанию: NULL. |
Возвращает: Client
Requests(): AbstractRequest
Описание: Discovery Request-класса по короткому ключу (Proxy, Profile, …).
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$requestType | string | Короткий ключ Request (Proxy, Profile, …). |
Возвращает: AbstractRequest | null
cacheEnabled(): bool
Описание: Включён ли кэш GET-ответов.
Возвращает: bool
cacheLifetime(): int
Описание: TTL кэша в секундах.
Возвращает: int
iterateMaxPages(): int
Описание: Лимит страниц для iterate().
Возвращает: int
Debug(): bool
Описание: Флаг отладки.
Возвращает: bool