SPIP Code

Documentation du code de SPIP et de ses plugins

SVP

Teleporteur

Table of Contents

Constants

_GIT_COMMAND  = 'git'
_SVN_COMMAND  = 'svn'
_SVP_PAQUET_MAX_SIZE  = 67108864

Functions

teleporter_git_dist()  : bool
Téléporter et déballer un composant GIT
teleporter_git_read()  : string|bool|array<string|int, mixed>
Lire l'état GIT du repository
teleporter_git_exec()  : mixed
Exécuter une commande GIT
teleporter_git_tester()  : bool
Tester si la commande 'git' est disponible
teleporter_http_dist()  : bool|string
Téléporter et déballer un composant HTTP
teleporter_http_recuperer_source()  : array<string|int, mixed>|string
Récupérer la source et détecter son extension
teleporter_http_extension()  : string
Retrouve l'extension d'un fichier
teleporter_svn_dist()  : bool
Téléporter et déballer un composant SVN
teleporter_svn_read()  : array<string|int, mixed>|string
Lire source et révision d'un répertoire SVN et reconstruire la ligne de commande
teleporter_svn_tester()  : bool
Tester si la commande 'svn' est disponible

Constants

_GIT_COMMAND

public mixed _GIT_COMMAND = 'git'

_SVN_COMMAND

public mixed _SVN_COMMAND = 'svn'

_SVP_PAQUET_MAX_SIZE

public mixed _SVP_PAQUET_MAX_SIZE = 67108864

Functions

teleporter_git_dist()

Téléporter et déballer un composant GIT

teleporter_git_dist(string $methode, string $source, string $dest[, array<string|int, mixed> $options = [] ]) : bool

Déployer un repository GIT depuis une source et une révision données

Parameters
$methode : string

Méthode de téléportation : http|git|svn|...

$source : string

URL de la source GIT

$dest : string

Chemin du répertoire de destination

$options : array<string|int, mixed> = []

Tableau d'options. Index possibles :

  • revision => 'ae89'
  • branche => 'xxx'
Return values
bool —

True si l'opération réussie, false sinon.

teleporter_git_read()

Lire l'état GIT du repository

teleporter_git_read(string $dest[, array<string|int, mixed> $options = [] ]) : string|bool|array<string|int, mixed>

Retourne les informations GIT d'un répertoire donné

Parameters
$dest : string

Chemin du répertoire à tester

$options : array<string|int, mixed> = []

Tableau d'options

Return values
string|bool|array<string|int, mixed> —
  • Chaîne vide si pas un dépot GIT
  • False si erreur sur le dépot GIT
  • array sinon. Tableau avec 3 index : -- source : Source du dépot GIT à cette destination -- revision : Révision du dépot -- dest : Répertoire du dépot.

teleporter_git_exec()

Exécuter une commande GIT

teleporter_git_exec(string $dest, string $command) : mixed
Parameters
$dest : string

Répertoire de destination

$command : string

Commande à exécuter

teleporter_git_tester()

Tester si la commande 'git' est disponible

teleporter_git_tester() : bool
Return values
bool —

true si on peut utiliser la commande svn

teleporter_http_dist()

Téléporter et déballer un composant HTTP

teleporter_http_dist(string $methode, string $source, string $dest[, array<string|int, mixed> $options = [] ]) : bool|string
Parameters
$methode : string

Méthode de téléportation : http|git|svn|...

$source : string

URL de la source HTTP

$dest : string

Chemin du répertoire de destination

$options : array<string|int, mixed> = []

Tableau d'options. Doit au moins avoir l'index :

  • dir_tmp : Indique un répertoire temporaire pour stocker les fichiers. Par exemple défini avec : sous_repertoire(_DIR_CACHE, 'chargeur');
Tags
uses
teleporter_http_recuperer_source()
uses
teleporter_nettoyer_vieille_version()
Return values
bool|string —

Texte d'erreur si erreur, True si l'opération réussie.

teleporter_http_recuperer_source()

Récupérer la source et détecter son extension

teleporter_http_recuperer_source(string $source, string $dest_tmp) : array<string|int, mixed>|string
Parameters
$source : string

URL de la source HTTP

$dest_tmp : string

Répertoire de destination

Tags
uses
teleporter_http_extension()
used-by
teleporter_http_dist()
Return values
array<string|int, mixed>|string —
  • Texte d'erreur si une erreur survient,
  • Liste sinon (répertoire de destination temporaire, extension du fichier source)

teleporter_http_extension()

Retrouve l'extension d'un fichier

teleporter_http_extension(string $file) : string
Parameters
$file : string

Chemin du fichier

Tags
note

Retourne tgz pour un fichier .tar.gz

used-by
teleporter_http_recuperer_source()
Return values
string —

Extension du fichier, sinon vide

teleporter_svn_dist()

Téléporter et déballer un composant SVN

teleporter_svn_dist(string $methode, string $source, string $dest[, array<string|int, mixed> $options = [] ]) : bool

Déployer un repository SVN depuis une source et une révision données

Parameters
$methode : string

Méthode de téléportation : http|git|svn|...

$source : string

URL de la source SVN

$dest : string

Chemin du répertoire de destination

$options : array<string|int, mixed> = []

Tableau d'options. Index possibles :

  • revision => 'nnn'
  • literal => --ignore-externals
Tags
uses
teleporter_svn_read()
uses
teleporter_nettoyer_vieille_version()
Return values
bool —

True si l'opération réussie, false sinon.

teleporter_svn_read()

Lire source et révision d'un répertoire SVN et reconstruire la ligne de commande

teleporter_svn_read(string $dest[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|string
Parameters
$dest : string

Chemin du répertoire SVN

$options : array<string|int, mixed> = []

Options

Tags
used-by
teleporter_svn_dist()
Return values
array<string|int, mixed>|string —

Chaîne vide si pas SVN ou erreur de lecture, Tableau sinon avec les index :

  • source : URL de la source SVN
  • revision : numéro de la révision SVN
  • dest : Chemin du répertoire

teleporter_svn_tester()

Tester si la commande 'svn' est disponible

teleporter_svn_tester() : bool
Return values
bool —

true si on peut utiliser la commande svn


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results