SPIP Code

Documentation du code de SPIP et de ses plugins

Big Upload

GestionRepertoires
in package

Gère la création ou le nettoyages de répertoires

Tags
notes

Certaines fonctions peuvent faire beaucoup d'accès disque.

Table of Contents

Methods

creer_sous_repertoire()  : bool|string
Vérifier et préparer l'arborescence jusqu'au répertoire parent
deplacer_fichier_upload()  : bool|mixed|string
Déplacer ou copier un fichier
filtrer_fichiers()  : array<string|int, mixed>
Enlever d'une liste des fichiers ce qui est inutile
nettoyer_repertoire_recursif()  : bool
Nettoyer un répertoire suivant l'age et le nombre de ses fichiers
nommer_fichier()  : string
Reformater le nom du fichier pour l'écrire sur le serveur
nommer_repertoire()  : mixed
Pour un nom donné, propose un nom de répertoire valide sur la plupart des systèmes de fichiers
supprimer_repertoire()  : bool
Supprimer le contenu d'un répertoire et nettoie les répertoires parents s'ils sont vides
supprimer_repertoires_vides()  : bool
Supprimer les répertoires vides enfants et parents (jusqu'à _DIR_TMP) d'un répertoire.
supprimer_repertoires_vides_enfants()  : bool
Supprimer les répertoires enfants vides et moi même si vide.
supprimer_repertoires_vides_parents()  : bool
Supprimer ce répertoire si vide et ses parents s'ils deviennent vides

Methods

creer_sous_repertoire()

Vérifier et préparer l'arborescence jusqu'au répertoire parent

public static creer_sous_repertoire(string $dest) : bool|string
Parameters
$dest : string
Tags
note

Code repris de SVP (action/teleporter)

Return values
bool|string —

false en cas d'échec Chemin du répertoire sinon

deplacer_fichier_upload()

Déplacer ou copier un fichier

public static deplacer_fichier_upload(string $source, string $dest[, bool $move = false ]) : bool|mixed|string
Parameters
$source : string

Fichier source à copier

$dest : string

Fichier de destination

$move : bool = false
  • true : on déplace le fichier source vers le fichier de destination
  • false : valeur par défaut. On ne fait que copier le fichier source vers la destination.
Tags
note

Proche de inc/documents: deplacer_fichier_upload() mais sans l'affichage d'erreur éventuelle.

uses
_DIR_RACINE
uses
spip_unlink()
Return values
bool|mixed|string

filtrer_fichiers()

Enlever d'une liste des fichiers ce qui est inutile

public static filtrer_fichiers(array<string|int, mixed> $fichiers) : array<string|int, mixed>

Enlève les fichiers .. et . ainsi que des fichiers à ne pas considérer comme importants pour tester qu'un répertoire a du contenu. Particulièrement .ok et file.bigup.json

Parameters
$fichiers : array<string|int, mixed>
Tags
todo

Trouver un mécanisme pour transmettre l'info file.bigup.json qui ne devrait pas être en dur ici.

Return values
array<string|int, mixed>

nettoyer_repertoire_recursif()

Nettoyer un répertoire suivant l'age et le nombre de ses fichiers

public static nettoyer_repertoire_recursif(string $repertoire[, int $age_max = 86400 ]) : bool

Nettoie aussi les sous répertoires. Supprime automatiquement les répertoires vides.

Parameters
$repertoire : string

Répertoire à nettoyer

$age_max : int = 86400

Age maxium des fichiers en seconde. Par défaut 24*3600

Return values
bool —
  • false : erreur de lecture du répertoire.
  • true : action réalisée.

nommer_fichier()

Reformater le nom du fichier pour l'écrire sur le serveur

public static nommer_fichier(string $filename) : string
Parameters
$filename : string
Tags
see
copier_document()

dans SPIP

Return values
string —

Nom du fichier corrigé

nommer_repertoire()

Pour un nom donné, propose un nom de répertoire valide sur la plupart des systèmes de fichiers

public static nommer_repertoire(string $nom) : mixed
Parameters
$nom : string

Nom d'origine

Return values
mixed —

string Nom possible pour un répertoire

supprimer_repertoire()

Supprimer le contenu d'un répertoire et nettoie les répertoires parents s'ils sont vides

public static supprimer_repertoire(string $chemin) : bool
Parameters
$chemin : string

Chemin du répertoire à supprimer

Return values
bool

supprimer_repertoires_vides()

Supprimer les répertoires vides enfants et parents (jusqu'à _DIR_TMP) d'un répertoire.

public static supprimer_repertoires_vides(string $chemin[, bool $parents = true ][, bool $enfants = true ]) : bool
Parameters
$chemin : string

Chemin du repertoire à nettoyer, dans _DIR_TMP

$parents : bool = true

True pour nettoyer les répertoires vides parents

$enfants : bool = true

True pour nettoyer les répertoires vides enfants

Return values
bool

supprimer_repertoires_vides_enfants()

Supprimer les répertoires enfants vides et moi même si vide.

public static supprimer_repertoires_vides_enfants(string $chemin) : bool
Parameters
$chemin : string

Chemin du répertoire à nettoyer, dans _DIR_TMP

Return values
bool

supprimer_repertoires_vides_parents()

Supprimer ce répertoire si vide et ses parents s'ils deviennent vides

public static supprimer_repertoires_vides_parents(string $chemin) : bool
Parameters
$chemin : string

Chemin du répertoire à nettoyer, dans _DIR_TMP

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results