SPIP Code

Documentation du code de SPIP et de ses plugins

Brèves

API Documentation

Table of Contents

Functions

action_editer_breve_dist()  : array<string|int, mixed>
Action d'édition d'une brève dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée
breve_inserer()  : int
Insertion d'une brève dans une rubrique
breve_modifier()  : string|null
Modifier une brève en base
breve_instituer()  : string|null
Instituer une brève : modifier son statut ou son parent
breves_declarer_tables_interfaces()  : array<string|int, mixed>
Déclare les alias de boucle et traitements automatiques de certaines balises
breves_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclarer l'objet éditorial de brèves
breves_upgrade()  : mixed
Installation/maj des tables de brèves
breves_vider_tables()  : mixed
Désinstallation du plugin
breves_autoriser()  : mixed
Fonction du pipeline autoriser. N'a rien à faire
autoriser_breves_voir_dist()  : bool
Autorisation de voir la page breves
autoriser_breves_menu_dist()  : bool
Autoriser les brèves dans le menu de navigation
autoriser_brevecreer_menu_dist()  : bool
Autoriser la création de brèves dans le menu de navigation
autoriser_breve_creer_dist()  : bool
Autorisation de créer une brève
autoriser_rubrique_creerbrevedans_dist()  : bool
Autoriser à créer une brève dans la rubrique $id
autoriser_breve_modifier_dist()  : bool
Autoriser à modifier la brève $id
breves_ieconfig_metas()  : array<string|int, mixed>
Ajoute les metas sauvegardables de Brèves pour le plugin IEConfig
breves_configurer_liste_metas()  : array<string|int, mixed>
Définir les meta de configuration liées aux brèves
breves_rubrique_encours()  : array<string|int, mixed>
Ajouter les brèves à valider sur les rubriques
breves_affiche_enfants()  : array<string|int, mixed>
Ajouter les brèves référencées sur les vues de rubriques
breves_accueil_informations()  : string
Ajoute le nombre de brèves sur l'accueil privé
breves_objet_compte_enfants()  : array<string|int, mixed>
Compter les brèves dans une rubrique
breves_trig_calculer_langues_rubriques()  : array<string|int, mixed>
Changer la langue des brèves si la rubrique change
breves_calculer_rubriques()  : array<string|int, mixed>
Publier et dater les rubriques qui ont une brève publiée
breves_accueil_encours()  : string
Ajouter les brèves à valider sur la page d'accueil
breves_optimiser_base_disparus()  : array<string|int, mixed>
Optimiser la base de données en supprimant les liens de brèves orphelins
breves_boite_infos()  : array<string|int, mixed>
Afficher le nombre de brèves dans chaque rubrique
breves_affiche_milieu()  : array<string|int, mixed>
Ajoute le formulaire de configuration des brèves sur la page de configuration des contenus
formulaires_configurer_breves_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de configuration des brèves
formulaires_configurer_breves_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire de configuration des brèves
formulaires_editer_breve_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'édition d'une brève
formulaires_editer_breve_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne representent pas l'objet édité
breves_edit_config()  : array<string|int, mixed>
Choix par défaut des options de présentation
formulaires_editer_breve_verifier_dist()  : array<string|int, mixed>
Vérification du formulaire d'édition d'une brève
formulaires_editer_breve_traiter_dist()  : array<string|int, mixed>
Traitements du formulaire d'édition d'une brève

Functions

action_editer_breve_dist()

Action d'édition d'une brève dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée

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

Si aucun identifiant n'est donné, on crée alors une nouvelle brève.

Parameters
$arg : null|int = null

Identifiant de la brève. En absence utilise l'argument de l'action sécurisée.

Return values
array<string|int, mixed> —

Liste : identifiant de la brève, texte d'erreur éventuel

breve_inserer()

Insertion d'une brève dans une rubrique

breve_inserer(int $id_rubrique[, array<string|int, mixed>|null $set = null ]) : int
Parameters
$id_rubrique : int

Identifiant de la rubrique

$set : array<string|int, mixed>|null = null
Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
int —

Identifiant de la nouvelle brève.

breve_modifier()

Modifier une brève en base

breve_modifier(int $id_breve[, array<string|int, mixed>|null $set = null ]) : string|null
Parameters
$id_breve : int

Identifiant de la brève à modifier

$set : array<string|int, mixed>|null = null

Couples (colonne => valeur) de données à modifier. En leur absence, on cherche les données dans les champs éditables qui ont été postés (via _request())

Return values
string|null —

Chaîne vide si aucune erreur, Null si aucun champ à modifier, Chaîne contenant un texte d'erreur sinon.

breve_instituer()

Instituer une brève : modifier son statut ou son parent

breve_instituer(int $id_breve, array<string|int, mixed> $c) : string|null
Parameters
$id_breve : int

Identifiant de la brève

$c : array<string|int, mixed>

Couples (colonne => valeur) des données à instituer

Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
string|null —

Null si aucun champ à modifier, chaîne vide sinon.

breves_declarer_tables_interfaces()

Déclare les alias de boucle et traitements automatiques de certaines balises

breves_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>

Déclarations d'interface pour le compilateur

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed> —

Déclarations d'interface pour le compilateur

breves_declarer_tables_objets_sql()

Déclarer l'objet éditorial de brèves

breves_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>
Parameters
$tables : array<string|int, mixed>

Description des tables

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed> —

Description complétée des tables

breves_upgrade()

Installation/maj des tables de brèves

breves_upgrade(string $nom_meta_base_version, string $version_cible) : mixed

Crée les tables SQL du plugin (spip_breves)

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

breves_vider_tables()

Désinstallation du plugin

breves_vider_tables(string $nom_meta_base_version) : mixed

Supprime les tables SQL du plugin (spip_breves)

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

breves_autoriser()

Fonction du pipeline autoriser. N'a rien à faire

breves_autoriser() : mixed
Tags
pipeline

autoriser

autoriser_breves_voir_dist()

Autorisation de voir la page breves

autoriser_breves_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Toujours OK, si les brèves sont activées

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_breves_menu_dist()

Autoriser les brèves dans le menu de navigation

autoriser_breves_menu_dist(string $faire[, string $type = '' ][, int $id = 0 ][, array<string|int, mixed> $qui = null ][, array<string|int, mixed> $opt = null ]) : bool
Parameters
$faire : string

Action demandée

$type : string = ''

Type d'objet sur lequel appliquer l'action

$id : int = 0

Identifiant de l'objet

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

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed> = null

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_brevecreer_menu_dist()

Autoriser la création de brèves dans le menu de navigation

autoriser_brevecreer_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_breve_creer_dist()

Autorisation de créer une brève

autoriser_breve_creer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool

Il faut que les brèves soient activées qu'une rubrique existe

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_rubrique_creerbrevedans_dist()

Autoriser à créer une brève dans la rubrique $id

autoriser_rubrique_creerbrevedans_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

autoriser_breve_modifier_dist()

Autoriser à modifier la brève $id

autoriser_breve_modifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
  • admins & redac si la brève n'est pas publiée
  • admins de rubrique parente si publiée
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool —

true s'il a le droit, false sinon

breves_ieconfig_metas()

Ajoute les metas sauvegardables de Brèves pour le plugin IEConfig

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

Déclaration des sauvegardes

Tags
pipeline

ieconfig_metas

Return values
array<string|int, mixed> —

Déclaration des sauvegardes complétées

breves_configurer_liste_metas()

Définir les meta de configuration liées aux brèves

breves_configurer_liste_metas(array<string|int, mixed> $metas) : array<string|int, mixed>
Parameters
$metas : array<string|int, mixed>

Couples nom de la méta => valeur par défaut

Tags
pipeline

configurer_liste_metas

Return values
array<string|int, mixed> —

Couples nom de la méta => valeur par défaut

breves_rubrique_encours()

Ajouter les brèves à valider sur les rubriques

breves_rubrique_encours(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

rubrique_encours

Return values
array<string|int, mixed> —

Données du pipeline

breves_affiche_enfants()

Ajouter les brèves référencées sur les vues de rubriques

breves_affiche_enfants(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_enfants

Return values
array<string|int, mixed> —

Données du pipeline

breves_accueil_informations()

Ajoute le nombre de brèves sur l'accueil privé

breves_accueil_informations(string $texte) : string
Parameters
$texte : string

HTML des informations générales concernant chaque type d'objet sur la page d'accueil privée

Tags
pipeline

accueil_informations

Return values
string —

HTML des informations générales concernant chaque type d'objet sur la page d'accueil privée

breves_objet_compte_enfants()

Compter les brèves dans une rubrique

breves_objet_compte_enfants(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

objet_compte_enfants

Return values
array<string|int, mixed> —

Données du pipeline

breves_trig_calculer_langues_rubriques()

Changer la langue des brèves si la rubrique change

breves_trig_calculer_langues_rubriques(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

trig_calculer_langues_rubriques

Return values
array<string|int, mixed> —

Données du pipeline

breves_calculer_rubriques()

Publier et dater les rubriques qui ont une brève publiée

breves_calculer_rubriques(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

calculer_rubriques

Return values
array<string|int, mixed> —

Données du pipeline

breves_accueil_encours()

Ajouter les brèves à valider sur la page d'accueil

breves_accueil_encours(string $flux) : string
Parameters
$flux : string

HTML du bloc encours sur la page d'accueil privée

Tags
pipeline

accueil_encours

Return values
string —

HTML du bloc encours sur la page d'accueil privée

breves_optimiser_base_disparus()

Optimiser la base de données en supprimant les liens de brèves orphelins

breves_optimiser_base_disparus(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

optimiser_base_disparus

Return values
array<string|int, mixed> —

Données du pipeline

breves_boite_infos()

Afficher le nombre de brèves dans chaque rubrique

breves_boite_infos(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

boite_infos

Return values
array<string|int, mixed> —

Données du pipeline

breves_affiche_milieu()

Ajoute le formulaire de configuration des brèves sur la page de configuration des contenus

breves_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed> —

Données du pipeline

formulaires_configurer_breves_charger_dist()

Chargement du formulaire de configuration des brèves

formulaires_configurer_breves_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Environnement du formulaire

formulaires_configurer_breves_traiter_dist()

Traitement du formulaire de configuration des brèves

formulaires_configurer_breves_traiter_dist() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Retours du traitement

formulaires_editer_breve_charger_dist()

Chargement du formulaire d'édition d'une brève

formulaires_editer_breve_charger_dist([int|string $id_breve = 'new' ][, int $id_rubrique = 0 ][, string $retour = '' ][, int $lier_trad = 0 ][, string $config_fonc = 'breves_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_breve : int|string = 'new'

Identifiant de la brève. 'new' pour une nouvelle brève.

$id_rubrique : int = 0

Identifiant de la rubrique parente (si connue)

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

Identifiant de la brève que l'on cherche à traduire

$config_fonc : string = 'breves_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL de la brève, si connue

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
see
formulaires_editer_objet_charger()
Return values
array<string|int, mixed> —

Environnement du formulaire

formulaires_editer_breve_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne representent pas l'objet édité

formulaires_editer_breve_identifier_dist([int|string $id_breve = 'new' ][, int $id_rubrique = 0 ][, string $retour = '' ][, int $lier_trad = 0 ][, string $config_fonc = 'breves_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : string
Parameters
$id_breve : int|string = 'new'

Identifiant de la brève. 'new' pour une nouvelle brève.

$id_rubrique : int = 0

Identifiant de la rubrique parente (si connue)

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

Identifiant de la brève que l'on cherche à traduire

$config_fonc : string = 'breves_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL de la brève, si connue

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
string —

Hash du formulaire

breves_edit_config()

Choix par défaut des options de présentation

breves_edit_config(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed> 
Valeurs de la ligne SQL d'un mot, si connu

return array Configuration pour le formulaire

Return values
array<string|int, mixed>

formulaires_editer_breve_verifier_dist()

Vérification du formulaire d'édition d'une brève

formulaires_editer_breve_verifier_dist([int|string $id_breve = 'new' ][, int $id_rubrique = 0 ][, string $retour = '' ][, int $lier_trad = 0 ][, string $config_fonc = 'breves_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_breve : int|string = 'new'

Identifiant de la brève. 'new' pour une nouvelle brève.

$id_rubrique : int = 0

Identifiant de la rubrique parente (si connue)

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

Identifiant de la brève que l'on cherche à traduire

$config_fonc : string = 'breves_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL de la brève, si connue

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
see
formulaires_editer_objet_verifier()
Return values
array<string|int, mixed> —

Tableau des erreurs

formulaires_editer_breve_traiter_dist()

Traitements du formulaire d'édition d'une brève

formulaires_editer_breve_traiter_dist([int|string $id_breve = 'new' ][, int $id_rubrique = 0 ][, string $retour = '' ][, int $lier_trad = 0 ][, string $config_fonc = 'breves_edit_config' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>
Parameters
$id_breve : int|string = 'new'

Identifiant de la brève. 'new' pour une nouvelle brève.

$id_rubrique : int = 0

Identifiant de la rubrique parente (si connue)

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

Identifiant de la brève que l'on cherche à traduire

$config_fonc : string = 'breves_edit_config'

Nom de la fonction ajoutant des configurations particulières au formulaire

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

Valeurs de la ligne SQL de la brève, si connue

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
see
formulaires_editer_objet_traiter()
Return values
array<string|int, mixed> —

Tableau des erreurs


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results