inscrire_auteur.php
Gestion de l'inscription d'un auteur
Table of Contents
Functions
- action_inscrire_auteur_dist() : array<string|int, mixed>|string
- Inscrire un nouvel auteur sur la base de son nom et son email
- test_inscription_dist() : array<string|int, mixed>|string
- Contrôler que le nom (qui sert à calculer le login) est plausible et que l'adresse courriel est valide.
- inscription_nouveau() : mixed|string
- On enregistre le demandeur comme 'nouveau', en memorisant le statut final provisoirement dans le champ prefs, afin de ne pas visualiser les inactifs A sa premiere connexion il obtiendra son statut final.
- test_login() : string
- Retourne un login valide à partir du nom et email donné
- envoyer_inscription_dist() : array<string|int, mixed>
- Construction du mail envoyant les identifiants
- creer_pass_pour_auteur() : string
- Creer un mot de passe initial aleatoire
- tester_statut_inscription() : string
- Determine le statut d'inscription : si $statut_tmp fourni, verifie qu'il est autorise sinon determine le meilleur statut possible et le renvoie
- confirmer_statut_inscription() : array<string|int, mixed>
- Un nouvel inscrit prend son statut definitif a la 1ere connexion.
- auteur_attribuer_jeton() : string
- Attribuer un jeton temporaire pour un auteur en assurant l'unicite du jeton.
- auteur_lire_jeton() : string|null
- Lire un jeton temporaire d’un auteur (peut le créer au besoin)
- auteur_verifier_jeton() : array<string|int, mixed>|bool
- Retrouver l'auteur par son jeton
- auteur_effacer_jeton() : bool
- Effacer le jeton d'un auteur apres utilisation
Functions
action_inscrire_auteur_dist()
Inscrire un nouvel auteur sur la base de son nom et son email
action_inscrire_auteur_dist(string $statut, string $mail_complet, string $nom[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|string
L'email est utilisé pour repérer si il existe déjà ou non => identifiant par défaut
Parameters
- $statut : string
- $mail_complet : string
- $nom : string
- $options : array<string|int, mixed> = []
-
- login : login precalcule
- id : id_rubrique fournit en second arg de #FORMULAIRE_INSCRIPTION
- redirect : URL où rediriger après validation depuis l'email, sinon c'est l'accueil
- from : email de l'envoyeur pour l'envoi du mail d'inscription
- force_nouveau : forcer le statut nouveau sur l'auteur inscrit, meme si il existait deja en base
- modele_mail : squelette de mail a utiliser
Return values
array<string|int, mixed>|stringtest_inscription_dist()
Contrôler que le nom (qui sert à calculer le login) est plausible et que l'adresse courriel est valide.
test_inscription_dist(string $statut, string $mail, string $nom, array<string|int, mixed> $options) : array<string|int, mixed>|string
On les normalise au passage (trim etc).
On peut redéfinir cette fonction pour filtrer les adresses mail et les noms, et donner des infos supplémentaires
Parameters
- $statut : string
- $mail : string
- $nom : string
- $options : array<string|int, mixed>
Return values
array<string|int, mixed>|string —- array : si ok, tableau avec au minimum email, nom, mode (redac / forum)
- string : si ko, chaîne de langue servant d'argument au filtre
_Texpliquant le refus
inscription_nouveau()
On enregistre le demandeur comme 'nouveau', en memorisant le statut final provisoirement dans le champ prefs, afin de ne pas visualiser les inactifs A sa premiere connexion il obtiendra son statut final.
inscription_nouveau(array<string|int, mixed> $desc) : mixed|string
Parameters
- $desc : array<string|int, mixed>
Return values
mixed|stringtest_login()
Retourne un login valide à partir du nom et email donné
test_login(string $nom, string $mail) : string
Un suffixe incrémental est ajouté si le login obtenu existe déjà en base pour ne pas créer de doublon.
Si le login est trop court 'user' est utilisé ; puis donc 'user1', 'user2' etc...
Parameters
- $nom : string
- $mail : string
Return values
stringenvoyer_inscription_dist()
Construction du mail envoyant les identifiants
envoyer_inscription_dist(array<string|int, mixed> $desc, string $nom, string $mode[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Fonction redefinissable qui doit retourner un tableau dont les elements seront les arguments de inc_envoyer_mail
Parameters
- $desc : array<string|int, mixed>
- $nom : string
- $mode : string
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed>creer_pass_pour_auteur()
Creer un mot de passe initial aleatoire
creer_pass_pour_auteur(int $id_auteur) : string
Parameters
- $id_auteur : int
Return values
stringtester_statut_inscription()
Determine le statut d'inscription : si $statut_tmp fourni, verifie qu'il est autorise sinon determine le meilleur statut possible et le renvoie
tester_statut_inscription(string $statut_tmp, int $id) : string
Parameters
- $statut_tmp : string
- $id : int
Return values
stringconfirmer_statut_inscription()
Un nouvel inscrit prend son statut definitif a la 1ere connexion.
confirmer_statut_inscription(array<string|int, mixed> $auteur) : array<string|int, mixed>
Le statut a ete memorise dans prefs (cf test_inscription_dist). On le verifie, car la config a peut-etre change depuis, et pour compatibilite avec les anciennes versions qui n'utilisaient pas "prefs".
Parameters
- $auteur : array<string|int, mixed>
Return values
array<string|int, mixed>auteur_attribuer_jeton()
Attribuer un jeton temporaire pour un auteur en assurant l'unicite du jeton.
auteur_attribuer_jeton(int $id_auteur) : string
Chaque appel crée un nouveau jeton pour l’auteur et invalide donc le précédent
Parameters
- $id_auteur : int
Return values
stringauteur_lire_jeton()
Lire un jeton temporaire d’un auteur (peut le créer au besoin)
auteur_lire_jeton(int $id_auteur[, bool $autoInit = false ]) : string|null
Cette fonction peut être pratique si plusieurs notifications proches dans la durée sont envoyées au même auteur.
Parameters
- $id_auteur : int
- $autoInit : bool = false
-
Attribue un jeton à l’auteur s’il n’en a pas déjà.
Return values
string|nullauteur_verifier_jeton()
Retrouver l'auteur par son jeton
auteur_verifier_jeton(string $jeton) : array<string|int, mixed>|bool
Parameters
- $jeton : string
Return values
array<string|int, mixed>|boolauteur_effacer_jeton()
Effacer le jeton d'un auteur apres utilisation
auteur_effacer_jeton(int $id_auteur) : bool
Parameters
- $id_auteur : int