RelationController

Uses a combination of lists and forms for managing Model relations.

 class Backend\Behaviors\RelationController
extends Backend\Classes\ControllerBehavior

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

public $relationConfig = 'config_relation.yaml';

# Extends

# Traits

# Constants

# Properties

# public $deferredBinding : bool = false

# public $readOnly : bool = false

# public $relationConfig : mixed = "config_relation.yaml"

# public $relationModel : Model

# public $relationName : string

# public $relationObject : Model

# public $relationType : string

# public $sessionKey : string

# protected $actions : array = []

# protected $alias : string

# protected $eventTarget : string

# protected $extraConfig : array

# protected $field : Model

# protected $forceManageMode : string

# protected $forceViewMode : string

# protected $foreignId : int

# protected $initialized : bool = false

# protected $manageFilterWidget : Backend\Widgets\Filter

# protected $manageId : int

# protected $manageMode : string

# protected $manageTitle : string

# protected $manageWidget : Backend\Classes\WidgetBase

# protected $model : Model

# protected $originalConfig : array

# protected $pivotWidget : Backend\Classes\WidgetBase

# protected $requiredConfig : array = []

# protected $requiredRelationProperties : array = ["label"]

# protected $searchWidget : Backend\Widgets\Search

# protected $toolbarButtons : array

# protected $toolbarWidget : Backend\Widgets\Toolbar

# protected $viewFilterWidget : Backend\Widgets\Filter

# protected $viewMode : string

# protected $viewModel : Model

# protected $viewWidget : Backend\Classes\WidgetBase

# 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 $controller : Backend\Classes\Controller

# 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 initRelation (Model $model, string $field = null) : void

# public onRelationButtonAdd ()

# public onRelationButtonCreate ()

# public onRelationButtonDelete ()

# public onRelationButtonLink ()

# public onRelationButtonRefresh ()

# public onRelationButtonRemove ()

# public onRelationButtonUnlink ()

# public onRelationButtonUpdate ()

# public onRelationClickManageList ()

# public onRelationClickManageListPivot ()

# public onRelationClickViewList ()

# public onRelationManageAdd ()

# public onRelationManageAddPivot ()

# public onRelationManageCreate ()

# public onRelationManageDelete ()

# public onRelationManageForm ()

# public onRelationManagePivotCreate ()

# public onRelationManagePivotForm ()

# public onRelationManagePivotUpdate ()

# public onRelationManageRemove ()

# public onRelationManageUpdate ()

# public prepareVars () : void

# public relationExtendConfig (object $config, string $field, Winter\Storm\Database\Model $model)

# public relationExtendManageFilterWidget (Backend\Widgets\Filter $widget, string $field, Winter\Storm\Database\Model $model)

# public relationExtendManageWidget (Backend\Classes\WidgetBase $widget, string $field, Winter\Storm\Database\Model $model)

# public relationExtendPivotWidget (Backend\Classes\WidgetBase $widget, string $field, Winter\Storm\Database\Model $model)

# public relationExtendRefreshResults (string $field) : array

# public relationExtendViewFilterWidget (Backend\Widgets\Filter $widget, string $field, Winter\Storm\Database\Model $model)

# public relationExtendViewWidget (Backend\Classes\WidgetBase $widget, string $field, Winter\Storm\Database\Model $model)

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

# public relationGetManageWidget () : Backend\Classes\WidgetBase

# public relationGetSessionKey (boolean $force = false)

# public relationGetViewWidget () : Backend\Classes\WidgetBase

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

# public relationRefresh (string $field = null) : array

# public relationRender (string $field, array $options = []) : string

# public relationRenderToolbar (string $field = null) : string

# public relationRenderView (string $field = null) : string

# protected applyExtraConfig ($config, $field = null)

# protected beforeAjax ()

# protected evalFormContext (string $mode = "manage", boolean $exists = false)

# protected evalManageMode () : string

# protected evalManageTitle () : string

# protected evalToolbarButtons () : array | null

# protected evalViewMode () : string

# protected findExistingRelationIds ($checkIds = null)

# protected makeConfigForMode (string $mode = "view", string $type = "list", boolean $throwException = true)

# protected makeFilterWidget (mixed $type) : Backend\Classes\WidgetBase | null

# protected makeManageWidget ()

# protected makePivotWidget ()

# protected makeSearchWidget ()

# protected makeToolbarWidget ()

# protected makeViewWidget ()

# protected validateField (string $field = null) : string

# 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