Label
in package
implements
ArrayAccess
uses
ArrayAccessHelper
Represents a personal message label.
Table of Contents
Interfaces
- ArrayAccess
Properties
- $id : int
- $loaded : array<string|int, mixed>
- $messages : int
- $name : string
- $pms : array<string|int, mixed>
- $unread_messages : int
- $prop_aliases : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructor.
- load() : array<string|int, mixed>
- Loads all the labels that belong to the current user.
- manage() : void
- Handles adding, deleting, and editing labels on messages.
- offsetExists() : bool
- Checks whether a property has been set when object is accessed as an array.
- offsetGet() : mixed
- Gets properties when object is accessed as an array.
- offsetSet() : void
- Sets properties when object is accessed as an array.
- offsetUnset() : void
- Unsets properties when object is accessed as an array.
Properties
$id
public
int
$id
ID number of this label.
$loaded
public
static array<string|int, mixed>
$loaded
= []
All loaded instances of this class.
$messages
public
int
$messages
The number of PMs that have this label.
$name
public
string
$name
Name of this label
$pms
public
array<string|int, mixed>
$pms
= []
IDs of the PMs that have this label.
$unread_messages
public
int
$unread_messages
The number of unread PMs that have this label.
$prop_aliases
protected
array<string|int, mixed>
$prop_aliases
= ['id_label' => 'id', 'id_member' => 'member']
Alternate names for some object properties.
Methods
__construct()
Constructor.
public
__construct(int $id, string $name[, array<string|int, mixed> $props = [] ]) : mixed
Parameters
- $id : int
-
ID number of this label.
- $name : string
-
Name of this label.
- $props : array<string|int, mixed> = []
-
Properties to set for this label.
load()
Loads all the labels that belong to the current user.
public
static load() : array<string|int, mixed>
Return values
array<string|int, mixed> —A copy of self::$loaded.
manage()
Handles adding, deleting, and editing labels on messages.
public
static manage() : void
offsetExists()
Checks whether a property has been set when object is accessed as an array.
public
offsetExists(mixed $prop) : bool
Parameters
- $prop : mixed
-
The property name.
Return values
booloffsetGet()
Gets properties when object is accessed as an array.
public
& offsetGet(mixed $prop) : mixed
Parameters
- $prop : mixed
-
The property name.
Return values
mixed —A reference to the property.
offsetSet()
Sets properties when object is accessed as an array.
public
offsetSet(mixed $prop, mixed $value) : void
Parameters
- $prop : mixed
-
The property name.
- $value : mixed
-
The value to set.
offsetUnset()
Unsets properties when object is accessed as an array.
public
offsetUnset(mixed $prop) : void
Parameters
- $prop : mixed
-
The property name.