Cloud
Reference for the Cloud module: register cloud vendors and services, drive container start and stop queues, and process container heartbeats. Containers run on servers, are addressed by a service identifier and a container reference, and report back over an admin-token authenticated heartbeat endpoint.
This page is a pure reference. For how the framework fits together, see the Guide.
Cloud- handle container heartbeat requests at the admin endpoint.CloudContainer- read a container's status as human-readable text.CloudContainerChannelConfig- register and read channel handlers by identifier.CloudContainerCurrentStatusData- real-time status data for a running container.CloudContainerData- immutable data for a container and its server.CloudContainerEnvironment- read base64-encoded container environment variables.CloudContainerEnvironmentPort- build port data objects from JSON.CloudContainerEnvironmentPortData- immutable port configuration for a container environment.CloudContainerHeartbeat- build a heartbeat request object from JSON.CloudContainerHeartbeatData- immutable stored heartbeat data.CloudContainerHeartbeatDatabase- store and read container heartbeats.CloudContainerHeartbeatRequestData- immutable incoming heartbeat request data.CloudContainerHeartbeatResponseData- immutable heartbeat response data.CloudContainerStatusEnum- the container status constants.CloudDatabase- start or stop a container through its vendor.CloudQueue- process a queued container start or stop.CloudServerData- immutable data for a server that hosts containers.CloudServerDatabase- read servers by id or identifier.CloudServiceConfig- register cloud services and their admin sections.CloudStartQueueDatabase- lock and process containers awaiting start.CloudStopQueueDatabase- lock and process containers awaiting stop.CloudVendorConfig- register cloud vendors and their callbacks.
Cloud
The primary class: handles container heartbeat requests posted to the admin endpoint.
HandleHeartbeat
Cloud::HandleHeartbeat(): void
Handle a container heartbeat request. Called from the app before the web server runs; it responds only to POST requests whose URI contains /cloud/admin/heartbeat, authenticates the admin token from the Authorization header, stores the heartbeat, and returns the JSON response. Other requests return without acting.
Returns void
CloudContainer
Reads a container's status as human-readable text.
StatusHumanReadable
CloudContainer::StatusHumanReadable($container): string
The human-readable status text for a container, such as Starting, Running, Stopping, Stopped or Error.
| Name | Type | Description |
|---|---|---|
$container | CloudContainerData|object | A container object with a status property. |
Returns string The status text.
CloudContainerChannelConfig
Register handlers for container channel identifiers and read them back. Each handler processes the data from a channel request and returns response data.
Properties
| Property | Type | Description |
|---|---|---|
CloudContainerChannelConfig::$handlers | array | The registered handler objects. |
AddHandler
CloudContainerChannelConfig::AddHandler(string $channelIdentifier, callable $handler): void
Register a handler for a channel identifier. Throws when a handler is already registered for that identifier.
| Name | Type | Description |
|---|---|---|
$channelIdentifier | string | The channel identifier; lowercased before use. |
$handler | callable | The function that processes the channel request. |
Returns void
GetHandler
CloudContainerChannelConfig::GetHandler(string $channelIdentifier): ?callable
The handler registered for a channel identifier, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$channelIdentifier | string | The channel identifier; lowercased before lookup. |
Returns ?callable The handler, or null.
CloudContainerCurrentStatusData
Real-time status data for a running container. Fields and constructor, plus JSON conversions.
Properties
| Property | Type | Description |
|---|---|---|
$status->containerName | string | The container name (readonly). |
$status->status | string | The container status text (readonly). |
$status->image | ?string | The image name (readonly). |
$status->imageId | ?string | The image id (readonly). |
$status->createdTimestamp | ?int | When the container was created (readonly). |
$status->optionalStartedTimestamp | ?int | When the container started (readonly). |
$status->optionalFinishedTimestamp | ?int | When the container finished (readonly). |
$status->exitCode | ?string | The exit code (readonly). |
$status->state | ?string | The container state (readonly). |
$status->restartCount | ?string | The restart count (readonly). |
$status->cpuUsage | ?string | CPU usage (readonly). |
$status->memoryUsage | ?string | Memory usage (readonly). |
$status->memoryLimit | ?string | Memory limit (readonly). |
$status->networkRxBytes | ?string | Bytes received (readonly). |
$status->networkTxBytes | ?string | Bytes transmitted (readonly). |
$status->blockReadBytes | ?string | Block bytes read (readonly). |
$status->blockWriteBytes | ?string | Block bytes written (readonly). |
$status->consoleOutput | ?string | The console output (readonly). |
__construct
new CloudContainerCurrentStatusData(string $containerName, string $status, ?string $image = null, ?string $imageId = null, ?int $createdTimestamp = null, ?int $optionalStartedTimestamp = null, ?int $optionalFinishedTimestamp = null, ?string $exitCode = null, ?string $state = null, ?string $restartCount = null, ?string $cpuUsage = null, ?string $memoryUsage = null, ?string $memoryLimit = null, ?string $networkRxBytes = null, ?string $networkTxBytes = null, ?string $blockReadBytes = null, ?string $blockWriteBytes = null, ?string $consoleOutput = null)
Create current status data for a container.
Returns CloudContainerCurrentStatusData
FromJson
CloudContainerCurrentStatusData::FromJson(string $json): CloudContainerCurrentStatusData
Build current status data from a JSON string, validating the decoded object and its timestamp fields.
| Name | Type | Description |
|---|---|---|
$json | string | The JSON status object. |
Returns CloudContainerCurrentStatusData The status data.
ToJson
CloudContainerCurrentStatusData::ToJson(): string
The status data as a JSON string.
Returns string The JSON representation.
CloudContainerData
Immutable data for a container and the server that hosts it. Fields and constructor only.
Properties
| Property | Type | Description |
|---|---|---|
$container->id | int | The container id (readonly). |
$container->vendorIdentifier | string | The vendor identifier (readonly). |
$container->serviceIdentifier | string | The service identifier (readonly). |
$container->parameters | string | The container parameters (readonly). |
$container->status | int | The status, a CloudContainerStatusEnum value (readonly). |
$container->visibility | int | The visibility, 0 to 3 (readonly). |
$container->containerRef | ?string | The container reference (readonly). |
$container->server | CloudServerData | The server hosting the container (readonly). |
$container->addedTimestamp | int | When the container was added (readonly). |
$container->adminToken | ?string | The container admin token (readonly). |
$container->portNumber | int | The port number, 1 to 65535 (readonly). |
$container->portAdminToken | string | The port admin token, a 64-character hex string (readonly). |
__construct
new CloudContainerData(int $id, string $vendorIdentifier, string $serviceIdentifier, string $parameters, int $status, int $visibility, ?string $containerRef, CloudServerData $server, int $addedTimestamp, ?string $adminToken, int $portNumber, string $portAdminToken)
Create container data from its fields and its server.
Returns CloudContainerData
CloudContainerEnvironment
Read environment variables set for a container. Values are base64-encoded by the start script; each reader trims quotes, decodes and validates.
Float
CloudContainerEnvironment::Float(string $name): float
A float environment variable, base64 decoded and parsed. Throws when the variable is missing, fails to decode, or cannot be parsed.
| Name | Type | Description |
|---|---|---|
$name | string | The environment variable name. |
Returns float The decoded value.
Integer
CloudContainerEnvironment::Integer(string $name): int
An integer environment variable, base64 decoded and parsed. Throws when the variable is missing, fails to decode, or cannot be parsed.
| Name | Type | Description |
|---|---|---|
$name | string | The environment variable name. |
Returns int The decoded value.
Object
CloudContainerEnvironment::Object(string $name, callable $decodeFunction): mixed
A JSON environment variable, base64 decoded, JSON decoded, then passed to the decode function for validation. Throws when the variable is missing, fails to decode, or is invalid JSON.
| Name | Type | Description |
|---|---|---|
$name | string | The environment variable name. |
$decodeFunction | callable | Callback that validates and transforms the decoded JSON. |
Returns mixed The value returned by the decode function.
OptionalString
CloudContainerEnvironment::OptionalString(string $name, string $defaultValue = ''): string
A string environment variable, base64 decoded, or the default when it is absent or empty after decoding. Throws when a present value fails to decode.
| Name | Type | Description |
|---|---|---|
$name | string | The environment variable name. |
$defaultValue | string | The value returned when none is present. |
Returns string The decoded value, or the default.
String
CloudContainerEnvironment::String(string $name): string
A string environment variable, base64 decoded and validated. Throws when the variable is missing, fails to decode, or is empty after decoding.
| Name | Type | Description |
|---|---|---|
$name | string | The environment variable name. |
Returns string The decoded value.
CloudContainerEnvironmentPort
Builds CloudContainerEnvironmentPortData objects from decoded JSON.
FromJson
CloudContainerEnvironmentPort::FromJson(array $data): CloudContainerEnvironmentPortData
Build one port data object from a decoded JSON array. Throws when required fields are missing.
| Name | Type | Description |
|---|---|---|
$data | array | The decoded port fields. |
Returns CloudContainerEnvironmentPortData The port data.
ListFromJson
CloudContainerEnvironmentPort::ListFromJson(array $jsonArray): array
Build a list of port data objects from a decoded JSON array of ports.
| Name | Type | Description |
|---|---|---|
$jsonArray | array | An array of port objects. |
Returns array A list of CloudContainerEnvironmentPortData.
CloudContainerEnvironmentPortData
Immutable port configuration for a container environment. Fields and constructor, plus a JSON conversion.
Properties
| Property | Type | Description |
|---|---|---|
$port->portIdentifier | string | The port identifier (readonly). |
$port->portNumber | int | The port number, 1 to 65535 (readonly). |
$port->adminToken | ?string | The admin token, a 64-character hex string (readonly). |
$port->sslCert | ?string | The SSL certificate (readonly). |
$port->sslKey | ?string | The SSL key (readonly). |
$port->sslCACert | ?string | The SSL CA certificate (readonly). |
__construct
new CloudContainerEnvironmentPortData(string $portIdentifier, int $portNumber, ?string $adminToken, ?string $sslCert, ?string $sslKey, ?string $sslCACert)
Create port configuration data.
Returns CloudContainerEnvironmentPortData
ToJson
CloudContainerEnvironmentPortData::ToJson(): string
The port data as a JSON string.
Returns string The JSON representation.
CloudContainerHeartbeat
Builds a heartbeat request object from JSON input.
FromJson
CloudContainerHeartbeat::FromJson(mixed $json): CloudContainerHeartbeatRequestData
Build a heartbeat request object from an array, object or JSON string, validating the counters and messages. Throws when the input is invalid or the service name or container ref is missing.
| Name | Type | Description |
|---|---|---|
$json | mixed | The heartbeat data as an array, object or JSON string. |
Returns CloudContainerHeartbeatRequestData The request data.
CloudContainerHeartbeatData
Immutable stored heartbeat data. Fields and constructor, plus JSON conversions.
Properties
| Property | Type | Description |
|---|---|---|
$heartbeat->id | int | The heartbeat id (readonly). |
$heartbeat->containerId | int | The container id (readonly). |
$heartbeat->counters | string | The counter data as a JSON string (readonly). |
$heartbeat->messages | string | The message data as a JSON string (readonly). |
$heartbeat->addedTimestamp | int | When the heartbeat was added (readonly). |
__construct
new CloudContainerHeartbeatData(int $id, int $containerId, string $counters, string $messages, int $addedTimestamp)
Create stored heartbeat data.
Returns CloudContainerHeartbeatData
FromJson
CloudContainerHeartbeatData::FromJson(string $json): CloudContainerHeartbeatData
Build stored heartbeat data from a JSON string, defaulting empty counters and messages to an empty array.
| Name | Type | Description |
|---|---|---|
$json | string | The JSON heartbeat object. |
Returns CloudContainerHeartbeatData The heartbeat data.
ToJson
CloudContainerHeartbeatData::ToJson(): string
The heartbeat data as a JSON string.
Returns string The JSON representation.
CloudContainerHeartbeatDatabase
Store and read container heartbeats.
Add
CloudContainerHeartbeatDatabase::Add(string $serviceName, string $containerRef, array $counters, array $messages): int
Look up the container by service name and container ref, then store a heartbeat with its counters and messages. Throws when the container is not found.
| Name | Type | Description |
|---|---|---|
$serviceName | string | The service name. |
$containerRef | string | The container reference. |
$counters | array | Counter entries, each with a name and value. |
$messages | array | A list of message strings. |
Returns int The new heartbeat id.
CountByContainerId
CloudContainerHeartbeatDatabase::CountByContainerId(int $containerId): int
The number of heartbeats stored for a container.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
Returns int The heartbeat count.
fromRow
CloudContainerHeartbeatDatabase::fromRow(stdClass $row): CloudContainerHeartbeatData
Build a heartbeat data object from a database row.
| Name | Type | Description |
|---|---|---|
$row | stdClass | The database row. |
Returns CloudContainerHeartbeatData The heartbeat data.
GetByContainerId
CloudContainerHeartbeatDatabase::GetByContainerId(int $containerId, int $limit = 100): array
The most recent heartbeats for a container, newest first.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
$limit | int | The maximum number to return, 1 to 1000. |
Returns array A list of CloudContainerHeartbeatData.
GetLatestByContainerId
CloudContainerHeartbeatDatabase::GetLatestByContainerId(int $containerId): ?CloudContainerHeartbeatData
The latest heartbeat for a container, or null when there is none.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
Returns ?CloudContainerHeartbeatData The latest heartbeat, or null.
CloudContainerHeartbeatRequestData
Immutable incoming heartbeat request data. Fields and constructor, plus a JSON conversion.
Properties
| Property | Type | Description |
|---|---|---|
$request->serviceName | string | The service sending the heartbeat (readonly). |
$request->containerRef | string | The container reference (readonly). |
$request->counters | array | Counter entries, each with a name and value (readonly). |
$request->messages | array | A list of message strings (readonly). |
__construct
new CloudContainerHeartbeatRequestData(string $serviceName, string $containerRef, array $counters, array $messages)
Create incoming heartbeat request data, validating the counters and messages.
Returns CloudContainerHeartbeatRequestData
ToJson
CloudContainerHeartbeatRequestData::ToJson(): string
The request data as a JSON string.
Returns string The JSON representation.
CloudContainerHeartbeatResponseData
Immutable heartbeat response data. Constructor only, plus a JSON conversion; no channel information is included.
__construct
new CloudContainerHeartbeatResponseData()
Create an empty heartbeat response.
Returns CloudContainerHeartbeatResponseData
ToJson
CloudContainerHeartbeatResponseData::ToJson(): string
The response as a JSON string.
Returns string The JSON representation.
CloudContainerStatusEnum
The container status constants used by CloudContainerData::$status.
Constants
| Constant | Value | Description |
|---|---|---|
CloudContainerStatusEnum::STARTING | 1 | The container is starting. |
CloudContainerStatusEnum::RUNNING | 2 | The container is running. |
CloudContainerStatusEnum::STOPPING | 3 | The container is stopping. |
CloudContainerStatusEnum::STOPPED | 4 | The container is stopped. |
CloudContainerStatusEnum::ERROR | 5 | The container is in error. |
CloudDatabase
Start or stop a container through its vendor callback, guarded by the container's current status.
StartContainer
CloudDatabase::StartContainer(CloudContainerData $container): void
Start a container that is in STARTING status by calling its vendor start callback; returns without acting when it is not in STARTING status.
| Name | Type | Description |
|---|---|---|
$container | CloudContainerData | The container to start. |
Returns void
StopContainer
CloudDatabase::StopContainer(CloudContainerData $container): void
Stop a container that is in STOPPING status by calling its vendor stop callback; returns without acting when it is not in STOPPING status.
| Name | Type | Description |
|---|---|---|
$container | CloudContainerData | The container to stop. |
Returns void
CloudQueue
Process a queued container start or stop by container id.
ProcessStartContainer
CloudQueue::ProcessStartContainer(int $containerId): void
Load the container by id and, when it is in STARTING status, call its vendor start callback.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
Returns void
ProcessStopContainer
CloudQueue::ProcessStopContainer(int $containerId): void
Load the container by id and, when it is in STOPPING status, call its vendor stop callback.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
Returns void
CloudServerData
Immutable data for a server that hosts containers. Fields and constructor only.
Properties
| Property | Type | Description |
|---|---|---|
$server->id | int | The server id (readonly). |
$server->vendorIdentifier | string | The vendor identifier (readonly). |
$server->identifier | string | The server identifier (readonly). |
$server->name | string | The server name (readonly). |
$server->ipAddress | string | The server IP address (readonly). |
$server->addedTimestamp | int | When the server was added (readonly). |
$server->managementPort | ?int | The management port (readonly). |
$server->managementToken | ?string | The management token (readonly). |
__construct
new CloudServerData(int $id, string $vendorIdentifier, string $identifier, string $name, string $ipAddress, int $addedTimestamp, ?int $managementPort = null, ?string $managementToken = null)
Create server data from its fields.
Returns CloudServerData
CloudServerDatabase
Read servers from the database by id or identifier.
fromRow
CloudServerDatabase::fromRow(stdClass $row): CloudServerData
Build a server data object from a database row.
| Name | Type | Description |
|---|---|---|
$row | stdClass | The database row. |
Returns CloudServerData The server data.
GetById
CloudServerDatabase::GetById(int $serverId): CloudServerData
The server with the given id. Throws when there is no matching row.
| Name | Type | Description |
|---|---|---|
$serverId | int | The server id. |
Returns CloudServerData The server data.
GetByIdentifier
CloudServerDatabase::GetByIdentifier(string $serverIdentifier): CloudServerData
The server with the given identifier, matched in lowercase. Throws when there is no matching row.
| Name | Type | Description |
|---|---|---|
$serverIdentifier | string | The server identifier. |
Returns CloudServerData The server data.
CloudServiceConfig
Register cloud services and the container admin sections that render their service-specific information. Services are keyed by a lowercase identifier.
Properties
| Property | Type | Description |
|---|---|---|
CloudServiceConfig::$services | array | The registered service objects. |
CloudServiceConfig::$containerAdminSections | array | The registered admin section callbacks, keyed by service identifier. |
AddContainerAdminSection
CloudServiceConfig::AddContainerAdminSection(string $serviceIdentifier, callable $containerAdminSectionCallback): void
Register a callback that renders service-specific container information in the admin.
| Name | Type | Description |
|---|---|---|
$serviceIdentifier | string | The service identifier; lowercased before use. |
$containerAdminSectionCallback | callable | Callback that receives the container id and renders the UI. |
Returns void
AddService
CloudServiceConfig::AddService(string $serviceIdentifier, string $description = ''): void
Register a service by identifier. Throws when the service is already registered.
| Name | Type | Description |
|---|---|---|
$serviceIdentifier | string | The service identifier; lowercased before use. |
$description | string | An optional description of the service. |
Returns void
GetContainerAdminSection
CloudServiceConfig::GetContainerAdminSection(string $serviceIdentifier): ?callable
The admin section callback for a service, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$serviceIdentifier | string | The service identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetServiceIdentifiers
CloudServiceConfig::GetServiceIdentifiers(): array
The identifiers of every registered service.
Returns array A list of service identifiers.
GetServices
CloudServiceConfig::GetServices(): array
Every registered service object.
Returns array A list of service objects.
CloudStartQueueDatabase
Lock and process containers awaiting start. Used as the start queue's lock-next and process callbacks.
LockNext
CloudStartQueueDatabase::LockNext(int $limit): array
Lock and return the ids of up to a number of containers in STARTING status, using SELECT ... FOR UPDATE SKIP LOCKED. Called within a transaction.
| Name | Type | Description |
|---|---|---|
$limit | int | The maximum number of rows to lock and return. |
Returns array A list of container ids.
Process
CloudStartQueueDatabase::Process(int $containerId): void
Load the container by id and, when it is in STARTING status, call its vendor start callback.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
Returns void
CloudStopQueueDatabase
Lock and process containers awaiting stop. Used as the stop queue's lock-next and process callbacks.
LockNext
CloudStopQueueDatabase::LockNext(int $limit): array
Lock and return the ids of up to a number of containers in STOPPING status, using SELECT ... FOR UPDATE SKIP LOCKED. Called within a transaction.
| Name | Type | Description |
|---|---|---|
$limit | int | The maximum number of rows to lock and return. |
Returns array A list of container ids.
Process
CloudStopQueueDatabase::Process(int $containerId): void
Load the container by id and, when it is in STOPPING status, call its vendor stop callback.
| Name | Type | Description |
|---|---|---|
$containerId | int | The container id. |
Returns void
CloudVendorConfig
Register cloud vendors and their start, stop and status callbacks, and read them back. Vendors are keyed by a lowercase identifier.
Properties
| Property | Type | Description |
|---|---|---|
CloudVendorConfig::$vendors | array | The registered vendor objects. |
CloudVendorConfig::$containerProcessors | array | The registered container processor callbacks, keyed by vendor identifier. |
CloudVendorConfig::$containerAdminSections | array | The registered admin section callbacks, keyed by vendor identifier. |
CloudVendorConfig::$containerStatusPanels | array | The registered status panel callbacks, keyed by vendor identifier. |
AddContainerAdminSection
CloudVendorConfig::AddContainerAdminSection(string $vendorIdentifier, callable $containerAdminSectionCallback): void
Register a callback that renders vendor-specific container information in the admin.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before use. |
$containerAdminSectionCallback | callable | Callback that receives the container id and renders the UI. |
Returns void
AddContainerProcessor
CloudVendorConfig::AddContainerProcessor(string $vendorIdentifier, callable $processorCallback): void
Register a processor callback for a vendor. Deprecated: use AddVendor with start and stop container callbacks instead.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before use. |
$processorCallback | callable | Callback that receives a container id and processes it. |
Returns void
AddContainerStatusPanel
CloudVendorConfig::AddContainerStatusPanel(string $vendorIdentifier, callable $containerStatusPanelCallback): void
Register a callback that renders a vendor-specific container status panel.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before use. |
$containerStatusPanelCallback | callable | Callback that receives a CloudContainerData and renders the status panel. |
Returns void
AddVendor
CloudVendorConfig::AddVendor(string $vendorIdentifier, string $vendorName, ?callable $startContainerCallback = null, ?callable $stopContainerCallback = null, ?callable $startServerCallback = null, ?callable $stopServerCallback = null, ?callable $getContainerStatusCallback = null): void
Register a vendor and its start, stop and status callbacks. Throws when the vendor is already registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before use. |
$vendorName | string | The human-readable vendor name. |
$startContainerCallback | ?callable | Callback to start a container, receiving the container object. |
$stopContainerCallback | ?callable | Callback to stop a container, receiving the container object. |
$startServerCallback | ?callable | Callback to start a server, receiving the server id. |
$stopServerCallback | ?callable | Callback to stop a server, receiving the server id. |
$getContainerStatusCallback | ?callable | Callback to read a container's status. |
Returns void
GetContainerAdminSection
CloudVendorConfig::GetContainerAdminSection(string $vendorIdentifier): ?callable
The admin section callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetContainerProcessor
CloudVendorConfig::GetContainerProcessor(string $vendorIdentifier): ?callable
The processor callback for a vendor, or null when none is registered. Deprecated: use GetStartContainerCallback and GetStopContainerCallback instead.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetContainerStatusCallback
CloudVendorConfig::GetContainerStatusCallback(string $vendorIdentifier): ?callable
The status callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetContainerStatusPanel
CloudVendorConfig::GetContainerStatusPanel(string $vendorIdentifier): ?callable
The status panel callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetStartContainerCallback
CloudVendorConfig::GetStartContainerCallback(string $vendorIdentifier): ?callable
The start container callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetStartServerCallback
CloudVendorConfig::GetStartServerCallback(string $vendorIdentifier): ?callable
The start server callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetStopContainerCallback
CloudVendorConfig::GetStopContainerCallback(string $vendorIdentifier): ?callable
The stop container callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetStopServerCallback
CloudVendorConfig::GetStopServerCallback(string $vendorIdentifier): ?callable
The stop server callback for a vendor, or null when none is registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?callable The callback, or null.
GetVendorIdentifiers
CloudVendorConfig::GetVendorIdentifiers(): array
The identifiers of every registered vendor.
Returns array A list of vendor identifiers.
GetVendorName
CloudVendorConfig::GetVendorName(string $vendorIdentifier): ?string
The human-readable name for a vendor, or null when the vendor is not registered.
| Name | Type | Description |
|---|---|---|
$vendorIdentifier | string | The vendor identifier; lowercased before lookup. |
Returns ?string The vendor name, or null.
GetVendors
CloudVendorConfig::GetVendors(): array
Every registered vendor object.
Returns array A list of vendor objects.