SPIP Code

Documentation du code de SPIP et de ses plugins

SVP Typologie

svptype_type_plugin.php

Ce fichier contient l'API de gestion des types de plugin.

Table of Contents

Functions

type_plugin_lire()  : array<string|int, mixed>|string
Retourne la description complète du type de plugin ou partielle ou uniquement une information précise.
type_plugin_repertorier()  : array<string|int, mixed>
Renvoie l'information brute demandée pour l'ensemble des types de plugins d'une typologie donnée ou toute les descriptions si aucune information n'est explicitement demandée.
type_plugin_repertorier_affectation()  : array<string|int, mixed>
Renvoie les affectations (type de plugin, plugin) pour une typologie donnée.
type_plugin_repertorier_enfant()  : array<string|int, mixed>
Liste les types de plugin enfants d'un type d'une typologie donnée.
type_plugin_compter_enfant()  : int
Dénombre les types de plugin enfants d'un type d'une typologie donnée.
type_plugin_compter_affectation()  : int
Dénombre les affectations (type de plugin, plugin) d'un type d'une typologie.
type_plugin_elaborer_condition()  : string
Elabore la condition SQL pour lister les types de plugin.

Functions

type_plugin_lire()

Retourne la description complète du type de plugin ou partielle ou uniquement une information précise.

type_plugin_lire(string $typologie, int|string $type_plugin[, null|array<string|int, mixed>|string $informations = [] ]) : array<string|int, mixed>|string
Parameters
$typologie : string

Typologie concernée : categorie, tag... Ne sert que si le type est passé sous forme du champ identifiant qui n'est unique qu'au sein d'une même typologie.

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

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

Identifiant d'un champ ou de plusieurs champs de la description d'un type de plugin. Si l'argument est vide, la fonction renvoie la description complète.

Return values
array<string|int, mixed>|string —

La description brute complète ou partielle du type de plugin :

  • sous la forme d'une valeur simple si l'information demandée est unique (chaine)
  • sous la forme d'un tableau associatif indexé par le nom du champ sinon.

type_plugin_repertorier()

Renvoie l'information brute demandée pour l'ensemble des types de plugins d'une typologie donnée ou toute les descriptions si aucune information n'est explicitement demandée.

type_plugin_repertorier(string $typologie[, null|array<string|int, mixed> $filtres = [] ][, array<string|int, mixed>|string $informations = [] ]) : array<string|int, mixed>
Parameters
$typologie : string

Typologie concernée : categorie, tag...

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

Liste des couples (champ, valeur) ou tableau vide.

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

Identifiant d'un champ ou de plusieurs champs de la description d'un type de plugin. Si l'argument est vide, la fonction renvoie les descriptions complètes.

Return values
array<string|int, mixed> —

Description complète ou information précise pour chaque type de plugin de la typologie concernée.

type_plugin_repertorier_affectation()

Renvoie les affectations (type de plugin, plugin) pour une typologie donnée.

type_plugin_repertorier_affectation(string $typologie[, null|array<string|int, mixed> $filtres = [] ]) : array<string|int, mixed>
Parameters
$typologie : string

Typologie concernée : categorie, tag...

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

Liste des couples (champ, valeur) ou tableau vide. Pratiquement, les critères admis sont prefixe, id_mot et aussi type qui revient à filtrer sur un type de plugin comme id_mot. Il est possible aussi d'utiliser type_racine qui indique qu'on cherche toutes les affectations des types enfants du type racine.

Return values
array<string|int, mixed> —

Description de chaque affectation (type de plugin, plugin) de la typologie concernée.

type_plugin_repertorier_enfant()

Liste les types de plugin enfants d'un type d'une typologie donnée.

type_plugin_repertorier_enfant(string $typologie, int|string $type_plugin) : array<string|int, mixed>
Parameters
$typologie : string

Typologie concernée : categorie, tag...

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

Return values
array<string|int, mixed> —

Liste des enfants d'un type de plugin ou tableau vide si aucun.

type_plugin_compter_enfant()

Dénombre les types de plugin enfants d'un type d'une typologie donnée.

type_plugin_compter_enfant(string $typologie, int|string $type_plugin) : int
Parameters
$typologie : string

Typologie concernée : categorie, tag...

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

Return values
int —

Nombre d'enfants d'un type de plugin ou 0 si aucun.

type_plugin_compter_affectation()

Dénombre les affectations (type de plugin, plugin) d'un type d'une typologie.

type_plugin_compter_affectation(string $typologie, int|string $type_plugin) : int
Parameters
$typologie : string

Typologie concernée : categorie, tag...

$type_plugin : int|string

Identifiant d'un type de plugin correspondant soit à son id_mot soit au champ identifiant.

Return values
int —

Nombre d'affectations (type de plugin, plugin) d'un type de plugin ou 0 si aucun.

type_plugin_elaborer_condition()

Elabore la condition SQL pour lister les types de plugin.

type_plugin_elaborer_condition(string $typologie, string $type_plugin, string $vue) : string
Parameters
$typologie : string

Typologie concernée : categorie, tag...

$type_plugin : string

Identifiant d'un type de plugin correspondant au champ identifiant.

$vue : string

Vue pour laquelle la condition est calculée

Return values
string —

Condition SQL


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results