SPIP Code

Documentation du code de SPIP et de ses plugins

Dump

Application

Table of Contents

Constants

_DUMP_SERVEUR_OK  = \true
_DUMP_STATUS_FILE  = $status_file

Functions

action_restaurer_dist()  : mixed
Sauvegarder par morceaux
action_sauvegarder_dist()  : mixed
Sauvegarder par morceaux
action_supprimer_dump_dist()  : mixed
Telecharger un dump quand on est webmestre
action_telecharger_dump_dist()  : mixed
Telecharger un dump quand on est webmestre
base_restaurer_dist()  : mixed
Restauration d'une sauvegarde
dump_autoriser()  : mixed
Fonction du pipeline autoriser. N'a rien à faire
autoriser_restaurer_menu_dist()  : bool
Autorisation de voir le menu restaurer
exec_base_restaurer_dist()  : mixed
Finir une restauration interrompue par logout
formulaires_restaurer_charger_dist()  : array<string|int, mixed>
Charger #FORMULAIRE_RESTAURER
formulaires_restaurer_verifier_dist()  : array<string|int, mixed>
Verifier
formulaires_restaurer_traiter_dist()  : array<string|int, mixed>
Traiter
formulaires_sauvegarder_charger_dist()  : array<string|int, mixed>
Charger `#FORMULAIRE_SAUVEGARDER`
formulaires_sauvegarder_verifier_dist()  : array<string|int, mixed>
Verifier
formulaires_sauvegarder_traiter_dist()  : array<string|int, mixed>
Traiter
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é.
inc_sauvegarder_dist()  : bool
Fonction principale de sauvegarde En mode sqlite on passe par une copie de base a base (dans l'API de SPIP)
dump_afficher_tables_restaurees_erreurs()  : string
Afficher les erreurs survenues dans la restauration
dump_afficher_tables_sauvegardees()  : string
Afficher les erreurs survenues dans la sauvegarde
dump_afficher_erreurs()  : mixed

Constants

_DUMP_SERVEUR_OK

public mixed _DUMP_SERVEUR_OK = \true

Functions

action_restaurer_dist()

Sauvegarder par morceaux

action_restaurer_dist([string $arg = null ]) : mixed
Parameters
$arg : string = null

action_sauvegarder_dist()

Sauvegarder par morceaux

action_sauvegarder_dist([string $arg = null ]) : mixed
Parameters
$arg : string = null

action_supprimer_dump_dist()

Telecharger un dump quand on est webmestre

action_supprimer_dump_dist([string $arg = null ]) : mixed
Parameters
$arg : string = null

action_telecharger_dump_dist()

Telecharger un dump quand on est webmestre

action_telecharger_dump_dist([string $arg = null ]) : mixed
Parameters
$arg : string = null

base_restaurer_dist()

Restauration d'une sauvegarde

base_restaurer_dist([string $titre = '' ][, bool $reprise = false ]) : mixed
Parameters
$titre : string = ''

Titre de la page

$reprise : bool = false

true s'il s'agit d'une reprise de sauvegarde

dump_autoriser()

Fonction du pipeline autoriser. N'a rien à faire

dump_autoriser() : mixed
Tags
pipeline

autoriser

autoriser_restaurer_menu_dist()

Autorisation de voir le menu restaurer

autoriser_restaurer_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Il faut avoir le droit de sauvegarder

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

exec_base_restaurer_dist()

Finir une restauration interrompue par logout

exec_base_restaurer_dist() : mixed

formulaires_restaurer_charger_dist()

Charger #FORMULAIRE_RESTAURER

formulaires_restaurer_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_restaurer_verifier_dist()

Verifier

formulaires_restaurer_verifier_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_restaurer_traiter_dist()

Traiter

formulaires_restaurer_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_sauvegarder_charger_dist()

Charger `#FORMULAIRE_SAUVEGARDER`

formulaires_sauvegarder_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_sauvegarder_verifier_dist()

Verifier

formulaires_sauvegarder_verifier_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_sauvegarder_traiter_dist()

Traiter

formulaires_sauvegarder_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed>

dump_repertoire()

Répertoire de sauvegarde

dump_repertoire() : string

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

Tags
see
_DIR_DUMP
Return values
string

dump_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
string

dump_type_serveur()

Détermine le type de serveur de sauvegarde, sqlite2 ou sqlite3

dump_type_serveur() : string
Return values
string

dump_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
staticvar

array $connect_args Pour stocker le premier conteneur

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
@return

bool/string

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
staticvar

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

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>|string

dump_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
@return

string/int Taille ou Chaine vide en cas de probleme

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
@return

string/int Date ou Chaine vide en cas de probleme

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
Tags
uses

$GLOBALS['visiteur_session']['id_auteur']

Return values
string

inc_sauvegarder_dist()

Fonction principale de sauvegarde En mode sqlite on passe par une copie de base a base (dans l'API de SPIP)

inc_sauvegarder_dist(string $status_file[, string $redirect = '' ]) : bool
Parameters
$status_file : string

Nom du fichier de status (stocke dans _DIR_TMP)

$redirect : string = ''

Redirection apres la sauvegarde

Return values
bool

dump_afficher_tables_restaurees_erreurs()

Afficher les erreurs survenues dans la restauration

dump_afficher_tables_restaurees_erreurs(string $status_file) : string
Parameters
$status_file : string

Nom du fichier qui contient le statut de la restauration sous une forme serialisee

Return values
string —

Code HTML a afficher

dump_afficher_tables_sauvegardees()

Afficher les erreurs survenues dans la sauvegarde

dump_afficher_tables_sauvegardees(string $status_file) : string
Parameters
$status_file : string

Nom du fichier qui contient le statut de la sauvegarde sous une forme serialisee

Return values
string —

Code HTML a afficher


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results