IMP_Prefs_Sort
in package
implements
ArrayAccess, IteratorAggregate
This class manages the sortpref preference.
Tags
Table of Contents
Interfaces
- ArrayAccess
- IteratorAggregate
Constants
- SORTPREF = 'sortpref'
Properties
- $_sortpref : array<string|int, mixed>
- The sortpref value.
Methods
- __construct() : mixed
- Constructor.
- gc() : mixed
- Garbage collection.
- getIterator() : Traversable
- newSortbyValue() : int
- Get the new sortby pref value for IMP 5.
- offsetExists() : mixed
- offsetGet() : IMP_Prefs_Sort_Sortpref
- offsetSet() : mixed
- Alter a sortpref entry.
- offsetUnset() : mixed
- upgradePrefs() : mixed
- Upgrade the preference from IMP 4 value.
- _offsetGet() : IMP_Prefs_Sort_Sortpref
- _save() : mixed
- Save the preference to the backend.
Constants
SORTPREF
public
mixed
SORTPREF
= 'sortpref'
Properties
$_sortpref
The sortpref value.
protected
array<string|int, mixed>
$_sortpref
= array()
Methods
__construct()
Constructor.
public
__construct() : mixed
gc()
Garbage collection.
public
gc() : mixed
getIterator()
public
getIterator() : Traversable
Return values
TraversablenewSortbyValue()
Get the new sortby pref value for IMP 5.
public
newSortbyValue(int $sortby) : int
Parameters
- $sortby : int
-
The old (IMP 4) value.
Return values
int —Null if no change or else the converted sort value.
offsetExists()
public
offsetExists(mixed $offset) : mixed
Parameters
- $offset : mixed
offsetGet()
public
offsetGet(mixed $offset) : IMP_Prefs_Sort_Sortpref
Parameters
- $offset : mixed
Return values
IMP_Prefs_Sort_SortprefoffsetSet()
Alter a sortpref entry.
public
offsetSet(string $offset, array<string|int, mixed> $value) : mixed
Parameters
- $offset : string
-
The mailbox name.
- $value : array<string|int, mixed>
-
An array with two possible keys: 'by' and 'dir'.
offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
upgradePrefs()
Upgrade the preference from IMP 4 value.
public
upgradePrefs() : mixed
_offsetGet()
protected
_offsetGet(mixed $offset) : IMP_Prefs_Sort_Sortpref
Parameters
- $offset : mixed
Return values
IMP_Prefs_Sort_Sortpref_save()
Save the preference to the backend.
protected
_save() : mixed