filtres_ecrire.php
Fonctions utilisées au calcul des squelette du privé.
Table of Contents
Constants
- AUTEURS_MIN_REDAC = '0minirezo,1comite,5poubelle'
Functions
- parametres_css_prive() : string
- Retourne les paramètres de personnalisation css de l'espace privé
- chercher_rubrique() : string
- Afficher le sélecteur de rubrique
- avoir_visiteurs() : bool
- Tester si le site peut avoir des visiteurs
- statuts_articles_visibles() : array<string|int, mixed>
- Lister les status d'article visibles dans l'espace prive en fonction du statut de l'auteur
- traduire_statut_auteur() : string
- Traduire le statut technique de l'auteur en langage compréhensible
- afficher_qui_edite() : string
- Afficher la mention des autres auteurs ayant modifié un objet
- auteurs_lister_statuts() : array<string|int, mixed>
- Lister les statuts des auteurs
- trouver_rubrique_creer_objet() : int
- Déterminer la rubrique pour la création d'un objet heuristique
- lien_article_virtuel() : string
- Afficher le lien de redirection d'un article virtuel si il y a lieu (rien si l'article n'est pas redirige)
- bouton_spip_rss() : string
- Filtre pour générer un lien vers un flux RSS privé
- alertes_auteur() : string
- Vérifier la présence d'alertes pour les auteur
- filtre_afficher_enfant_rub_dist() : string
- Filtre pour afficher les rubriques enfants d'une rubrique
- afficher_plus_info() : string
- Afficher un petit "i" pour lien vers autre page
- lister_objets_lies() : array<string|int, mixed>
- Lister les id objet_source associés à l'objet id_objet via la table de lien objet_lien
Constants
AUTEURS_MIN_REDAC
public
mixed
AUTEURS_MIN_REDAC
= '0minirezo,1comite,5poubelle'
Functions
parametres_css_prive()
Retourne les paramètres de personnalisation css de l'espace privé
parametres_css_prive() : string
Ces paramètres sont (ltr et couleurs) ce qui permet une écriture comme : generer_url_public('style_prive', parametres_css_prive()) qu'il est alors possible de récuperer dans le squelette style_prive.html avec
#SET{claire,##ENV{couleur_claire,edf3fe}} #SET{foncee,##ENV{couleur_foncee,3874b0}} #SET{left,#ENV{ltr}|choixsiegal{left,left,right}} #SET{right,#ENV{ltr}|choixsiegal{left,right,left}}
Return values
stringchercher_rubrique()
Afficher le sélecteur de rubrique
chercher_rubrique(string $titre, int $id_objet, int $id_parent, string $objet, int $id_secteur, bool $restreint[, bool $actionable = false ][, bool $retour_sans_cadre = false ]) : string
Il permet de placer un objet dans la hiérarchie des rubriques de SPIP
Parameters
- $titre : string
- $id_objet : int
- $id_parent : int
- $objet : string
- $id_secteur : int
- $restreint : bool
- $actionable : bool = false
-
true : fournit le selecteur dans un form directement postable
- $retour_sans_cadre : bool = false
Tags
Return values
stringavoir_visiteurs()
Tester si le site peut avoir des visiteurs
avoir_visiteurs([bool $past = false ][, bool $accepter = true ]) : bool
Parameters
- $past : bool = false
-
si true, prendre en compte le fait que le site a deja des visiteurs comme le droit d'en avoir de nouveaux
- $accepter : bool = true
Return values
boolstatuts_articles_visibles()
Lister les status d'article visibles dans l'espace prive en fonction du statut de l'auteur
statuts_articles_visibles(string $statut_auteur) : array<string|int, mixed>
Pour l'extensibilie de SPIP, on se repose sur autoriser('voir','article') en testant un à un les status présents en base
On mémorise en static pour éviter de refaire plusieurs fois.
Parameters
- $statut_auteur : string
Return values
array<string|int, mixed>traduire_statut_auteur()
Traduire le statut technique de l'auteur en langage compréhensible
traduire_statut_auteur(string $statut[, string $attente = '' ]) : string
Si $statut=='nouveau' et que le statut en attente est fourni, le prendre en compte en affichant que l'auteur est en attente
Parameters
- $statut : string
- $attente : string = ''
Return values
stringafficher_qui_edite()
Afficher la mention des autres auteurs ayant modifié un objet
afficher_qui_edite(int $id_objet, string $objet) : string
Parameters
- $id_objet : int
- $objet : string
Return values
stringauteurs_lister_statuts()
Lister les statuts des auteurs
auteurs_lister_statuts([string $quoi = 'tous' ][, bool $en_base = true ]) : array<string|int, mixed>
Parameters
- $quoi : string = 'tous'
-
- redacteurs : retourne les statuts des auteurs au moins redacteur, tels que defini par AUTEURS_MIN_REDAC
- visiteurs : retourne les statuts des autres auteurs, cad les visiteurs et autres statuts perso
- tous : retourne tous les statuts connus
- $en_base : bool = true
-
si true, ne retourne strictement que les status existants en base dans tous les cas, les statuts existants en base sont inclus
Return values
array<string|int, mixed>trouver_rubrique_creer_objet()
Déterminer la rubrique pour la création d'un objet heuristique
trouver_rubrique_creer_objet(int $id_rubrique, string $objet) : int
Rubrique courante si possible,
- sinon rubrique administrée pour les admin restreint
- sinon première rubrique de premier niveau autorisée que l'on trouve
Parameters
- $id_rubrique : int
-
Identifiant de rubrique (si connu)
- $objet : string
-
Objet en cours de création
Return values
int —Identifiant de la rubrique dans laquelle créer l'objet
lien_article_virtuel()
Afficher le lien de redirection d'un article virtuel si il y a lieu (rien si l'article n'est pas redirige)
lien_article_virtuel(string $virtuel) : string
Parameters
- $virtuel : string
Return values
stringbouton_spip_rss()
Filtre pour générer un lien vers un flux RSS privé
bouton_spip_rss(string $op[, array<string|int, mixed> $args = [] ][, string $lang = '' ][, string $title = 'RSS' ]) : string
Le RSS est protegé par un hash de faible sécurité
Parameters
- $op : string
- $args : array<string|int, mixed> = []
- $lang : string = ''
- $title : string = 'RSS'
Tags
Return values
string —Code HTML du lien
alertes_auteur()
Vérifier la présence d'alertes pour les auteur
alertes_auteur(int $id_auteur) : string
Parameters
- $id_auteur : int
Return values
stringfiltre_afficher_enfant_rub_dist()
Filtre pour afficher les rubriques enfants d'une rubrique
filtre_afficher_enfant_rub_dist(int $id_rubrique) : string
Parameters
- $id_rubrique : int
Return values
stringafficher_plus_info()
Afficher un petit "i" pour lien vers autre page
afficher_plus_info(string $lien[, string $titre = '+' ][, string $titre_lien = '' ]) : string
Parameters
- $lien : string
-
URL du lien desire
- $titre : string = '+'
-
Titre au survol de l'icone pointant le lien
- $titre_lien : string = ''
-
Si present, ajoutera en plus apres l'icone un lien simple, vers la meme URL, avec le titre indique
Return values
stringlister_objets_lies()
Lister les id objet_source associés à l'objet id_objet via la table de lien objet_lien
lister_objets_lies(string $objet_source, string $objet, int $id_objet, string $objet_lien) : array<string|int, mixed>
Utilisé pour les listes de #FORMULAIRE_EDITER_LIENS
Parameters
- $objet_source : string
- $objet : string
- $id_objet : int
- $objet_lien : string