Ignore:
Timestamp:
May 7, 2019, 3:15:40 PM (2 years ago)
Author:
abelass@…
Message:
  • doc
  • liens vers doc
File:
1 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/objets_disponibilites/trunk/README.md

    r114027 r115266  
    1 # Objets disponibles
    2 Permet de définir des disponibilités pour les objets
     1# Disponibilités objets
     2Permet de définir des disponibilités pour vos objets
     3
     4## Dépendances
     5- [Saisies](https://plugins.spip.net/saisies.html)
     6- [Vérifier](https://plugins.spip.net/verifier.html)
     7- [Dates outils](https://plugins.spip.net/dates_outils.html)
    38
    49## Utilisation
     10### Configuration
    511Dans la configuration du plugin déclarez les objets pour lesquels vous voulez gérer
    6 des diponibilités.
     12des disponibilités.
    713
    8 Vous popuvez alors définir pour ces objets des periodes de disponibilité ou de non
    9 disponibilités
     14### Édition
     15Vous pouvez alors définir pour ces objets des périodes de disponibilité ou de non
     16disponibilités.
    1017
     18### Squelettes
    1119Dans l'état actuel, la manière principal d'affichage des dates disponibles est via
    12 la saisies `dates_disponibles`, vous y trouverez des examples ainsi que toutes les
    13 variables utilisées.
     20les saisies `dates_disponibles` ou `dates_disponibles_select` (regardez dans le dossiers `saisies`), vous y trouverez des exemples ainsi que toutes les variables utilisées.
    1421
    15 Il existe également une fonction `dates_disponibles($options, $contexte)` qui utilise
    16 les mêmes variables que la saisies et retourne un tableau avec les dates disponibles.
     22Ces saisies utilisent le filtre `dates_disponibles($options, $contexte)` qui prend
     23les mêmes variables que les saisies et retourne un tableau avec les dates disponibles.
    1724
    18 ## Fonctionnement
    19 Basiquement on calcules les dates disponibles pour un objet on y déduit les non disponibles
    20 puis les dates utilisées (par example dans le cadre d'une location avec le plugin
    21 [Objets Location](https://github.com/abelass/location_objets)
     25## Filtre
     26Le filtre `dates_disponibles($options, $contexte = array())` calcule les dates disponibles pour un objet, en déduit les non disponibles ainsi que les dates utilisées (par exemple dans le cadre d'une location avec le plugin
     27[Objets Location](https://github.com/abelass/location_objets).
    2228
    23 toutes les calcules se font dans des squelettes, donc facilement modifiable. Les dates
    24 disponibles et indisponibles se trouvent dans le dossier disponibilites puis si nécessaire
    25 on peut déclarer un squelette utilisé pour le calcul des dates utilisées en employant la
    26 variable `utilisation_squelette` comme dans l'example avec `utilisation_squelette=disponibilites/utilisees_objet_location.html`,
     29Les calculs des dates disponibles et non disponibles se font dans des squelettes (voir dossier disponibilites), donc facilement modifiable. Pour les dates utilisées, s'il existe une fonction personnalisé pour l'objet `disponibilites_objetEnQuestion_utilise_dist()` celle-ci sera utilisée, sinon on recourt à la fonction par défaut `disponibilites_objet_utilise_dist()` qui se trouve dans le fichier `disponibilites/objet_utilise.php`.
     30
    2731
    2832## to do
Note: See TracChangeset for help on using the changeset viewer.