Documentation du code de SPIP et de ses plugins

Organiseur

Fonctions

Table of Contents

Functions

calendrier_categories()  : string
Retourne un nom de classe CSS représentant la catégorie de l'événement dans le calendrier
quete_calendrier_jour()  : array<string|int, mixed>
Pour une date donnée, retourne une période allant de la veille au lendemain
quete_calendrier_interval()  : array<string|int, mixed>
Retourne les publications et les messages pour une période donnée
quete_calendrier_interval_forums()  : mixed
Retourne la liste des messages de forum (format ICS) écrits dans une période donnée
quete_calendrier_interval_articles()  : mixed
Retourne la liste des articles (format ICS) publiés dans une période donnée
quete_calendrier_interval_rubriques()  : mixed
Retourne la liste des rubriques (format ICS) publiées dans une période donnée
quete_calendrier_interval_breves()  : mixed
Retourne la liste des brèves (format ICS) publiées dans une période donnée
quete_calendrier_interval_rv()  : array<string|int, mixed>
Retourne la liste des messages (format ICS) de l'auteur connecté, pour une période donnée
quete_calendrier_agenda()  : array<string|int, mixed>
Retourne la liste des rendez-vous de l'auteur connecté pour le mois indiqué

Functions

calendrier_categories()

Retourne un nom de classe CSS représentant la catégorie de l'événement dans le calendrier

calendrier_categories(string $table, int $num, string $objet) : string

S'appuie soit sur une fonction PHP generer_calendrier_class() si elle existe, soit à défaut sur le numéro de rubrique.

Parameters
$table : string

Nom de la table SQL d'où provient l'événement

$num : int

Identifiant dans la table

$objet : string

Nom de la clé primaire

Return values
string

Nom de classe CSS

quete_calendrier_jour()

Pour une date donnée, retourne une période allant de la veille au lendemain

quete_calendrier_jour(int $annee, int $mois, int $jour) : array<string|int, mixed>
Parameters
$annee : int
$mois : int
$jour : int
Return values
array<string|int, mixed>

Liste (date de la veille à 0h, date du lendemain à 23h59:59)

quete_calendrier_interval()

Retourne les publications et les messages pour une période donnée

quete_calendrier_interval(array<string|int, mixed> $limites) : array<string|int, mixed>

Retourne un tableau de 2 tableaux indéxés par des dates :

  • le premier indique les événements du jour, sans indication de durée (par exemple les publications d'articles)
  • le deuxième indique les événements commençant ce jour, avec indication de durée (par exemple les rendez-vous)
Parameters
$limites : array<string|int, mixed>

Liste (date de début, date de fin)

Tags
uses
quete_calendrier_interval_articles()
uses
quete_calendrier_interval_breves()
uses
quete_calendrier_interval_rubriques()
uses
quete_calendrier_interval_rv()
used-by
action_quete_calendrier_prive_dist()
Return values
array<string|int, mixed>

Liste (événements sans durée, événements avec durée)

quete_calendrier_interval_forums()

Retourne la liste des messages de forum (format ICS) écrits dans une période donnée

quete_calendrier_interval_forums(array<string|int, mixed> $limites, array<string|int, mixed> &$evenements) : mixed
Parameters
$limites : array<string|int, mixed>

Liste (date de début, date de fin)

$evenements : array<string|int, mixed>

Tableau des événements déjà présents qui sera complété par la fonction. Format : $evenements[$amj][] = Tableau de description ICS

quete_calendrier_interval_articles()

Retourne la liste des articles (format ICS) publiés dans une période donnée

quete_calendrier_interval_articles(string $avant, string $apres, array<string|int, mixed> &$evenements) : mixed
Parameters
$avant : string

Date de début

$apres : string

Date de fin

$evenements : array<string|int, mixed>

Tableau des événements déjà présents qui sera complété par la fonction. Format : $evenements[$amj][] = Tableau de description ICS

Tags
used-by
quete_calendrier_interval()

quete_calendrier_interval_rubriques()

Retourne la liste des rubriques (format ICS) publiées dans une période donnée

quete_calendrier_interval_rubriques(string $avant, string $apres, array<string|int, mixed> &$evenements) : mixed
Parameters
$avant : string

Date de début

$apres : string

Date de fin

$evenements : array<string|int, mixed>

Tableau des événements déjà présents qui sera complété par la fonction. Format : $evenements[$amj][] = Tableau de description ICS

Tags
used-by
quete_calendrier_interval()

quete_calendrier_interval_breves()

Retourne la liste des brèves (format ICS) publiées dans une période donnée

quete_calendrier_interval_breves(string $avant, string $apres, array<string|int, mixed> &$evenements) : mixed
Parameters
$avant : string

Date de début

$apres : string

Date de fin

$evenements : array<string|int, mixed>

Tableau des événements déjà présents qui sera complété par la fonction. Format : $evenements[$amj][] = Tableau de description ICS

Tags
used-by
quete_calendrier_interval()

quete_calendrier_interval_rv()

Retourne la liste des messages (format ICS) de l'auteur connecté, pour une période donnée

quete_calendrier_interval_rv(string $avant, string $apres) : array<string|int, mixed>
Parameters
$avant : string

Date de début

$apres : string

Date de fin

Tags
used-by
action_quete_calendrier_prive_dist()
used-by
quete_calendrier_interval()
Return values
array<string|int, mixed>

De la forme : $evt[date][id_message] = Tableau des données ICS

quete_calendrier_agenda()

Retourne la liste des rendez-vous de l'auteur connecté pour le mois indiqué

quete_calendrier_agenda(int $annee, int $mois) : array<string|int, mixed>
Parameters
$annee : int
$mois : int
Return values
array<string|int, mixed>

        
On this page

Search results