{"$schema":"https://yii2-framework.github.io/docs/reference/reference.schema.json","schemaVersion":1,"package":"dynamicform","title":"DynamicForm","repository":"https://github.com/yii2-extensions/dynamicform","ref":"main","commit":"eda8d3a3ff602589f52055ec1775342d05299637","generatedAt":"2026-11-20","url":"https://yii2-framework.github.io/docs/extensions/dynamicform/reference/","types":{"Yii2\\Extensions\\DynamicForm\\DynamicFormAsset":{"kind":"class","url":"https://yii2-framework.github.io/docs/extensions/dynamicform/reference/dynamicformasset/","summary":"Asset bundle for Dynamic form Widget","extends":"yii\\web\\AssetBundle","implements":["yii\\base\\Configurable"],"properties":{"depends":{"default":"['yii\\web\\JqueryAsset', 'yii\\widgets\\ActiveFormAsset']","description":"Dependencies that provide jQuery and ActiveForm client validation."}},"methods":{"init":{"signature":"public function init(): void","summary":"Sets the default asset directory and scripts while preserving bundle overrides.","return":{"type":"void"}},"setSourcePath":{"signature":"protected function setSourcePath(string $path): void","summary":"Sets the source path if empty","params":[{"name":"$path","type":"string","description":"The path to be set"}],"return":{"type":"void"},"visibility":"protected"},"setupAssets":{"signature":"protected function setupAssets(string $type, list<string> $files = []): void","summary":"Set up CSS and JS asset arrays based on the base-file names","params":[{"name":"$type","type":"string","description":"Whether 'css' or 'js'"},{"name":"$files","type":"list<string>","default":"[]","optional":true,"description":"The list of 'css' or 'js' basefile names"}],"return":{"type":"void"},"visibility":"protected"}},"inherited":{"properties":{"basePath":"yii\\web\\AssetBundle","baseUrl":"yii\\web\\AssetBundle","css":"yii\\web\\AssetBundle","cssOptions":"yii\\web\\AssetBundle","js":"yii\\web\\AssetBundle","jsOptions":"yii\\web\\AssetBundle","publishOptions":"yii\\web\\AssetBundle","sourcePath":"yii\\web\\AssetBundle"},"methods":{"__call":"yii\\base\\BaseObject","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\BaseObject","__isset":"yii\\base\\BaseObject","__set":"yii\\base\\BaseObject","__unset":"yii\\base\\BaseObject","canGetProperty":"yii\\base\\BaseObject","canSetProperty":"yii\\base\\BaseObject","className":"yii\\base\\BaseObject","hasMethod":"yii\\base\\BaseObject","hasProperty":"yii\\base\\BaseObject","publish":"yii\\web\\AssetBundle","register":"yii\\web\\AssetBundle","registerAssetFiles":"yii\\web\\AssetBundle"}}},"Yii2\\Extensions\\DynamicForm\\DynamicFormWidget":{"kind":"class","url":"https://yii2-framework.github.io/docs/extensions/dynamicform/reference/dynamicformwidget/","summary":"Yii2 Dynamic form widget for cloning form elements in a nested manner while maintaining accessibility.","extends":"yii\\base\\Widget","implements":["yii\\base\\ViewContextInterface","yii\\base\\Configurable"],"properties":{"deleteButton":{"type":"string","default":"null","description":"Non-empty CSS selector of the buttons that delete a row."},"formFields":{"type":"list<string>|null","default":"null","description":"Fields to be validated."},"formId":{"type":"string","default":"null","description":"Form ID"},"insertButton":{"type":"string","default":"null","description":"Non-empty CSS selector of the buttons that insert a row."},"insertPosition":{"type":"string","default":"'bottom'","description":"'bottom' or 'top';"},"limit":{"type":"int","default":"999","description":"Maximum row count for client-side insertion."},"min":{"type":"int","default":"1","description":"Minimum row count for client-side deletion."},"model":{"type":"yii\\base\\Model|null","default":"null","description":"The model used for the form"},"widgetBody":{"type":"string","default":"null","description":"CSS selector of the element that holds the rows."},"widgetContainer":{"type":"string","default":"null","description":"Class of the container rendered around the rows; letters, digits and underscores only."},"widgetItem":{"type":"string","default":"null","description":"CSS selector of one row; the first matching element supplies the client template."}},"methods":{"getHashVarName":{"signature":"protected function getHashVarName(): string","summary":"Returns the hashed variable: the one registered for the form and container in the current page, if any.","return":{"type":"string"},"visibility":"protected"},"hashOptions":{"signature":"protected function hashOptions(): void","summary":"Generates a hashed variable to store the options.","return":{"type":"void"},"visibility":"protected"},"init":{"signature":"public function init(): void","summary":"Initializes the widget.","return":{"type":"void"},"throws":[{"type":"yii\\base\\InvalidConfigException"}]},"initOptions":{"signature":"protected function initOptions(): void","summary":"Initializes the widget options.","return":{"type":"void"},"visibility":"protected"},"registerAssets":{"signature":"public function registerAssets(yii\\web\\View $view): void","summary":"Registers the needed assets.","params":[{"name":"$view","type":"yii\\web\\View","description":"The View object"}],"return":{"type":"void"}},"registerHashVarWidget":{"signature":"public function registerHashVarWidget(): bool","summary":"Registers the widget for its form and container in the current page of the view.","return":{"type":"bool","description":"`true` when the widget was registered, `false` when the page already holds a compatible registration."},"throws":[{"type":"yii\\base\\InvalidConfigException","description":"When the page already holds a registration for the same form and container whose options, other than the row template, differ."}]},"registerOptions":{"signature":"protected function registerOptions(yii\\web\\View $view): void","summary":"Registers plugin options by storing it in a hashed javascript variable.","params":[{"name":"$view","type":"yii\\web\\View","description":"The View object"}],"return":{"type":"void"},"visibility":"protected"},"run":{"signature":"public function run(): mixed","summary":"Renders the buffered rows and registers their template and client behavior.","return":{"type":"mixed"}}},"constants":{"WIDGET_NAME":{"value":"'dynamicform'"}},"inherited":{"properties":{"autoIdPrefix":"yii\\base\\Widget","behaviors":"yii\\base\\Component","id":"yii\\base\\Widget","view":"yii\\base\\Widget","viewPath":"yii\\base\\Widget"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Component","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","afterRun":"yii\\base\\Widget","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","beforeRun":"yii\\base\\Widget","begin":"yii\\base\\Widget","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","end":"yii\\base\\Widget","ensureBehaviors":"yii\\base\\Component","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getId":"yii\\base\\Widget","getView":"yii\\base\\Widget","getViewPath":"yii\\base\\Widget","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","off":"yii\\base\\Component","on":"yii\\base\\Component","render":"yii\\base\\Widget","renderFile":"yii\\base\\Widget","setId":"yii\\base\\Widget","setView":"yii\\base\\Widget","trigger":"yii\\base\\Component","widget":"yii\\base\\Widget"},"events":{"EVENT_INIT":"yii\\base\\Widget","EVENT_BEFORE_RUN":"yii\\base\\Widget","EVENT_AFTER_RUN":"yii\\base\\Widget"}}},"Yii2\\Extensions\\DynamicForm\\Models\\Model":{"kind":"class","url":"https://yii2-framework.github.io/docs/extensions/dynamicform/reference/models/model/","summary":"Creates or reuses row models for tabular form submissions.","extends":"yii\\base\\Model","implements":["yii\\base\\StaticInstanceInterface","IteratorAggregate","ArrayAccess","yii\\base\\Arrayable","yii\\base\\Configurable"],"traits":["yii\\base\\ArrayableTrait","yii\\base\\StaticInstanceTrait"],"methods":{"createMultiple":{"signature":"public static function createMultiple(class-string<Yii2\\Extensions\\DynamicForm\\Models\\T> $modelClass, array<array-key, Yii2\\Extensions\\DynamicForm\\Models\\T> $multipleModels = [], string $pk = 'id'): list<Yii2\\Extensions\\DynamicForm\\Models\\T>","summary":"Creates or reuses models in submitted order; call loadMultiple() to populate attributes.","params":[{"name":"$modelClass","type":"class-string<Yii2\\Extensions\\DynamicForm\\Models\\T>"},{"name":"$multipleModels","type":"array<array-key, Yii2\\Extensions\\DynamicForm\\Models\\T>","default":"[]","optional":true},{"name":"$pk","type":"string","default":"'id'","optional":true}],"return":{"type":"list<Yii2\\Extensions\\DynamicForm\\Models\\T>"},"static":true}},"inherited":{"properties":{"activeValidators":"yii\\base\\Model","attributes":"yii\\base\\Model","behaviors":"yii\\base\\Component","errors":"yii\\base\\Model","firstErrors":"yii\\base\\Model","iterator":"yii\\base\\Model","scenario":"yii\\base\\Model","validators":"yii\\base\\Model"},"methods":{"__call":"yii\\base\\Component","__clone":"yii\\base\\Model","__construct":"yii\\base\\BaseObject","__get":"yii\\base\\Component","__isset":"yii\\base\\Component","__set":"yii\\base\\Component","__unset":"yii\\base\\Component","activeAttributes":"yii\\base\\Model","addError":"yii\\base\\Model","addErrors":"yii\\base\\Model","afterValidate":"yii\\base\\Model","attachBehavior":"yii\\base\\Component","attachBehaviors":"yii\\base\\Component","attributeHints":"yii\\base\\Model","attributeLabels":"yii\\base\\Model","attributes":"yii\\base\\Model","beforeValidate":"yii\\base\\Model","behaviors":"yii\\base\\Component","canGetProperty":"yii\\base\\Component","canSetProperty":"yii\\base\\Component","className":"yii\\base\\BaseObject","clearErrors":"yii\\base\\Model","createValidators":"yii\\base\\Model","detachBehavior":"yii\\base\\Component","detachBehaviors":"yii\\base\\Component","ensureBehaviors":"yii\\base\\Component","extractFieldsFor":"yii\\base\\ArrayableTrait","extractRootFields":"yii\\base\\ArrayableTrait","extraFields":"yii\\base\\ArrayableTrait","fields":"yii\\base\\Model","formName":"yii\\base\\Model","generateAttributeLabel":"yii\\base\\Model","getActiveValidators":"yii\\base\\Model","getAttributeHint":"yii\\base\\Model","getAttributeLabel":"yii\\base\\Model","getAttributes":"yii\\base\\Model","getBehavior":"yii\\base\\Component","getBehaviors":"yii\\base\\Component","getErrors":"yii\\base\\Model","getErrorSummary":"yii\\base\\Model","getFirstError":"yii\\base\\Model","getFirstErrors":"yii\\base\\Model","getIterator":"yii\\base\\Model","getScenario":"yii\\base\\Model","getValidators":"yii\\base\\Model","hasErrors":"yii\\base\\Model","hasEventHandlers":"yii\\base\\Component","hasMethod":"yii\\base\\Component","hasProperty":"yii\\base\\Component","init":"yii\\base\\BaseObject","instance":"yii\\base\\StaticInstanceTrait","isAttributeActive":"yii\\base\\Model","isAttributeRequired":"yii\\base\\Model","isAttributeSafe":"yii\\base\\Model","load":"yii\\base\\Model","loadMultiple":"yii\\base\\Model","off":"yii\\base\\Component","offsetExists":"yii\\base\\Model","offsetGet":"yii\\base\\Model","offsetSet":"yii\\base\\Model","offsetUnset":"yii\\base\\Model","on":"yii\\base\\Component","onUnsafeAttribute":"yii\\base\\Model","resolveFields":"yii\\base\\ArrayableTrait","rules":"yii\\base\\Model","safeAttributes":"yii\\base\\Model","scenarios":"yii\\base\\Model","setAttributes":"yii\\base\\Model","setScenario":"yii\\base\\Model","toArray":"yii\\base\\ArrayableTrait","trigger":"yii\\base\\Component","validate":"yii\\base\\Model","validateMultiple":"yii\\base\\Model"},"constants":{"SCENARIO_DEFAULT":"yii\\base\\Model"},"events":{"EVENT_BEFORE_VALIDATE":"yii\\base\\Model","EVENT_AFTER_VALIDATE":"yii\\base\\Model"}}}}}
