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

YooKassa API SDK

Class: \YooKassa\Helpers\ProductCode

Namespace: \YooKassa\Helpers

---

Summary:

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

---

Examples

04-product-code.php 6 7 Вариант через метод

04-product-code.php 15 7 Вариант через массив

---

Constants

Visibility	Name	Flag	Summary
public	PREFIX_DATA_MATRIX
public	PREFIX_UNKNOWN
public	PREFIX_EAN_8
public	PREFIX_EAN_13
public	PREFIX_ITF_14
public	PREFIX_FUR
public	PREFIX_EGAIS_20
public	PREFIX_EGAIS_30
public	TYPE_UNKNOWN
public	TYPE_EAN_8
public	TYPE_EAN_13
public	TYPE_ITF_14
public	TYPE_GS_10
public	TYPE_GS_1M
public	TYPE_SHORT
public	TYPE_FUR
public	TYPE_EGAIS_20
public	TYPE_EGAIS_30
public	AI_GTIN
public	AI_SERIAL
public	AI_SUM
public	MAX_PRODUCT_CODE_LENGTH
public	MAX_MARK_CODE_LENGTH

---

Methods

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

---

Details

• File: lib/Helpers/ProductCode.php

• Package: YooKassa

• Class Hierarchy:

  • \YooKassa\Helpers\ProductCode

• See Also:

---

Constants

PREFIX_DATA_MATRIX

PREFIX_DATA_MATRIX = '444D' : string

PREFIX_UNKNOWN

PREFIX_UNKNOWN = '0000' : string

PREFIX_EAN_8

PREFIX_EAN_8 = '4508' : string

PREFIX_EAN_13

PREFIX_EAN_13 = '450D' : string

PREFIX_ITF_14

PREFIX_ITF_14 = '4909' : string

PREFIX_FUR

PREFIX_FUR = '5246' : string

PREFIX_EGAIS_20

PREFIX_EGAIS_20 = 'C514' : string

PREFIX_EGAIS_30

PREFIX_EGAIS_30 = 'C51E' : string

TYPE_UNKNOWN

TYPE_UNKNOWN = 'unknown' : string

TYPE_EAN_8

TYPE_EAN_8 = 'ean_8' : string

TYPE_EAN_13

TYPE_EAN_13 = 'ean_13' : string

TYPE_ITF_14

TYPE_ITF_14 = 'itf_14' : string

TYPE_GS_10

TYPE_GS_10 = 'gs_10' : string

TYPE_GS_1M

TYPE_GS_1M = 'gs_1m' : string

TYPE_SHORT

TYPE_SHORT = 'short' : string

TYPE_FUR

TYPE_FUR = 'fur' : string

TYPE_EGAIS_20

TYPE_EGAIS_20 = 'egais_20' : string

TYPE_EGAIS_30

TYPE_EGAIS_30 = 'egais_30' : string

AI_GTIN

AI_GTIN = '01' : string

AI_SERIAL

AI_SERIAL = '21' : string

AI_SUM

AI_SUM = '8005' : string

MAX_PRODUCT_CODE_LENGTH

MAX_PRODUCT_CODE_LENGTH = 30 : int

MAX_MARK_CODE_LENGTH

MAX_MARK_CODE_LENGTH = 32 : int

---

Methods

public __construct() : mixed

public __construct(string|null $codeDataMatrix = null, bool|string $usePrefix = true) : 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

public calcResult() : string

Summary

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

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

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

public getAppIdentifiers() : array|null

public getAppIdentifiers() : array|null

Summary

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

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: array|null - Массив дополнительных идентификаторов применения

public getGtin() : string

public getGtin() : string

Summary

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

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

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

public getMarkCodeInfo() : \YooKassa\Model\Receipt\MarkCodeInfo

public getMarkCodeInfo() : \YooKassa\Model\Receipt\MarkCodeInfo

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Returns: \YooKassa\Model\Receipt\MarkCodeInfo -

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 getType() : string

public getType() : 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 setAppIdentifiers() : mixed

public setAppIdentifiers(array|null $appIdentifiers) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
array OR null	appIdentifiers	Массив дополнительных идентификаторов применения

Returns: mixed -

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 setMarkCodeInfo() : mixed

public setMarkCodeInfo(\YooKassa\Model\Receipt\MarkCodeInfo|array|string $markCodeInfo) : mixed

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
\YooKassa\Model\Receipt\MarkCodeInfo OR array OR string	markCodeInfo

Returns: mixed -

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 setType() : mixed

public setType(string $type) : mixed

Summary

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

Details:

• Inherited From: \YooKassa\Helpers\ProductCode

Parameters:

Type	Name	Description
string	type	Тип маркировки

Returns: mixed -

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 - 1
• Deprecated - 25

---

This document was automatically generated from source code comments on 2023-04-06 using phpDocumentor

© 2023 YooMoney