EnglishReferenceClasses
SdkConfig v1.0.0
SDK configuration. Reads `MYSHOWS_*` environment variables and allows explicit overrides.
Description: SDK configuration. Reads MYSHOWS_* environment variables and allows explicit overrides.
Namespace: DevCraftClub\MyShows\Config
Since: 1.0.0
Constants
| Constant | Type | Value |
|---|---|---|
DEFAULT_ENDPOINT | const | 'https://api.myshows.me/v2/rpc/' |
DEFAULT_ACCEPT_LANGUAGE | const | 'ru' |
DEFAULT_CACHE_TTL | const | 86400 |
DEFAULT_RATE_LIMIT_RPS | const | 5 |
DEFAULT_RATE_LIMIT_RPM | const | 90 |
DEFAULT_RATE_LIMIT_ENABLED | const | true |
Properties
| Property | Type | Description |
|---|---|---|
$endpoint | string | — Default: self::DEFAULT_ENDPOINT. |
$userAgent | ?string | — Default: null. |
$acceptLanguage | string | — Default: self::DEFAULT_ACCEPT_LANGUAGE. |
$accessToken | ?string | — Default: null. |
$cacheTtl | int | — Default: self::DEFAULT_CACHE_TTL. |
$cacheDir | string | — Default: '/tmp/myshows_cache'. |
$rateLimitEnabled | bool | — Default: self::DEFAULT_RATE_LIMIT_ENABLED. |
$rateLimitRps | int | — Default: self::DEFAULT_RATE_LIMIT_RPS. |
$rateLimitRpm | int | — Default: self::DEFAULT_RATE_LIMIT_RPM. |
$oauthClientId | ?string | — Default: null. |
$oauthClientSecret | ?string | — Default: null. |
$oauthRedirectUri | ?string | — Default: null. |
$tokenStorePath | ?string | — Default: null. |
Methods
__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
| Parameter | Type | Description |
|---|---|---|
$endpoint | string | — Default: self::DEFAULT_ENDPOINT. |
$userAgent | ?string | — Default: null. |
$acceptLanguage | string | — Default: self::DEFAULT_ACCEPT_LANGUAGE. |
$accessToken | ?string | — Default: null. |
$cacheTtl | int | — Default: self::DEFAULT_CACHE_TTL. |
$cacheDir | string | — Default: '/tmp/myshows_cache'. |
$rateLimitEnabled | bool | — Default: self::DEFAULT_RATE_LIMIT_ENABLED. |
$rateLimitRps | int | — Default: self::DEFAULT_RATE_LIMIT_RPS. |
$rateLimitRpm | int | — Default: self::DEFAULT_RATE_LIMIT_RPM. |
$oauthClientId | ?string | — Default: null. |
$oauthClientSecret | ?string | — Default: null. |
$oauthRedirectUri | ?string | — Default: null. |
$tokenStorePath | ?string | — Default: null. |
Returns: void
static fromEnv(?array $overrides = null): self
Description: Build configuration from the environment, with optional overrides.
| Parameter | Type | Description |
|---|---|---|
$overrides | ?array | — Default: null. |
Returns: self