Documentation du code de SPIP et de ses plugins

SPIP

install.php

Gestion de l'installation de SPIP

Table of Contents

Functions

install_fichier_connexion()  : void
Écrit un fichier PHP nécessitant SPIP
analyse_fichier_connection()  : array<string|int, mixed>
Analyse un fichier de connexion à une base de données
bases_referencees()  : array<string|int, mixed>
Liste les connecteurs aux bases SQL disponibles
install_mode_appel()  : mixed
tester_compatibilite_hebergement()  : mixed
info_etape()  : mixed
bouton_suivant()  : string
Retourne le code HTML d'un bouton `suivant>>` pour les phases d'installation
info_progression_etape()  : mixed
fieldset()  : mixed
fieldset_champs()  : mixed
install_select_serveur()  : mixed
install_connexion_form()  : mixed
predef_ou_cache()  : mixed
install_etape_liste_bases()  : mixed
install_propager()  : mixed

Functions

install_fichier_connexion()

Écrit un fichier PHP nécessitant SPIP

install_fichier_connexion(string $nom, string $texte) : void

Écrit le texte transmis dans un fichier PHP. Cette fonction ajoute les entêtes PHP et le test de sécurité vérifiant que SPIP est chargé.

Parameters
$nom : string

Chemin du fichier à créer

$texte : string

Code source du fichier (sans l'ouverture/fermeture PHP)

Tags
example
install_fichier_connexion(_FILE_CONNECT_TMP, $contenu);
todo

Renommer cette fonction qui peut servir à d'autres utilisations ?

analyse_fichier_connection()

Analyse un fichier de connexion à une base de données

analyse_fichier_connection(string $file) : array<string|int, mixed>

Le fichier contient normalement le résultat de la fonction install_connexion(). L'analyse tient également compte des syntaxes des versions précédentes.

Parameters
$file : string

Chemin du fichier de connexion à analyser

Return values
array<string|int, mixed>

Tableau des informations sur la connexion

bases_referencees()

Liste les connecteurs aux bases SQL disponibles

bases_referencees([string $exclu = '' ]) : array<string|int, mixed>

Dans le code SPIP ces connecteurs sont souvent appelés $connect ou $serveur

Parameters
$exclu : string = ''

Exclure un connecteur particulier (nom du fichier)

Tags
example

$bases = bases_referencees(_FILE_CONNECT_TMP);

Return values
array<string|int, mixed>

Liste des noms de connecteurs

install_mode_appel()

install_mode_appel(mixed $server_db[, mixed $tout = true ]) : mixed
Parameters
$server_db : mixed
$tout : mixed = true

tester_compatibilite_hebergement()

tester_compatibilite_hebergement() : mixed

info_etape()

info_etape(mixed $titre[, mixed $complement = '' ]) : mixed
Parameters
$titre : mixed
$complement : mixed = ''

bouton_suivant()

Retourne le code HTML d'un bouton `suivant>>` pour les phases d'installation

bouton_suivant([string $code = '' ]) : string
Parameters
$code : string = ''

texte du bouton

Return values
string

Code HTML du bouton

info_progression_etape()

info_progression_etape(mixed $en_cours, mixed $phase, mixed $dir[, mixed $erreur = false ]) : mixed
Parameters
$en_cours : mixed
$phase : mixed
$dir : mixed
$erreur : mixed = false

fieldset()

fieldset(mixed $legend[, mixed $champs = [] ][, mixed $apres = '' ][, mixed $avant = '' ]) : mixed
Parameters
$legend : mixed
$champs : mixed = []
$apres : mixed = ''
$avant : mixed = ''

fieldset_champs()

fieldset_champs([mixed $champs = [] ]) : mixed
Parameters
$champs : mixed = []

install_connexion_form()

install_connexion_form(mixed $db, mixed $login, mixed $pass, mixed $predef, mixed $hidden, mixed $etape[, mixed $jquery = true ]) : mixed
Parameters
$db : mixed
$login : mixed
$pass : mixed
$predef : mixed
$hidden : mixed
$etape : mixed
$jquery : mixed = true

predef_ou_cache()

predef_ou_cache(mixed $adresse_db, mixed $login_db, mixed $pass_db, mixed $server_db) : mixed
Parameters
$adresse_db : mixed
$login_db : mixed
$pass_db : mixed
$server_db : mixed

install_etape_liste_bases()

install_etape_liste_bases(mixed $server_db, mixed $login_db[, mixed $disabled = [] ]) : mixed
Parameters
$server_db : mixed
$login_db : mixed
$disabled : mixed = []

install_propager()

install_propager(mixed $hidden) : mixed
Parameters
$hidden : mixed

        
On this page

Search results