Documentation du code de SPIP et de ses plugins

Organiseur

Application

Table of Contents

Constants

_EMAIL_GENERAL  = 'general'

Functions

action_effacer_messagerecu_dist()  : void
action_envoyer_message_dist()  : void
action_quete_autocomplete_dist()  : mixed
action_supprimer_message_dist()  : void
organiseur_declarer_tables_objets_sql()  : array<string|int, mixed>
Declaration des champs complementaires sur la table auteurs, pour les clients
organiseur_declarer_tables_interfaces()  : array<string|int, mixed>
Interfaces des tables agenda et messagerie
todate()  : mixed
formulaires_configurer_messagerie_agenda_charger_dist()  : mixed
formulaires_configurer_messagerie_agenda_traiter_dist()  : mixed
formulaires_editer_message_charger_dist()  : mixed
formulaires_editer_message_verifier_dist()  : mixed
formulaires_editer_message_traiter_dist()  : mixed
verifier_corriger_date_saisie()  : int
Recuperer les champs date_xx et heure_xx, verifier leur coherence et les reformater
messagerie_statuts_destinataires_possibles()  : array<string|int, mixed>
Lister les statuts des auteurs pouvant recevoir un message c'est tous les auteurs au moins redacteur
messagerie_nettoyer_destinataires()  : array<string|int, mixed>
Nettoyer une liste de destinataires
messagerie_verifier_destinataires()  : array<string|int, mixed>
Fonction generique de verification des destinataires lors de l'envoi d'un message ou de recommander un destinataire peut etre un id_auteur numerique ou une adresse mail valide, si l'options accepter_email est true
messagerie_destiner()  : array<string|int, mixed>
Selectionner les destinataires en distinguant emails et id_auteur
messagerie_diffuser_message()  : bool|int
Diffuser un message par la messagerie interne
messagerie_mailer_message()  : bool
Envoyer un message par mail pour les destinataires externes
messagerie_marquer_message()  : void
Marquer un message dans l'etat indique par $vu
messagerie_marquer_lus()  : mixed
Marquer un message comme lu
messagerie_marquer_non_lus()  : mixed
Marquer un message comme non lu
messagerie_effacer_message_recu()  : mixed
Effacer un message recu
notifications_instituermessage_dist()  : mixed
Envoyer les notifications consecutives a l'envoi d'un message (ie passage en statut=publie)
organiseur_upgrade()  : mixed
Installation/maj des tables messagerie
organiseur_vider_tables()  : mixed
Desinstallation/suppression des tables mots et groupes de mots
organiseur_autoriser()  : void
Fonction vide pour charger ce fichier sans declencher de warning
autoriser_calendrier_voir_dist()  : bool
Autorisation de voir la page calendrier
autoriser_messages_voir_dist()  : bool
Autorisation de voir la page messages
autoriser_calendrier_menu_dist()  : mixed
autoriser_messagerie_menu_dist()  : mixed
autoriser_message_modifier_dist()  : mixed
autoriser_message_instituer_dist()  : mixed
autoriser_message_supprimer_dist()  : mixed
autoriser_messagerecu_effacer_dist()  : mixed
autoriser_message_dater_dist()  : mixed
autoriser_envoyermessage_dist()  : mixed
autoriser_message_voir_dist()  : mixed
autoriser_message_repondre_dist()  : mixed
critere_MESSAGES_destinataire_dist()  : mixed
critere_MESSAGES_non_lu_dist()  : mixed
organiseur_calculer_date_reference()  : string
Fonction privee pour mutualiser de code des criteres_MESSAGES_rv_* Retourne le code php pour obtenir la date de reference de comparaison des evenements a trouver
critere_MESSAGES_rv_a_venir_dist()  : mixed
{rv_a_venir} {rv_a_venir #ENV{date}}
critere_MESSAGES_rv_passe_dist()  : mixed
{rv_passe} {rv_passe #ENV{date}}
critere_MESSAGES_rv_en_cours_dist()  : mixed
{rv_en_cours} {rv_en_cours #ENV{date}}
organiseur_icone_message()  : mixed
organiseur_texte_modifier_message()  : mixed
organiseur_texte_nouveau_message()  : mixed

Constants

Functions

action_effacer_messagerecu_dist()

action_effacer_messagerecu_dist([int $id_auteur = null ][, int $id_message = null ]) : void
Parameters
$id_auteur : int = null
$id_message : int = null

action_envoyer_message_dist()

action_envoyer_message_dist([int $id_message = null ]) : void
Parameters
$id_message : int = null

action_supprimer_message_dist()

action_supprimer_message_dist([int $id_message = null ]) : void
Parameters
$id_message : int = null

organiseur_declarer_tables_objets_sql()

Declaration des champs complementaires sur la table auteurs, pour les clients

organiseur_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>
Parameters
$tables : array<string|int, mixed>
Return values
array<string|int, mixed>

organiseur_declarer_tables_interfaces()

Interfaces des tables agenda et messagerie

organiseur_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_editer_message_charger_dist()

formulaires_editer_message_charger_dist([mixed $id_message = 'new' ][, mixed $type = 'message' ][, mixed $retour = '' ][, mixed $accepter_email = 'oui' ][, mixed $destinataires = '' ][, mixed $titre = '' ][, mixed $texte = '' ]) : mixed
Parameters
$id_message : mixed = 'new'
$type : mixed = 'message'
$retour : mixed = ''
$accepter_email : mixed = 'oui'
$destinataires : mixed = ''
$titre : mixed = ''
$texte : mixed = ''

formulaires_editer_message_verifier_dist()

formulaires_editer_message_verifier_dist([mixed $id_message = 'new' ][, mixed $type = 'message' ][, mixed $retour = '' ][, mixed $accepter_email = 'oui' ][, mixed $destinataires = '' ][, mixed $titre = '' ][, mixed $texte = '' ]) : mixed
Parameters
$id_message : mixed = 'new'
$type : mixed = 'message'
$retour : mixed = ''
$accepter_email : mixed = 'oui'
$destinataires : mixed = ''
$titre : mixed = ''
$texte : mixed = ''

formulaires_editer_message_traiter_dist()

formulaires_editer_message_traiter_dist([mixed $id_message = 'new' ][, mixed $type = 'message' ][, mixed $retour = '' ][, mixed $accepter_email = 'oui' ][, mixed $destinataires = '' ][, mixed $titre = '' ][, mixed $texte = '' ]) : mixed
Parameters
$id_message : mixed = 'new'
$type : mixed = 'message'
$retour : mixed = ''
$accepter_email : mixed = 'oui'
$destinataires : mixed = ''
$titre : mixed = ''
$texte : mixed = ''

verifier_corriger_date_saisie()

Recuperer les champs date_xx et heure_xx, verifier leur coherence et les reformater

verifier_corriger_date_saisie(string $suffixe, bool $horaire, array<string|int, mixed> &$erreurs) : int
Parameters
$suffixe : string
$horaire : bool
$erreurs : array<string|int, mixed>
Return values
int

messagerie_statuts_destinataires_possibles()

Lister les statuts des auteurs pouvant recevoir un message c'est tous les auteurs au moins redacteur

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

messagerie_nettoyer_destinataires()

Nettoyer une liste de destinataires

messagerie_nettoyer_destinataires( $destinataires) : array<string|int, mixed>
Parameters
$destinataires :
Return values
array<string|int, mixed>

messagerie_verifier_destinataires()

Fonction generique de verification des destinataires lors de l'envoi d'un message ou de recommander un destinataire peut etre un id_auteur numerique ou une adresse mail valide, si l'options accepter_email est true

messagerie_verifier_destinataires(array<string|int, mixed> $destinataires[, array<string|int, mixed> $options = ['accepter_email' => true] ]) : array<string|int, mixed>
Parameters
$destinataires : array<string|int, mixed>
$options : array<string|int, mixed> = ['accepter_email' => true]
Return values
array<string|int, mixed>

messagerie_destiner()

Selectionner les destinataires en distinguant emails et id_auteur

messagerie_destiner(array<string|int, mixed> $dests) : array<string|int, mixed>
Parameters
$dests : array<string|int, mixed>
Return values
array<string|int, mixed>

messagerie_diffuser_message()

Diffuser un message par la messagerie interne

messagerie_diffuser_message(int $id_message[, array<string|int, mixed> $auteurs_dest = [] ]) : bool|int
Parameters
$id_message : int
$auteurs_dest : array<string|int, mixed> = []
Return values
bool|int

messagerie_mailer_message()

Envoyer un message par mail pour les destinataires externes

messagerie_mailer_message(int $id_message[, array<string|int, mixed> $emails_dest = [] ]) : bool
Parameters
$id_message : int
$emails_dest : array<string|int, mixed> = []
Return values
bool

messagerie_marquer_message()

Marquer un message dans l'etat indique par $vu

messagerie_marquer_message(int $id_auteur, array<string|int, mixed> $liste, string $vu) : void
Parameters
$id_auteur : int
$liste : array<string|int, mixed>
$vu : string

messagerie_marquer_lus()

Marquer un message comme lu

messagerie_marquer_lus(int $id_auteur, array<string|int, mixed> $liste_id_message) : mixed
Parameters
$id_auteur : int
$liste_id_message : array<string|int, mixed>

messagerie_marquer_non_lus()

Marquer un message comme non lu

messagerie_marquer_non_lus(int $id_auteur, array<string|int, mixed> $liste_id_message) : mixed
Parameters
$id_auteur : int
$liste_id_message : array<string|int, mixed>

messagerie_effacer_message_recu()

Effacer un message recu

messagerie_effacer_message_recu(int $id_auteur, array<string|int, mixed> $liste_id_message) : mixed
Parameters
$id_auteur : int
$liste_id_message : array<string|int, mixed>

notifications_instituermessage_dist()

Envoyer les notifications consecutives a l'envoi d'un message (ie passage en statut=publie)

notifications_instituermessage_dist(string $quoi, int $id_message[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$quoi : string
$id_message : int
$options : array<string|int, mixed> = []

organiseur_upgrade()

Installation/maj des tables messagerie

organiseur_upgrade(string $nom_meta_base_version, string $version_cible) : mixed
Parameters
$nom_meta_base_version : string
$version_cible : string

organiseur_vider_tables()

Desinstallation/suppression des tables mots et groupes de mots

organiseur_vider_tables(string $nom_meta_base_version) : mixed
Parameters
$nom_meta_base_version : string

organiseur_autoriser()

Fonction vide pour charger ce fichier sans declencher de warning

organiseur_autoriser() : void

autoriser_calendrier_voir_dist()

Autorisation de voir la page calendrier

autoriser_calendrier_voir_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_messages_voir_dist()

Autorisation de voir la page messages

autoriser_messages_voir_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_calendrier_menu_dist()

autoriser_calendrier_menu_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_messagerie_menu_dist()

autoriser_messagerie_menu_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_message_modifier_dist()

autoriser_message_modifier_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_message_instituer_dist()

autoriser_message_instituer_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_message_supprimer_dist()

autoriser_message_supprimer_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_messagerecu_effacer_dist()

autoriser_messagerecu_effacer_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_message_dater_dist()

autoriser_message_dater_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_envoyermessage_dist()

autoriser_envoyermessage_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_message_voir_dist()

autoriser_message_voir_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

autoriser_message_repondre_dist()

autoriser_message_repondre_dist(mixed $faire[, mixed $type = '' ][, mixed $id = 0 ][, mixed $qui = null ][, mixed $opt = null ]) : mixed
Parameters
$faire : mixed
$type : mixed = ''
$id : mixed = 0
$qui : mixed = null
$opt : mixed = null

critere_MESSAGES_destinataire_dist()

critere_MESSAGES_destinataire_dist(mixed $idb, mixed &$boucles, mixed $crit) : mixed
Parameters
$idb : mixed
$boucles : mixed
$crit : mixed

critere_MESSAGES_non_lu_dist()

critere_MESSAGES_non_lu_dist(mixed $idb, mixed &$boucles, mixed $crit) : mixed
Parameters
$idb : mixed
$boucles : mixed
$crit : mixed

organiseur_calculer_date_reference()

Fonction privee pour mutualiser de code des criteres_MESSAGES_rv_* Retourne le code php pour obtenir la date de reference de comparaison des evenements a trouver

organiseur_calculer_date_reference(string $idb, object &$boucles, object $crit) : string
Parameters
$idb : string
$boucles : object
$crit : object
Return values
string

code PHP concernant la date.

critere_MESSAGES_rv_a_venir_dist()

{rv_a_venir} {rv_a_venir #ENV{date}}

critere_MESSAGES_rv_a_venir_dist(string $idb, object &$boucles, object $crit) : mixed
Parameters
$idb : string
$boucles : object
$crit : object

critere_MESSAGES_rv_passe_dist()

{rv_passe} {rv_passe #ENV{date}}

critere_MESSAGES_rv_passe_dist(string $idb, object &$boucles, object $crit) : mixed
Parameters
$idb : string
$boucles : object
$crit : object

critere_MESSAGES_rv_en_cours_dist()

{rv_en_cours} {rv_en_cours #ENV{date}}

critere_MESSAGES_rv_en_cours_dist(string $idb, object &$boucles, object $crit) : mixed
Parameters
$idb : string
$boucles : object
$crit : object

organiseur_icone_message()

organiseur_icone_message(mixed $type[, mixed $taille = 24 ]) : mixed
Parameters
$type : mixed
$taille : mixed = 24

organiseur_texte_modifier_message()

organiseur_texte_modifier_message(mixed $type) : mixed
Parameters
$type : mixed

organiseur_texte_nouveau_message()

organiseur_texte_nouveau_message(mixed $type) : mixed
Parameters
$type : mixed

        
On this page

Search results