Добавлены новые методы. Изменены некоторые методы

Обновлены описания классов, свойств и методов для документации
Добавлена документация
Добавлены примеры использования SDK
This commit is contained in:
Антон Н. Николаев
2021-04-21 11:24:28 +03:00
parent 25c35bb316
commit bd2a5b95fd
399 changed files with 93734 additions and 577 deletions
@@ -33,16 +33,20 @@ use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
use YooKassa\Helpers\TypeCast;
use YooKassa\Model\NotificationEventType;
use YooKassa\Model\NotificationType;
use YooKassa\Model\PaymentInterface;
use YooKassa\Model\RefundInterface;
/**
* Базовый класс уведомлений
*
* @package YooKassa\Model\Notification
* @example 03-notification.php 3 Пример скрипта обработки уведомления
*
* @package YooKassa
*
* @property-read string $type Тип уведомления в виде строки
* @property-read string $event Тип события
*/
abstract class AbstractNotification extends AbstractObject
abstract class AbstractNotification extends AbstractObject implements NotificationInterface
{
/**
* @var string Тип уведомления
@@ -135,4 +139,18 @@ abstract class AbstractNotification extends AbstractObject
);
}
}
/**
* Возвращает объект с информацией о платеже или возврате, уведомление о котором хранится в текущем объекте
*
* Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет
* получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о
* платеже у API.
*
* @return PaymentInterface|RefundInterface Объект с информацией о платеже
*/
public function getObject()
{
return null;
}
}