SPIP Code

Documentation du code de SPIP et de ses plugins

Mashup Factory

ezmashup_fonctions.php

Ce fichier contient les fonction d'API concernant les catégories et les actions ainsi que les balises du plugin.

Table of Contents

Functions

balise_FEED_CATEGORIES_dist()  : Champ
Compile la balise `#FEED_CATEGORIES` qui fournit la configuration d'une ou des catégories affectées aux différents feeds, pour un plugin utilisateur donné.
feed_categorie_repertorier()  : array<string|int, mixed>|string
Renvoie tout ou partie de la liste des catégories de feed et de leur description.
feed_source_lister()  : string
Construit la liste des types de source du feed pour un affichage.
feed_tag_lister()  : string
Construit la liste des tags non techniques du feed pour un affichage.
balise_FEED_URL_ACTION_dist()  : Champ
Compile la balise `#FEED_URL_ACTION` qui fournit l'url de la page de création ou d'édition d'un feed éditable.
feed_action_definir_url()  : string
Fournit l'url de la page de création ou d'édition d'un feed éditable.
balise_FEED_ACTIONS_dist()  : Champ
Compile la balise `#FEED_ACTIONS` qui fournit, pour un plugin utilisateur, la configuration de liste des actions possibles sur les feeds éventuellement filtrée sur un ou plusieurs critères.
feed_action_repertorier()  : array<string|int, mixed>|string
Renvoie tout ou partie de la liste des actions sur les feeds et de leur configuration.
feed_action_liste_autorisee()  : bool
Vérifie si une liste d'actions sur les feeds possède au moins une action autorisée.
balise_EZMASHUP_PLUGINS_dist()  : Champ
Compile la balise `#EZMASHUP_PLUGINS` qui fournit les plugins utilisateur actifs implémentant des feeds.
ezmashup_lister_plugins()  : array<string|int, mixed>
Renvoie la liste des préfixes des plugins actifs ou de tous les plugins utilisant Mashup Factory.

Functions

balise_FEED_CATEGORIES_dist()

Compile la balise `#FEED_CATEGORIES` qui fournit la configuration d'une ou des catégories affectées aux différents feeds, pour un plugin utilisateur donné.

balise_FEED_CATEGORIES_dist(Champ $p) : Champ

La signature de la balise est : #FEED_CATEGORIES{plugin[, id_categorie, information]}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#FEED_CATEGORIES{isocode}, renvoie la description complète des catégories des feeds du plugin `isocode`.
#FEED_CATEGORIES{isocode, map}, renvoie la description de la catégorie `map` des feeds du plugin `isocode`.
#FEED_CATEGORIES{isocode, map, name}, renvoie le nom de la catégorie `map` des feeds du plugin `isocode`.
Return values
Champ —

Pile complétée par le code à générer.

feed_categorie_repertorier()

Renvoie tout ou partie de la liste des catégories de feed et de leur description.

feed_categorie_repertorier(string $plugin[, null|string $id_categorie = '' ][, null|string $information = '' ]) : array<string|int, mixed>|string

Il est possible de demander toutes les catégories ou juste une seule désignée par son identifiant voire une seule information sur une catégorie donnée.

Parameters
$plugin : string

Préfixe du plugin utilisateur.

$id_categorie : null|string = ''

Identifiant de la catégorie ou chaine vide pour toutes les catégories.

$information : null|string = ''

Information de la description d'une catégorie (name, description, icon).

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

Liste des descriptions de catégorie, une description d'une seule catégorie voire une information.

feed_source_lister()

Construit la liste des types de source du feed pour un affichage.

feed_source_lister(array<string|int, mixed> $sources[, null|string $separateur = ',' ]) : string
Parameters
$sources : array<string|int, mixed>

Tableau des sources du feed

$separateur : null|string = ','

Séparateur des tags dans la liste affichée (par défaut une virgule)

Return values
string —

Liste des types de source au format chaine

feed_tag_lister()

Construit la liste des tags non techniques du feed pour un affichage.

feed_tag_lister(array<string|int, mixed> $tags[, null|string $separateur = ',' ]) : string

Les tags techniques commencent par un _.

Parameters
$tags : array<string|int, mixed>

Tableau des tags du feed

$separateur : null|string = ','

Séparateur des tags dans la liste affichée (par défaut une virgule)

Return values
string —

Liste des tags non techniques au format chaine

balise_FEED_URL_ACTION_dist()

Compile la balise `#FEED_URL_ACTION` qui fournit l'url de la page de création ou d'édition d'un feed éditable.

balise_FEED_URL_ACTION_dist(Champ $p) : Champ

La signature de la balise est : #FEED_URL_ACTION{plugin, action[, id_feed, page_admin]}.

Parameters
$p : Champ

Pile au niveau de la balise

Tags
balise
example 
#FEED_URL_ACTION{isocode, creer}.
#FEED_URL_ACTION{isocode, editer, id_du_feed, page_admin}.
Return values
Champ —

Pile complétée par le code à générer.

feed_action_definir_url()

Fournit l'url de la page de création ou d'édition d'un feed éditable.

feed_action_definir_url(string $plugin, string $action[, null|string $id_feed = '' ][, null|string $page_admin = '' ]) : string
Parameters
$plugin : string

Préfixe du plugin utilisateur.

$action : string

Action de création (creer) ou d'édition (editer) du feed.

$id_feed : null|string = ''

Identifiant du feed, uniquement pour l'édition.

$page_admin : null|string = ''

URL de la page d'admin d'où provient l'action.

Tags
uses
feed_lire()
uses
ezmashup_feed_action_definir_url()
uses
ezmashup_log_creer_message()
Return values
string —

URL de la page de traitement correspondant à l'action ou vide si erreur. Les erreurs sont tracées mais pas retournées.

balise_FEED_ACTIONS_dist()

Compile la balise `#FEED_ACTIONS` qui fournit, pour un plugin utilisateur, la configuration de liste des actions possibles sur les feeds éventuellement filtrée sur un ou plusieurs critères.

balise_FEED_ACTIONS_dist(Champ $p) : Champ

La signature de la balise est : #FEED_ACTIONS{plugin[, filtres]}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#FEED_ACTIONS{isocode}, renvoie la description complète des actions possibles.
Return values
Champ —

Pile complétée par le code à générer.

feed_action_repertorier()

Renvoie tout ou partie de la liste des actions sur les feeds et de leur configuration.

feed_action_repertorier(string $plugin[, null|array<string|int, mixed> $filtres = [] ]) : array<string|int, mixed>|string

Il est possible de filtrer les actions suivant un ou plusieurs critères.

Parameters
$plugin : string

Préfixe du plugin utilisateur.

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

Filtres éventuels sur un ou plusieurs champs d'une action. Seule l'égalité est gérée.

Tags
uses
ezmashup_feed_action_lister()
Return values
array<string|int, mixed>|string —

Liste des configurations d'actions éventuellement filtrée.

feed_action_liste_autorisee()

Vérifie si une liste d'actions sur les feeds possède au moins une action autorisée.

feed_action_liste_autorisee(string $plugin, string $id_feed, array<string|int, mixed> $actions) : bool
Parameters
$plugin : string

Préfixe du plugin utilisateur.

$id_feed : string

Identifiant du feed, uniquement pour l'édition

$actions : array<string|int, mixed>

Liste des actions pour lesquelles vérifier l'autorisation.

Return values
bool —

true si au moins une action est autorisée, false sinon

balise_EZMASHUP_PLUGINS_dist()

Compile la balise `#EZMASHUP_PLUGINS` qui fournit les plugins utilisateur actifs implémentant des feeds.

balise_EZMASHUP_PLUGINS_dist(Champ $p) : Champ

La signature de la balise est : #EZMASHUP_PLUGINS{[actifs_seuls]}.

Parameters
$p : Champ

Pile au niveau de la balise.

Tags
balise
example 
#EZMASHUP_PLUGINS, renvoie la liste des préfixes de plugins actifs utilisant Mashup Factory.
#EZMASHUP_PLUGINS{oui}, renvoie la liste des préfixes de plugins actifs utilisant Mashup Factory.
#EZMASHUP_PLUGINS{non}, renvoie la liste des préfixes de tous plugins utilisant Mashup Factory.
Return values
Champ —

Pile complétée par le code à générer.

ezmashup_lister_plugins()

Renvoie la liste des préfixes des plugins actifs ou de tous les plugins utilisant Mashup Factory.

ezmashup_lister_plugins([string $actifs_seuls = 'oui' ]) : array<string|int, mixed>

L'utilisation du plugin Mashup Factory est repérée via les consignations dans la table spip_meta.

Parameters
$actifs_seuls : string = 'oui'

Indique de renvoyer seulement les plugins actifs (oui) ou tous les plugins

Return values
array<string|int, mixed> —

Liste des préfixes en minuscules


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results