DevCraft Документации
СправочникКлассы

SdkConfig v1.0.0

Конфигурация SDK. Читает переменные окружения `MYSHOWS_*` и позволяет переопределить явно.

Описание: Конфигурация SDK. Читает переменные окружения MYSHOWS_* и позволяет переопределить явно.

Namespace: DevCraftClub\MyShows\Config

С версии: 1.0.0

Константы

КонстантаТипЗначение
DEFAULT_ENDPOINTconst'https://api.myshows.me/v2/rpc/'
DEFAULT_ACCEPT_LANGUAGEconst'ru'
DEFAULT_CACHE_TTLconst86400
DEFAULT_RATE_LIMIT_RPSconst5
DEFAULT_RATE_LIMIT_RPMconst90
DEFAULT_RATE_LIMIT_ENABLEDconsttrue

Свойства

СвойствоТипОписание
$endpointstring— По умолчанию: self::DEFAULT_ENDPOINT.
$userAgent?string— По умолчанию: null.
$acceptLanguagestring— По умолчанию: self::DEFAULT_ACCEPT_LANGUAGE.
$accessToken?string— По умолчанию: null.
$cacheTtlint— По умолчанию: self::DEFAULT_CACHE_TTL.
$cacheDirstring— По умолчанию: '/tmp/myshows_cache'.
$rateLimitEnabledbool— По умолчанию: self::DEFAULT_RATE_LIMIT_ENABLED.
$rateLimitRpsint— По умолчанию: self::DEFAULT_RATE_LIMIT_RPS.
$rateLimitRpmint— По умолчанию: self::DEFAULT_RATE_LIMIT_RPM.
$oauthClientId?string— По умолчанию: null.
$oauthClientSecret?string— По умолчанию: null.
$oauthRedirectUri?string— По умолчанию: null.
$tokenStorePath?string— По умолчанию: null.

Методы

__construct(string $endpoint = self::DEFAULT_ENDPOINT, ?string $userAgent = null, string $acceptLanguage = self::DEFAULT_ACCEPT_LANGUAGE, ?string $accessToken = null, int $cacheTtl = self::DEFAULT_CACHE_TTL, string $cacheDir = '/tmp/myshows_cache', bool $rateLimitEnabled = self::DEFAULT_RATE_LIMIT_ENABLED, int $rateLimitRps = self::DEFAULT_RATE_LIMIT_RPS, int $rateLimitRpm = self::DEFAULT_RATE_LIMIT_RPM, ?string $oauthClientId = null, ?string $oauthClientSecret = null, ?string $oauthRedirectUri = null, ?string $tokenStorePath = null): void

ПараметрТипОписание
$endpointstring— По умолчанию: self::DEFAULT_ENDPOINT.
$userAgent?string— По умолчанию: null.
$acceptLanguagestring— По умолчанию: self::DEFAULT_ACCEPT_LANGUAGE.
$accessToken?string— По умолчанию: null.
$cacheTtlint— По умолчанию: self::DEFAULT_CACHE_TTL.
$cacheDirstring— По умолчанию: '/tmp/myshows_cache'.
$rateLimitEnabledbool— По умолчанию: self::DEFAULT_RATE_LIMIT_ENABLED.
$rateLimitRpsint— По умолчанию: self::DEFAULT_RATE_LIMIT_RPS.
$rateLimitRpmint— По умолчанию: self::DEFAULT_RATE_LIMIT_RPM.
$oauthClientId?string— По умолчанию: null.
$oauthClientSecret?string— По умолчанию: null.
$oauthRedirectUri?string— По умолчанию: null.
$tokenStorePath?string— По умолчанию: null.

Возвращает: void

static fromEnv(?array $overrides = null): self

Описание: Собрать конфигурацию из окружения с возможными переопределениями.

ПараметрТипОписание
$overrides?array— По умолчанию: null.

Возвращает: self

TokenProviderInterface

Поставщик Bearer-токена для JSON-RPC клиента.

MyShowsClient

Фасад SDK MyShows.

На этой странице

КонстантыСвойстваМетоды__construct(string $endpoint = self::DEFAULT_ENDPOINT, ?string $userAgent = null, string $acceptLanguage = self::DEFAULT_ACCEPT_LANGUAGE, ?string $accessToken = null, int $cacheTtl = self::DEFAULT_CACHE_TTL, string $cacheDir = '/tmp/myshows_cache', bool $rateLimitEnabled = self::DEFAULT_RATE_LIMIT_ENABLED, int $rateLimitRps = self::DEFAULT_RATE_LIMIT_RPS, int $rateLimitRpm = self::DEFAULT_RATE_LIMIT_RPM, ?string $oauthClientId = null, ?string $oauthClientSecret = null, ?string $oauthRedirectUri = null, ?string $tokenStorePath = null): voidstatic fromEnv(?array $overrides = null): self