Document::getFields() — параметры и описание

Сигнатура

public getFields([array<string|int, mixed> $fieldNames = [] ][, bool $isConvertValuesToString = false ][, bool $groupsAsArrays = false ]) : array<string|int, mixed>

Описание

Возвращает массив со всеми плейсхолдерами, их описаниями полей и фактическими значениями.

Параметры

$fieldNames array<string|int, mixed> = []

$isConvertValuesToString bool = false

$groupsAsArrays bool = false

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

array<string|int, mixed>

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

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

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

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

Loader::includeModule('documentgenerator');

/** @var Document $object */
$result = $object->getFields();
// $result: array<string|int, mixed>

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

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

getFields() есть и у других классов модуля «Генератор документов»: ArrayDataProvider, Body, DataProvider, Document, Docx, DocxXml, EntityDataProvider, HashDataProvider.