SPIP Code

Documentation du code de SPIP et de ses plugins

Fabrique

Futilitaire
in package

Encapsule les fonctions d'aides

Tags
example 
$futil = new Futilitaire($data, $destination_plugin, $destination_ancien_plugin);

Table of Contents

Properties

$data  : array<string|int, mixed>
Information complète des saisies du formulaire de création de la fabrique complétee de quelques raccourcis
$dir_backup  : string
Chemin de l'ancien plugin
$dir_dest  : string
Chemin de destination de notre plugin
$lignes  : array<string|int, Futilitaire_Lignes>

Methods

__construct()  : mixed
Le constructeur charge les infos utiles :
ajouter_lignes()  : bool
Insère du code dans un fichier indiqué
appliquer_lignes()  : mixed
Applique les modifications de lignes qui ont été définies avec `set_lignes()`
creer_arborescence_destination()  : bool
Crée les répertoires manquants dans le plugin crée par rapport au chemin désiré
deplacer_dossiers()  : mixed
Déplacer une liste de dossiers/répertoires du backup vers le nouveau plugin et créer les repertoires manquants si besoin dans le nouveau plugin.
deplacer_fichiers()  : mixed
Déplacer une liste de fichiers du backup vers le nouveau plugin et créer les repertoires manquants si besoin dans le nouveau plugin.
inserer()  : Futilitaire_Ligne
Facilitateur d'écriture
log()  : mixed
Log une erreur

Properties

$data

Information complète des saisies du formulaire de création de la fabrique complétee de quelques raccourcis

public array<string|int, mixed> $data = []

$dir_backup

Chemin de l'ancien plugin

public string $dir_backup = ''

Celui que l'on recrée et que l'on a copié en sauvegarde avant

$dir_dest

Chemin de destination de notre plugin

public string $dir_dest = ''

Methods

__construct()

Le constructeur charge les infos utiles :

public __construct(array<string|int, mixed> $data, string $dir_dest, string $dir_backup) : mixed
  • le tableau $data contenant les saisies utilisateurs
  • le lieu de destination du plugin
  • le lieu de sauvegarde de la precedente creation du plugin (qui contient donc peut etre des informations/fichiers que l'on veut recuperer)
Parameters
$data : array<string|int, mixed>

Information complète des saisies du formulaire de création de la fabrique complétee de quelques raccourcis

$dir_dest : string

Chemin de destination de notre plugin

$dir_backup : string

Chemin de l'ancien plugin (celui que l'on recrée et que l'on a copié en sauvegarde avant)

ajouter_lignes()

Insère du code dans un fichier indiqué

public ajouter_lignes(string $chemin, int $debut, int $fin, string $code) : bool
Parameters
$chemin : string

Chemin du fichier depuis la racine du plugin

$debut : int

Ligne du départ de l'insertion Peut être négatif : -3 indique 3 lignes avant la fin de fichier

$fin : int

Indique combien de lignes seront supprimées du fichier à partir du début choisi 0 (zero) pour conserver tout le code existant dans le fichier

$code : string

Le code à insérer.

Tags
example 
$futil->ajouter_lignes('lang/geoniche_fr.php', -3, 0, fabrique_tabulations($lignes, 1));
Return values
bool —

Operation reussie ou pas.

appliquer_lignes()

Applique les modifications de lignes qui ont été définies avec `set_lignes()`

public appliquer_lignes() : mixed

creer_arborescence_destination()

Crée les répertoires manquants dans le plugin crée par rapport au chemin désiré

public creer_arborescence_destination(string $chemin[, bool $is_file = true ]) : bool
Parameters
$chemin : string

Destination depuis la racine du plugin

$is_file : bool = true

Est-ce un fichier (true) ou un répertoire (false) ?

Tags
example 
$this->creer_arborescence_destination("inclure/config.php");
Return values
bool —

Est-ce que c'est bien crée ?

deplacer_dossiers()

Déplacer une liste de dossiers/répertoires du backup vers le nouveau plugin et créer les repertoires manquants si besoin dans le nouveau plugin.

public deplacer_dossiers(string|array<string|int, mixed> $dossiers) : mixed
Parameters
$dossiers : string|array<string|int, mixed>

Liste des fichiers a déplacer

Tags
example 
$futil->deplacer_dossiers('lib');
$futil->deplacer_dossiers(array('lib','actions'));

deplacer_fichiers()

Déplacer une liste de fichiers du backup vers le nouveau plugin et créer les repertoires manquants si besoin dans le nouveau plugin.

public deplacer_fichiers(string|array<string|int, mixed> $fichiers) : mixed
Parameters
$fichiers : string|array<string|int, mixed>

Liste des fichiers à déplacer

Tags
example 
$futil->deplacer_fichiers(array(
   'base/importer_spip_villes.php',
   'base/importer_spip_villes_donnees.gz',
));

inserer()

Facilitateur d'écriture

public inserer(string $chemin, int $debut[, int $fin = 0 ][, int $tabulation = 0 ][, string $contenu = '' ]) : Futilitaire_Ligne

Crée une nouvelle ligne, la stocke et retourne l'objet crée pour modifications

Parameters
$chemin : string

Chemin du fichier à traiter

$debut : int

Numero de la ligne à modifier

$fin : int = 0

Nombre de lignes supprimées

$tabulation : int = 0

Ajout de n caractères de tabulations en début de chaque ligne

$contenu : string = ''

Contenu à insérer

Tags
example 
$futil->inserer($chemin, $debut, $fin, $tabulation)->contenu = X;
$futil->inserer($chemin, $debut, $fin, $tabulation)->contenu = <<<EOT
contenu
EOT;

$futil->appliquer_lignes();
Return values
Futilitaire_Ligne —

Retourne l'objet créé, ce qui permet de le modifier, tout en gardant ici au passage ce qui a été modifié.

log()

Log une erreur

public log([string $texte = '' ]) : mixed
Parameters
$texte : string = ''

Le texte à logguer.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results