GridView
extends Entity
in package
GridView Entity - Saved grid view configuration.
Stores user-specific or system-wide grid configurations including filters, sorting, column visibility, and pagination.
Table of Contents
Properties
- $config : string
- $created : DateTime
- $grid_key : string
- $id : int
- $is_default : bool
- $is_system_default : bool
- $member : Member
- $member_id : int|null
- $modified : DateTime
- $name : string
- $_accessible : array<string, bool>
- Fields that can be mass assigned using newEntity() or patchEntity().
Methods
- getConfigArray() : array<string, mixed>
- Get the config as a decoded array
- getViewType() : string
- Get a human-readable description of the view type
- isSystemDefault() : bool
- Check if this is a system-wide default view
- isUserDefault() : bool
- Check if this is a user's default view
- setConfigArray() : void
- Set the config from an array
Properties
$config
public
string
$config
JSON configuration
$created
public
DateTime
$created
$grid_key
public
string
$grid_key
Grid identifier (e.g., 'Members.index.main')
$id
public
int
$id
$is_default
public
bool
$is_default
User's preferred default
$is_system_default
public
bool
$is_system_default
Application-wide default
$member
public
Member
$member
$member_id
public
int|null
$member_id
Owner (NULL for system defaults)
$modified
public
DateTime
$modified
$name
public
string
$name
Display name
$_accessible
Fields that can be mass assigned using newEntity() or patchEntity().
protected
array<string, bool>
$_accessible
= ['grid_key' => true, 'member_id' => true, 'name' => true, 'is_default' => true, 'is_system_default' => true, 'config' => true, 'created' => true, 'modified' => true, 'created_by' => true, 'modified_by' => true, 'deleted' => true, 'member' => true, 'creator' => true, 'modifier' => true]
Methods
getConfigArray()
Get the config as a decoded array
public
getConfigArray() : array<string, mixed>
Convenience method for accessing the JSON config as a PHP array.
Return values
array<string, mixed>getViewType()
Get a human-readable description of the view type
public
getViewType() : string
Return values
stringisSystemDefault()
Check if this is a system-wide default view
public
isSystemDefault() : bool
Return values
boolisUserDefault()
Check if this is a user's default view
public
isUserDefault() : bool
Return values
boolsetConfigArray()
Set the config from an array
public
setConfigArray(array<string, mixed> $configArray) : void
Convenience method for setting the config from a PHP array.
Parameters
- $configArray : array<string, mixed>
-
Configuration array