Initial Commit
This commit is contained in:
@@ -0,0 +1,68 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Model\MonetaryAmount;
|
||||
use YooKassa\Model\Refund;
|
||||
|
||||
/**
|
||||
* Абстрактный класс ответа от API с информацией о возврате
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
abstract class AbstractRefundResponse extends Refund
|
||||
{
|
||||
/**
|
||||
* Конструктор
|
||||
* @param array $options Ассоциативный массив с информацией, вернувшейся от API
|
||||
* @throws \Exception
|
||||
*/
|
||||
public function __construct($options)
|
||||
{
|
||||
$this->setId(empty($options['id']) ? null : $options['id']);
|
||||
$this->setPaymentId(empty($options['payment_id']) ? null : $options['payment_id']);
|
||||
$this->setStatus(empty($options['status']) ? null : $options['status']);
|
||||
$this->setCreatedAt(empty($options['created_at']) ? null : $options['created_at']);
|
||||
$this->setAmount(new MonetaryAmount($options['amount']['value'], $options['amount']['currency']));
|
||||
|
||||
if (!empty($options['requestor'])) {
|
||||
$this->setRequestor($options['requestor']);
|
||||
}
|
||||
|
||||
if (!empty($options['sources'])) {
|
||||
$this->setSources($options['sources']);
|
||||
}
|
||||
|
||||
if (!empty($options['receipt_registration'])) {
|
||||
$this->setReceiptRegistration($options['receipt_registration']);
|
||||
}
|
||||
|
||||
if (!empty($options['description'])) {
|
||||
$this->setDescription($options['description']);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,208 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Common\AbstractPaymentRequest;
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
|
||||
use YooKassa\Helpers\TypeCast;
|
||||
use YooKassa\Model\AmountInterface;
|
||||
use YooKassa\Model\ReceiptInterface;
|
||||
use YooKassa\Model\Source;
|
||||
use YooKassa\Model\SourceInterface;
|
||||
|
||||
/**
|
||||
* Класс объекта запроса для создания возврата
|
||||
*
|
||||
* @property string $paymentId Айди платежа для которого создаётся возврат
|
||||
* @property AmountInterface $amount Сумма возврата
|
||||
* @property string $description Комментарий к операции возврата, основание для возврата средств покупателю.
|
||||
* @property ReceiptInterface|null $receipt Инстанс чека или null
|
||||
*/
|
||||
class CreateRefundRequest extends AbstractPaymentRequest implements CreateRefundRequestInterface
|
||||
{
|
||||
/**
|
||||
* @var string Айди платежа для которого создаётся возврат
|
||||
*/
|
||||
private $_paymentId;
|
||||
|
||||
/**
|
||||
* @var string Комментарий к операции возврата, основание для возврата средств покупателю.
|
||||
*/
|
||||
private $_description;
|
||||
|
||||
/**
|
||||
* @var SourceInterface[]
|
||||
*/
|
||||
private $_sources;
|
||||
|
||||
/**
|
||||
* Возвращает айди платежа для которого создаётся возврат средств
|
||||
* @return string Айди платежа для которого создаётся возврат
|
||||
*/
|
||||
public function getPaymentId()
|
||||
{
|
||||
return $this->_paymentId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает айди платежа для которого создаётся возврат
|
||||
* @param string $value Айди платежа
|
||||
*
|
||||
* @throws EmptyPropertyValueException Выбрасывается если передано пустое значение айди платежа
|
||||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение является строкой, но не является
|
||||
* валидным значением айди платежа
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если передано значение не валидного типа
|
||||
*/
|
||||
public function setPaymentId($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
throw new EmptyPropertyValueException(
|
||||
'Empty payment id value in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId'
|
||||
);
|
||||
} elseif (TypeCast::canCastToString($value)) {
|
||||
$length = mb_strlen($value, 'utf-8');
|
||||
if ($length != 36) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid payment id value in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId', $value
|
||||
);
|
||||
}
|
||||
$this->_paymentId = (string)$value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid payment id value type in CreateRefundRequest', 0, 'CreateRefundRequest.paymentId', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает комментарий к возврату или null, если комментарий не задан
|
||||
* @return string Комментарий к операции возврата, основание для возврата средств покупателю.
|
||||
*/
|
||||
public function getDescription()
|
||||
{
|
||||
return $this->_description;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет задан ли комментарий к создаваемому возврату
|
||||
* @return bool True если комментарий установлен, false если нет
|
||||
*/
|
||||
public function hasDescription()
|
||||
{
|
||||
return $this->_description !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает комментарий к возврату
|
||||
* @param string $value Комментарий к операции возврата, основание для возврата средств покупателю
|
||||
*
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если была передана не строка
|
||||
*/
|
||||
public function setDescription($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_description = null;
|
||||
} elseif (TypeCast::canCastToString($value)) {
|
||||
$this->_description = (string)$value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid description value type in CreateRefundRequest', 0, 'CreateRefundRequest.description', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает transfers (массив распределения денег между магазинами)
|
||||
* @param SourceInterface[]|array $value
|
||||
*/
|
||||
public function setSources($value)
|
||||
{
|
||||
if (!is_array($value)) {
|
||||
$message = 'Sources must be an array of SourceInterface';
|
||||
throw new InvalidPropertyValueTypeException($message, 0, 'CreateRefundRequest.sources', $value);
|
||||
}
|
||||
|
||||
$sources = array();
|
||||
foreach ($value as $item) {
|
||||
if (is_array($item)) {
|
||||
$item = new Source($item);
|
||||
}
|
||||
|
||||
if (!($item instanceof SourceInterface)) {
|
||||
$message = 'Source must be instance of SourceInterface';
|
||||
throw new InvalidPropertyValueTypeException($message, 0, 'CreateRefundRequest.sources', $value);
|
||||
}
|
||||
$sources[] = $item;
|
||||
}
|
||||
|
||||
$this->_sources = $sources;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return SourceInterface[]
|
||||
*/
|
||||
public function getSources()
|
||||
{
|
||||
return $this->_sources;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function hasSources()
|
||||
{
|
||||
return !empty($this->_sources);
|
||||
}
|
||||
|
||||
/**
|
||||
* Валидирует текущий объект запроса
|
||||
* @return bool True если текущий объект запроса валиден, false если нет
|
||||
*/
|
||||
public function validate()
|
||||
{
|
||||
if (!parent::validate()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (empty($this->_paymentId)) {
|
||||
$this->setValidationError('Payment id not specified');
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает билдер объектов текущего типа
|
||||
* @return CreateRefundRequestBuilder Инстанс билдера запрсов
|
||||
*/
|
||||
public static function builder()
|
||||
{
|
||||
return new CreateRefundRequestBuilder();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,118 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Common\AbstractPaymentRequestBuilder;
|
||||
use YooKassa\Common\Exceptions\EmptyPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
|
||||
use YooKassa\Model\SourceInterface;
|
||||
|
||||
/**
|
||||
* Класс билдера запросов к API на создание возврата средств
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class CreateRefundRequestBuilder extends AbstractPaymentRequestBuilder
|
||||
{
|
||||
|
||||
/**
|
||||
* @var CreateRefundRequest Собираемый объет запроса к API
|
||||
*/
|
||||
protected $currentObject;
|
||||
|
||||
/**
|
||||
* Возвращает новый объект для сборки
|
||||
* @return CreateRefundRequest Собираемый объет запроса к API
|
||||
*/
|
||||
protected function initCurrentObject()
|
||||
{
|
||||
parent::initCurrentObject();
|
||||
return new CreateRefundRequest();
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает айди платежа для которого создаётся возврат
|
||||
* @param string $value Айди платежа
|
||||
* @return CreateRefundRequestBuilder Инстанс текущего билдера
|
||||
*
|
||||
* @throws EmptyPropertyValueException Выбрасывается если передано пустое значение айди платежа
|
||||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение является строкой, но не является
|
||||
* валидным значением айди платежа
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если передано значение не валидного типа
|
||||
*/
|
||||
public function setPaymentId($value)
|
||||
{
|
||||
$this->currentObject->setPaymentId($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает комментарий к возврату
|
||||
* @param string $value Комментарий к возврату
|
||||
* @return CreateRefundRequestBuilder Инстанс текущего билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если была передана не строка
|
||||
*/
|
||||
public function setDescription($value)
|
||||
{
|
||||
$this->currentObject->setDescription($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает источники возврата
|
||||
*
|
||||
* @param SourceInterface[]|array $value Массив трансферов
|
||||
*
|
||||
* @return self Инстанс билдера запросов
|
||||
*/
|
||||
public function setSources($value)
|
||||
{
|
||||
$this->currentObject->setSources($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Строит объект запроса к API
|
||||
* @param array|null $options Устаналвиваемые параметры запроса
|
||||
* @return CreateRefundRequestInterface Инстанс сгенерированного объекта запроса к API
|
||||
*/
|
||||
public function build(array $options = null)
|
||||
{
|
||||
if (!empty($options)) {
|
||||
$this->setOptions($options);
|
||||
}
|
||||
|
||||
$this->currentObject->setAmount($this->amount);
|
||||
|
||||
if ($this->receipt->notEmpty()) {
|
||||
$this->currentObject->setReceipt($this->receipt);
|
||||
}
|
||||
return parent::build();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,90 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Model\AmountInterface;
|
||||
use YooKassa\Model\ReceiptInterface;
|
||||
use YooKassa\Model\SourceInterface;
|
||||
|
||||
/**
|
||||
* Интерфейс объекта запроса на возврат
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*
|
||||
* @property-read string $paymentId Айди платежа для которого создаётся возврат
|
||||
* @property-read AmountInterface $amount Сумма возврата
|
||||
* @property-read string $description Комментарий к операции возврата, основание для возврата средств покупателю.
|
||||
* @property-read ReceiptInterface|null $receipt Инстанс чека или null
|
||||
*/
|
||||
interface CreateRefundRequestInterface
|
||||
{
|
||||
/**
|
||||
* Возвращает айди платежа для которого создаётся возврат средств
|
||||
* @return string Айди платежа для которого создаётся возврат
|
||||
*/
|
||||
function getPaymentId();
|
||||
|
||||
/**
|
||||
* Возвращает сумму возвращаемых средств
|
||||
* @return AmountInterface Сумма возврата
|
||||
*/
|
||||
function getAmount();
|
||||
|
||||
/**
|
||||
* Возвращает комментарий к возврату или null, если комментарий не задан
|
||||
* @return string Комментарий к операции возврата, основание для возврата средств покупателю.
|
||||
*/
|
||||
function getDescription();
|
||||
|
||||
/**
|
||||
* Проверяет задан ли комментарий к создаваемому возврату
|
||||
* @return bool True если комментарий установлен, false если нет
|
||||
*/
|
||||
function hasDescription();
|
||||
|
||||
/**
|
||||
* Возвращает инстанс чека или null если чек не задан
|
||||
* @return ReceiptInterface|null Инстанс чека или null
|
||||
*/
|
||||
function getReceipt();
|
||||
|
||||
/**
|
||||
* Проверяет задан ли чек
|
||||
* @return bool True если чек есть, false если нет
|
||||
*/
|
||||
function hasReceipt();
|
||||
|
||||
/**
|
||||
* @return SourceInterface[]
|
||||
*/
|
||||
function getSources();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
function hasSources();
|
||||
}
|
||||
@@ -0,0 +1,136 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Model\AmountInterface;
|
||||
use YooKassa\Model\ReceiptItem;
|
||||
use YooKassa\Model\SourceInterface;
|
||||
|
||||
/**
|
||||
* Класс сериалайзера запросов к API на создание нового возврата средств
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class CreateRefundRequestSerializer
|
||||
{
|
||||
/**
|
||||
* Сериализует переданный объект запроса к API в массив
|
||||
*
|
||||
* @param CreateRefundRequestInterface $request Сериализуемый объект запроса
|
||||
*
|
||||
* @return array Ассоциативный массив для передачи в API
|
||||
*/
|
||||
public function serialize(CreateRefundRequestInterface $request)
|
||||
{
|
||||
$result = array(
|
||||
'payment_id' => $request->getPaymentId(),
|
||||
'amount' => array(
|
||||
'value' => $request->getAmount()->getValue(),
|
||||
'currency' => $request->getAmount()->getCurrency(),
|
||||
),
|
||||
);
|
||||
if ($request->hasDescription()) {
|
||||
$result['description'] = $request->getDescription();
|
||||
}
|
||||
if ($request->hasReceipt()) {
|
||||
$receipt = $request->getReceipt();
|
||||
$result['receipt'] = array();
|
||||
/** @var ReceiptItem $item */
|
||||
foreach ($receipt->getItems() as $item) {
|
||||
$itemArray = array(
|
||||
'description' => $item->getDescription(),
|
||||
'amount' => array(
|
||||
'value' => $item->getPrice()->getValue(),
|
||||
'currency' => $item->getPrice()->getCurrency(),
|
||||
),
|
||||
'quantity' => $item->getQuantity(),
|
||||
'vat_code' => $item->getVatCode(),
|
||||
);
|
||||
|
||||
if ($item->getPaymentSubject()) {
|
||||
$itemArray['payment_subject'] = $item->getPaymentSubject();
|
||||
}
|
||||
|
||||
if ($item->getPaymentMode()) {
|
||||
$itemArray['payment_mode'] = $item->getPaymentMode();
|
||||
}
|
||||
|
||||
$result['receipt']['items'][] = $itemArray;
|
||||
}
|
||||
|
||||
$value = $receipt->getCustomer()->getEmail();
|
||||
if (!empty($value)) {
|
||||
$result['receipt']['customer']['email'] = $value;
|
||||
}
|
||||
$value = $receipt->getCustomer()->getPhone();
|
||||
if (!empty($value)) {
|
||||
$result['receipt']['customer']['phone'] = $value;
|
||||
}
|
||||
$value = $receipt->getTaxSystemCode();
|
||||
if (!empty($value)) {
|
||||
$result['receipt']['tax_system_code'] = $value;
|
||||
}
|
||||
}
|
||||
|
||||
if ($request->hasSources()) {
|
||||
$result['sources'] = $this->serializeSources($request->getSources());
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param AmountInterface $amount
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function serializeAmount(AmountInterface $amount)
|
||||
{
|
||||
return array(
|
||||
'value' => $amount->getValue(),
|
||||
'currency' => $amount->getCurrency(),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param SourceInterface[] $transfers
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function serializeSources(array $sources)
|
||||
{
|
||||
$result = array();
|
||||
foreach ($sources as $source) {
|
||||
$result[] = array(
|
||||
'account_id' => $source->getAccountId(),
|
||||
'amount' => $this->serializeAmount($source->getAmount())
|
||||
);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
/**
|
||||
* Класс объекта ответа от API при создании нового возврата
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class CreateRefundResponse extends AbstractRefundResponse
|
||||
{}
|
||||
@@ -0,0 +1,35 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
/**
|
||||
* Класс объекта ответа от API при запросе одного конкретного возврата
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class RefundResponse extends AbstractRefundResponse
|
||||
{}
|
||||
@@ -0,0 +1,462 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use Exception;
|
||||
use YooKassa\Common\AbstractRequest;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
|
||||
use YooKassa\Helpers\TypeCast;
|
||||
use YooKassa\Model\RefundStatus;
|
||||
|
||||
/**
|
||||
* Класс объекта запроса к API списка возвратов магазина
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*
|
||||
* @property \DateTime $createdAtGte Время создания, от (включительно)
|
||||
* @property \DateTime $createdAtGt Время создания, от (не включая)
|
||||
* @property \DateTime $createdAtLte Время создания, до (включительно)
|
||||
* @property \DateTime $createdAtLt Время создания, до (не включая)
|
||||
* @property string $paymentId Идентификатор платежа
|
||||
* @property string $status Статус возврата
|
||||
* @property integer|null $limit Ограничение количества объектов возврата, отображаемых на одной странице выдачи
|
||||
* @property string $cursor Токен для получения следующей страницы выборки
|
||||
*/
|
||||
class RefundsRequest extends AbstractRequest implements RefundsRequestInterface
|
||||
{
|
||||
const MAX_LIMIT_VALUE = 100;
|
||||
|
||||
/**
|
||||
* @var \DateTime Время создания, от (включительно)
|
||||
*/
|
||||
private $_createdAtGte;
|
||||
|
||||
/**
|
||||
* @var \DateTime Время создания, от (не включая)
|
||||
*/
|
||||
private $_createdAtGt;
|
||||
|
||||
/**
|
||||
* @var \DateTime Время создания, до (включительно)
|
||||
*/
|
||||
private $_createdAtLte;
|
||||
|
||||
/**
|
||||
* @var \DateTime Время создания, до (не включая)
|
||||
*/
|
||||
private $_createdAtLt;
|
||||
|
||||
/**
|
||||
* @var string Идентификатор шлюза
|
||||
*/
|
||||
private $_paymentId;
|
||||
|
||||
/**
|
||||
* @var string Статус возврата
|
||||
*/
|
||||
private $_status;
|
||||
|
||||
/**
|
||||
* @var string Ограничение количества объектов платежа
|
||||
*/
|
||||
private $_limit;
|
||||
|
||||
/**
|
||||
* @var string Токен для получения следующей страницы выборки
|
||||
*/
|
||||
private $_cursor;
|
||||
|
||||
/**
|
||||
* Возвращает идентификатор платежа если он задан или null
|
||||
* @return string|null Идентификатор платежа
|
||||
*/
|
||||
public function getPaymentId()
|
||||
{
|
||||
return $this->_paymentId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет, был ли задан идентификатор платежа
|
||||
* @return bool True если идентификатор был задан, false если нет
|
||||
*/
|
||||
public function hasPaymentId()
|
||||
{
|
||||
return !empty($this->_paymentId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает идентификатор платежа или null если требуется его удалить
|
||||
* @param string|null $value Идентификатор платежа
|
||||
*
|
||||
* @throws InvalidPropertyValueException Выбрасывается если длина переданной строки не равна 36 символам
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||||
*/
|
||||
public function setPaymentId($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_paymentId = null;
|
||||
} elseif (TypeCast::canCastToString($value)) {
|
||||
$length = mb_strlen((string)$value, 'utf-8');
|
||||
if ($length != 36) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid payment id value in RefundsRequest', 0, 'RefundsRequest.paymentId', $value
|
||||
);
|
||||
}
|
||||
$this->_paymentId = (string)$value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid payment id value type in RefundsRequest', 0, 'RefundsRequest.paymentId', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, от (включительно)
|
||||
*/
|
||||
public function getCreatedAtGte()
|
||||
{
|
||||
return $this->_createdAtGte;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания от которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
public function hasCreatedAtGte()
|
||||
{
|
||||
return !empty($this->_createdAtGte);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания от которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, от (включительно) или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtGte($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_createdAtGte = null;
|
||||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||||
$dateTime = TypeCast::castToDateTime($value);
|
||||
if ($dateTime === null) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid created_gte value in RefundsRequest', 0, 'RefundsRequest.createdAtGte'
|
||||
);
|
||||
}
|
||||
$this->_createdAtGte = $dateTime;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid created_gte value type in RefundsRequest', 0, 'RefundsRequest.createdAtGte'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, от (не включая)
|
||||
*/
|
||||
public function getCreatedAtGt()
|
||||
{
|
||||
return $this->_createdAtGt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания от которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
public function hasCreatedAtGt()
|
||||
{
|
||||
return !empty($this->_createdAtGt);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания от которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, от (не включая) или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtGt($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_createdAtGt = null;
|
||||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||||
$dateTime = TypeCast::castToDateTime($value);
|
||||
if ($dateTime === null) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid created_gt value in RefundsRequest', 0, 'RefundsRequest.createdAtGt'
|
||||
);
|
||||
}
|
||||
$this->_createdAtGt = $dateTime;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid created_gt value type in RefundsRequest', 0, 'RefundsRequest.createdAtGt'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, до (включительно)
|
||||
*/
|
||||
public function getCreatedAtLte()
|
||||
{
|
||||
return $this->_createdAtLte;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания до которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
public function hasCreatedAtLte()
|
||||
{
|
||||
return !empty($this->_createdAtLte);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания до которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, до (включительно) или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtLte($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_createdAtLte = null;
|
||||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||||
$dateTime = TypeCast::castToDateTime($value);
|
||||
if ($dateTime === null) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid created_lte value in RefundsRequest', 0, 'RefundsRequest.createdLte'
|
||||
);
|
||||
}
|
||||
$this->_createdAtLte = $dateTime;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid created_lte value type in RefundsRequest', 0, 'RefundsRequest.createdLte'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, до (не включая)
|
||||
*/
|
||||
public function getCreatedAtLt()
|
||||
{
|
||||
return $this->_createdAtLt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания до которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
public function hasCreatedAtLt()
|
||||
{
|
||||
return !empty($this->_createdAtLt);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания до которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, до (не включая) или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtLt($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_createdAtLt = null;
|
||||
} elseif (TypeCast::canCastToDateTime($value)) {
|
||||
$dateTime = TypeCast::castToDateTime($value);
|
||||
if ($dateTime === null) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid created_lt value in RefundsRequest', 0, 'RefundsRequest.createdLt'
|
||||
);
|
||||
}
|
||||
$this->_createdAtLt = $dateTime;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid created_lt value type in RefundsRequest', 0, 'RefundsRequest.createdLt'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает статус выбираемых возвратов или null если он до этого не был установлен
|
||||
* @return string|null Статус выбираемых возвратов
|
||||
*/
|
||||
public function getStatus()
|
||||
{
|
||||
return $this->_status;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет был ли установлен статус выбираемых возвратов
|
||||
* @return bool True если статус был установлен, false если нет
|
||||
*/
|
||||
public function hasStatus()
|
||||
{
|
||||
return !empty($this->_status);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает статус выбираемых возвратов
|
||||
* @param string $value Статус выбираемых платежей или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение не является валидным статусом
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||||
*/
|
||||
public function setStatus($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_status = null;
|
||||
} elseif (TypeCast::canCastToEnumString($value)) {
|
||||
if (!RefundStatus::valueExists((string)$value)) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid status value in RefundsRequest', 0, 'RefundsRequest.status', $value
|
||||
);
|
||||
} else {
|
||||
$this->_status = (string)$value;
|
||||
}
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid status value in RefundsRequest', 0, 'RefundsRequest.status', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает токен для получения следующей страницы выборки
|
||||
* @return string|null Токен для получения следующей страницы выборки
|
||||
*/
|
||||
public function getCursor()
|
||||
{
|
||||
return $this->_cursor;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет был ли установлен токен следующей страницы
|
||||
* @return bool True если токен был установлен, false если нет
|
||||
*/
|
||||
public function hasCursor()
|
||||
{
|
||||
return !empty($this->_cursor);
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает токен следующей страницы выборки
|
||||
* @param string $value Токен следующей страницы выборки или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||||
*/
|
||||
public function setCursor($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_cursor = null;
|
||||
} elseif (TypeCast::canCastToString($value)) {
|
||||
$this->_cursor = (string) $value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid status value in RefundsRequest', 0, 'RefundsRequest.cursor', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Ограничение количества объектов платежа
|
||||
* @return integer|null Ограничение количества объектов платежа
|
||||
*/
|
||||
public function getLimit()
|
||||
{
|
||||
return $this->_limit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет был ли установлено ограничение количества объектов платежа
|
||||
* @return bool True если было установлено, false если нет
|
||||
*/
|
||||
public function hasLimit()
|
||||
{
|
||||
return $this->_limit !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает ограничение количества объектов платежа
|
||||
* @param integer|null $value Ограничение количества объектов платежа или null чтобы удалить значение
|
||||
*
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передано не целое число
|
||||
*/
|
||||
public function setLimit($value)
|
||||
{
|
||||
if ($value === null || $value === '') {
|
||||
$this->_limit = null;
|
||||
} elseif (is_int($value)) {
|
||||
if ($value < 0 || $value > self::MAX_LIMIT_VALUE) {
|
||||
throw new InvalidPropertyValueException(
|
||||
'Invalid limit value in RefundsRequest', 0, 'RefundsRequest.limit', $value
|
||||
);
|
||||
}
|
||||
$this->_limit = $value;
|
||||
} else {
|
||||
throw new InvalidPropertyValueTypeException(
|
||||
'Invalid limit value type in RefundsRequest', 0, 'RefundsRequest.limit', $value
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет валидность текущего объекта запроса
|
||||
* @return bool True если объект валиден, false если нет
|
||||
*/
|
||||
public function validate()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает инстанс билдера объектов запросов списка возвратов магазина
|
||||
* @return RefundsRequestBuilder Билдер объектов запросов списка возвратов
|
||||
*/
|
||||
public static function builder()
|
||||
{
|
||||
return new RefundsRequestBuilder();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,181 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Common\AbstractRequestBuilder;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueException;
|
||||
use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
|
||||
|
||||
/**
|
||||
* Класс билдера объектов запросов к API списка возвратов
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class RefundsRequestBuilder extends AbstractRequestBuilder
|
||||
{
|
||||
/**
|
||||
* @var RefundsRequest Инстанс собираемого объекта запроса
|
||||
*/
|
||||
protected $currentObject;
|
||||
|
||||
/**
|
||||
* Инициализирует новый инстанс собираемого объекта
|
||||
* @return RefundsRequest Инстанс собираемого запроса
|
||||
*/
|
||||
protected function initCurrentObject()
|
||||
{
|
||||
return new RefundsRequest();
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает идентификатор платежа или null если требуется его удалить
|
||||
* @param string|null $value Идентификатор платежа
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueException Выбрасывается если длина переданной строки не равна 36 символам
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||||
*/
|
||||
public function setPaymentId($value)
|
||||
{
|
||||
$this->currentObject->setPaymentId($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает статус выбираемых возвратов
|
||||
* @param string $value Статус выбираемых платежей или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueException Выбрасывается если переданное значение не является валидным статусом
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||||
*/
|
||||
public function setStatus($value)
|
||||
{
|
||||
$this->currentObject->setStatus($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает ограничение количества объектов возвратов
|
||||
* @param string $value Ограничение количества объектов возвратов или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод было передана не целое число
|
||||
*/
|
||||
public function setLimit($value)
|
||||
{
|
||||
$this->currentObject->setLimit($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает токен следующей страницы выборки
|
||||
* @param string $value Токен следующей страницы выборки или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueTypeException Выбрасывается если в метод была передана не строка
|
||||
*/
|
||||
public function setCursor($value)
|
||||
{
|
||||
$this->currentObject->setCursor($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания от которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, от (не включая) или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|\Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtGt($value)
|
||||
{
|
||||
$this->currentObject->setCreatedAtGt($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания от которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, от (включительно) или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|\Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtGte($value)
|
||||
{
|
||||
$this->currentObject->setCreatedAtGte($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания до которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, до (не включая) или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|\Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtLt($value)
|
||||
{
|
||||
$this->currentObject->setCreatedAtLt($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Устанавливает дату создания до которой выбираются возвраты
|
||||
* @param \DateTime|string|int|null $value Время создания, до (включительно) или null чтобы удалить значение
|
||||
* @return RefundsRequestBuilder Инстанс текущего объекта билдера
|
||||
*
|
||||
* @throws InvalidPropertyValueException Генерируется если была передана дата в невалидном формате (была передана
|
||||
* строка или число, которые не удалось преобразовать в валидную дату)
|
||||
* @throws InvalidPropertyValueTypeException|\Exception Генерируется если была передана дата с не тем типом (передана не
|
||||
* строка, не число и не значение типа \DateTime)
|
||||
*/
|
||||
public function setCreatedAtLte($value)
|
||||
{
|
||||
$this->currentObject->setCreatedAtLte($value);
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Собирает и возвращает объект запроса списка возвратов магазина
|
||||
* @param array|null $options Массив с настройками запроса
|
||||
* @return RefundsRequestInterface Инстанс объекта запроса к API для получения списка возвратов магазина
|
||||
*/
|
||||
public function build(array $options = null)
|
||||
{
|
||||
return parent::build($options);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
/**
|
||||
* Интерфейс объекта запроса списка возвратов
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*
|
||||
* @property-read string $paymentId Идентификатор платежа
|
||||
* @property-read \DateTime $createdAtGte Время создания, от (включительно)
|
||||
* @property-read \DateTime $createdAtGt Время создания, от (не включая)
|
||||
* @property-read \DateTime $createdAtLte Время создания, до (включительно)
|
||||
* @property-read \DateTime $createdAtLt Время создания, до (не включая)
|
||||
* @property-read string $status Статус возврата
|
||||
* @property-read string $cursor Токен для получения следующей страницы выборки
|
||||
* @property-read integer|null $limit Ограничение количества объектов, отображаемых на одной странице выдачи
|
||||
*/
|
||||
interface RefundsRequestInterface
|
||||
{
|
||||
/**
|
||||
* Возвращает идентификатор платежа если он задан или null
|
||||
* @return string|null Идентификатор платежа
|
||||
*/
|
||||
function getPaymentId();
|
||||
|
||||
/**
|
||||
* Проверяет, был ли задан идентификатор платежа
|
||||
* @return bool True если идентификатор был задан, false если нет
|
||||
*/
|
||||
function hasPaymentId();
|
||||
|
||||
/**
|
||||
* Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, от (включительно)
|
||||
*/
|
||||
function getCreatedAtGte();
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания от которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
function hasCreatedAtGte();
|
||||
|
||||
/**
|
||||
* Возвращает дату создания от которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, от (не включая)
|
||||
*/
|
||||
function getCreatedAtGt();
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания от которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
function hasCreatedAtGt();
|
||||
|
||||
/**
|
||||
* Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, до (включительно)
|
||||
*/
|
||||
function getCreatedAtLte();
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания до которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
function hasCreatedAtLte();
|
||||
|
||||
/**
|
||||
* Возвращает дату создания до которой будут возвращены возвраты или null если дата не была установлена
|
||||
* @return \DateTime|null Время создания, до (не включая)
|
||||
*/
|
||||
function getCreatedAtLt();
|
||||
|
||||
/**
|
||||
* Проверяет была ли установлена дата создания до которой выбираются возвраты
|
||||
* @return bool True если дата была установлена, false если нет
|
||||
*/
|
||||
function hasCreatedAtLt();
|
||||
|
||||
/**
|
||||
* Возвращает статус выбираемых возвратов или null если он до этого не был установлен
|
||||
* @return string|null Статус выбираемых возвратов
|
||||
*/
|
||||
function getStatus();
|
||||
|
||||
/**
|
||||
* Проверяет был ли установлен статус выбираемых возвратов
|
||||
* @return bool True если статус был установлен, false если нет
|
||||
*/
|
||||
function hasStatus();
|
||||
|
||||
/**
|
||||
* Возвращает токен для получения следующей страницы выборки
|
||||
* @return string|null Токен для получения следующей страницы выборки
|
||||
*/
|
||||
function getCursor();
|
||||
|
||||
/**
|
||||
* Проверяет был ли установлен токен следующей страницы
|
||||
* @return bool True если токен был установлен, false если нет
|
||||
*/
|
||||
function hasCursor();
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
/**
|
||||
* Класс сериализатора объектов запросов к API для получения списка возвратов
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class RefundsRequestSerializer
|
||||
{
|
||||
/**
|
||||
* @var array Карта маппинга свойств объекта запроса на поля отправляемого запроса
|
||||
*/
|
||||
private static $propertyMap = array(
|
||||
'cursor' => 'cursor',
|
||||
'createdAtGte' => 'created_at.gte',
|
||||
'createdAtGt' => 'created_at.gt',
|
||||
'createdAtLte' => 'created_at.lte',
|
||||
'createdAtLt' => 'created_at.lt',
|
||||
'limit' => 'limit',
|
||||
'paymentId' => 'payment_id',
|
||||
'status' => 'status',
|
||||
);
|
||||
|
||||
/**
|
||||
* Сериализует объект запроса к API для дальнейшей его отправки
|
||||
* @param RefundsRequestInterface $request Сериализуемый объект
|
||||
* @return array Массив с инфомрацией, отпарвляемый в дальнейшем в API
|
||||
*/
|
||||
public function serialize(RefundsRequestInterface $request)
|
||||
{
|
||||
$result = array();
|
||||
foreach (self::$propertyMap as $property => $name) {
|
||||
$value = $request->{$property};
|
||||
if (!empty($value)) {
|
||||
if ($value instanceof \DateTime) {
|
||||
if ($value->getTimestamp() > 1) {
|
||||
$result[$name] = $value->format(YOOKASSA_DATE);
|
||||
}
|
||||
} else {
|
||||
$result[$name] = $value;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,90 @@
|
||||
<?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\Request\Refunds;
|
||||
|
||||
use YooKassa\Model\RefundInterface;
|
||||
|
||||
/**
|
||||
* Класс объекта ответа от API со списком возвратов магазина
|
||||
*
|
||||
* @package YooKassa\Request\Refunds
|
||||
*/
|
||||
class RefundsResponse
|
||||
{
|
||||
/**
|
||||
* @var RefundInterface[] Массив возвратов
|
||||
*/
|
||||
private $items;
|
||||
|
||||
/**
|
||||
* @var string|null Токен следующей страницы
|
||||
*/
|
||||
private $nextCursor;
|
||||
|
||||
/**
|
||||
* Конструктор, устанавливает свойства объекта из пришедшего из API ассоциативного массива
|
||||
* @param array $options Массив настроек, пришедший от API
|
||||
*/
|
||||
public function __construct(array $options)
|
||||
{
|
||||
$this->items = array();
|
||||
foreach ($options['items'] as $item) {
|
||||
$this->items[] = new RefundResponse($item);
|
||||
}
|
||||
if (!empty($options['next_cursor'])) {
|
||||
$this->nextCursor = $options['next_cursor'];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает список возвратов
|
||||
* @return RefundInterface[] Список возвратов
|
||||
*/
|
||||
public function getItems()
|
||||
{
|
||||
return $this->items;
|
||||
}
|
||||
|
||||
/**
|
||||
* Возвращает токен следующей страницы, если он задан, или null
|
||||
* @return string|null Токен следующей страницы
|
||||
*/
|
||||
public function getNextCursor()
|
||||
{
|
||||
return $this->nextCursor;
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет имееотся ли в ответе токен следующей страницы
|
||||
* @return bool True если токен следующей страницы есть, false если нет
|
||||
*/
|
||||
public function hasNextCursor()
|
||||
{
|
||||
return $this->nextCursor !== null;
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user