SessionMaker
Session Maker Trait

 trait Backend\Traits\SessionMaker

Adds session management based methods to a controller class, or a class that contains a $controller property referencing a controller.

Methods

public resetSession () : void

Resets all session data related to this widget.

Returns

void

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

Retrieves a widget related key/value pair from session data.

Parameters

Property	Type	Description
$key	string	string Unique key for the data store.
$default	string	string A default value to use when value is not found.

Returns

string

protected makeSessionId () : string

Returns a unique session identifier for this widget and controller action.

Returns

string

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

Saves a widget related key/value pair in to session data.

Parameters

Property	Type	Description
$key	string	string Unique key for the data store.
$value	mixed	mixed The value to store.

Returns

void

Used by

Class	Description
`Status`	System status report widget.
`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.
`ImportExportController`	Adds features for importing and exporting data.
`ListController`	Adds features for working with backend lists.
`RelationController`	Uses a combination of lists and forms for managing Model relations.
`ReorderController`	Used for reordering and sorting records.
`ControllerBehavior`	Controller Behavior base class
`FormWidgetBase`	Form Widget base class Widgets used specifically for forms
`ReportWidgetBase`	Report Widget base class Report widgets are used inside the ReportContainer.
`WidgetBase`	Widget base class.
`CodeEditor`	Code Editor Renders a code editor field.
`ColorPicker`	Color picker Renders a color picker field.
`DataTable`	Data Table Renders a table field.
`DatePicker`	Date picker Renders a date picker field.
`FileUpload`	File upload field Renders a form file uploader field.
`IconPicker`	Icon picker Renders an icon picker field.
`MarkdownEditor`	Code Editor Renders a code editor field.
`MediaFinder`	Media Finder Renders a record finder field.
`NestedForm`	Nested Form Renders a nested form bound to a jsonable field of a model.
`PermissionEditor`	User/group permission editor This widget is used by the system internally on the System / Administrators pages.
`RecordFinder`	Record Finder Renders a record finder field.
`Relation`	Form Relationship Renders a field prepopulated with a belongsTo and belongsToHasMany relation.
`RelationManager`
`Repeater`	Repeater Form Widget
`RichEditor`	Rich Editor Renders a rich content editor field.
`Sensitive`	Sensitive widget.
`TagList`	Tag List Form Widget
`Welcome`	User welcome report widget.
`Filter`	Filter Widget Renders a container used for filtering things.
`Form`	Form Widget Used for building back end forms and renders a form.
`Lists`	List Widget Used for building back end lists, renders a list of model objects
`MediaManager`	Media Manager widget.
`ReportContainer`	Report Container Widget Creates an area hosting report widgets.
`Search`	Search Widget Used for building a toolbar, Renders a search container.
`Table`	Table Widget.
`Toolbar`	Toolbar Widget Used for building a toolbar, renders a toolbar.
`Components`	Component Builder Builds a collection of Cms components and configures them.
`MediaFinder`	Media Finder Renders a record finder field.
`ActiveTheme`	Active theme report widget.
`AssetList`	CMS asset list widget.
`ComponentList`	Component list widget.
`MediaManager`	Media Manager widget.
`TemplateList`	Template list widget.

← Previous page Backend\Traits\SelectableWidget Next page → Backend\Traits\UploadableWidget

SessionMaker Session Maker Trait

# Methods

# public resetSession () : void

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

# protected makeSessionId () : string

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

# Used by

SessionMaker
Session Maker Trait

Methods

public resetSession () : void

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

protected makeSessionId () : string

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

Used by