SPIP Code

Documentation du code de SPIP et de ses plugins

Mashup Factory

Application

Table of Contents

Constants

_EXTRAIRE_IDIOME  = ',<:(?:([a-z0-9_]+):)?([a-z0-9_]*):/?>,iS'
Extrait les composants d'un idiome de langue utilisable dans un YAML '@<:(?:([a-z0-9_]+):)?([a-z0-9_]+):>@isS'.
_EXTRAIRE_MULTI  = '@<multi>(.*?)</multi>@sS'
Restaure cette constante à partir de SPIP 4.2.
_EZMASHUP_TARGET_SQL_DATE_FIELD_TYPES  = ['DATE']
_EZMASHUP_TARGET_SQL_DATETIME_FIELD_TYPES  = ['DATETIME', 'TIMESTAMP']
_EZMASHUP_TARGET_SQL_NUMERIC_FIELD_TYPES  = ['BIT', 'TINYINT', 'BOOL', 'BOOLEAN', 'SMALLINT', 'MEDIUMINT', 'INT', 'INTEGER', 'BIGINT', 'FLOAT', 'DOUBLE', 'DECIMAL', 'DEC']
_EZMASHUP_TARGET_SQL_TIME_FIELD_TYPES  = ['TIME']
_EZMASHUP_TARGET_SQL_YEAR_FIELD_TYPES  = ['YEAR']

Functions

action_peupler_feed_dist()  : array<string|int, mixed>
Cette action permet à l'utilisateur de reconstruire, de façon sécurisée, le dataset cible correspondant au feed.
action_recharger_feeds_dist()  : void
Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les feeds d'un plugin utilisateur donné à partir de leur fichier YAML.
action_supprimer_feed_dist()  : array<string|int, mixed>
Cette action permet à l'utilisateur de supprimer, de façon sécurisée, un feed éditable.
action_vider_feed_dist()  : array<string|int, mixed>
Cette action permet à l'utilisateur de vider, de façon sécurisée, le dataset cible correspondant au feed.
ezmashup_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
ezmashup_declarer_tables_principales()  : array<string|int, mixed>
Déclaration des nouvelles tables de la base de données propres au plugin.
ezmashup_cache_configurer()  : array<string|int, mixed>
Renvoie la configuration spécifique des caches gérés par Mashup Factory pour les datasets cible, le fichier config.yaml et les datasets source.
ezmashup_normaliser_idiome()  : string
Compile les traductions d'un idiome.
ezmashup_upgrade()  : void
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
ezmashup_vider_tables()  : void
Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.
ezmashup_autoriser()  : mixed
Fonction appelée par le pipeline.
autoriser_ezmashup_dist()  : bool
Autorisation minimale d'accès à toutes les pages du plugin Mashup Factory ou d'un plugin utilisateur.
autoriser_feeds_voir_dist()  : bool
Autorisation de voir la liste des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).
autoriser_feeds_charger_dist()  : bool
Autorisation de charger ou décharger les feeds d'un plugin utilisateur dans la table `spip_feeds`.
autoriser_feed_executer_dist()  : bool
Autorisation de peupler ou de vider le dataset cible d'un feed.
autoriser_feed_creer_dist()  : bool
Autorisation de créer des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).
autoriser_feed_modifier_dist()  : bool
Autorisation, pour les feeds éditables, de supprimer ou d'éditer un feed.
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.
formulaires_admin_feeds_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'administration des feeds.
formulaires_admin_feeds_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'administration des feeds.
record_remplir()  : array<string|int, mixed>
Remplit un enregistrement avec l'ensemble des types de champs configurés dans le feed.
record_initialiser()  : array<string|int, mixed>
Initialise le record d'un dataset cible avec des valeurs par défaut et remplit les champs statiques avec leur valeur finale.
record_normaliser_champs_sql()  : array<string|int, mixed>
Renvoie la description normalisée SQL de la table.

Constants

_EXTRAIRE_IDIOME

Extrait les composants d'un idiome de langue utilisable dans un YAML '@<:(?:([a-z0-9_]+):)?([a-z0-9_]+):>@isS'.

public mixed _EXTRAIRE_IDIOME = ',<:(?:([a-z0-9_]+):)?([a-z0-9_]*):/?>,iS'

_EXTRAIRE_MULTI

Restaure cette constante à partir de SPIP 4.2.

public mixed _EXTRAIRE_MULTI = '@<multi>(.*?)</multi>@sS'

_EZMASHUP_TARGET_SQL_DATE_FIELD_TYPES

public mixed _EZMASHUP_TARGET_SQL_DATE_FIELD_TYPES = ['DATE']

_EZMASHUP_TARGET_SQL_DATETIME_FIELD_TYPES

public mixed _EZMASHUP_TARGET_SQL_DATETIME_FIELD_TYPES = ['DATETIME', 'TIMESTAMP']

_EZMASHUP_TARGET_SQL_NUMERIC_FIELD_TYPES

public mixed _EZMASHUP_TARGET_SQL_NUMERIC_FIELD_TYPES = ['BIT', 'TINYINT', 'BOOL', 'BOOLEAN', 'SMALLINT', 'MEDIUMINT', 'INT', 'INTEGER', 'BIGINT', 'FLOAT', 'DOUBLE', 'DECIMAL', 'DEC']

_EZMASHUP_TARGET_SQL_TIME_FIELD_TYPES

public mixed _EZMASHUP_TARGET_SQL_TIME_FIELD_TYPES = ['TIME']

_EZMASHUP_TARGET_SQL_YEAR_FIELD_TYPES

public mixed _EZMASHUP_TARGET_SQL_YEAR_FIELD_TYPES = ['YEAR']

Functions

action_peupler_feed_dist()

Cette action permet à l'utilisateur de reconstruire, de façon sécurisée, le dataset cible correspondant au feed.

action_peupler_feed_dist([null|string $arguments = null ]) : array<string|int, mixed>

Cette action est réservée aux utilisateurs pouvant exécuter un feed. Elle nécessite l'id du feed et le préfixe du plugin utilisateur.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
feed_peupler()
throws
Exception
Return values
array<string|int, mixed> —

Tableau de retour contenant l'erreur éventuelle

action_recharger_feeds_dist()

Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les feeds d'un plugin utilisateur donné à partir de leur fichier YAML.

action_recharger_feeds_dist([null|string $arguments = null ]) : void

Cette action est réservée aux utilisateurs pouvant utiliser le plugin Mashup Factory. Elle nécessite le préfixe du plugin utilisateur comme seul argument.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
feed_charger()

action_supprimer_feed_dist()

Cette action permet à l'utilisateur de supprimer, de façon sécurisée, un feed éditable.

action_supprimer_feed_dist([null|string $arguments = null ]) : array<string|int, mixed>

Cela consiste à supprimer le dossier du feed et l'ensemble de ses ressources (config.yaml et fichiers sources éventuels).

Les données du feed sont au préalable vidées et le feed lui-même est déchargé de la base.

Cette action est réservée aux utilisateurs pouvant modifier un feed. Elle nécessite l'id du feed et le préfixe du plugin utilisateur.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
feed_supprimer()
throws
Exception
Return values
array<string|int, mixed> —

Tableau de retour contenant l'erreur éventuelle

action_vider_feed_dist()

Cette action permet à l'utilisateur de vider, de façon sécurisée, le dataset cible correspondant au feed.

action_vider_feed_dist([null|string $arguments = null ]) : array<string|int, mixed>

Cette action est réservée aux utilisateurs pouvant exécuter un feed. Elle nécessite l'id du feed et le préfixe du plugin utilisateur.

Parameters
$arguments : null|string = null

Arguments de l'action ou null si l'action est appelée par une URL

Tags
uses
feed_vider()
throws
Exception
Return values
array<string|int, mixed> —

Tableau de retour contenant l'erreur éventuelle

ezmashup_declarer_tables_interfaces()

Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.

ezmashup_declarer_tables_interfaces(array<string|int, mixed> $interface) : array<string|int, mixed>

Le plugin se contente de déclarer les alias des tables et quelques traitements.

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

Tableau global des informations tierces sur les tables de la base de données

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed> —

Tableau fourni en entrée et mis à jour avec les nouvelles informations

ezmashup_declarer_tables_principales()

Déclaration des nouvelles tables de la base de données propres au plugin.

ezmashup_declarer_tables_principales(array<string|int, mixed> $tables_principales) : array<string|int, mixed>

Le plugin déclare une nouvelle table :

  • spip_feeds, qui contient les éléments descriptifs des feeds du mashup.
Parameters
$tables_principales : array<string|int, mixed>

Tableau global décrivant la structure des tables de la base de données

Tags
pipeline

declarer_tables_principales

Return values
array<string|int, mixed> —

Tableau fourni en entrée et mis à jour avec les nouvelles déclarations

ezmashup_cache_configurer()

Renvoie la configuration spécifique des caches gérés par Mashup Factory pour les datasets cible, le fichier config.yaml et les datasets source.

ezmashup_cache_configurer(string $plugin) : array<string|int, mixed>
Parameters
$plugin : string

Préfixe du plugin utilisateur..

Return values
array<string|int, mixed> —

Tableau de la configuration brute du plugin Taxonomie.

ezmashup_normaliser_idiome()

Compile les traductions d'un idiome.

ezmashup_normaliser_idiome(string $plugin, string $idiome) : string
Parameters
$plugin : string

Préfixe du plugin utilisateur.

$idiome : string

Idiome ou texte brut

Return values
string —

Les traductions de l'idiome en multi ou le texte fourni en entrée si celui-ci n'est pas un idiome

ezmashup_upgrade()

Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.

ezmashup_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le schéma comprend des tables et des variables de configuration.

Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

$version_cible : string

Version du schéma de données en fin d'upgrade

ezmashup_vider_tables()

Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.

ezmashup_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

autoriser_ezmashup_dist()

Autorisation minimale d'accès à toutes les pages du plugin Mashup Factory ou d'un plugin utilisateur.

autoriser_ezmashup_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • fournir un préfixe valide de plugin actif.
  • éventuellement, avoir une autorisation d'accès spécifique (service propre au plugin) Par défaut, en l'absence de personnalisation par un plugin, Mashup Factory limite l'autorisation aux administrateurs complets.

Cette autorisation est à la base des autres autorisations du plugin. Il n'est jamais utile de l'appeler dans une fonction autre que les autorisations dérivées.

Parameters
$faire : string

L'action : ezmashup

$type : string

Le type d'objet ou nom de table : chaine vide

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_feeds_voir_dist()

Autorisation de voir la liste des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).

autoriser_feeds_voir_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • posséder l'autorisation minimale ezmashup
  • éventuellement, avoir une autorisation de visualisation des feeds spécifique (service propre au plugin).
Parameters
$faire : string

L'action : voir

$type : string

Le type d'objet ou nom de table : _feeds (ce n'est pas un objet au sens SPIP)

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_feeds_charger_dist()

Autorisation de charger ou décharger les feeds d'un plugin utilisateur dans la table `spip_feeds`.

autoriser_feeds_charger_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • posséder l'autorisation minimale ezmashup.
  • éventuellement, avoir une autorisation de chargement spécifique (service propre au plugin)
Parameters
$faire : string

Action demandée : charger

$type : string

Le type d'objet ou nom de table : _feeds (ce n'est pas un objet au sens SPIP)

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin, préfixe du plugin utilisateur

Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_feed_executer_dist()

Autorisation de peupler ou de vider le dataset cible d'un feed.

autoriser_feed_executer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • posséder l'autorisation minimale ezmashup
  • fournir un identifiant de feed existant
  • que le feed soit actif
  • et éventuellement, avoir une autorisation d'exécution spécifique (service propre au plugin)
Parameters
$faire : string

Action demandée : executer (pour peupler, vider)

$type : string

Type d'objet sur lequel appliquer l'action : feed

$id : int

Identifiant de l'objet : celui du feed sur lequel appliquer l'action

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_feed_creer_dist()

Autorisation de créer des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).

autoriser_feed_creer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • posséder l'autorisation minimale ezmashup.
  • éventuellement, avoir une autorisation de création spécifique (service propre au plugin)

Par défaut, Mashup Factory renvoie false pour cette autorisation.

Parameters
$faire : string

L'action : creer

$type : string

Le type d'objet ou nom de table : feed (ce n'est pas un objet au sens SPIP)

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_feed_modifier_dist()

Autorisation, pour les feeds éditables, de supprimer ou d'éditer un feed.

autoriser_feed_modifier_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • posséder l'autorisation minimale ezmashup
  • fournir un identifiant de feed existant
  • que le feed soit actif et éditable
  • et éventuellement, avoir une autorisation de modification spécifique (service propre au plugin)

Par défaut, Mashup Factory renvoie false pour cette autorisation.

Parameters
$faire : string

Action demandée : modifier (pour éditer ou supprimer)

$type : string

Type d'objet sur lequel appliquer l'action : feed

$id : int

Identifiant de l'objet : celui du feed sur lequel appliquer l'action

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

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

formulaires_admin_feeds_charger_dist()

Chargement du formulaire d'administration des feeds.

formulaires_admin_feeds_charger_dist(string $plugin[, null|string $id_categorie = '' ][, null|string $id_feed_affiche = '' ][, null|string $module = '' ][, null|string $page_admin = '' ]) : array<string|int, mixed>

Il est obligatoire de fournir un préfixe de plugin utilisateur sinon le formulaire n'est pas utilisable.

Parameters
$plugin : string

Préfixe du plugin utilisateur

$id_categorie : null|string = ''

Identifiant de la catégorie ou vide si on veut afficher tous les feeds

$id_feed_affiche : null|string = ''

Identificant du feed servant à l'affichage du bloc de détails

$module : null|string = ''

Identificant du module dans lequel piocher les items de langue (ezmashup par défaut)

$page_admin : null|string = ''

URL de la page d'admin dans laquelle le présent formulaire est inclus

Return values
array<string|int, mixed> —

Environnement du formulaire

formulaires_admin_feeds_traiter_dist()

Traitement du formulaire d'administration des feeds.

formulaires_admin_feeds_traiter_dist(string $plugin[, null|string $id_categorie = '' ][, null|string $id_feed_affiche = '' ][, null|string $module = '' ][, null|string $page_admin = '' ]) : array<string|int, mixed>

Soit l'action demandée est lancée immédiatement (peupler, vider, supprimer), soit l'action (creer) renvoie vers une page dans laquelle elle sera réellement traitée.

Parameters
$plugin : string

Préfixe du plugin utilisateur

$id_categorie : null|string = ''

Identifiant de la catégorie ou vide si on veut afficher tous les feeds

$id_feed_affiche : null|string = ''

Identificant du feed servant à l'affichage du bloc de détails

$module : null|string = ''

Identificant du module dans lequel piocher les items de langue (ezmashup par défaut)

$page_admin : null|string = ''

URL de la page d'admin dans laquelle le présent formulaire est inclus

Return values
array<string|int, mixed> —

Retour du traitement : rien de spécial car pour l'instant, il n'est pas utilisé

record_remplir()

Remplit un enregistrement avec l'ensemble des types de champs configurés dans le feed.

record_remplir(array<string|int, mixed> $item_source, array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : array<string|int, mixed>
Parameters
$item_source : array<string|int, mixed>

Description d'un item de la source dont certains champs seront insérés dans l'enregistrement cible

$feed : array<string|int, mixed>

Description complète du feed.

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

Tableau constitutif d'une erreur ou vide si aucune erreur à remonter

Return values
array<string|int, mixed> —

Enregistrement de la cible mis à jour ou vide si erreur.

record_initialiser()

Initialise le record d'un dataset cible avec des valeurs par défaut et remplit les champs statiques avec leur valeur finale.

record_initialiser(array<string|int, mixed> $feed[, null|array<string|int, mixed> &$erreur = [] ]) : array<string|int, mixed>
Parameters
$feed : array<string|int, mixed>

Description complète du feed.

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

Tableau constitutif d'une erreur ou vide si aucune erreur à remonter

Return values
array<string|int, mixed> —

Enregistrement par défaut de la cible initialisé ou vide si erreur.

record_normaliser_champs_sql()

Renvoie la description normalisée SQL de la table.

record_normaliser_champs_sql(string $table) : array<string|int, mixed>
Parameters
$table : string

Nom de la table SQL sans le préfixe spip_.

Return values
array<string|int, mixed> —

Description de la table SQL normalisée.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results