FieldGroup
extends Meta
in package
Field Group class
Table of Contents
- $contextId : string
- The context ID.
- $key : string
- The field key.
- $postId : int
- The post ID.
- $userId : int
- The post ID.
- get() : mixed
- Get the field group.
- getFieldKeys() : array<string|int, mixed>
- Get all field keys of a field group
- getFields() : array<string|int, mixed>
- Get Fields
- getVisibleFieldKeys() : array<string|int, mixed>
- Get the visible fields of the field group.
- setContextId() : static
- Set the context ID.
- setKey() : static
- Set the field key.
- setPostId() : static
- Set the post ID.
- setUserId() : static
- Set the user ID.
Properties
$contextId
The context ID.
public
static string
$contextId
$key
The field key.
public
static string
$key
$postId
The post ID.
public
static int
$postId
$userId
The post ID.
public
static int
$userId
Methods
get()
Get the field group.
public
static get([mixed $key = null ]) : mixed
Parameters
- $key : mixed = null
-
Key to any value stored in the object.
Return values
mixed —getFieldKeys()
Get all field keys of a field group
public
static getFieldKeys() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getFields()
Get Fields
public
static getFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —getVisibleFieldKeys()
Get the visible fields of the field group.
public
static getVisibleFieldKeys() : array<string|int, mixed>
Return values
array<string|int, mixed> —setContextId()
Set the context ID.
public
static setContextId(string $contextId) : static
Parameters
- $contextId : string
-
The context ID.
Return values
static —setKey()
Set the field key.
public
static setKey(string $key) : static
Parameters
- $key : string
-
The field key.
Return values
static —setPostId()
Set the post ID.
public
static setPostId(int $postId) : static
Parameters
- $postId : int
-
The post ID.
Return values
static —setUserId()
Set the user ID.
public
static setUserId(int $userId) : static
Parameters
- $userId : int
-
The user ID.