ID
in package
This class describes a Matrix ID.
Table of Contents
Properties
- $id : mixed
- A Matrix ID.
Methods
- __construct() : mixed
- get_id() : string|null
- Get the identity part from the ID.
- get_server() : string|null
- Get the server part from the ID.
- get_type() : string|null
- Get the type of the Matrix ID.
- is_valid() : bool
- Predicate. Check if the Matrix ID is correct.
- to_string() : string
- Return the string representation of the Matrix ID.
Properties
$id
A Matrix ID.
private
mixed
$id
Methods
__construct()
public
__construct(string $id) : mixed
Parameters
- $id : string
get_id()
Get the identity part from the ID.
public
get_id() : string|null
Return values
string|null —An identity or NULL.
get_server()
Get the server part from the ID.
public
get_server() : string|null
Return values
string|null —The server name or NULL.
get_type()
Get the type of the Matrix ID.
public
get_type() : string|null
Return values
string|null —Type of the Matrix ID, or NULL if the type is unknown.
is_valid()
Predicate. Check if the Matrix ID is correct.
public
is_valid() : bool
Return values
bool —true if the ID is correct, false otherwise.
to_string()
Return the string representation of the Matrix ID.
public
to_string() : string
Return values
string —A Matrix ID.