dump.php
SPIP, Système de publication pour l'internet
Copyright © avec tendresse depuis 2001 Arnaud Martin, Antoine Pitrou, Philippe Rivière, Emmanuel Saint-James
Ce programme est un logiciel libre distribué sous licence GNU/GPL.
Table of Contents
Functions
- dump_repertoire() : string
 - Répertoire de sauvegarde
 - dump_nom_fichier() : string
 - Nom du fichier de sauvegarde
 - dump_type_serveur() : string
 - Détermine le type de serveur de sauvegarde, sqlite2 ou sqlite3
 - dump_serveur() : array<string|int, mixed>
 - Conteneur pour les arguments de la connexion
 - dump_connect_args() : mixed
 - dump_init() : mixed
 - Initialiser un dump
 - dump_afficher_progres() : mixed
 - Afficher l'avancement de la copie
 - dump_relance() : string
 - Écrire le js pour relancer la procédure de dump
 - dump_end() : mixed
 - Marquer la procédure de dump comme finie
 - dump_lister_sauvegardes() : array<string|int, mixed>
 - Lister les fichiers de sauvegarde existant dans un repertoire trie par nom, date ou taille
 - dump_lire_status() : array<string|int, mixed>|string
 - Extraire le statut contenu dans un fichier
 - dump_verifie_sauvegarde_finie() : string
 - Verifier qu'un sauvegarde est finie
 - dump_nom_sauvegarde() : string
 - Recuperer le nom du fichier d'archivage qui est memorise dans le fichier de statut
 - dump_taille_sauvegarde() : mixed
 - Recuperer la taille du fichier de sauvegarde
 - dump_date_sauvegarde() : mixed
 - Recuperer la date de derniere modification du fichier de sauvegarde
 - base_dump_meta_name() : string
 - Retourne un nom de meta pour une rubrique et l'auteur connecté.
 
Functions
dump_repertoire()
Répertoire de sauvegarde
    
                    dump_repertoire() : string
        Crée et retourne le chemin du répertoire de sauvegarde
Tags
Return values
stringdump_nom_fichier()
Nom du fichier de sauvegarde
    
                    dump_nom_fichier(string $dir[, string $extension = 'sqlite' ]) : string
        la fourniture de l'extension permet de vérifier que le nom n'existe pas déjà.
Parameters
- $dir : string
 - 
                    
Chemin de stockage du fichier
 - $extension : string = 'sqlite'
 - 
                    
Extension du fichier de sauvegarde
 
Return values
stringdump_type_serveur()
Détermine le type de serveur de sauvegarde, sqlite2 ou sqlite3
    
                    dump_type_serveur() : string
    
    
    
            Return values
stringdump_serveur()
Conteneur pour les arguments de la connexion
    
                    dump_serveur([array<string|int, mixed> $args = null ]) : array<string|int, mixed>
        Si on passe $args, les arguments de la connexion sont memorisés. Renvoie toujours les derniers arguments memorisés.
Parameters
- $args : array<string|int, mixed> = null
 
Tags
Return values
array<string|int, mixed>dump_connect_args()
    
                    dump_connect_args(mixed $archive) : mixed
    
        Parameters
- $archive : mixed
 
dump_init()
Initialiser un dump
    
                    dump_init(string $status_file, string $archive[, array<string|int, mixed> $tables = null ][, array<string|int, mixed> $where = [] ][, string $action = 'sauvegarde' ]) : mixed
    
        Parameters
- $status_file : string
 - 
                    
Fichier contenant les informations serialisees sur le statut de l'export
 - $archive : string
 - 
                    
Nom de l'archive (stockee dans le fichier de statut)
 - $tables : array<string|int, mixed> = null
 - 
                    
Liste des tables a exporter (autocaculee par defaut)
 - $where : array<string|int, mixed> = []
 - 
                    
Condition sur l'export
 - $action : string = 'sauvegarde'
 - 
                    
Pour differencier la sauvegarde de l'import
 
Tags
dump_afficher_progres()
Afficher l'avancement de la copie
    
                    dump_afficher_progres(mixed $courant, mixed $total, mixed $table) : mixed
    
        Parameters
- $courant : mixed
 - $total : mixed
 - $table : mixed
 
Tags
dump_relance()
Écrire le js pour relancer la procédure de dump
    
                    dump_relance(string $redirect) : string
    
        Parameters
- $redirect : string
 - 
                    
URL de la prochaine etape du dump
 
Return values
string —Code HTML de redirection
dump_end()
Marquer la procédure de dump comme finie
    
                    dump_end(string $status_file[, string $action = '' ]) : mixed
    
        Parameters
- $status_file : string
 - 
                    
Fichier qui mémorise les infos utiles concernant la sauvegarde en cours
 - $action : string = ''
 - 
                    
Type d'action supplémentaire à réaliser :
- restaurer : supprimer la structure qui était stockée dans le dump
 - 'auvegarder : stocker dans le dump la structure de la base source
 
 
dump_lister_sauvegardes()
Lister les fichiers de sauvegarde existant dans un repertoire trie par nom, date ou taille
    
                    dump_lister_sauvegardes(string $dir[, string $tri = 'nom' ][, string $extension = 'sqlite' ][, int $limit = 100 ]) : array<string|int, mixed>
    
        Parameters
- $dir : string
 - 
                    
Repertoire de sauvegarde
 - $tri : string = 'nom'
 - 
                    
Tri pour recuperer les fichiers
 - $extension : string = 'sqlite'
 - 
                    
Extension des fichiers de sauvegarde
 - $limit : int = 100
 - 
                    
Nombre max de fichiers listes
 
Return values
array<string|int, mixed>dump_lire_status()
Extraire le statut contenu dans un fichier
    
                    dump_lire_status(Nom $status_file) : array<string|int, mixed>|string
    
        Parameters
- $status_file : Nom
 - 
                    
du fichier stocke dans _DIR_TMP
 
Return values
array<string|int, mixed>|stringdump_verifie_sauvegarde_finie()
Verifier qu'un sauvegarde est finie
    
                    dump_verifie_sauvegarde_finie(Nom $status_file) : string
    
        Parameters
- $status_file : Nom
 - 
                    
du fichier stocke dans _DIR_TMP
 
Return values
string —Chaine non vide s'il reste des choses a faire
dump_nom_sauvegarde()
Recuperer le nom du fichier d'archivage qui est memorise dans le fichier de statut
    
                    dump_nom_sauvegarde(Nom $status_file) : string
    
        Parameters
- $status_file : Nom
 - 
                    
du fichier stocke dans _DIR_TMP
 
Return values
string —Nom ou chaine vide si on a un probleme
dump_taille_sauvegarde()
Recuperer la taille du fichier de sauvegarde
    
                    dump_taille_sauvegarde(Nom $status_file) : mixed
    
        Parameters
- $status_file : Nom
 - 
                    
du fichier stocke dans _DIR_TMP
 
Tags
dump_date_sauvegarde()
Recuperer la date de derniere modification du fichier de sauvegarde
    
                    dump_date_sauvegarde(Nom $status_file) : mixed
    
        Parameters
- $status_file : Nom
 - 
                    
du fichier stocke dans _DIR_TMP
 
Tags
base_dump_meta_name()
Retourne un nom de meta pour une rubrique et l'auteur connecté.
    
                    base_dump_meta_name(int $rub) : string
        Ce nom servira pour le stockage dans un fichier temporaire des informations sérialisées sur le statut de l'export.
Parameters
- $rub : int