Fichier plugins-dist/dump/inc/dump.php

API permettant la manipulation des sauvegardes

Source

Liste des fonctions

dump_afficher_progres()

Afficher l'avancement de la copie
void dump_afficher_progres( \<type> $courant , \<type> $total , \<type> $table )

Paramètres

  1. \<type> $courant

    Flag pour indiquer si c'est la table sur laquelle on travaille actuellement

  2. \<type> $total

    Nombre total de tables

  3. \<type> $table

    Nom de la table

Package

Staticvar

  • int $etape Nombre de fois ou on est passe dans cette foncion

Source

dump_connect_args()
void dump_connect_args( $archive )

Paramètres

  1. $archive

Package

Source

dump_date_sauvegarde()

Recuperer la date de derniere modification du fichier de sauvegarde
\string/int dump_date_sauvegarde( $status_file )

Paramètres

  1. $status_file

    Nom du fichier stocke dans _DIR_TMP

Retour

  • \string/int

    Date ou Chaine vide en cas de probleme

Package

Source

dump_end()

Marquer la procédure de dump comme finie
void dump_end( string $status_file , string $action = '' )

Paramètres

  1. string $status_file

    Fichier qui mémorise les infos utiles concernant la sauvegarde en cours

  2. string $action = ''

    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

Package

Source

dump_init()

Initialiser un dump
\bool/string dump_init( string $status_file , string $archive , array $tables = null , array $where = array() , string $action = 'sauvegarde' )

Paramètres

  1. string $status_file

    Fichier contenant les informations serialisees sur le statut de l'export

  2. string $archive

    Nom de l'archive (stockee dans le fichier de statut)

  3. array $tables = null

    Liste des tables a exporter (autocaculee par defaut)

  4. array $where = array()

    Condition sur l'export

  5. string $action = 'sauvegarde'

    Pour differencier la sauvegarde de l'import

Retour

  • \bool/string

Package

Source

dump_lire_status()

Extraire le statut contenu dans un fichier
array dump_lire_status( $status_file )

Paramètres

  1. $status_file

    Nom du fichier stocke dans _DIR_TMP

Retour

  • array

Package

Source

dump_lister_sauvegardes()

Lister les fichiers de sauvegarde existant dans un repertoire trie par nom, date ou taille
array dump_lister_sauvegardes( string $dir , string $tri = 'nom' , string $extension = 'sqlite' , integer $limit = 100 )

Paramètres

  1. string $dir

    Repertoire de sauvegarde

  2. string $tri = 'nom'

    Tri pour recuperer les fichiers

  3. string $extension = 'sqlite'

    Extension des fichiers de sauvegarde

  4. integer $limit = 100

    Nombre max de fichiers listes

Retour

  • array

Package

Source

dump_nom_fichier()

Nom du fichier de sauvegarde

la fourniture de l'extension permet de vérifier que le nom n'existe pas déjà.

string dump_nom_fichier( string $dir , string $extension = 'sqlite' )

Paramètres

  1. string $dir

    Chemin de stockage du fichier

  2. string $extension = 'sqlite'

    Extension du fichier de sauvegarde

Retour

  • string

Package

Source

dump_nom_sauvegarde()

Recuperer le nom du fichier d'archivage qui est memorise dans le fichier de statut
string dump_nom_sauvegarde( $status_file )

Paramètres

  1. $status_file

    Nom du fichier stocke dans _DIR_TMP

Retour

  • string

    Nom ou chaine vide si on a un probleme

Package

Source

dump_relance()

Écrire le js pour relancer la procédure de dump
string dump_relance( string $redirect )

Paramètres

  1. string $redirect

    URL de la prochaine etape du dump

Retour

  • string

    Code HTML de redirection

Package

Source

dump_repertoire()

Répertoire de sauvegarde

Crée et retourne le chemin du répertoire de sauvegarde

string dump_repertoire( )

Retour

  • string

Voir également

Package

Source

dump_serveur()

Conteneur pour les arguments de la connexion

Si on passe $args, les arguments de la connexion sont memorisés. Renvoie toujours les derniers arguments memorisés.

array dump_serveur( array $args = null )

Paramètres

  1. array $args = null

Retour

  • array

Package

Staticvar

  • array $connect_args Pour stocker le premier conteneur

Source

dump_taille_sauvegarde()

Recuperer la taille du fichier de sauvegarde
\string/int dump_taille_sauvegarde( $status_file )

Paramètres

  1. $status_file

    Nom du fichier stocke dans _DIR_TMP

Retour

  • \string/int

    Taille ou Chaine vide en cas de probleme

Package

Source

dump_verifie_sauvegarde_finie()

Verifier qu'un sauvegarde est finie
string dump_verifie_sauvegarde_finie( $status_file )

Paramètres

  1. $status_file

    Nom du fichier stocke dans _DIR_TMP

Retour

  • string

    Chaine non vide s'il reste des choses a faire

Package

Source

Liste des erreurs

GravitéLigneDescription
Erreur 122
  • No summary for function \dump_connect_args()
  • Argument $archive is missing from the Docblock of dump_connect_args