AvailabilityStatusInterface
in
Availability Status Logic Interface
Tags
Table of Contents
- STATUS_AVAILABLE = 1
- Status code for available items
- STATUS_UNAVAILABLE = 0
- Status code for unavailable items
- STATUS_UNCERTAIN = 2
- Status code for items with uncertain availability
- STATUS_UNKNOWN = 3
- Status code for items where no status information is available
- 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.
- getPriority() : int
- Get status priority.
- 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.
- setVisibilityInHoldings() : AvailabilityStatus
- Set visibility status.
Constants
STATUS_AVAILABLE
Status code for available items
public
int
STATUS_AVAILABLE
= 1
STATUS_UNAVAILABLE
Status code for unavailable items
public
int
STATUS_UNAVAILABLE
= 0
STATUS_UNCERTAIN
Status code for items with uncertain availability
public
int
STATUS_UNCERTAIN
= 2
STATUS_UNKNOWN
Status code for items where no status information is available
public
int
STATUS_UNKNOWN
= 3
Methods
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> —getPriority()
Get status priority.
public
getPriority() : int
Return values
int —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.
public
isVisibleInHoldings() : bool
Return values
bool —setVisibilityInHoldings()
Set visibility status.
public
setVisibilityInHoldings(bool $visibilityInHoldingsTab) : AvailabilityStatus
Parameters
- $visibilityInHoldingsTab : bool
-
Visibility toggle