yookassa-sdk-php/docs/classes/YooKassa-Model-Requestor.md

YooKassa API SDK

Class: \YooKassa\Model\Requestor

Namespace: \YooKassa\Model

---

Summary:

Инициатор платежа или возврата.

Description:

Инициатором может быть магазин, подключенный к ЮKassa, merchant или приложение, которому владелец магазина разрешил совершать операции от своего имени third_party_client.

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$account_id		Идентификатор магазина
public	$accountId		Идентификатор магазина
public	$client_id		Идентификатор приложения
public	$client_name		Название приложения (только для type = RequestorThirdPartyService)
public	$clientId		Идентификатор приложения
public	$clientName		Название приложения (только для type = RequestorThirdPartyService)
public	$type		Тип инициатора

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getAccountId()		Возвращает идентификатор магазина
public	getClientId()		Возвращает идентификатор приложения
public	getClientName()		Возвращает название приложения
public	getType()		Возвращает тип инициатора
public	jsonSerialize()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации
public	offsetExists()		Проверяет наличие свойства
public	offsetGet()		Возвращает значение свойства
public	offsetSet()		Устанавливает значение свойства
public	offsetUnset()		Удаляет свойство
public	setAccountId()		Устанавливает идентификатор магазина
public	setClientId()		Устанавливает идентификатор приложения
public	setClientName()		Устанавливает название приложения
public	setType()		Устанавливает тип инициатора
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Requestor.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Requestor
• Implements:
  • \YooKassa\Model\RequestorInterface

---

Tags

Tag	Version	Description
deprecated		Не используется. Будет удален в следующих версиях

---

Properties

public $account_id : string

---

Description

Идентификатор магазина

Type: string

Details:

public $accountId : string

---

Description

Идентификатор магазина

Type: string

Details:

public $client_id : string

---

Description

Идентификатор приложения

Type: string

Details:

public $client_name : string

---

Description

Название приложения (только для type = RequestorThirdPartyService)

Type: string

Details:

public $clientId : string

---

Description

Идентификатор приложения

Type: string

Details:

public $clientName : string

---

Description

Название приложения (только для type = RequestorThirdPartyService)

Type: string

Details:

public $type : string

---

Description

Тип инициатора

Type: string

Details:

---

Methods

public __construct() : mixed

public __construct(array $data = array()) : mixed

Summary

AbstractObject constructor.

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array	data

Returns: mixed -

public __get() : mixed

public __get(string $propertyName) : mixed

Summary

Возвращает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства

Returns: mixed - Значение свойства

public __isset() : bool

public __isset(string $propertyName) : bool

Summary

Проверяет наличие свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public __set() : mixed

public __set(string $propertyName, mixed $value) : mixed

Summary

Устанавливает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя свойства
mixed	value	Значение свойства

Returns: mixed -

public __unset() : mixed

public __unset(string $propertyName) : mixed

Summary

Удаляет свойство

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	propertyName	Имя удаляемого свойства

Returns: mixed -

public fromArray() : mixed

public fromArray(array|\Traversable $sourceArray) : mixed

Summary

Устанавливает значения свойств текущего объекта из массива

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
array OR \Traversable	sourceArray	Ассоциативный массив с настройками

Returns: mixed -

public getAccountId() : string|null

public getAccountId() : string|null

Summary

Возвращает идентификатор магазина

Details:

• Inherited From: \YooKassa\Model\Requestor

Returns: string|null -

Tags

Tag	Version	Description
inheritdoc

public getClientId() : string|null

public getClientId() : string|null

Summary

Возвращает идентификатор приложения

Details:

• Inherited From: \YooKassa\Model\Requestor

Returns: string|null -

Tags

Tag	Version	Description
inheritdoc

public getClientName() : string|null

public getClientName() : string|null

Summary

Возвращает название приложения

Details:

• Inherited From: \YooKassa\Model\Requestor

Returns: string|null -

Tags

Tag	Version	Description
inheritdoc

public getType() : string

public getType() : string

Summary

Возвращает тип инициатора

Details:

• Inherited From: \YooKassa\Model\Requestor

Returns: string -

Tags

Tag	Version	Description
inheritdoc

public jsonSerialize() : array

public jsonSerialize() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив со свойствами текущего объекта

public offsetExists() : bool

public offsetExists(string $offset) : bool

Summary

Проверяет наличие свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя проверяемого свойства

Returns: bool - True если свойство имеется, false если нет

public offsetGet() : mixed

public offsetGet(string $offset) : mixed

Summary

Возвращает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя свойства

Returns: mixed - Значение свойства

public offsetSet() : mixed

public offsetSet(string $offset, mixed $value) : mixed

Summary

Устанавливает значение свойства

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя свойства
mixed	value	Значение свойства

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(string $offset) : mixed

Summary

Удаляет свойство

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
string	offset	Имя удаляемого свойства

Returns: mixed -

public setAccountId() : mixed

public setAccountId(string $value) : mixed

Summary

Устанавливает идентификатор магазина

Details:

• Inherited From: \YooKassa\Model\Requestor

Parameters:

Type	Name	Description
string	value	Идентификатор магазина

Returns: mixed -

Tags

Tag	Version	Description
inheritdoc

public setClientId() : mixed

public setClientId(string $value) : mixed

Summary

Устанавливает идентификатор приложения

Details:

• Inherited From: \YooKassa\Model\Requestor

Parameters:

Type	Name	Description
string	value	Идентификатор приложения

Returns: mixed -

Tags

Tag	Version	Description
inheritdoc

public setClientName() : mixed

public setClientName(string $value) : mixed

Summary

Устанавливает название приложения

Details:

• Inherited From: \YooKassa\Model\Requestor

Parameters:

Type	Name	Description
string	value	Название приложения

Returns: mixed -

Tags

Tag	Version	Description
inheritdoc

public setType() : mixed

public setType(string $value) : mixed

Summary

Устанавливает тип инициатора

Details:

• Inherited From: \YooKassa\Model\Requestor

Parameters:

Type	Name	Description
string	value	Тип инициатора

Returns: mixed -

Tags

Tag	Version	Description
inheritdoc

public toArray() : array

public toArray() : array

Summary

Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив со свойствами текущего объекта

protected getUnknownProperties() : array

protected getUnknownProperties() : array

Summary

Возвращает массив свойств которые не существуют, но были заданы у объекта

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: array - Ассоциативный массив с не существующими у текущего объекта свойствами

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 13

---

This document was automatically generated from source code comments on 2021-12-09 using phpDocumentor

© 2021 YooMoney