yoomoney_api-2.5.2/vendor/yoomoney/yookassa-sdk-php/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php
vendor/yoomoney/yookassa-sdk-php/lib/Request/Receipts/CreatePostReceiptRequestBuilder.php
<?php
/*
* The MIT License
*
* Copyright (c) 2025 "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\Receipts;
use YooKassa\Common\AbstractPaymentRequestBuilder;
use YooKassa\Common\AbstractRequest;
use YooKassa\Common\AbstractRequestBuilder;
use YooKassa\Common\Exceptions\InvalidRequestException;
use YooKassa\Model\AmountInterface;
use YooKassa\Model\MonetaryAmount;
use YooKassa\Model\Receipt\AdditionalUserProps;
use YooKassa\Model\Receipt\IndustryDetails;
use YooKassa\Model\ReceiptCustomer;
use YooKassa\Model\ReceiptCustomerInterface;
use YooKassa\Model\ReceiptItemInterface;
use YooKassa\Model\ReceiptType;
use YooKassa\Model\SettlementInterface;
/**
* Класс билдера объектов запросов к API на создание чека
*
* @example 02-builder.php 91 56 Пример использования билдера
*
* @package YooKassa
*/
class CreatePostReceiptRequestBuilder extends AbstractRequestBuilder
{
/**
* Собираемый объект запроса
* @var CreatePostReceiptRequest
*/
protected $currentObject;
/**
* Сумма чека
* @var AmountInterface
*/
protected $amount;
/**
* Информация о плательщике
* @var ReceiptCustomer
*/
protected $customer;
/**
* Инициализирует объект запроса, который в дальнейшем будет собираться билдером
* @return CreatePostReceiptRequest Инстанс собираемого объекта запроса к API
*/
protected function initCurrentObject()
{
$this->customer = new ReceiptCustomer();
$this->amount = new MonetaryAmount();
return new CreatePostReceiptRequest();
}
/**
* Устанавливает сумму
*
* @param AmountInterface|array|string $value Сумма оплаты
*
* @return self Инстанс билдера запросов
*/
public function setAmount($value)
{
if (is_object($value) && $value instanceof AmountInterface) {
$this->amount->setValue($value->getValue());
$this->amount->setCurrency($value->getCurrency());
} elseif (is_array($value)) {
$this->amount->fromArray($value);
} else {
$this->amount->setValue($value);
}
return $this;
}
/**
* Устанавливает валюту в которой будет происходить подтверждение оплаты заказа
*
* @param string $value Валюта в которой подтверждается оплата
*
* @return self Инстанс билдера запросов
*/
public function setCurrency($value)
{
$this->amount->setCurrency($value);
foreach ($this->currentObject->getItems() as $item) {
$item->getPrice()->setCurrency($value);
}
return $this;
}
/**
* Устанавливает информацию о пользователе
*
* @param ReceiptCustomerInterface|array $value Информация о плательщике
* @return self Инстанс билдера запросов
*/
public function setCustomer($value)
{
if (is_array($value)) {
$this->customer->fromArray($value);
} elseif ($value instanceof ReceiptCustomerInterface) {
$this->customer = $value;
} else {
$this->customer = null;
}
$this->currentObject->setCustomer($this->customer);
return $this;
}
/**
* Устанавливает список товаров чека
*
* @param ReceiptItemInterface[]|array $value Список товаров чека
* @return CreatePostReceiptRequestBuilder
*/
public function setItems($value)
{
$this->currentObject->setItems($value);
return $this;
}
/**
* Добавляет товар в чек
*
* @param ReceiptItemInterface|array $value Информация о товаре
* @return CreatePostReceiptRequestBuilder
*/
public function addItem($value)
{
$this->currentObject->addItem($value);
return $this;
}
/**
* Устанавливает код системы налогообложения
*
* @param int $value Код системы налогообложения. Число 1-6.
* @return CreatePostReceiptRequestBuilder
*/
public function setTaxSystemCode($value)
{
$this->currentObject->setTaxSystemCode($value);
return $this;
}
/**
* Устанавливает дополнительный реквизит пользователя
*
* @param AdditionalUserProps|array $value Дополнительный реквизит пользователя
* @return CreatePostReceiptRequestBuilder Инстанс билдера запросов
*/
public function setAdditionalUserProps($value)
{
$this->currentObject->setAdditionalUserProps($value);
return $this;
}
/**
* Устанавливает отраслевой реквизит чека
*
* @param array|IndustryDetails[] $value Отраслевой реквизит чека
CreatePostReceiptRequestBuilder */
public function setReceiptIndustryDetails($value)
{
$this->currentObject->setReceiptIndustryDetails($value);
return $this;
}
/**
* Устанавливает отраслевой реквизит чека
*
* @param array|IndustryDetails[] $value Отраслевой реквизит чека
* @return CreatePostReceiptRequestBuilder Инстанс билдера запросов
*/
public function setReceiptOperationalDetails($value)
{
$this->currentObject->setReceiptOperationalDetails($value);
return $this;
}
/**
* Устанавливает тип чека в онлайн-кассе
*
* @param string $value Тип чека в онлайн-кассе: приход "payment" или возврат "refund".
* @return CreatePostReceiptRequestBuilder
*/
public function setType($value)
{
$this->currentObject->setType($value);
return $this;
}
/**
* Устанавливает признак отложенной отправки чека.
*
* @param bool $value Признак отложенной отправки чека.
* @return CreatePostReceiptRequestBuilder
*/
public function setSend($value)
{
$this->currentObject->setSend($value);
return $this;
}
/**
* Устанавливает идентификатор магазина, от имени которого нужно отправить чек.
* Выдается ЮKassa, отображается в разделе Продавцы личного кабинета (столбец shopId).
* Необходимо передавать, если вы используете решение ЮKassa для платформ.
*
* @param string $value Идентификатор магазина, от имени которого нужно отправить чек
* @return CreatePostReceiptRequestBuilder
*/
public function setOnBehalfOf($value)
{
$this->currentObject->setOnBehalfOf($value);
return $this;
}
/**
* Устанавливает массив оплат, обеспечивающих выдачу товара.
*
* @param SettlementInterface[]|array $value Массив оплат, обеспечивающих выдачу товара
* @return CreatePostReceiptRequestBuilder
*/
public function setSettlements($value)
{
$this->currentObject->setSettlements($value);
return $this;
}
/**
* Устанавливает Id объекта чека
*
* @param string $value Id объекта чека
* @param string|null $type Тип объекта чека
* @return CreatePostReceiptRequestBuilder
*/
public function setObjectId($value, $type = null)
{
$this->currentObject->setObjectId($value);
if (!empty($type)) {
$this->currentObject->setObjectType($type);
}
return $this;
}
/**
* Устанавливает тип объекта чека
*
* @param string $value Тип объекта чека
* @return CreatePostReceiptRequestBuilder
*/
public function setObjectType($value)
{
$this->currentObject->setObjectType($value);
return $this;
}
/**
* Строит и возвращает объект запроса для отправки в API ЮKassa
*
* @param array|null $options Массив параметров для установки в объект запроса
* @return CreatePostReceiptRequest|AbstractRequest Инстанс объекта запроса
*
* @throws InvalidRequestException Выбрасывается если собрать объект запроса не удалось
*/
public function build(array $options = null)
{
if (!empty($options)) {
$this->setOptions($options);
if (!empty($options['payment_id'])) {
$this->setObjectId($options['payment_id']);
$this->setObjectType(ReceiptType::PAYMENT);
} elseif (!empty($options['refund_id'])) {
$this->setObjectId($options['refund_id']);
$this->setObjectType(ReceiptType::REFUND);
}
}
return parent::build($options);
}
}
