yookassa-sdk-php/docs/classes/YooKassa-Helpers-ProductCode.md

YooKassa API SDK

Class: \YooKassa\Helpers\ProductCode

Namespace: \YooKassa\Helpers

---

Summary:

Класс для формирования тега 1162 на основе кода в формате Data Matrix

---

Examples

Вариант через метод

$inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh';
$productCode = new \YooKassa\Helpers\ProductCode($inputDataMatrix);
$receiptItem = new \YooKassa\Model\ReceiptItem();
$receiptItem->setProductCode($productCode);

var_dump($receiptItem);

Вариант через массив

$inputDataMatrix = '010463003407001221SxMGorvNuq6Wk91fgr92sdfsdfghfgjh';
$receiptItem = new \YooKassa\Model\ReceiptItem(array(
    'product_code' => (string)(new \YooKassa\Helpers\ProductCode($inputDataMatrix)),
));

var_dump($receiptItem);

---

Constants

Visibility	Name	Flag	Summary
public	PREFIX_DATA_MATRIX		Код типа маркировки DataMatrix

---

Methods

Visibility	Name	Flag	Summary
public	__construct()		ProductCode constructor.
public	__toString()		Приводит объект к строке
public	calcResult()		Формирует тег 1162.
public	getGtin()		Возвращает Глобальный номер товарной продукции
public	getPrefix()		Возвращает Код типа маркировки
public	getResult()		Возвращает Сформированный тег 1162.
public	getSerial()		Возвращает Серийный номер товара
public	isUsePrefix()		Возвращает флаг использования кода типа маркировки
public	setGtin()		Устанавливает Глобальный номер товарной продукции
public	setPrefix()		Устанавливает Код типа маркировки
public	setSerial()		Устанавливает Серийный номер товара
public	setUsePrefix()		Устанавливает флаг использования кода типа маркировки
public	validate()		Проверяет заполненность необходимых свойств

---

Details

• File: lib/Helpers/ProductCode.php
• Package: YooKassa
• Class Hierarchy:
  • \YooKassa\Helpers\ProductCode
• See Also:

---

Constants

PREFIX_DATA_MATRIX

Код типа маркировки DataMatrix

PREFIX_DATA_MATRIX = '444D'

---

Methods

public __construct() : mixed

public __construct(string|null $codeDataMatrix = null, bool|string $usePrefix = false) : mixed

Summary

ProductCode constructor.

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
string OR null	codeDataMatrix	Строка, расшифрованная из QR-кода
bool OR string	usePrefix	Нужен ли код типа маркировки в результате

Returns: mixed -

public __toString() : string

public __toString() : string

Summary

Приводит объект к строке

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: string -

public calcResult() : string|null

public calcResult() : string|null

Summary

Формирует тег 1162.

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: string|null - Сформированный тег 1162.

public getGtin() : string

public getGtin() : string

Summary

Возвращает Глобальный номер товарной продукции

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: string - Глобальный номер товарной продукции

public getPrefix() : string

public getPrefix() : string

Summary

Возвращает Код типа маркировки

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: string - Код типа маркировки

public getResult() : string

public getResult() : string

Summary

Возвращает Сформированный тег 1162.

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: string - Сформированный тег 1162.

public getSerial() : string

public getSerial() : string

Summary

Возвращает Серийный номер товара

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: string - Серийный номер товара

public isUsePrefix() : bool

public isUsePrefix() : bool

Summary

Возвращает флаг использования кода типа маркировки

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: bool -

public setGtin() : \YooKassa\Helpers\ProductCode

public setGtin(string $gtin) : \YooKassa\Helpers\ProductCode

Summary

Устанавливает Глобальный номер товарной продукции

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
string	gtin	Глобальный номер товарной продукции

Returns: \YooKassa\Helpers\ProductCode -

public setPrefix() : \YooKassa\Helpers\ProductCode

public setPrefix(string|int $prefix) : \YooKassa\Helpers\ProductCode

Summary

Устанавливает Код типа маркировки

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
string OR int	prefix	Код типа маркировки

Returns: \YooKassa\Helpers\ProductCode -

public setSerial() : \YooKassa\Helpers\ProductCode

public setSerial(string $serial) : \YooKassa\Helpers\ProductCode

Summary

Устанавливает Серийный номер товара

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
string	serial	Серийный номер товара

Returns: \YooKassa\Helpers\ProductCode -

public setUsePrefix() : \YooKassa\Helpers\ProductCode

public setUsePrefix(bool $usePrefix) : \YooKassa\Helpers\ProductCode

Summary

Устанавливает флаг использования кода типа маркировки

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
bool	usePrefix	Флаг использования кода типа маркировки

Returns: \YooKassa\Helpers\ProductCode -

public validate() : bool

public validate() : bool

Summary

Проверяет заполненность необходимых свойств

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: bool -

---

Top Namespaces

• \YooKassa

---

Reports

• Errors - 0
• Markers - 0
• Deprecated - 7

---

This document was automatically generated from source code comments on 2021-09-16 using phpDocumentor

© 2021 YooMoney