API des agendas - Historique des versions

Paul le 24 août 2010 à 15:45

2010-08-24T15:45:40Z

Paul : /* Les objets */

2010-08-24T11:52:22Z

‎Les objets

Paul le 24 août 2010 à 11:44

2010-08-24T11:44:57Z

Paul : Révocation des modifications de Rebeca123 (retour à la version précédente de Paul)

2010-08-19T12:55:03Z

Révocation des modifications de Rebeca123 (retour à la version précédente de Paul)

Rebeca123 le 17 août 2010 à 18:30

2010-08-17T18:30:28Z

Paul le 4 mars 2009 à 07:43

2009-03-04T07:43:04Z

Paul le 4 mars 2009 à 07:38

2009-03-04T07:38:49Z

Paul le 2 mars 2009 à 18:45

2009-03-02T18:45:00Z

Paul le 2 mars 2009 à 18:44

2009-03-02T18:44:33Z

Paul le 4 novembre 2008 à 14:13

2008-11-04T14:13:33Z

← Version précédente		Version du 24 août 2010 à 15:45
Ligne 24 :		Ligne 24 :

	== Ajouter un nouvel agenda ==		== Ajouter un nouvel agenda ==
−
−
−
−
−
−
−
−
−
−	~~Les constantes suivantes peuvent être utilisées :~~
−
−	* <code>BAB_PERIOD_WORKING</code> périodes travaillées
−	* <code>BAB_PERIOD_NONWORKING</code> périodes non-travaillées
−	* <code>BAB_PERIOD_NWDAY</code> jours fériés
−	* <code>BAB_PERIOD_CALEVENT</code> événements d'agenda
−	* <code>BAB_PERIOD_VACATION</code> périodes de congés
−
−
−
−	~~Utiliser l'api pour mélanger les différentes sources d'événements (voir exemple dans utilit/mcalincl.php) :~~
−	~~<source lang="php">~~
−	~~$this->whObj = new bab_userWorkingHours(~~
−	~~BAB_dateTime::fromIsoDateTime($startdate),~~
−	~~BAB_dateTime::fromIsoDateTime($enddate)~~
−	);
−	~~</source>~~
−
−	~~Les 2 paramètres sont des objets date générés par BAB_dateTime (voir la classe utilit/dateTime.php).~~
−	~~C'est la période totale de calcul~~
−
−
−
−	~~Pour utiliser les informations d'horaire de travail et des congés, il faut ajouter 1 ou plusieurs id utilisateurs.~~
−	~~Pour chaque ID user ajouté, les périodes correspondantes seront prises en compte~~
−
−	~~<source lang="php">~~
−	~~$this->whObj->addIdUser($GLOBALS['BAB_SESS_USERID']);~~
−	~~</source>~~
−
−	~~Pour utiliser les événements d'agenda, il faut ajouter 1 ou plusieurs id d'agenda.~~
−	~~Pour chaque ID calendar ajouté, les périodes correspondantes seront prises en compte~~
−
−	~~<source lang="php">~~
−	~~$this->whObj->addCalendar($this->idcalendar);~~
−	~~</source>~~
−
−	~~Chargement des périodes en mémoire :~~
−	~~<source lang="php">~~
−	~~$this->whObj->createPeriods(BAB_PERIOD_NWDAY \| BAB_PERIOD_WORKING \| BAB_PERIOD_VACATION \| BAB_PERIOD_CALEVENT);~~
−	~~</source>~~
−	~~Cette fonction va chercher les informations dans toutes les tables correspondantes aux types de périodes spécifiées en paramètres.~~
−
−	~~il est possible d'ajouter des périodes à ce moment en utilisant l'événement <code>bab_eventBeforePeriodsCreated</code>~~
−
−
−	~~<code>orderBoundaries()</code>, fonction à appeler obligatoirement pour préparer les périodes qui doivent être parcourues, les périodes serons indexées par date de début et de fin~~
−
−	~~<source lang="php">~~
−	~~$this->whObj->orderBoundaries();~~
−	~~</source>~~
−
−
−	~~Parcourir les événements ; on peut filtrer sur le type avec le paramètre :~~
−
−	~~<source lang="php">~~
−	~~$p = $this->whObj->getNextEvent(BAB_PERIOD_NWDAY \| BAB_PERIOD_VACATION \| BAB_PERIOD_CALEVENT)~~
−	~~</source>~~
−
−	~~récupérer un tableau d'événements, les paramètres de date sont des timestamp pour délimiter la période :~~
−
−	~~<source lang="php">~~
−	~~$events = $this->whObj->getEventsBetween(bab_mktime($startdate), bab_mktime($enddate), BAB_PERIOD_NWDAY \| BAB_PERIOD_VACATION \| BAB_PERIOD_CALEVENT);~~
−	~~</source>~~
−
−
−	~~Trouver les périodes de disponibilité entre 2 dates, $gap permet de définir la durée minimum des périodes à remonter (en secondes)~~
−	~~Pour ces 2 dernières fonctions, il faut que la période de récupération des infos soit incluse dans la période total qui a été utilisée à la création de l'objet~~
−
−	~~<source lang="php">~~
−	~~$freeevents = $whObj->getAvailabilityBetween(bab_mktime($startdate), bab_mktime($enddate), $gap);~~
−
−	~~</source>~~

@@ Ligne 14 : / Ligne 14 : @@
 === Les objets ===
-<code>bab_EventCalendar</code> : Tous les agendas visibles dans l'interface hérite de cet objet
+<code>bab_EventCalendar</code> : Tous les agendas visibles dans l'interface héritent de cet objet, c'est une classe abstraite sur laquelle sont déclarées des méthodes permettant le contrôle des droits d'accès sur l'agenda.
 === Les événements ===

@@ Ligne 1 : / Ligne 1 : @@
 [[Catégorie:API Ovidentia]]
 {{Incomplet}}
-{{Warning|Cette API n'est pas utilisable dans les modules pour le moment}}

← Version précédente		Version du 19 août 2010 à 12:55
Ligne 79 :		Ligne 79 :

	</source>		</source>
−	~~[http://www.college-paper.org paper writing service]~~

← Version précédente		Version du 17 août 2010 à 18:30
Ligne 79 :		Ligne 79 :

	</source>		</source>
		+	[http://www.college-paper.org paper writing service]

@@ Ligne 47 : / Ligne 47 : @@
 $this->whObj->createPeriods(BAB_PERIOD_NWDAY | BAB_PERIOD_WORKING | BAB_PERIOD_VACATION | BAB_PERIOD_CALEVENT);
 </source>
-Cette fonction va chercher les informations dans toutes les tables correspondantes aux types de périodes spécifiées en paramètres
+Cette fonction va chercher les informations dans toutes les tables correspondantes aux types de périodes spécifiées en paramètres.

@@ Ligne 7 : / Ligne 7 : @@
 Les constantes suivantes peuvent être utilisées :
-<pre>
-define("BAB_PERIOD_WORKING"        , 1);
+* <code>BAB_PERIOD_WORKING</code> périodes travaillées
-define("BAB_PERIOD_NONWORKING"    , 2);
+* <code>BAB_PERIOD_NONWORKING</code> périodes non-travaillées
-define("BAB_PERIOD_NWDAY"        , 4);
+* <code>BAB_PERIOD_NWDAY</code> jours fériés
-define("BAB_PERIOD_CALEVENT"    , 8);
+* <code>BAB_PERIOD_CALEVENT</code> événements d'agenda
-define("BAB_PERIOD_TSKMGR"        , 16);
+* <code>BAB_PERIOD_VACATION</code> périodes de congés
-define("BAB_PERIOD_VACATION"    , 32);
-</pre>
 Utiliser l'api pour mélanger les différentes sources d'événements (voir exemple dans utilit/mcalincl.php) :
-<pre>
+<source lang="php">
 $this->whObj = new bab_userWorkingHours(
              BAB_dateTime::fromIsoDateTime($startdate),
              BAB_dateTime::fromIsoDateTime($enddate)
          );
-</pre>
+</source>
 Les 2 paramètres sont des objets date générés par BAB_dateTime (voir la classe utilit/dateTime.php).
 C'est la période totale de calcul
-<pre>
-$this->whObj->addIdUser($GLOBALS['BAB_SESS_USERID']);
-</pre>
 Pour utiliser les informations d'horaire de travail et des congés, il faut ajouter 1 ou plusieurs id utilisateurs.
 Pour chaque ID user ajouté, les périodes correspondantes seront prises en compte
-<pre>
-$this->whObj->addCalendar($this->idcalendar);
+<source lang="php">
-</pre>
+$this->whObj->addIdUser($GLOBALS['BAB_SESS_USERID']);
 Pour utiliser les événements d'agenda, il faut ajouter 1 ou plusieurs id d'agenda.
 Pour chaque ID calendar ajouté, les périodes correspondantes seront prises en compte
-<pre>
 $this->whObj->createPeriods(BAB_PERIOD_NWDAY | BAB_PERIOD_WORKING | BAB_PERIOD_VACATION | BAB_PERIOD_CALEVENT);
-</pre>
+</source>
 Cette fonction va chercher les informations dans toutes les tables correspondantes aux types de périodes spécifiées en paramètres
-<pre>
 $this->whObj->orderBoundaries();
-</pre>
+</source>
-Fonction  à  appeler  obligatoirement pour préparer les périodes qui doivent être parcourues
-<pre>
 $p = $this->whObj->getNextEvent(BAB_PERIOD_NWDAY | BAB_PERIOD_VACATION | BAB_PERIOD_CALEVENT)
-</pre>
+</source>
-parcourir les événements ; on peut filtrer sur le type avec le paramètre
-<pre>
+<source lang="php">
 $events = $this->whObj->getEventsBetween(bab_mktime($startdate), bab_mktime($enddate), BAB_PERIOD_NWDAY | BAB_PERIOD_VACATION | BAB_PERIOD_CALEVENT);
-</pre>
+</source>
-récupérer un tableau d'événements, les paramètres de date sont des timestamp pour délimiter la période
 Trouver les périodes de  disponibilité entre 2 dates, $gap permet de définir la durée minimum des périodes à remonter (en secondes)
 Pour ces 2 dernières fonctions, il faut que  la période de récupération des infos soit incluse dans la période total qui a été utilisée à la création de l'objet

← Version précédente		Version du 2 mars 2009 à 18:44
Ligne 1 :		Ligne 1 :
	[[Catégorie:API Ovidentia]]		[[Catégorie:API Ovidentia]]

−	~~'''~~Cette API n'est pas utilisable dans les modules pour le moment~~'''~~	+	{{Warning\|Cette API n'est pas utilisable dans les modules pour le moment}}

← Version précédente		Version du 4 novembre 2008 à 14:13
Ligne 1 :		Ligne 1 :
		+	[[Catégorie:API Ovidentia]]
		+
	'''Cette API n'est pas utilisable dans les modules pour le moment'''		'''Cette API n'est pas utilisable dans les modules pour le moment'''