meraproject/vendor/yoomoney/yookassa-sdk-php/docs/classes/YooKassa-Model-Webhook-Webhook.md

YooKassa API SDK

Class: \YooKassa\Model\Webhook\Webhook

Namespace: \YooKassa\Model\Webhook

---

Summary:

Класс Webhook содержит информацию о подписке на одно событие

---

Constants

• No constants found

---

Properties

Visibility	Name	Flag	Summary
public	$event		Событие, о котором уведомляет ЮKassa
public	$id		Идентификатор webhook
public	$url		URL, на который ЮKassa будет отправлять уведомления

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		AbstractObject constructor.
public	__get()		Возвращает значение свойства
public	__isset()		Проверяет наличие свойства
public	__set()		Устанавливает значение свойства
public	__unset()		Удаляет свойство
public	fromArray()		Устанавливает значения свойств текущего объекта из массива
public	getEvent()		Возвращает событие, о котором уведомляет ЮKassa
public	getId()		Возвращает идентификатор webhook
public	getUrl()		Возвращает URL, на который ЮKassa будет отправлять уведомления
public	jsonSerialize()
public	offsetExists()
public	offsetGet()
public	offsetSet()
public	offsetUnset()
public	setEvent()		Устанавливает событие, о котором уведомляет ЮKassa
public	setId()		Устанавливает идентификатор webhook
public	setUrl()		Устанавливает URL, на который ЮKassa будет отправлять уведомления
public	toArray()		Возвращает ассоциативный массив со свойствами текущего объекта для его дальнейшей JSON сериализации Является алиасом метода AbstractObject::jsonSerialize()
protected	getUnknownProperties()		Возвращает массив свойств которые не существуют, но были заданы у объекта

---

Details

• File: lib/Model/Webhook/Webhook.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Common\AbstractObject
  • \YooKassa\Model\Webhook\Webhook

---

Properties

public $event : string

---

Description

Событие, о котором уведомляет ЮKassa

Type: string

Details:

public $id : string

---

Description

Идентификатор webhook

Type: string

Details:

public $url : string

---

Description

URL, на который ЮKassa будет отправлять уведомления

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 getEvent() : string

public getEvent() : string

Summary

Возвращает событие, о котором уведомляет ЮKassa

Details:

• Inherited From: \YooKassa\Model\Webhook\Webhook

Returns: string - Событие, о котором уведомляет ЮKassa

public getId() : string

public getId() : string

Summary

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

Details:

• Inherited From: \YooKassa\Model\Webhook\Webhook

Returns: string - Идентификатор webhook

public getUrl() : string

public getUrl() : string

Summary

Возвращает URL, на который ЮKassa будет отправлять уведомления

Details:

• Inherited From: \YooKassa\Model\Webhook\Webhook

Returns: string - URL, на который ЮKassa будет отправлять уведомления

public jsonSerialize() : mixed

public jsonSerialize() : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Returns: mixed -

public offsetExists() : mixed

public offsetExists(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetGet() : mixed

public offsetGet(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public offsetSet() : mixed

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

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset
mixed	value

Returns: mixed -

public offsetUnset() : mixed

public offsetUnset(mixed $offset) : mixed

Details:

• Inherited From: \YooKassa\Common\AbstractObject

Parameters:

Type	Name	Description
mixed	offset

Returns: mixed -

public setEvent() : mixed

public setEvent(string $event) : mixed

Summary

Устанавливает событие, о котором уведомляет ЮKassa

Details:

• Inherited From: \YooKassa\Model\Webhook\Webhook

Parameters:

Type	Name	Description
string	event	Событие, о котором уведомляет ЮKassa

Returns: mixed -

public setId() : mixed

public setId(mixed $id) : mixed

Summary

Устанавливает идентификатор webhook

Details:

• Inherited From: \YooKassa\Model\Webhook\Webhook

Parameters:

Type	Name	Description
mixed	id	Идентификатор webhook

Returns: mixed -

public setUrl() : mixed

public setUrl(string $url) : mixed

Summary

Устанавливает URL, на который ЮKassa будет отправлять уведомления

Details:

• Inherited From: \YooKassa\Model\Webhook\Webhook

Parameters:

Type	Name	Description
string	url	URL, на который ЮKassa будет отправлять уведомления

Returns: mixed -

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 - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney