| Methods |
abstract
public
static
|
isValid(string $uid): bool
Whether the passed value is valid for the constructor of the current class.
Whether the passed value is valid for the constructor of the current class.
Implemented by
|
#
|
abstract
public
static
|
fromString(string $uid): static
Creates an AbstractUid from an identifier represented in any of the supported formats.
Creates an AbstractUid from an identifier represented in any of the supported formats.
Throws
Implemented by
|
#
|
public
static
|
fromBinary(string $uid): static
|
#
|
public
static
|
fromBase58(string $uid): static
|
#
|
public
static
|
fromBase32(string $uid): static
|
#
|
public
static
|
fromRfc4122(string $uid): static
Parameters
| $uid |
A valid RFC 9562/4122 uid
|
Throws
|
#
|
abstract
public
|
toBinary(): string
Returns the identifier as a raw binary string.
Returns the identifier as a raw binary string.
Implemented by
|
#
|
public
|
toBase58(): string
Returns the identifier as a base58 case-sensitive string.
Returns the identifier as a base58 case-sensitive string.
|
#
|
public
|
toBase32(): string
Returns the identifier as a base32 case-insensitive string.
Returns the identifier as a base32 case-insensitive string.
Overriden by
|
#
|
public
|
toRfc4122(): string
Returns the identifier as a RFC 9562/4122 case-insensitive string.
Returns the identifier as a RFC 9562/4122 case-insensitive string.
|
#
|
public
|
toHex(): string
Returns the identifier as a prefixed hexadecimal case insensitive string.
Returns the identifier as a prefixed hexadecimal case insensitive string.
|
#
|
public
|
equals(mixed $other): bool
Returns whether the argument is an AbstractUid and contains the same value as the current instance.
Returns whether the argument is an AbstractUid and contains the same value as the current instance.
Parameters
| $other |
The object to compare the current instance to,
which is always an instance of the same class.
|
Returns
True if equal, false otherwise.
Implements
|
#
|
public
|
hash(): string
Returns a scalar value to be used as the hash value of the objects.
Returns a scalar value to be used as the hash value of the objects.
While the hash value does not define equality, all objects that are
equal according to Ds\Hashable::equals() must have the same hash
value. Hash values of equal objects don't have to be unique, for
example you could just return TRUE for all objects and nothing
would break - the only implication would be that hash tables then
turn into linked lists because all your objects will be hashed to
the same bucket. It's therefore very important that you pick a good
hash value, such as an ID or email address.
This method allows objects to be used as keys in structures such as
Ds\Map and Ds\Set, or any other lookup structure that honors this
interface.
Caution: Do not pick a value that might change within the object,
such as a public property. Hash table lookups would fail because
the hash has changed.
Caution: All objects that are equal must have the same hash value.
Returns
A scalar value to be used as this object's hash value.
Implements
|
#
|
public
|
compare(self $other): int
|
#
|
final
public
|
toString(): string
|
#
|
public
|
__toString(): string
|
#
|
public
|
jsonSerialize(): string
|
#
|