Initial Commit
This commit is contained in:
@@ -0,0 +1,138 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2020 "YooMoney", NBСO LLC
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace YooKassa\Model\Notification;
|
||||
|
||||
use YooKassa\Common\AbstractObject;
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
|
||||
use YooKassa\Helpers\TypeCast;
|
||||
use YooKassa\Model\NotificationEventType;
|
||||
use YooKassa\Model\NotificationType;
|
||||
|
||||
/**
|
||||
* Базовый класс уведомлений
|
||||
*
|
||||
* @package YooKassa\Model\Notification
|
||||
*
|
||||
* @property-read string $type Тип уведомления в виде строки
|
||||
* @property-read string $event Тип события
|
||||
*/
|
||||
abstract class AbstractNotification extends AbstractObject
|
||||
{
|
||||
/**
|
||||
* @var string Тип уведомления
|
||||
*/
|
||||
private $_type;
|
||||
|
||||
/**
|
||||
* @var string Тип произошедшего события
|
||||
*/
|
||||
private $_event;
|
||||
|
||||
/**
|
||||
* Возвращает тип уведомления
|
||||
*
|
||||
* Тип уведомления - одна из констант, указанных в перечислении {@link NotificationType}.
|
||||
*
|
||||
* @return string Тип уведомления в виде строки
|
||||
*/
|
||||
public function getType()
|
||||
{
|
||||
return $this->_type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает тип уведомления
|
||||
*
|
||||
* @param string $value Тип уведомления
|
||||
*
|
||||
* @throws EmptyPropertyValueException Выбрасывается если в качестве значения было передано пустое значение
|
||||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение не найдено в перечислении типов
|
||||
* нотификаций
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой
|
||||
*/
|
||||
protected function _setType($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
throw new EmptyPropertyValueException('Empty parameter "type" in Notification', 0, 'notification.type');
|
||||
} elseif (TypeCast::canCastToEnumString($value)) {
|
||||
if (NotificationType::valueExists($value)) {
|
||||
$this->_type = (string)$value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "type" parameter in Notification', 0, 'notification.type', $value
|
||||
);
|
||||
}
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid value type for "type" parameter in Notification', 0, 'notification.type', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает тип события
|
||||
*
|
||||
* Тип события - одна из констант, указанных в перечислении {@link NotificationEventType}.
|
||||
*
|
||||
* @return string Тип события
|
||||
*/
|
||||
public function getEvent()
|
||||
{
|
||||
return $this->_event;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает тип события
|
||||
*
|
||||
* @param string $value Тип события
|
||||
*
|
||||
* @throws EmptyPropertyValueException Выбрасывается если в качестве значения было передано пустое значение
|
||||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение не найдено в перечислении типов
|
||||
* событий
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если переданное значение не является строкой
|
||||
*/
|
||||
protected function _setEvent($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
throw new EmptyPropertyValueException('Empty parameter "event" in Notification', 0, 'notification.event');
|
||||
} elseif (TypeCast::canCastToEnumString($value)) {
|
||||
if (NotificationEventType::valueExists($value)) {
|
||||
$this->_event = (string)$value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "event" parameter in Notification', 0, 'notification.event', $value
|
||||
);
|
||||
}
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid value type for "event" parameter in Notification', 0, 'notification.event', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2020 "YooMoney", NBСO LLC
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace YooKassa\Model\Notification;
|
||||
|
||||
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Model\NotificationEventType;
|
||||
use YooKassa\Model\NotificationType;
|
||||
use YooKassa\Model\Payment;
|
||||
use YooKassa\Model\PaymentInterface;
|
||||
use YooKassa\Request\Payments\PaymentResponse;
|
||||
|
||||
class NotificationCanceled extends AbstractNotification
|
||||
{
|
||||
/**
|
||||
* Объект платежа, для которого пришла нотификация. Так как нотификация может быть сгенерирована и поставлена в
|
||||
* очередь на отправку гораздо раньше, чем она будет получена на сайте, то опираться на статус пришедшего
|
||||
* платежа не стоит, лучше запросить текущую информацию о платеже у API.
|
||||
*
|
||||
* @var Payment Объект платежа
|
||||
*/
|
||||
private $_object;
|
||||
|
||||
/**
|
||||
* Конструктор объекта нотификации о возможности подтверждения платежа
|
||||
*
|
||||
* Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из
|
||||
* тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если
|
||||
* передать уведомление не того типа, будет сгенерировано исключение типа {@link InvalidPropertyValueException}
|
||||
*
|
||||
* @param array $source Ассоциативный массив с информацией о уведомлении
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если значение типа нотификации или события не равны
|
||||
* "notification" и "payment.canceled" соответственно, что может говорить о том, что переданные в
|
||||
* конструктор данные не являются уведомлением нужного типа.
|
||||
*/
|
||||
public function __construct(array $source)
|
||||
{
|
||||
$this->_setType(NotificationType::NOTIFICATION);
|
||||
$this->_setEvent(NotificationEventType::PAYMENT_CANCELED);
|
||||
if (!empty($source['type'])) {
|
||||
if ($this->getType() !== $source['type']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (!empty($source['event'])) {
|
||||
if ($this->getEvent() !== $source['event']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (empty($source['object'])) {
|
||||
throw new EmptyPropertyValueException('Parameter object in NotificationSucceeded is empty');
|
||||
}
|
||||
$this->_object = new PaymentResponse($source['object']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте
|
||||
*
|
||||
* Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет
|
||||
* получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о
|
||||
* платеже у API.
|
||||
*
|
||||
* @return PaymentInterface Объект с информацией о платеже
|
||||
*/
|
||||
public function getObject()
|
||||
{
|
||||
return $this->_object;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2020 "YooMoney", NBСO LLC
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace YooKassa\Model\Notification;
|
||||
|
||||
use YooKassa\Model\Notification\AbstractNotification;
|
||||
use YooKassa\Model\NotificationEventType;
|
||||
|
||||
class NotificationFactory
|
||||
{
|
||||
private $typeClassMap = array(
|
||||
NotificationEventType::PAYMENT_CANCELED => 'NotificationCanceled',
|
||||
NotificationEventType::REFUND_SUCCEEDED => 'NotificationRefundSucceeded',
|
||||
NotificationEventType::PAYMENT_SUCCEEDED => 'NotificationSucceeded',
|
||||
NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE => 'NotificationWaitingForCapture',
|
||||
);
|
||||
|
||||
/**
|
||||
* @param array $data
|
||||
* @return AbstractNotification
|
||||
*/
|
||||
public function factory(array $data)
|
||||
{
|
||||
if (!array_key_exists('event', $data)) {
|
||||
throw new \InvalidArgumentException(
|
||||
'Parameter event not specified in NotificationFactory.factory()'
|
||||
);
|
||||
}
|
||||
if (!is_string($data['event'])) {
|
||||
throw new \InvalidArgumentException('Invalid notification type value in notification factory');
|
||||
}
|
||||
if (!array_key_exists($data['event'], $this->typeClassMap)) {
|
||||
throw new \InvalidArgumentException('Invalid notification data type "' . $data['event'] . '"');
|
||||
}
|
||||
$className = __NAMESPACE__ . '\\' . $this->typeClassMap[$data['event']];
|
||||
|
||||
return new $className($data);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
<?php
|
||||
/**
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2020 "YooMoney", NBСO LLC
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace YooKassa\Model\Notification;
|
||||
|
||||
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Model\NotificationEventType;
|
||||
use YooKassa\Model\NotificationType;
|
||||
use YooKassa\Model\Refund;
|
||||
use YooKassa\Model\RefundInterface;
|
||||
use YooKassa\Request\Refunds\RefundResponse;
|
||||
|
||||
class NotificationRefundSucceeded extends AbstractNotification
|
||||
{
|
||||
/**
|
||||
* Объект возварата, для которого пришла нотификация. Так как нотификация может быть сгенерирована и поставлена в
|
||||
* очередь на отправку гораздо раньше, чем она будет получена на сайте, то опираться на статус пришедшего
|
||||
* возврата не стоит, лучше запросить текущую информацию о возврате у API.
|
||||
*
|
||||
* @var Refund Объект платежа
|
||||
*/
|
||||
private $_object;
|
||||
|
||||
/**
|
||||
* Конструктор объекта нотификации
|
||||
*
|
||||
* Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из
|
||||
* тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если
|
||||
* передать уведомление не того типа, будет сгенерировано исключение типа {@link InvalidPropertyValueException}
|
||||
*
|
||||
* @param array $source Ассоциативный массив с информацией о уведомлении
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если значение типа нотификации или события не равны
|
||||
* "notification" и "refund.succeeded" соответственно, что может говорить о том, что переданные в
|
||||
* конструктор данные не являются уведомлением нужного типа.
|
||||
*/
|
||||
public function __construct(array $source)
|
||||
{
|
||||
$this->_setType(NotificationType::NOTIFICATION);
|
||||
$this->_setEvent(NotificationEventType::REFUND_SUCCEEDED);
|
||||
if (!empty($source['type'])) {
|
||||
if ($this->getType() !== $source['type']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (!empty($source['event'])) {
|
||||
if ($this->getEvent() !== $source['event']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (empty($source['object'])) {
|
||||
throw new EmptyPropertyValueException('Parameter object in NotificationSucceeded is empty');
|
||||
}
|
||||
$this->_object = new RefundResponse($source['object']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает объект с информацией о возврате, уведомление о котором хранится в текущем объекте
|
||||
*
|
||||
* Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет
|
||||
* получена на сайте, то опираться на статус пришедшего возврата не стоит, лучше запросить текущую информацию о
|
||||
* возврате у API.
|
||||
*
|
||||
* @return RefundInterface Объект с информацией о возврате
|
||||
*/
|
||||
public function getObject()
|
||||
{
|
||||
return $this->_object;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,105 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2020 "YooMoney", NBСO LLC
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace YooKassa\Model\Notification;
|
||||
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Model\NotificationEventType;
|
||||
use YooKassa\Model\NotificationType;
|
||||
use YooKassa\Model\Payment;
|
||||
use YooKassa\Model\PaymentInterface;
|
||||
use YooKassa\Request\Payments\PaymentResponse;
|
||||
|
||||
/**
|
||||
* Класс объекта, присылаемого API при изменении статуса платежа на "succeeded"
|
||||
*
|
||||
* @package YooKassa\Model\Notification
|
||||
*
|
||||
* @property-read PaymentInterface $object Объект с информацией о платеже
|
||||
*/
|
||||
class NotificationSucceeded extends AbstractNotification
|
||||
{
|
||||
/**
|
||||
* Объект платежа, для которого пришла нотификация. Так как нотификация может быть сгенерирована и поставлена в
|
||||
* очередь на отправку гораздо раньше, чем она будет получена на сайте, то опираться на статус пришедшего
|
||||
* платежа не стоит, лучше запросить текущую информацию о платеже у API.
|
||||
*
|
||||
* @var Payment Объект платежа
|
||||
*/
|
||||
private $_object;
|
||||
|
||||
/**
|
||||
* Конструктор объекта нотификации о возможности подтверждения платежа
|
||||
*
|
||||
* Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из
|
||||
* тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если
|
||||
* передать уведомление не того типа, будет сгенерировано исключение типа {@link InvalidPropertyValueException}
|
||||
*
|
||||
* @param array $source Ассоциативный массив с информацией о уведомлении
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если значение типа нотификации или события не равны
|
||||
* "notification" и "payment.succeeded" соответственно, что может говорить о том, что переданные в
|
||||
* конструктор данные не являются уведомлением нужного типа.
|
||||
*/
|
||||
public function __construct(array $source)
|
||||
{
|
||||
$this->_setType(NotificationType::NOTIFICATION);
|
||||
$this->_setEvent(NotificationEventType::PAYMENT_SUCCEEDED);
|
||||
if (!empty($source['type'])) {
|
||||
if ($this->getType() !== $source['type']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (!empty($source['event'])) {
|
||||
if ($this->getEvent() !== $source['event']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (empty($source['object'])) {
|
||||
throw new EmptyPropertyValueException('Parameter object in NotificationSucceeded is empty');
|
||||
}
|
||||
$this->_object = new PaymentResponse($source['object']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте
|
||||
*
|
||||
* Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет
|
||||
* получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о
|
||||
* платеже у API.
|
||||
*
|
||||
* @return PaymentInterface Объект с информацией о платеже
|
||||
*/
|
||||
public function getObject()
|
||||
{
|
||||
return $this->_object;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,109 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2020 "YooMoney", NBСO LLC
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace YooKassa\Model\Notification;
|
||||
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Model\NotificationEventType;
|
||||
use YooKassa\Model\NotificationType;
|
||||
use YooKassa\Model\Payment;
|
||||
use YooKassa\Model\PaymentInterface;
|
||||
use YooKassa\Request\Payments\PaymentResponse;
|
||||
|
||||
/**
|
||||
* Класс объекта, присылаемого API при изменении статуса платежа на "waiting_for_capture"
|
||||
*
|
||||
* При создании платежа с флагом "capture" равным false, после того как клиент проводит платёж, от API на эндпоинт,
|
||||
* указанный в настройках API посылается уведомление о том, что платёж теперь может быть проведён. В классе описана
|
||||
* структура такого объекта для магазинов, которые получают уведомления на HTTPS endpoint.
|
||||
*
|
||||
* @package YooKassa\Model\Notification
|
||||
*
|
||||
* @property-read PaymentInterface $object Объект с информацией о платеже, который можно подтвердить или отменить
|
||||
*/
|
||||
class NotificationWaitingForCapture extends AbstractNotification
|
||||
{
|
||||
/**
|
||||
* Объект платежа, для которого пришла нотификация. Так как нотификация может быть сгенерирована и поставлена в
|
||||
* очередь на отправку гораздо раньше, чем она будет получена на сайте, то опираться на статус пришедшего
|
||||
*платежа не стоит, лучше запросить текущую информацию о платеже у API.
|
||||
*
|
||||
* @var Payment Объект платежа
|
||||
*/
|
||||
private $_object;
|
||||
|
||||
/**
|
||||
* Конструктор объекта нотификации о возможности подтверждения платежа
|
||||
*
|
||||
* Инициализирует текущий объект из ассоциативного массива, который просто путём JSON десериализации получен из
|
||||
* тела пришедшего запроса. При конструировании проверяется валидность типа передаваемого уведомления, если
|
||||
* передать уведомление не того типа, будет сгенерировано исключение типа {@link InvalidPropertyValueException}
|
||||
*
|
||||
* @param array $source Ассоциативный массив с информацией о уведомлении
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если значение типа нотификации или события не равны
|
||||
* "notification" и "payment.waiting_for_capture" соответственно, что может говорить о том, что переданные в
|
||||
* конструктор данные не являются уведомлением нужного типа.
|
||||
*/
|
||||
public function __construct(array $source)
|
||||
{
|
||||
$this->_setType(NotificationType::NOTIFICATION);
|
||||
$this->_setEvent(NotificationEventType::PAYMENT_WAITING_FOR_CAPTURE);
|
||||
if (!empty($source['type'])) {
|
||||
if ($this->getType() !== $source['type']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "type" parameter in Notification', 0, 'notification.type', $source['type']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (!empty($source['event'])) {
|
||||
if ($this->getEvent() !== $source['event']) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid value for "event" parameter in Notification', 0, 'notification.event', $source['event']
|
||||
);
|
||||
}
|
||||
}
|
||||
if (empty($source['object'])) {
|
||||
throw new EmptyPropertyValueException('Parameter object in NotificationWaitingForCapture is empty');
|
||||
}
|
||||
$this->_object = new PaymentResponse($source['object']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает объект с информацией о платеже, уведомление о котором хранится в текущем объекте
|
||||
*
|
||||
* Так как нотификация может быть сгенерирована и поставлена в очередь на отправку гораздо раньше, чем она будет
|
||||
* получена на сайте, то опираться на статус пришедшего платежа не стоит, лучше запросить текущую информацию о
|
||||
* платеже у API.
|
||||
*
|
||||
* @return PaymentInterface Объект с информацией о платеже, который можно подтвердить или отменить
|
||||
*/
|
||||
public function getObject()
|
||||
{
|
||||
return $this->_object;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user