templates/js/library/symfony_form_data_builder/symfony_form_data_builder.js.twig line 1

Open in your IDE?
  1. /*
  2.  * SymfonyFormDataBuilder
  3.  * Utility to create and update FormData for Symfony-style form field names.
  4.  *
  5.  * Usage:
  6.  *   const builder = new SymfonyFormDataBuilder('reviewer_settings');
  7.  *   builder.setTextArrayField('candidateDeclineCommentsAsArray', ['a','b']);
  8.  *   const fd = builder.getFormData();
  9.  */
  11. class SymfonyFormDataBuilder {
  12.     /**
  13.      * @param {string} formPrefix - optional form prefix used by Symfony form (e.g. "reviewer_settings").
  14.      */
  15.     constructor(formPrefix = '') {
  16.         this.formPrefix = formPrefix || '';
  17.         this.formData = null; // lazy-created FormData
  18.     }
  20.     // internal: build full field name with prefix
  21.     _prefixedName(name) {
  22.         if (!this.formPrefix) return name;
  23.         return `${this.formPrefix}[${name}]`;
  24.     }
  26.     // Create new FormData (replaces existing)
  27.     create() {
  28.         this.formData = new FormData();
  29.         return this.formData;
  30.     }
  32.     // Ensure FormData exists
  33.     ensure() {
  34.         if (!this.formData) this.create();
  35.         return this.formData;
  36.     }
  38.     // Completely clear current FormData
  39.     clear() {
  40.         this.formData = new FormData();
  41.         return this;
  42.     }
  44.     // Get current FormData (may be null)
  45.     getFormData() {
  46.         return this.formData;
  47.     }
  49.     // Set scalar field (overwrites existing key)
  50.     setField(name, value) {
  51.         this.ensure();
  52.         this.formData.set(this._prefixedName(name), value);
  53.         return this;
  54.     }
  56.     // Append scalar field (allows duplicate keys)
  57.     appendField(name, value) {
  58.         this.ensure();
  59.         this.formData.append(this._prefixedName(name), value);
  60.         return this;
  61.     }
  63.     // Remove all keys that belong to array field `name`, e.g. form[name][0], form[name][1]...
  64.     _removeArrayKeys(name) {
  65.         if (!this.formData) return;
  66.         // Remove any key that equals baseName or starts with baseName[  (handles different renderings)
  67.         const baseName = this._prefixedName(name); // e.g. reviewer_settings[candidateDeclineCommentsAsArray]
  68.         const prefix = baseName + '[';
  70.         const newFd = new FormData();
  71.         for (let pair of this.formData.entries()) {
  72.             const key = pair[0];
  73.             const value = pair[1];
  74.             if (key === baseName || key.indexOf(prefix) === 0) {
  75.                 // skip array keys for this name
  76.                 continue;
  77.             }
  78.             newFd.append(key, value);
  79.         }
  80.         this.formData = newFd;
  81.     }
  83.     removeField(name) {
  84.         if (!this.formData) return this;
  85.         const fullName = this._prefixedName(name);
  86.         const newFd = new FormData();
  87.         for (let pair of this.formData.entries()) {
  88.             const key = pair[0];
  89.             const value = pair[1];
  90.             if (key === fullName) {
  91.                 // skip this key
  92.                 continue;
  93.             }
  94.             newFd.append(key, value);
  95.         }
  96.         this.formData = newFd;
  97.         return this;
  98.     }
  100.     /**
  101.      * Установить поле-массив текстовых строк для Symfony-формы.
  102.      * Будет создана (если необходимо) FormData, существующие ключи этого массива удалены и
  103.      * добавлены новые элементы в форме `prefix[name][]`.
  104.      *
  105.      * @param {string} name - имя поля, например 'candidateDeclineCommentsAsArray'
  106.      * @param {string[]} textArray - массив строк
  107.      * @returns {SymfonyFormDataBuilder}
  108.      */
  109.     setTextArrayField(name, textArray) {
  110.         if (!Array.isArray(textArray)) {
  111.             throw new Error('textArray must be an Array of strings');
  112.         }
  114.         this.ensure();
  116.         // remove old keys related to this array
  117.         this._removeArrayKeys(name);
  119.         const baseName = this._prefixedName(name); // e.g. reviewer_settings[candidateDeclineCommentsAsArray]
  121.         // Symfony обычно ожидает индексы 0..N-1. Добавляем поля именно в таком формате.
  122.         // Используем формат с пустыми скобками (e.g. name[]), который PHP/Symfony распарсят как массив.
  123.         const arrayKey = `${baseName}[]`;
  124.         for (let i = 0; i < textArray.length; i++) {
  125.             const value = textArray[i] == null ? '' : String(textArray[i]);
  126.             this.formData.append(arrayKey, value);
  127.         }
  129.         // Для безопасности: если массив пустой, добавим пустой ключ без индекса — Symfony может корректно обработать.
  130.         // if (textArray.length === 0) {
  131.         //     // ensure there's at least an empty value so Symfony treats it as an empty array
  132.         //     const arrayKeyEmpty = `${baseName}[]`;
  133.         //     this.formData.append(arrayKeyEmpty, '');
  134.         // }
  136.         // NOTE: removed DOM synchronization. This builder now only manipulates FormData,
  137.         // and does not add/remove hidden inputs in the HTML form. The caller may
  138.         // submit FormData via fetch/XHR or use native form rendering to handle inputs.
  140.         return this;
  141.     }
  143.     // Debug helper: convert FormData to plain object (arrays for duplicate keys)
  144.     toObject() {
  145.         if (!this.formData) return {};
  146.         const out = {};
  147.         for (let pair of this.formData.entries()) {
  148.             const key = pair[0];
  149.             const value = pair[1];
  150.             if (out.hasOwnProperty(key)) {
  151.                 if (!Array.isArray(out[key])) out[key] = [out[key]];
  152.                 out[key].push(value);
  153.             } else {
  154.                 out[key] = value;
  155.             }
  156.         }
  157.         return out;
  158.     }
  159. }