SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

Installation

Table of Contents

Functions

base_determine_autoinc()  : bool
Determiner le flag autoinc pour une table en fonction de si c'est une table principale
creer_ou_upgrader_table()  : void
Créer une table, ou ajouter les champs manquants si elle existe déjà
alterer_base()  : void
Creer ou mettre à jour un ensemble de tables en fonction du flag `$up`
creer_base()  : void
Créer une base de données à partir des tables principales et auxiliaires
maj_tables()  : void
Mettre à jour une liste de tables
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

base_determine_autoinc()

Determiner le flag autoinc pour une table en fonction de si c'est une table principale

base_determine_autoinc(string $table[, array<string|int, mixed> $desc = [] ]) : bool
Parameters
$table : string
$desc : array<string|int, mixed> = []
Return values
bool

creer_ou_upgrader_table()

Créer une table, ou ajouter les champs manquants si elle existe déjà

creer_ou_upgrader_table(string $table, array<string|int, mixed> $desc, bool|string $autoinc[, bool $upgrade = false ][, string $serveur = '' ]) : void
Parameters
$table : string
$desc : array<string|int, mixed>
$autoinc : bool|string

'auto' pour detecter automatiquement si le champ doit etre autoinc ou non en fonction de la table

$upgrade : bool = false
$serveur : string = ''

alterer_base()

Creer ou mettre à jour un ensemble de tables en fonction du flag `$up`

alterer_base(array<string|int, mixed> $tables_inc,  $tables_noinc[, bool|array<string|int, mixed> $up = false ][, string $serveur = '' ]) : void
Parameters
$tables_inc : array<string|int, mixed>

tables avec autoincrement sur la cle primaire

$tables_noinc :

tables sans autoincrement sur la cle primaire

$up : bool|array<string|int, mixed> = false

upgrader (true) ou creer (false) si un tableau de table est fournie, seules l'intersection de ces tables et des $tables_inc / $tables_noinc seront traitees

$serveur : string = ''

serveur sql

Tags
uses
creer_ou_upgrader_table()
used-by
creer_base()
used-by
maj_tables()

creer_base()

Créer une base de données à partir des tables principales et auxiliaires

creer_base([string $serveur = '' ]) : void

Lorsque de nouvelles tables ont été déclarées, cette fonction crée les tables manquantes. mais ne crée pas des champs manquant d'une table déjà présente. Pour cela, c’est maj_tables() qu’il faut appeler.

Parameters
$serveur : string = ''
Tags
see
maj_tables()
uses
alterer_base()
used-by
base_upgrade_dist()

maj_tables()

Mettre à jour une liste de tables

maj_tables([array<string|int, mixed> $upgrade_tables = [] ][, string $serveur = '' ]) : void

Fonction facilitatrice utilisée pour les maj de base dans les plugins.

Elle permet de créer les champs manquants d'une table déjà présente.

Parameters
$upgrade_tables : array<string|int, mixed> = []
$serveur : string = ''
Tags
see
creer_base()
uses
alterer_base()

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