method public

Document::setFields()

Класс: \Bitrix\DocumentGenerator\Document

Сигнатура

public setFields(array<string|int, mixed> $fields) : $this

Описание

Добавляет новые поля или перезаписывает старые (кроме 'SOURCE' и 'DOCUMENT'), но не очищает весь список.

Параметры

$fields array<string|int, mixed>

Возвращаемое значение

$this

Как применяется в Document

Document::setFields() — метод класса \Bitrix\DocumentGenerator\Document модуля «Генератор документов».

Метод объекта: сначала нужен экземпляр Document.

use Bitrix\Main\Loader;
use Bitrix\DocumentGenerator\Document;

Loader::includeModule('documentgenerator');

/** @var Document $object */
$fields = [];
$result = $object->setFields($fields);
// $result: $this

Другие методы Document

__get()
actualize() Пересоздать документ, используя те же внешние значения.
checkFields() Если $requiredOnly равно true, возвращает список обязательных с пустыми значениями.
createByTemplate() Создаёт новый документ из шаблона на основе конкретного значения.
enablePublicUrl()
enableStamps()
excludeFields() Добавляет $fieldNames в $this->excludeFields (не перезаписывает их)
getCreateTime()
getCreationMethod()
getDownloadUrl()
getEmailDiskFile()
getFields() Возвращает массив со всеми плейсхолдерами, их описаниями полей и фактическими значениями.

setFields() есть и у других классов модуля «Генератор документов»: Body, Docx, DocxXml, PlainText, Xml, ZipDocument.

Исходный файл: source/documentgenerator/lib/document.php:255