Changeset 115266 in spip-zone


Ignore:
Timestamp:
May 7, 2019, 3:15:40 PM (2 weeks ago)
Author:
abelass@…
Message:
  • doc
  • liens vers doc
Location:
_plugins_/objets_disponibilites/trunk
Files:
6 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
  • _plugins_/objets_disponibilites/trunk/disponibilites/objet_utilise.php

    r114257 r115266  
    55}
    66
     7/**
     8 * Calcul l'utilisation de l'objet
     9 *
     10 * @param string $utilise_objet
     11 *   L'objet pour le quel on calcul la disponibilité.
     12 * @param array $contexte
     13 *   Les données du contexte.
     14 *   les optiosn suivants sont nécessaires:
     15 *   - objet
     16 *   - id_objet
     17 *   - statuts
     18 *
     19 * @return array
     20 *   Les dates utilisées.
     21 */
    722function disponibilites_objet_utilise_dist($utilise_objet, $contexte) {
    823        include_spip('filtres/dates_outils');
     
    3954
    4055        if ($table = table_objet_sql($utilise_objet)) {
     56
    4157        $utilisation = sql_allfetsel($select, $table , $where);
    4258
     
    4864                if (isset($contexte['verifier']) AND $contexte['verifier']) {
    4965                        if (dates_difference($date_debut, $date_fin, 'jour') == 1) {
    50                                 //$contexte['utilise_decalage_debut'] = 0;
    5166                                $contexte['utilise_decalage_fin'] = 0;
    5267                        }
    5368                }
    54 
    5569
    5670                if ($date_debut != $date_fin) {
     
    6781                        $dates = array_merge($dates, $intervalle);
    6882                        }
    69 
    7083                }
    7184        }
  • _plugins_/objets_disponibilites/trunk/lang/paquet-objets_disponibilites_fr.php

    r114249 r115266  
    1010        // O
    1111        'objets_disponibilites_description' => 'Système de gestion de disponibilité de vos objets.',
    12         'objets_disponibilites_nom' => 'Disponibilites objets',
     12        'objets_disponibilites_nom' => 'Disponibilités objets',
    1313        'objets_disponibilites_slogan' => 'Gère la disponibilité d’un objet'
    1414);
  • _plugins_/objets_disponibilites/trunk/objets_disponibilites_administrations.php

    r114027 r115266  
    3333function objets_disponibilites_upgrade($nom_meta_base_version, $version_cible) {
    3434        $maj = array();
    35         # quelques exemples
    36         # (que vous pouvez supprimer !)
    37         #
    38         # $maj['create'] = array(array('creer_base'));
    39         #
    40         # include_spip('inc/config')
    41         # $maj['create'] = array(
    42         #       array('maj_tables', array('spip_xx', 'spip_xx_liens')),
    43         #       array('ecrire_config', 'objets_disponibilites', array('exemple' => "Texte de l'exemple"))
    44         #);
    45         #
    46         # $maj['1.1.0']  = array(array('sql_alter','TABLE spip_xx RENAME TO spip_yy'));
    47         # $maj['1.2.0']  = array(array('sql_alter','TABLE spip_xx DROP COLUMN id_auteur'));
    48         # $maj['1.3.0']  = array(
    49         #       array('sql_alter','TABLE spip_xx CHANGE numero numero int(11) default 0 NOT NULL'),
    50         #       array('sql_alter','TABLE spip_xx CHANGE texte petit_texte mediumtext NOT NULL default \'\''),
    51         # );
    52         # ...
    5335
    5436        $maj['create'] = array(array('maj_tables', array('spip_disponibilite_dates', 'spip_disponibilite_dates_liens')));
     
    7355**/
    7456function objets_disponibilites_vider_tables($nom_meta_base_version) {
    75         # quelques exemples
    76         # (que vous pouvez supprimer !)
    77         # sql_drop_table('spip_xx');
    78         # sql_drop_table('spip_xx_liens');
    7957
    8058        sql_drop_table('spip_disponibilite_dates');
  • _plugins_/objets_disponibilites/trunk/objets_disponibilites_fonctions.php

    r114257 r115266  
    4545        if (isset($contexte['utilise_objet'])) {
    4646                $utilise_objet = $contexte['utilise_objet'];
     47                // On regarde si on trouve un fonction spécifique pour l'objet
    4748                if ($fonction = charger_fonction($utilise_objet . '_utilise', 'disponibilites', TRUE)) {
    4849                        $dates_utilisees = $fonction($contexte);;
  • _plugins_/objets_disponibilites/trunk/paquet.xml

    r114257 r115266  
    22        prefix="objets_disponibilites"
    33        categorie="auteur"
    4         version="1.2.1"
     4        version="1.2.2"
    55        etat="test"
    66        compatibilite="[3.0.0;3.2.*]"
    77        logo="prive/themes/spip/images/objets_disponibilites-64.png"
    8         documentation=""
     8        documentation="https://contrib.spip.net/Disponibilites-objets"
    99        schema="1.0.1"
    1010>
    1111
    12         <nom>Disponibilites objets</nom>
     12        <nom>Disponibilités objets</nom>
    1313        <!-- Gère la disponibilité d&#039;un objet -->
    1414
Note: See TracChangeset for help on using the changeset viewer.