Documentation du code de SPIP et de ses plugins

SPIP

VersionChecker
in package

Read onlyYes
FinalYes

Service de vérification des mises à jour de SPIP.

Interroge le serveur de versions SPIP pour déterminer si des mises à jour mineures ou majeures sont disponibles.

Table of Contents

Properties

$logger  : LoggerInterface
$versionsCacheFile  : string
$versionsServerUrl  : string

Methods

__construct()  : mixed
checkForUpdates()  : array{mineure: string, majeure: string}
Indique les mises à jour majeures et mineures pour une version de SPIP.
compareVersions()  : array{mineure: string, majeure: string}
Compare la version actuelle avec les versions disponibles.
getUpdateMessage()  : string
Génère un message HTML présentant les mises à jour disponibles.
notifyWebmasters()  : void
Notifie les webmestres d'une nouvelle version disponible.
fetchVersionsCache()  : array<string, mixed>
Récupère (et met en cache) la liste des versions de SPIP disponibles.

Properties

$logger

private LoggerInterface $logger
Attributes
#[Autowire]
$service: 'spip.update.logger'

$versionsCacheFile

private string $versionsCacheFile
Attributes
#[Autowire]
'%spip.update.versions_cache_file%'

$versionsServerUrl

private string $versionsServerUrl
Attributes
#[Autowire]
'%spip.update.versions_server_url%'

Methods

__construct()

public __construct(string $versionsServerUrl, string $versionsCacheFile, LoggerInterface $logger) : mixed
Parameters
$versionsServerUrl : string
$versionsCacheFile : string
$logger : LoggerInterface

checkForUpdates()

Indique les mises à jour majeures et mineures pour une version de SPIP.

public checkForUpdates([string $version = SpipVersion::VERSION ]) : array{mineure: string, majeure: string}
Parameters
$version : string = SpipVersion::VERSION
Return values
array{mineure: string, majeure: string}

compareVersions()

Compare la version actuelle avec les versions disponibles.

public compareVersions(string $version, array<string|int, string> $versions) : array{mineure: string, majeure: string}

Détermine les mises à jour mineures (même branche) et majeures (branche supérieure).

Parameters
$version : string

Notre version actuelle

$versions : array<string|int, string>

Les versions distantes disponibles

Return values
array{mineure: string, majeure: string}

getUpdateMessage()

Génère un message HTML présentant les mises à jour disponibles.

public getUpdateMessage([string $version = SpipVersion::VERSION ]) : string
Parameters
$version : string = SpipVersion::VERSION
Return values
string

notifyWebmasters()

Notifie les webmestres d'une nouvelle version disponible.

public notifyWebmasters(string $version) : void

La constante _MAJ_NOTIF_EMAILS peut servir :

  • à indiquer les emails à notifier à la place des webmestres du site
  • ou (falsy) à empêcher cette notification
Parameters
$version : string

fetchVersionsCache()

Récupère (et met en cache) la liste des versions de SPIP disponibles.

private fetchVersionsCache() : array<string, mixed>

Teste la nouveauté par If-Modified-Since pour limiter les accès HTTP.

Return values
array<string, mixed>

        
On this page

Search results