1. Documentation
  2. API
  3. Backend
  4. Behaviors
  5. ReorderController

Backend\Behaviors\ReorderController

Overview

ReorderController is deprecated

Extends

Public Properties

public Model $model

Import model

public string $nameFrom

Model attribute to use for the display name

Show inherited public properties

Inherited Public Properties

Protected Properties

protected $requiredProperties

requiredProperties that must exist in the controller using this behavior.

protected array $requiredConfig

Configuration values that must exist when applying the primary config file.

protected array $actions

Visible actions in context of the controller

protected bool $showTree

Display parent/child relationships in the list.

protected string $sortMode

Reordering mode.

protected Backend\Classes\WidgetBase $toolbarWidget

Reference to the widget used for the toolbar.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __construct()

public __construct(Backend\Classes\Controller $controller): void

__construct the behavior

public beforeDisplay()

public beforeDisplay(): void

beforeDisplay fires before the page is displayed and AJAX is executed.

public onReorder()

public onReorder(): void

public reorder()

public reorder(): void

public reorderExtendQuery()

public reorderExtendQuery(October\Rain\Database\Builder $query): void

Extend the query used for finding reorder records. Extra conditions can be applied to the query, for example, $query->withTrashed();

public reorderGetModel()

public reorderGetModel(): void

public reorderGetRecordName()

public reorderGetRecordName($record): string

Returns the display name for a record.

public reorderMakePartial()

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

Controller accessor for making partials within this behavior.

public reorderRender()

public reorderRender(): void

Show inherited public methods

Inherited Public Methods

Protected Methods

protected getRecords()

protected getRecords(): Collection

Returns all the records from the supplied model.

protected makeToolbarWidget()

protected makeToolbarWidget(): void

protected prepareVars()

protected prepareVars(): void

Prepares common form data

protected validateModel()

protected validateModel(): void

validateModel validates the supplied form model.

Show inherited protected methods

Inherited Protected Methods