AvailabilityStatus
in package
implements
AvailabilityStatusInterface
Availability Status Logic Class
Tags
Interfaces, Classes, Traits and Enums
- AvailabilityStatusInterface
- Availability Status Logic Interface
Table of Contents
- $availability : int
- Items availability
- $extraStatusInformation : array<string|int, mixed>
- $status : string
- __construct() : mixed
- Constructor
- availabilityAsString() : string
- Convert availability to a string
- compareTo() : int
- Compares priority with other availability status for acquiring overall status of multiple status.
- getExtraStatusInformation() : array<string|int, mixed>
- Get extra status information.
- getSchemaAvailabilityUri() : string|null
- Get schema.org availability URI.
- getStatusDescription() : string
- Get status description.
- getStatusDescriptionTokens() : array<string|int, mixed>
- Get status description tokens. Used when status description is being translated.
- is() : bool
- Check if item has given availability status.
- isAvailable() : bool
- Check if available.
- isVisibleInHoldings() : bool
- Check if status should be visible in the holdings tab.
- getPriority() : int
- Get status priority.
Properties
$availability
Items availability
protected
int
$availability
$extraStatusInformation
protected
array<string|int, mixed>
$extraStatusInformation
= []
$status
protected
string
$status
= ''
Methods
__construct()
Constructor
public
__construct(int|bool $availability[, string $status = '' ][, array<string|int, mixed> $extraStatusInformation = [] ]) : mixed
Parameters
- $availability : int|bool
-
Availability
- $status : string = ''
-
Status Description
- $extraStatusInformation : array<string|int, mixed> = []
-
Extra Status Information
Return values
mixed —availabilityAsString()
Convert availability to a string
public
availabilityAsString() : string
Return values
string —compareTo()
Compares priority with other availability status for acquiring overall status of multiple status.
public
compareTo(AvailabilityStatusInterface $other) : int
Parameters
- $other : AvailabilityStatusInterface
-
Other Availability Status
Return values
int —getExtraStatusInformation()
Get extra status information.
public
getExtraStatusInformation() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSchemaAvailabilityUri()
Get schema.org availability URI.
public
getSchemaAvailabilityUri() : string|null
Return values
string|null —getStatusDescription()
Get status description.
public
getStatusDescription() : string
Return values
string —getStatusDescriptionTokens()
Get status description tokens. Used when status description is being translated.
public
getStatusDescriptionTokens() : array<string|int, mixed>
Return values
array<string|int, mixed> —is()
Check if item has given availability status.
public
is(int $availability) : bool
Parameters
- $availability : int
-
Availability status
Return values
bool —isAvailable()
Check if available.
public
isAvailable() : bool
Return values
bool —isVisibleInHoldings()
Check if status should be visible in the holdings tab.
public
isVisibleInHoldings() : bool
Return values
bool —getPriority()
Get status priority.
protected
getPriority() : int