Documentation
La session
Cette variable session est très importante. Elle contient de nombreuses informations sur l’environnement, l’utilisateur, les modules ou les espaces qui permettent d‘éviter des requêtes souvent complexes sur la base de données.
Attention, si elle permet d’optimiser significativement le temps d’exécution des scripts, l’empreinte mémoire de cette variable peut ne pas être négligeable lorsque vous utilisez des configurations d’espaces de travail complexes.
La session est stockée par défaut dans la base de données (paramétrable lors de l’installation de PLOOPI). Cette configuration n’est pas optimale en terme de performance (par rapport à un stockage sur disque dur ou en mémoire). Elle est par contre recommandée pour des question de sécurités et facilité de mise en oeuvre dans des environnement de production complexes (load_balancing notamment).
La variable globale $_SESSION[‘ploopi’] est un (gros) tableau associatif contenant notamment les clés suivantes :
| Clé | Valeur |
| action | Type daccès au module : public/admin) |
| adminlevel | Niveau d’administration de l’utilisateur connecté dans l’espace en cours d’utilisation |
| allworkspaces | Chaîne contenant l’ensemble des identifiants des espaces de travails séparés par le caractère “virgule” |
| backoffice[‘moduleid’] | Identifiant du module sélectionné en backoffice |
| backoffice[‘workspaceid’] | Identifiant de l’espace de travail sélectionné en backoffice |
| connected | Indique si l’utilisateur est connecté (booléen) |
| currentrequesttime | Timestamp unix de l’exécution du script |
| login | Login (nom d’utilisateur) de l’utilisateur connecté |
| env | Contaténation des variables “mainmenu”, “workspaceid”, “moduleid”, “action” : utilisé pour indiquer le positionnement d’un utilisateur dans une URL |
| fingerprint | Empreinte du portail en cours d’exécution |
| frontoffice[‘moduleid’] | Identifiant du module sélectionné en frontoffice |
| frontoffice[‘workspaceid’] | Identifiant de l’espace de travail sélectionné en frontoffice |
| host | Nom de domaine utilisé |
| hosts[‘frontoffice’] | Tableau contenant les identifiants des espaces de travail accessibles en frontoffice |
| hosts[‘backoffice’] | Tableau contenant les identifiants des espaces de travail accessibles en backoffice |
| lastrequesttime | Timestamp unix de l’exécution du script précédent |
| loginerror | Indique si la requête précédente a fait l’objet d’une erreur de connexion |
| mainmenu | Identifiant du menu principal sélectionné |
| mode | Mode d’accès au portail : backoffice/frontoffice |
| moduleid | Identifiant du module sélectionné |
| moduletype | Intitulé du type de module sélectionné (doc, rss, etc.) |
| moduletypeid | Identifiant du type de module sélectionné |
| modulelabel | Intitulé du module sélectionné |
| modules | Tableau des modules |
| moduletypes | Tableau des types de modules |
| newtickets | Nombre de nouveau tickets (non lus) pour l’utilisateur connecté |
| paramloaded | Indique si les paramètres ont été chargés |
| password | Mot de passe de l’utilisateur connecté |
| remote_ip | Adresse IP de l’utilisateur |
| remote_browser | Navigateur de l’utilisateur |
| remote_system | Système d’exploitation de l’utilisateur |
| scriptname | Nom du script appelé |
| template_name | Nom du template utilisé |
| template_path | Chemin du template utilisé |
| timezone | Nom du fuseau horaire utilisé |
| userid | Identifiant l’utilisateur connecté |
| uri | URI demandée |
| workspaceid | Identifiant de l’espace de travail en cours d’utilisation |
| workspaces | Tableau des espaces de travail accessibles |
$_SESSION[‘ploopi’][‘adminlevel’] peut prendre les valeurs suivantes :
_PLOOPI_ID_LEVEL_VISITOR (0) : visiteur
_PLOOPI_ID_LEVEL_USER (10) : utilisateur connecté
_PLOOPI_ID_LEVEL_GROUPMANAGER (15) : Gestionnaire d’espace de travail
_PLOOPI_ID_LEVEL_GROUPADMIN (20) : Administrateur d’espace de travail
_PLOOPI_ID_LEVEL_SYSTEMADMIN (99) : Administrateur système
$_SESSION[‘ploopi’][‘mainmenu’] peut prendre les valeurs suivantes :
_PLOOPI_MENU_WORKSPACES (1) : espaces de travail
_PLOOPI_MENU_MYWORKSPACE (2) : espace perso de l’utilisateur
_PLOOPI_MENU_ABOUT (3) : à propos de
_PLOOPI_MENU_ANNOTATIONS (4) : mes annotations
_PLOOPI_MENU_TICKETS (5) : mes tickets
_PLOOPI_MENU_SEARCH (6) : recherche intégrale
Retour en haut de la page
