(OBSOLÈTE) FREEEVENT 2.8
Le module FREEEVENT a pour objectif d'apporter un ensemble de fonctionnalités à Dynacase pour représenter les documents en fonction de critères de temps.
FREEEVENT introduit trois nouvelles familles :
- événement
- recherche d'événements
- dossier d'événements
La famille événement contient les informations temporelles et descriptives permettant la sélection et l'affichage de ces événements sous forme de planning ou d'agenda.
Les documents événements ne sont pas produits directement par l'utilisateur mais par des familles de document dites « productrices d'événements ».
Un événement est un document issu de la famille événement ou de ses héritiers. Il sert à réserver des ressources (humaines ou matérielles) dans un laps de temps défini.
L'événement contient obligatoirement une date de début et une date de fin. Ces dates ont une précision à la minute.
| attribut | description |
|---|---|
| titre | descriptif court de l'événement |
| description | descriptif long de l'événement |
| type | catégorie de l'événement. Ces catégories sont fonctions de la famille référent |
| date début | date du début de l'événement à la minute : exemple : 10/12/2004 12:54 |
| date de fin | date du fin de l'événement à la minute : exemple : 11/12/2004 23:54 |
| créateur/propriétaire | par défaut c'est l'utilisateur qui a créé l'événement |
| ressources | ce sont la liste des documents ressources impactés par l'événement |
| famille référent | la famille qui a servi à produire l'événement |
| document référent | le document qui a produit l'événement |
| fonction de transfert | la méthode qui a produit l'événement (pEventDefault par défaut) |
| fonction de transfert inverse | la méthode qui sert pour modifier le document référent à partir de l'événement. (Non utilisée pour l'instant) |
Il ne peut exister qu'un seul événement par document producteur et par méthode de transfert. Si l'événement associé à un producteur existe déjà avec la méthode de transfert utilisé alors il est modifié.
Les ressources peuvent être n'importe quel document marqué comme tel. Pour marquer un document comme ressource il suffit de lui assigner le marquage applicatif 'R' (propriétés //atags//). Ce marquage n'est pas modifiable par l'interface actuellement. Si une famille est marquée 'R', tous les documents produits auront le même marquage.
Pour marquer une famille il est nécessaire de passer par le fichier d'importation avec la définition suivante. L'exemple suivant indique que les utilisateurs peuvent être des ressources.
| BEGIN | IUSER | ||||
|---|---|---|---|---|---|
| TAG | R | ||||
| END |
Ce marquage ne modifie pas les utilisateurs existants. Pour indiquer que les utilisateurs existants sont aussi des ressources, il est nécessaire de modifier directement la base de données.
[root@host root]# PGSERVICE=test psql
Bienvenue dans psql 7.4.2, l'interface interactive de PostgreSQL.
test=# UPDATE doc128 set atags = 'R';
UPDATE 2233
Les familles productrices sont celles qui sont capable d'engendrer des événements. La déclaration d'une famille productrice doit contenir les éléments suivants :
| BEGIN | Demande de congés | ABSENCE | |||
|---|---|---|---|---|---|
| TAG | P | ||||
| METHOD | *Method.PEvents.php | ||||
| METHOD | +Method.PEvtAbs.php | ||||
| END |
Ces familles doivent être marquées 'P' (comme productrice), ceci dans le but de pouvoir les rechercher suivant ce critère. Ces familles doivent hériter des méthodes de production d'événements. Par défaut, une seule fonction de production est disponible (pEventDefault). Cette fonction de production est appelée par la méthode ::setEvent(). Le fait d'hériter des méthodes de production ne permet pas la production directement.
La famille productrice doit surcharger les méthodes pour remplir les attributs de l'événement et elle doit indiquer quand elle doit produire, modifier et supprimer cet événement (appel à ::setEvent(), ::deleteEvent() ).
Si la famille productrice a des attributs qui correspondent directement à des attributs de l'événement, elle peut utiliser les attributs suivants pour indiquer la relation :
- $eventAttBeginDate : date de début
- $eventAttEndDate : date de fin
- $eventAttDesc : description longue
- $eventAttCode : catégorie
- $eventRessources : tableau de ressource;
Si certains attributs ne correspondent pas, la famille productrice doit alors redéfinir les méthodes suivantes :
-
::getEventBeginDate() : retourne la date de début, si pas de minutes c'est la date à 00:00 heures.
-
::getEventEndDate() : retourne la date de fin
-
::getEventOwner() : retourne l'identificateur FREEDOM du propriétaire (par défaut basé sur propriété owner du producteur
-
::getEventTitle() : retourne la titre (par défaut titre du producteur)
-
::getEventDesc() : retourne la description (vide par défaut basé sur $eventAttDesc)
-
::getEventCode() : retourne la catégorie (vide par défaut basé sur $eventAttCode)
-
::getEventRessources() : retourne un tableau des identifiants des documents ressources.
-
::getOverDescription() : retourne une portion de code HTML qui décrit l'événement lorsque que le curseur de la souris passe sur la représentation de l'événement. Par défaut la description est basée sur Event::getEventDesc().
-
::getContextMenu() : retourne la description du menu contextuel lié à l'événement
-
::getSelectAction() : retourne l'action qui va être réalisée lors d'un clic de l'événement ** syntaxe : soit ''url:<url composé>'' exemple * ''url:%S%app=TEST&action=MONACTION&id=%I%'' * ''url:%S%app=TEST&action=MONACTION_DU_PRODUCTEUR&id=%EVT_IDINITIATOR%'' * ''javascript:execution(event,'%I%')'' * ''url:%S%app=FDL&action=FDL_CARD&id=%EVT_IDINITIATOR%'' (par défaut)
Exemple Method.PEvtAbs.php :
var $eventAttBeginDate="ABS_VDBEG";
var $eventAttEndDate="ABS_VDEND";
var $eventAttDesc="ABS_TYPE";
var $eventAttCode="ABS_TYPE";
var $eventRessources=array("ABS_IDDEMAND","ABS_IDVAL","ABS_IDDIR","ABS_IDRH");
function getEventEndDate() {
return substr($this->getValue($this->eventAttEndDate),0,10)." 23:59:59";
}
function postModify() {
$err=$this->setEvent(); //modification de l'événement à chaque modification du producteur
}
Si une famille productrice doit générer des événements répétables elle doit donner tous les éléments de répétabilité à l'événement pour qu'il puisse se découper. Il faut au préalable créer une famille héritée d'événement qui doit contenir les attributs contenant les informations de répétabilité.
Soit la famille événement journalier qui permet de répéter un événement suivant le jour de la semaine.
| BEGIN | "EVENT" | Évenement journalier | DAYEVENT | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| METHOD | Method.DayEvent.php | |||||||||||
| idattr | idframe | label | T | A | type | ord | vis | need | link | phpfile | phpfunc | |
| ATTR | Répétabilité | N | N | Frame | 200 | W | N | |||||
| ATTR | DEVT_DAY | DEVT_FR_REPEAT | Jour | N | N | enum | 1¦Lundi,2¦Mardi,3¦Mercredi,4¦Jeudi,5¦Vendredi,6¦Samedi,7¦Dimanche | |||||
| END |
Cette famille d'événement doit redéfinir la méthode explodeEvt() pour produire plusieurs événements atomiques à partir d'un événement répétable.
public function explodeEvt($d1,$d2) {
include_once("FDL/Lib.Util.php");
$jdi1=($d1=="")?0:Iso8601ToJD($d1);
$jdi2=StringDateToJD($this->getValue("evt_begdate"));
$jd1=max($jdi1,$jdi2); // search begin date
$jdi1=($d2=="")?5000000:Iso8601ToJD($d2);
$jdi2=StringDateToJD($this->getValue("evt_enddate"));
$jd2=min($jdi1,$jdi2);// search end date
$day=intval($this->getValue("DEVT_DAY")); // the day to repeat
if (($day < 1) || ($day > 7)) {
print "error day $day";
return array();
}
$djd1=jdWeekDay($jd1);
$jd1+=($day-$djd1+7)%7; // search the first day
$te=array();
$te1=get_object_vars($this);
for ($i=$jd1;$i<$jd2;$i+=7) {
$te[$i]=$te1;
$te[$i]["evt_begdate"]=jd2cal($i); // change date period
$te[$i]["evt_enddate"]=jd2cal($i+1); // one day later
$te[$i]["evt_desc"]=$i;
}
return $te;
}Avec cette famille, l'événement "manger des patates tous les mardis" pourra être créé à partir de la famille productrice "menu journalier" par exemple.
Soit la définition suivante de la famille "menu journalier" :
| BEGIN | Menu journalier | DAYMENU | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| TAG | P | |||||||||||
| METHOD | *Method.PEvents.php | |||||||||||
| METHOD | Method.DayMenu.php | |||||||||||
| idattr | idframe | label | T | A | type | ord | vis | need | link | phpfile | phpfunc | |
| ATTR | DAYM_FR_IDENT | Identification | N | N | frame | 200 | W | |||||
| ATTR | DAYM_DESC | DAYM_FR_IDENT | description | Y | N | text | 210 | W | ||||
| ATTR | DAYM_IDUSER | DAYM_FR_IDENT | id utilisateur | N | N | docid | 220 | H | ||||
| ATTR | DAYM_USER | DAYM_FR_IDENT | utilisateur | N | N | text | 230 | W | fdl.php | lfamily(D,USER,DAYM_USER):DAYM_IDUSER,DAYM_USER | ||
| ATTR | DAYM_BEGDATE | DAYM_FR_IDENT | date début | N | N | date | 240 | W | ||||
| ATTR | DAYM_ENDDATE | DAYM_FR_IDENT | date fin | N | N | date | 250 | W | ||||
| ATTR | DAYM_FR_REPEAT | Répétabilité | N | N | frame | 260 | W | |||||
| ATTR | DAYM_DAY | DAYM_FR_REPEAT | jour | N | N | enum | 270 | W | 1¦Lundi,2¦Mardi,3¦Mercredi,4¦Jeudi,5¦Vendredi,6¦Samedi,7¦Dimanche | |||
| END |
La famille productrice en plus de mettre à jour les attributs de l'événement « brut » doit aussi mettre à jour les informations nécessaire pour la répétabilité. Ceci peut être fait en surchargeant la méthode «::setEventSpec().
Voici un exemple de production de répétable avec la famille « //menu journalier// ».
// Methode.DayMenu.php
public $eventAttBeginDate="DAYM_BEGDATE";
public $eventAttEndDate="DAYM_ENDDATE";
public $eventAttDesc="DAYM_DESC";
public $eventFamily="DAYEVENT";
var $eventRessources=array("DAYM_IDUSER");
function getEventEndDate() {
return substr($this->getValue($this->eventAttEndDate),0,10)." 23:59:59";
}
function setEventSpec(&$e) { //mise à jour attribut de répétabilité
$e->setValue("DEVT_DAY", $this->getValue("DAYM_DAY"));
}
function postModify() {
$this->setEvent();
}
La recherche d'événements est basée sur la recherche détaillée. Cette recherche construit sa requête sur les critères tel que cela est fait avec la recherche détaillé . De plus, la requête est aussi construite en fonction des critères issus de l'édition par défaut tels que des contraintes de ressources ou de famille productrices. Deux critères obligatoires sont aussi ajoutés sur la recherche : date de début et date de fin non nulle pour les événements. Tous les événements construits sans ces deux attributs obligatoires seront ignorés. Puisque recherche d'événements hérite de recherche détaillé, il est possible d'indiquer des paramètres ou des fonctions dans la requête. Pour utiliser ces fonctionnalités, il est néanmoins nécessaire d'utiliser la vue d'édition spéciale : détaillée. Dans cette vue, l'interface d'édition est la même que celle de la recherche détaillée. Si vous utilisez cette vue d'édition, il faut bien se souvenir que la requête complète sera faite en fonction des critères de cette vue et de la vue par défaut d'édition. Il est préférable de ne pas mélanger les deux vues pour ne pas avoir des critères contradictoires.
Cette famille dispose d'une vue de consultation sous forme de planning.
Le dossier événement permet de rassembler des événements quelconques. La seule différence avec un dossier classique est qu'il possède une vue //planning// comme la recherche d'événement. L'ajout ou la suppression d'événement dans ce dossier ce fait comme pour un dossier classique. Le dossier événements ne peut contenir que des événements.