IMP_Ajax_Application_Viewport
in package
Viewport data object.
Tags
Table of Contents
Properties
- $cacheid : string
- $data : array<string|int, mixed>
- $data_reset : bool
- $disappear : array<string|int, mixed>
- $label : string
- $metadata : object
- $metadata_reset : bool
- $rangelist : array<string|int, mixed>
- $rowlist : array<string|int, mixed>
- $rowlist_reset : bool
- $rownum : int
- $totalrows : int
- $view : string
- $_data : object
- Data.
- $_mbox : IMP_Mailbox
- View object.
- $_metadata : array<string|int, mixed>
- Metadata.
Methods
- __construct() : mixed
- Constructor.
- __get() : mixed
- __set() : mixed
- addFlagMetadata() : mixed
- Add flag metadata to output.
- setMetadata() : mixed
- Set a metadata element.
- toObject() : object
- Prepare the object used by the ViewPort javascript class.
Properties
$cacheid read-only
public
string
$cacheid
The cache ID.
$data
public
array<string|int, mixed>
$data
The data array.
$data_reset
public
bool
$data_reset
True if viewport data should be reset.
$disappear
public
array<string|int, mixed>
$disappear
The list of UIDs that have disappeared.
$label
public
string
$label
The view label.
$metadata
public
object
$metadata
Metadata.
$metadata_reset
public
bool
$metadata_reset
True if metadata should be reset.
$rangelist
public
array<string|int, mixed>
$rangelist
Results of a range request.
$rowlist
public
array<string|int, mixed>
$rowlist
The rowlist array.
$rowlist_reset
public
bool
$rowlist_reset
True if rowlist data should be reset.
$rownum
public
int
$rownum
The row number of the provided UID.
$totalrows
public
int
$totalrows
The total number of rows in the view.
$view read-only
public
string
$view
The view ID.
$_data
Data.
private
object
$_data
$_mbox
View object.
private
IMP_Mailbox
$_mbox
$_metadata
Metadata.
private
array<string|int, mixed>
$_metadata
= array()
Methods
__construct()
Constructor.
public
__construct(IMP_Mailbox $mbox) : mixed
Parameters
- $mbox : IMP_Mailbox
-
Viewport view.
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__set()
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
addFlagMetadata()
Add flag metadata to output.
public
addFlagMetadata() : mixed
setMetadata()
Set a metadata element.
public
setMetadata(string $name, string $value) : mixed
Parameters
- $name : string
-
Metadata name.
- $value : string
-
Metadata value.
toObject()
Prepare the object used by the ViewPort javascript class.
public
toObject() : object
Return values
object —The ViewPort object.