Документация для разработчиков
Темная тема

Методы

API

Метод Описание С версии
type(string $type)Позволяет указать желаемый тип (стандарт) для штрих-кода. Список возможных значений доступен в Bitrix\UI\Util\Barcode\BarcodeDictionary.
Не является обязательным, по умолчанию установлен QR.
format(string $format)Позволяет указать желаемый формат для штрих кода. Список возможных значений доступен в Bitrix\UI\Util\Barcode\BarcodeDictionary.
Не является обязательным, по умолчанию установлен png.
option(string $optionName, $value)Используемая библиотека поддерживает большое количество опций, позволяющих кастомизировать результат. С помощью данного метода можно указать значение для какой-то конкретной опции. Полный список всех доступных опций можно найти на странице библиотеки https://github.com/kreativekorp/barcode.
options(array $options)Используемая библиотека поддерживает большое количество опций, позволяющих кастомизировать результат. С помощью данного метода можно установить значения для всех опций разом. Полный список всех доступных опций можно найти на странице библиотеки https://github.com/kreativekorp/barcode.
render(string $message)Обеспечивает генерацию штрих кода с указанным сообщением и возвращает полученный результат.
print(string $message)Обеспечивает генерацию штрих кода с указанным сообщением и печатает результат в поток вывода.

Пример

use Bitrix\UI\Barcode\BarcodeDictionary;
use Bitrix\UI\Barcode\Barcode;

// генерация штрих кода в gif формате и прямая печать в вывод
$message = '1234567890';
(new Barcode())
	->type(BarcodeDictionary::TYPE_UPC_A)
	->format(BarcodeDictionary::FORMAT_GIF)
	->print($message);
    
// создание QR кода и дальнейшее сохранение в файл
// по умолчанию используется тип QR и формат png
$link = 'https://google.com';
$content = (new Barcode())->render($link);
$arFile = array(
	'name' => 'myCode.png',
	'content'  => $content,
	'module_id' => 'ui'
);
$fileId = \CFile::SaveFile($arFile, 'ui');

// генерация с указанием линейных размеров
(new Barcode())
	->type(BarcodeDictionary::TYPE_QR)
	->format(BarcodeDictionary::FORMAT_JPEG)
	->option('w', 150)
	->option('h', 150)
	->render($link);


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх