Антон Н. Николаев
8.4 KiB
YooKassa API SDK
Class: \YooKassa\Client\UserAgent
Namespace: \YooKassa\Client
Summary:
Класс, представляющий модель UserAgent.
Description:
Класс для создания заголовка User-Agent в запросах к API.
Constants
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | HEADER | Имя заголовка для User-Agent | |
| public | VERSION_DELIMITER | Разделитель части заголовка и её версии | |
| public | PART_DELIMITER | Разделитель между частями заголовка |
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | __construct() | Конструктор UserAgent. | |
| public | createVersion() | Создание строки версии компонента. | |
| public | getCms() | Возвращает версию CMS. | |
| public | getFramework() | Возвращает версию фреймворка. | |
| public | getHeaderString() | Формирует конечную строку из составных частей. | |
| public | getModule() | Возвращает версию модуля. | |
| public | getOs() | Возвращает версию операционной системы. | |
| public | getPhp() | Возвращает версию PHP. | |
| public | getSdk() | Возвращает версию SDK. | |
| public | setCms() | Устанавливает версию CMS. | |
| public | setFramework() | Устанавливает версию фреймворка. | |
| public | setModule() | Устанавливает версию модуля. |
Details
-
File: lib/Client/UserAgent.php
-
Package: YooKassa
-
Class Hierarchy:
- \YooKassa\Client\UserAgent
-
See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Class | |
| author | cms@yoomoney.ru |
Constants
HEADER
Имя заголовка для User-Agent
HEADER = 'YM-User-Agent'
VERSION_DELIMITER
Разделитель части заголовка и её версии
VERSION_DELIMITER = '/'
PART_DELIMITER
Разделитель между частями заголовка
PART_DELIMITER = ' '
Methods
public __construct() : mixed
public __construct() : mixed
Summary
Конструктор UserAgent.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: mixed -
public createVersion() : string
public createVersion(string $name, string $version) : string
Summary
Создание строки версии компонента.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Parameters:
| Type | Name | Description |
|---|---|---|
string |
name | |
string |
version |
Returns: string -
public getCms() : ?string
public getCms() : ?string
Summary
Возвращает версию CMS.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: ?string -
public getFramework() : ?string
public getFramework() : ?string
Summary
Возвращает версию фреймворка.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: ?string -
public getHeaderString() : string
public getHeaderString() : string
Summary
Формирует конечную строку из составных частей.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: string -
public getModule() : ?string
public getModule() : ?string
Summary
Возвращает версию модуля.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: ?string -
public getOs() : ?string
public getOs() : ?string
Summary
Возвращает версию операционной системы.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: ?string -
public getPhp() : ?string
public getPhp() : ?string
Summary
Возвращает версию PHP.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: ?string -
public getSdk() : ?string
public getSdk() : ?string
Summary
Возвращает версию SDK.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Returns: ?string -
public setCms() : void
public setCms(string $name, string $version) : void
Summary
Устанавливает версию CMS.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Parameters:
| Type | Name | Description |
|---|---|---|
string |
name | |
string |
version |
Returns: void -
public setFramework() : void
public setFramework(string $name, string $version) : void
Summary
Устанавливает версию фреймворка.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Parameters:
| Type | Name | Description |
|---|---|---|
string |
name | |
string |
version |
Returns: void -
public setModule() : void
public setModule(string $name, string $version) : void
Summary
Устанавливает версию модуля.
Details:
- Inherited From: \YooKassa\Client\UserAgent
Parameters:
| Type | Name | Description |
|---|---|---|
string |
name | |
string |
version |
Returns: void -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2024-12-16 using phpDocumentor
© 2024 YooMoney