HubPages

MMO\admin\monitoring · 1 symbole · générée le 27 Oct 2026

class

HubPages

What the pages of a monitoring hub are made of ({MMO\admin}/monitoring/pages/hub.phtml): mmo.client's design system -- .widgets of tiles, article.card, table.data, .status-tag -- its <mmo-chart> for the curves, and mmo.admin's own elements for what a page does: <mmo-hub-bar> (collect now, reload), <mmo-hub-ack> (acknowledge an incident), <mmo-hub-tools> (the read-only tools).

class MMO\admin\monitoring\HubPages

Espace de noms: MMO\admin\monitoring

Every page is drawn on the server from what the last collection kept ([`Hub`](https://mmoframework.fr/fr/documentation/mmo.admin/php/monitoring/HubPages.md#hubpages-hub), [`MonitorStore`](https://mmoframework.fr/fr/documentation/mmo.admin/php/monitoring/MonitorStore.md#monitorstore)): nothing is asked of a server to draw one. Every value is escaped here; mmo-chart prints its labels as html, and they are the hub's.

<?php use MMO\admin\monitoring\HubPages as P; if (!($hub = P::Guard())) {return;} ?> <?= P::Header($hub, P::T('Overview')) ?>

Index

	RANGES	the ranges a page's curves can show: seconds => label
	SITE_PROBES	the probes of a site, in the order a page shows them
	TONES	a reading's status => the design system's tone
	charts static
	hub static
	styled static
	Ago($time) static
	Api() static
	Bars($rows, $label, $value, $format, $link, $note) static
	CanCollect() static
	Card($title, $body, $note, $class) static
	Chart($series, $metrics, $unit, $type, $height, $width) static	Curves of a subject, drawn by mmo-chart.
	Deployments($deployments, $site) static
	Duration($seconds) static
	Empty($message) static
	Errors($hub) static
	Facts($facts, $keys, $labels) static
	Fill($values) static
	Gauge($label, $value, $warning, $critical, $text, $fill) static
	Gauges($m) static
	Guard() static	The hub, or a callout saying why there is none: a page shows nothing else then.
	H($value) static
	Header($hub, $title, $subtitle, $ranges) static
	Host($url) static
	Hub() static
	Incidents($incidents, $empty) static
	Level($value, $warning, $critical, $below) static
	Mb($value) static
	Ms($value) static
	Number($value, $decimals) static
	Percent($value) static
	ProbeTags($target) static
	Query($key) static
	Range() static
	Ranges() static
	ReadingCard($probe, $reading) static
	ServerCard($server, $targets) static
	SetHub($hub) static	Use another hub (a test).
	Setting($name) static
	SitesTable($targets) static
	Spark($lines, $max) static	A small curve, no axis: a card's or a row's last day.
	Status($status, $label, $title) static
	Strip($statuses) static
	Styles() static	The few styles the design system has no class for: the gauges, the strip, the bars, the dots.
	SubjectUrl($id) static
	T($message, $context) static
	Table($headers, $rows, $empty, $links) static
	Tag($text, $tone, $title) static
	Tiles($tiles) static
	Tools($subject, $tools) static
	Url($page, $query) static

Constantes3

RANGES

the ranges a page's curves can show: seconds => label

const RANGES = […4 items]

SITE_PROBES

the probes of a site, in the order a page shows them

const SITE_PROBES = ['http', 'release', 'database', 'logs', 'application']

TONES

a reading's status => the design system's tone

const TONES = […4 items]

Propriétés3

charts

static

protected static int $charts = 0

Type: int

hub

static

protected static ?MMO\admin\monitoring\Hub $hub = null

Type: null | Hub

styled

static

protected static bool $styled = false

Type: bool

Méthodes45

Ago($time)

staticHubPages.php:127

static function Ago(?int $time): string

$time	null \| int
retourne	string	how long ago $time was, in words

Api()

staticHubPages.php:67

static function Api(): string

retourne string HubController's api, for the elements: .../api/hub

Bars($rows, $label, $value, $format, $link, $note)

staticHubPages.php:517

static function Bars( array $rows, string $label, string $value, callable $format, ?callable $link = null, string $note = '' ): string

$rows	array
$label	string
$value	string
$format	callable
$link = null	null \| callable
$note = ''	string
retourne	string	bars of a value per row: the largest collections, the sites' databases

CanCollect()

staticHubPages.php:70

static function CanCollect(): bool

retourne bool whether the page may reach the servers (HubController's canCollect)

Card($title, $body, $note, $class)

staticHubPages.php:218

static function Card(string $title, string $body, string $note = '', string $class = ''): string

$title	string
$body	string
$note = ''	string
$class = ''	string
retourne	string	a card: a title (escaped), a body (html), an optional note (escaped)

Chart($series, $metrics, $unit, $type, $height, $width)

staticHubPages.php:324

Curves of a subject, drawn by mmo-chart.

static function Chart( array $series, array $metrics, string $unit = '', string $type = 'line', int $height = 260, int $width = 640 ): string

mmo-chart draws a missing value as 0, so the curves start where the first of them does, and a gap between two readings is filled by the line between them: readings further apart than the buckets (every 5 minutes, a week in 90 points is not) are not holes.

$series	array	what `MonitorStore::series` returned
$metrics	array
$unit = ''	string	a suffix for every value (`%`, `ms`)
$type = 'line'	string	`line` or `area`
$height = 260	int
$width = 640	int
retourne	string

Deployments($deployments, $site)

staticHubPages.php:492

static function Deployments(array $deployments, bool $site = true): string

$deployments	array
$site = true	bool
retourne	string	the deployments, newest first

Duration($seconds)

staticHubPages.php:139

static function Duration(int $seconds): string

$seconds	int
retourne	string	a length of time, in words

Empty($message)

staticHubPages.php:224

static function Empty(string $message): string

$message	string
retourne	string	the design system's empty table text

Errors($hub)

staticHubPages.php:191

static function Errors(MMO\admin\monitoring\Hub $hub): string

$hub	Hub
retourne	string	what the hub could not read, and a hint when nothing was ever collected

Facts($facts, $keys, $labels)

staticHubPages.php:250

static function Facts(array $facts, ?array $keys = null, array $labels = []): string

$facts	array
$keys = null	null \| array
$labels = []	array
retourne	string	facts as a definition list, the empty ones left out

Fill($values)

staticHubPages.php:368

static function Fill(array $values): array

$values	array	numbers, null where there is none
retourne	array	the gaps filled: between two values, the line joining them; before the first, the first; after the last, the last

Gauge($label, $value, $warning, $critical, $text, $fill)

staticHubPages.php:260

static function Gauge( string $label, int|float|null $value, float $warning, float $critical, string $text, ?float $fill = null ): string

$label	string
$value	int \| float \| null
$warning	float
$critical	float
$text	string
$fill = null	null \| float
retourne	string	a value on a bar, in the tone its limits give it

Gauges($m)

staticHubPages.php:268

static function Gauges(array $m): string

$m	array
retourne	string	the four gauges of a server: cpu, memory, its fullest disk, its load

Guard()

staticHubPages.php:52

The hub, or a callout saying why there is none: a page shows nothing else then.

static function Guard(): ?MMO\admin\monitoring\Hub

retourne

null | Hub

H($value)

staticHubPages.php:104

static function H(mixed $value): string

$value	mixed
retourne	string	$value escaped for html

Header($hub, $title, $subtitle, $ranges)

staticHubPages.php:172

static function Header( MMO\admin\monitoring\Hub $hub, string $title, string $subtitle = '', bool $ranges = false ): string

$hub	Hub
$title	string
$subtitle = ''	string
$ranges = false	bool
retourne	string	the page's title, what it is about, and the hub's bar

Host($url)

staticHubPages.php:148

static function Host(?string $url): string

$url	null \| string
retourne	string	the host of an url

Hub()

staticHubPages.php:38

static function Hub(): MMO\admin\monitoring\Hub

retourne Hub the hub HubController is configured with (its hub), read once

Incidents($incidents, $empty)

staticHubPages.php:455

static function Incidents(array $incidents, string $empty): string

$incidents	array
$empty	string
retourne	string	incidents, each with what it is, since when, and its acknowledgement

Level($value, $warning, $critical, $below)

staticHubPages.php:159

static function Level( int|float|null $value, float $warning, float $critical, bool $below = false ): string

$value	int \| float \| null
$warning	float
$critical	float
$below = false	bool
retourne	string	the tone of a value against two limits: `success`, `warning` or `error`

Mb($value)

staticHubPages.php:121

static function Mb(mixed $value): string

$value	mixed
retourne	string	megabytes, or gigabytes past 1024

Ms($value)

staticHubPages.php:118

static function Ms(mixed $value): string

$value	mixed
retourne	string

Number($value, $decimals)

staticHubPages.php:110

static function Number(mixed $value, int $decimals = 1): string

$value	mixed
$decimals = 1	int
retourne	string	a number the way a person reads it: no decimals past 100

Percent($value)

staticHubPages.php:116

static function Percent(mixed $value): string

$value	mixed
retourne	string

ProbeTags($target)

staticHubPages.php:418

static function ProbeTags(array $target): string

$target	array
retourne	string	each probe of a site, as a tag of its status

Query($key)

staticHubPages.php:97

static function Query(string $key): ?string

$key	string
retourne	null \| string	a query parameter, as a string

Range()

staticHubPages.php:91

static function Range(): int

retourne int seconds of curves the page shows: ?range=, a day by default

Ranges()

staticHubPages.php:180

static function Ranges(): string

retourne

string

the links to the other ranges of the curves

ReadingCard($probe, $reading)

staticHubPages.php:478

static function ReadingCard(string $probe, ?array $reading): string

$probe	string
$reading	null \| array
retourne	string	a probe's latest reading: its status, what it says, its numbers

ServerCard($server, $targets)

staticHubPages.php:391

static function ServerCard(array $server, array $targets): string

$server	array
$targets	array
retourne	string	a server's card: its status, address, gauges, last day and sites

SetHub($hub)

staticHubPages.php:46

Use another hub (a test).

static function SetHub(?MMO\admin\monitoring\Hub $hub): void

$hub	null \| Hub
retourne	void

Setting($name)

staticHubPages.php:73

static function Setting(string $name): mixed

$name	string
retourne	mixed	one of HubController's settings: the configuration's, else its default

SitesTable($targets)

staticHubPages.php:428

static function SitesTable(array $targets): string

$targets	array
retourne	string	the sites, one row each: their status, each probe's, the main numbers

Spark($lines, $max)

staticHubPages.php:282

A small curve, no axis: a card's or a row's last day.

static function Spark(array $lines, ?float $max = null): string

$lines	array	the curves' values, null where there is none
$max = null	null \| float	the top of the drawing (100 for percentages); null: the highest value
retourne	string

Status($status, $label, $title)

staticHubPages.php:153

static function Status(string $status, ?string $label = null, string $title = ''): string

$status	string
$label = null	null \| string
$title = ''	string
retourne	string	a status as the design system's tag: its word, or $label

Strip($statuses)

staticHubPages.php:303

static function Strip(array $statuses): string

$statuses	array
retourne	string	the worst status of each bucket of a period, as a strip

Styles()

staticHubPages.php:533

The few styles the design system has no class for: the gauges, the strip, the bars, the dots. Once a page.

static function Styles(): string

retourne

string

SubjectUrl($id)

staticHubPages.php:85

static function SubjectUrl(string $id): string

$id	string
retourne	string	the url of a server's or a site's page

T($message, $context)

staticHubPages.php:107

static function T(string $message, array $context = []): string

$message	string
$context = []	array
retourne	string	a sentence of the hub, translated and escaped

Table($headers, $rows, $empty, $links)

staticHubPages.php:232

static function Table(array $headers, array $rows, string $empty = '', array $links = []): string

$headers	array	html, `>` first for a right-aligned column
$rows	array	html cells
$empty = ''	string
$links = []	array	the url of each row, or ''
retourne	string	a table of the design system

Tag($text, $tone, $title)

staticHubPages.php:167

static function Tag(string $text, string $tone, string $title = ''): string

$text	string
$tone	string
$title = ''	string
retourne	string	a value as a tag in its tone

Tiles($tiles)

staticHubPages.php:207

static function Tiles(array $tiles): string

$tiles	array
retourne	string	a row of tiles

Tools($subject, $tools)

staticHubPages.php:511

static function Tools(string $subject, array $tools): string

$subject	string
$tools	array
retourne	string	the read-only tools of a subject

Url($page, $query)

staticHubPages.php:80

static function Url(string $page, array $query = []): string

$page	string
$query = []	array
retourne	string	the url of a page of the hub: `server`, ['name' => 'ovh1'] (mmo.client's PageController serves it)