FormController

Adds features for working with backend forms. This behavior will inject CRUD actions to the controller -- including create, update and preview -- along with some relevant AJAX handlers.

 class Backend\Behaviors\FormController
extends Backend\Classes\ControllerBehavior

public $implement = [
    \Backend\Behaviors\FormController::class,
];

public $formConfig = 'config_form.yaml';

# Extends

# Traits

# Constants

# Properties

# public $formConfig : mixed = "config_form.yaml"

# protected $actions : array = ["create","update","preview"]

# protected $context : string

# protected $controller : Backend\Classes\Controller | FormController

# protected $formWidget : Backend\Widgets\Form

# protected $model : Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model

# protected $requiredConfig : array = ["modelClass","form"]

# inherited public $assetPath : string

# inherited public static $extendableStaticCalledClass : string = null

# inherited public $layout : string

# inherited public $suppressLayout : bool = false

# inherited public $vars : array = []

# inherited protected $assets : array = {"js":[],"css":[],"rss":[],"vite":[]}

# inherited protected $config : array

# inherited protected $configPath : string

# inherited protected static $extensionCallbacks : array = []

# inherited protected $extensionHidden : mixed = {"fields":[],"methods":["extensionIsHiddenField","extensionIsHiddenMethod"]}

# inherited protected $layoutPath : string

# inherited protected $modelsToSave : array = []

# inherited protected $orderFactor : integer

# inherited protected $requiredProperties : array = []

# inherited protected $viewPath : string | array

# Methods

# public __construct (Backend\Classes\Controller $controller)

# public create (string $context = null) : void

# public create_onSave (string $context = null) : Illuminate\Http\RedirectResponse | void

# public static extendFormFields (callable $callback) : void

# public formAfterCreate ($model)

# public formAfterDelete ($model)

# public formAfterSave ($model)

# public formAfterUpdate ($model)

# public formBeforeCreate ($model)

# public formBeforeSave ($model)

# public formBeforeUpdate ($model)

# public formCreateModelObject () : Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model

# public formExtendFields (Backend\Widgets\Form $host, array $fields) : void

# public formExtendFieldsBefore (Backend\Widgets\Form $host) : void

# public formExtendModel (Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model $model) : Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model | void

# public formExtendQuery (Winter\Storm\Database\Builder | Winter\Storm\Halcyon\Builder $query) : void

# public formExtendRefreshData (Backend\Widgets\Form $host, array $saveData) : array | void

# public formExtendRefreshFields (Backend\Widgets\Form $host, array $fields) : array | void

# public formExtendRefreshResults (Backend\Widgets\Form $host, array $result) : array | void

# public formFindModelObject (string $recordId) : Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model

# public formGetContext () : string

# public formGetId (string $suffix = null) : string

<div id="<?= $this->formGetId()">...</div>

<button id="<?= $this->formGetId('button')">...</button>

# public formGetModel () : Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model

# public formGetRedirectUrl (string $context = null, Model $model = null) : string

# public formGetSessionKey () : string

# public formGetWidget () : Backend\Widgets\Form

# public formHasOutsideFields () : bool

<!-- Do something -->

# public formHasPrimaryTabs () : bool

<!-- Do something -->

# public formHasSecondaryTabs () : bool

<!-- Do something -->

# public formRender (array $options = []) : string

<?= $this->formRender(['preview' => true, section' => 'primary']) ?>

# public formRenderField (string $name, array $options = []) : string

# public formRenderOutsideFields () : string

# public formRenderPreview () : string

# public formRenderPrimaryTabs () : string

# public formRenderSecondaryTabs () : string

# public initForm (Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model $model, string $context = null) : void

# public makeRedirect (string $context = null, Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model $model = null) : Illuminate\Http\RedirectResponse

# public preview (int $recordId = null, string $context = null) : void

# public update (int $recordId = null, string $context = null) : void

# public update_onDelete (int $recordId = null) : Illuminate\Http\RedirectResponse | void

# public update_onSave (int $recordId = null, string $context = null) : Illuminate\Http\RedirectResponse | void

# protected createModel () : Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model

# protected getLang (string $name, string $default = null, array $extras = []) : string

# protected prepareVars (Winter\Storm\Database\Model | Winter\Storm\Halcyon\Model $model)

# inherited public addCss (string | array $name, array $attributes = []) : void

# inherited public addJs (string | array $name, array $attributes = []) : void

# inherited public addRss (string $name, array $attributes = []) : void

# inherited public addViewPath (string | array $path) : void

# inherited public addVite (array | string $entrypoints, ?string $package = null) : void

# inherited public combineAssets (array $assets, string $localPath = "") : string

# inherited public static extend (callable $callback)

# inherited public extensionApplyInitCallbacks ()

# inherited public static extensionExtendCallback (callable $callback) : void

# inherited public extensionIsHiddenField ($name)

# inherited public extensionIsHiddenMethod ($name)

# inherited public flushAssets () : void

# inherited public getAssetPath (string $fileName, $assetPath = null) : string

# inherited public getAssetPaths () : array

# inherited public static getCalledExtensionClass ()

# inherited public getConfig (string $name = null, mixed $default = null) : string

# inherited public getConfigPath (string $fileName, mixed $configPath = null) : string

# inherited public getViewPath (string $fileName, $viewPaths = null) : string

# inherited public getViewPaths () : array

# inherited public guessConfigPath (string $suffix = "") : string

# inherited public guessConfigPathFrom (string $class, string $suffix = "") : string

# inherited public guessViewPath (string $suffix = "", boolean $isPublic = false) : string | null

# inherited public guessViewPathFrom (string $class, string $suffix = "", boolean $isPublic = false) : string | null

# inherited public hasAssetsDefined () : bool

# inherited public makeAssets ($type = null) : string | null

# inherited public makeConfig (array $configFile = [], array $requiredConfig = []) : array | stdClass

# inherited public makeConfigFromArray (array $configArray = []) : stdClass

# inherited public makeFileContents (string $filePath, array $extraParams = []) : string

# inherited public makeFormWidget (string $class, array $fieldConfig = [], array $widgetConfig = []) : Backend\Classes\FormWidgetBase

# inherited public makeLayout ($name = null, array $params = [], boolean $throwException = true) : string | bool

# inherited public makeLayoutPartial (string $partial, array $params = []) : string

# inherited public makePartial (string $partial, array $params = [], boolean $throwException = true) : mixed

# inherited public makeView (string $view) : string

# inherited public makeViewContent (string $contents, $layout = null) : string

# inherited public makeWidget (string $class, array $widgetConfig = []) : mixed | Backend\Classes\WidgetBase

# inherited public mergeConfig (mixed $configA, mixed $configB) : stdClass

# inherited public orderAssets (array $assets) : array

# inherited public resetSession () : void

# inherited public setConfig (mixed $config, array $required = [])

# inherited protected addAsset (string $type, string $path, array $attributes) : void

# inherited protected controllerMethodExists (string $methodName) : bool

# inherited protected deferPurgedSaveAttributes (Winter\Storm\Database\Model $model, array $attributesToPurge) : void

# inherited protected extensionHideField ($name)

# inherited protected extensionHideMethod ($name)

# inherited protected getAssetEntryBuildPath (array $asset) : string

# inherited protected getAssetScheme (string $asset) : string

# inherited protected getLocalPath (string | null $relativePath) : string

# inherited protected getSession (string $key = null, string $default = null) : string

# inherited protected handleViewException (Throwable $e, integer $obLevel) : void

# inherited protected hideAction (mixed $methodName)

# inherited protected makeSessionId () : string

# inherited protected prepareModelsToSave (Winter\Storm\Database\Model $model, array $saveData) : array

$modelsToSave = $this->prepareModelsToSave($model, [...]);

foreach ($modelsToSave as $modelToSave) {
    $modelToSave->save();
}

# inherited protected putSession (string $key, mixed $value) : void

# inherited protected removeDuplicates () : void

# inherited protected setModelAttributes (Winter\Storm\Database\Model $model, array $saveData) : void