Fichier ecrire/plugins/installer.php

Gestion de l'installation des plugins

Source

Proposer une amélioration

Liste des fonctions

Retourne la meta plugin désérialisée. Chaque élément du tableau est lui-même un tableau contenant les détails du plugin en question : répertoire et version.

array liste_plugin_actifs( )

Retour

  • array

    Tableau des plugins actifs

Package

Note

  • Si le contenu de la meta n’est pas un tableau, cette fonction transforme l’ancien format en tableau sérialisé pour être conforme au nouveau fonctionnement (SPIP >= 1.9.2)
Proposer une amélioration

Permet d'installer ou retirer un plugin en incluant les fichiers associés et en lançant les fonctions spécifiques.

  1. d'abord sur l'argument test,
  2. ensuite sur l'action demandée si le test repond false
  3. enfin sur l'argument test à nouveau.

L'index install_test du tableau résultat est un tableau formé :

  • du résultat 3
  • des echo de l'étape 2
array | boolean plugins_installer_dist( string $plug , string $action , string $dir_type = '_DIR_PLUGINS' )

Paramètres

  1. string $plug

    Nom du plugin

  2. string $action

    Nom de l'action (install|uninstall)

  3. string $dir_type = '_DIR_PLUGINS'

    Répertoire du plugin

Retour

  • array | boolean
    • False si le plugin n'a pas d'installation,
    • true si déjà installé,
    • le tableau de get_infos sinon

Package

Note

  • La fonction quitte (retourne false) si le plugin n'a pas de version d'installation définie (information version_base dans le paquet.xml)
Proposer une amélioration
void spip_plugin_install( $action , $infos , $version_cible )

Paramètres

  1. $action
  2. $infos
  3. $version_cible

Package

Proposer une amélioration

Cette fonction est identique (arguments et retours) a la fonction PHP version_compare() qu'elle appelle. Cependant, cette fonction reformate les numeros de versions pour ameliorer certains usages dans SPIP ou bugs dans PHP. On permet ainsi de comparer 3.0.4 à 3.0.* par exemple.

integer | boolean spip_version_compare( string $v1 , string $v2 , string $op = null )

Paramètres

  1. string $v1

    Numero de version servant de base a la comparaison. Ce numero ne peut pas comporter d'etoile.

  2. string $v2

    Numero de version a comparer. Il peut posseder des etoiles tel que 3.0.*

  3. string $op = null

    Un operateur eventuel (<, >, <=, >=, =, == ...)

Retour

  • integer | boolean

    Sans operateur : int. -1 pour inferieur, 0 pour egal, 1 pour superieur Avec operateur : bool.

Package

Proposer une amélioration

Liste des erreurs

GravitéLigneDescription
Erreur 118
  • No summary for function \spip_plugin_install()
  • Argument $version_cible is missing from the Docblock of spip_plugin_install
  • Argument $infos is missing from the Docblock of spip_plugin_install
  • Argument $action is missing from the Docblock of spip_plugin_install