Codification.php 17.4 KB
Newer Older
llaffont's avatar
llaffont committed
1 2 3 4
<?php
/**
 * Copyright (c) 2012, Agence Française Informatique (AFI). All rights reserved.
 *
Laurent's avatar
Laurent committed
5
 * BOKEH is free software; you can redistribute it and/or modify
llaffont's avatar
llaffont committed
6 7 8 9 10 11
 * it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
 * the Free Software Foundation.
 *
 * There are special exceptions to the terms and conditions of the AGPL as it
 * is applied to this software (see README file).
 *
Laurent's avatar
Laurent committed
12
 * BOKEH is distributed in the hope that it will be useful,
llaffont's avatar
llaffont committed
13 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU AFFERO GENERAL PUBLIC LICENSE
Laurent's avatar
Laurent committed
18
 * along with BOKEH; if not, write to the Free Software
Laurent's avatar
Laurent committed
19
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
llaffont's avatar
llaffont committed
20 21
 */

22 23 24 25 26 27 28

/**
 * Liste des codes utilisés:
 * A: auteur
 * B: bib
 * C: collection
 * D: dewey
29
 * E: emplacement
30 31 32 33 34 35 36 37 38 39 40
 * F: centre intérêt
 * G: genre
 * H: thésaurus
 * I: identifiant
 * J: titre
 * K: collation
 * L: langue
 * M: matière
 * N: année
 * O: notes
 * P: pcdm4
41
 * Q: domain for pseudo record
42 43 44
 * R: résumé
 * S: section
 * T: type de doc
45
 * U: vignette/image
46
 * V: disponibilité
47
 * W: éditeur
48
 * X: index dewey pcdm4
49 50
 * Y: annexe
 * Z: tag
51
 * 5: données autorités
52 53 54
 * 8: urlg
 * 9: nouveauté
 */
55
class Class_Codification {
Patrick Barroca's avatar
Patrick Barroca committed
56 57
  use Trait_Singleton, Trait_Translator;
  const
58
    CHAMPS = 'JAKEFCNMDGHPILOR8QW5',
Patrick Barroca's avatar
Patrick Barroca committed
59
    CODE_COLLECTION = 'C',
60
    CODE_EDITEUR = 'W',
Patrick Barroca's avatar
Patrick Barroca committed
61 62 63 64 65 66 67
    CODE_IDENTIFIANT = 'I',
    CODE_TITRE = 'J',
    CODE_COLLATION = 'K',
    CODE_ANNEE = 'N',
    CODE_NOTES = 'O',
    CODE_PRIX = 'Q',
    CODE_RESUME = 'R',
68 69
    CODE_AVAILABILITY='V',
    CODE_AUTHORITY_DATAS='5',
Patrick Barroca's avatar
Patrick Barroca committed
70
    CODE_URL = '8',
71 72 73
    CODE_NOUVEAUTE = '9',
    CODE_INDEX_DEWEY_PCDM4 = 'X',
    CODE_THUMBNAIL = 'U';
Patrick Barroca's avatar
Patrick Barroca committed
74 75


76 77 78
  protected
    $_nom_champs,
    $_nom_onglets;
Patrick Barroca's avatar
Patrick Barroca committed
79 80 81 82 83 84 85 86


  public function getTypesDocs()  {
    return Class_TypeDoc::allByIdLabel();
  }


  public function getCodesLibellesFacette($concatenated_facettes) {
87
    return Class_Notice_RubriqueFacette::parseRubriquesFromPreferenceField($concatenated_facettes);
Patrick Barroca's avatar
Patrick Barroca committed
88 89 90 91 92 93 94 95 96
  }


  public function getLibelleFacette($rubrique)  {
    $type=$rubrique[0];
    if (!$id=substr($rubrique,1))
      return '';

    switch($type) {
97
      case Class_Codification::CODE_INDEX_DEWEY_PCDM4:
Patrick Barroca's avatar
Patrick Barroca committed
98
        $lib=[" ", $this->_('Livres et Vidéos'), $this->_('Musique')];
Laurent's avatar
Laurent committed
99 100
        $l=Class_AdminVar::get("FACETTE_PCDM4_LIBELLE"); if(trim($l)) $lib[2]=$l;
        $l=Class_AdminVar::get("FACETTE_DEWEY_LIBELLE"); if(trim($l)) $lib[1]=$l;
Patrick Barroca's avatar
Patrick Barroca committed
101
        return $lib[intval($id)];
Ghislain Loas's avatar
Ghislain Loas committed
102 103
      case Class_CodifDewey::CODE_FACETTE:              return Class_CodifDewey::getLibelleOf($id);
      case Class_CodifPcdm4::CODE_FACETTE:              return Class_CodifPcdm4::getLibelleOf($id);
Patrick Barroca's avatar
Patrick Barroca committed
104 105 106 107 108 109 110 111 112
      case Class_Codification::CODE_AVAILABILITY:       return ($bib            = Class_Bib::find((int)$id))                                ? $bib->getLibelle()             : '';
      case Class_CodifThesaurus::CODE_FACETTE:          return ($thesaurus      = Class_CodifThesaurus::findFirstBy(['id_thesaurus'=>$id]))   ? $thesaurus->getLibelleFacette(): '';
      case Class_CodifAuteur::CODE_FACETTE:             return ($auteur         = Class_CodifAuteur::find($id))                               ? $auteur->getLibelle()          : '';
      case Class_CodifMatiere::CODE_FACETTE:            return ($matiere        = Class_CodifMatiere::find((int)$id))                         ? $matiere->getLibelle()         : '';
      case Class_CodifCentreInteret::CODE_FACETTE:      return ($interet        = Class_CodifCentreInteret::find((int)$id))                   ? $interet->getLibelle()         : '';
      case Class_CodifGenre::CODE_FACETTE:              return ($genre          = Class_CodifGenre::find((int)$id))                           ? $genre->getLibelle()           : '';
      case Class_CodifLangue::CODE_FACETTE:             return ($langue         = Class_CodifLangue::find($id))                               ? $langue->getLibelle()          : '';
      case Class_CodifSection::CODE_FACETTE:            return ($section        = Class_CodifSection::find((int)$id))                         ? $section->getLibelle()         : '';
      case Class_CodifEmplacement::CODE_FACETTE:        return ($emplacement    = Class_CodifEmplacement::find((int)$id))                     ? $emplacement->getLibelle()     : '';
113
      case Class_Bib::CODE_FACETTE:                  return ($bib            = Class_Bib::find((int)$id))                               ? $bib->getLibelle()            : '';
Patrick Barroca's avatar
Patrick Barroca committed
114 115
      case Class_CodifAnnexe::CODE_FACETTE:             return ($annexe         = Class_CodifAnnexe::findFirstBy(['code' => addslashes($id)]))? $annexe->getLibelle()          : '';
      case Class_CodifTags::CODE_FACETTE:               return ($tag            = Class_CodifTags::find((int)$id))                            ? $tag->getLibelle()             : '';
116
      case Class_TypeDoc::CODE_FACETTE:                 return ($type_doc       = Class_TypeDoc::find($id))                              ? $type_doc->getLabel()          : '';
Patrick Barroca's avatar
Patrick Barroca committed
117 118 119 120 121 122 123 124 125
    }
    return '';
  }


  public function genereNomsChamps () {
    if (isset($this->_nom_champs))
      return;

126
    $this->_nom_champs =
127 128 129 130 131 132 133 134 135 136 137 138
      [Class_CodifAuteur::CODE_FACETTE           => [    $this->_("Auteur"),          $this->_( "Auteur(s)")],
       Class_Bib::CODE_FACETTE                   => [    $this->_("Bibliothèque"),    $this->_("Bibliothèque(s)")],
       Class_Codification::CODE_COLLECTION       => [    $this->_("Collection"),      $this->_("Collection(s)")],
       Class_CodifDewey::CODE_FACETTE            => [    $this->_("Livres et Vidéos"),$this->_("Livres et Vidéos")],
       Class_Codification::CODE_EDITEUR          => [    $this->_("Editeur"),         $this->_("Editeur(s)")],
       Class_CodifCentreInteret::CODE_FACETTE    => [    $this->_("Centre d'intérêt"),$this->_("Centre(s) d'intérêt")],
       Class_CodifGenre::CODE_FACETTE            => [    $this->_("Genre"),           $this->_("Genre")],
       Class_Codification::CODE_IDENTIFIANT      => [    $this->_("Identifiant"),     $this->_("Identifiant")],
       Class_Codification::CODE_TITRE            => [    $this->_("Titre"),           $this->_("Titre(s)")],
       Class_Codification::CODE_COLLATION        => [    $this->_("Collation"),       $this->_("Collation")],
       Class_CodifLangue::CODE_FACETTE           => [    $this->_("Langue"),          $this->_("Langue(s)")],
       Class_CodifMatiere::CODE_FACETTE          => [    $this->_("Sujet"),           $this->_("Sujet(s)")],
139
       Class_Codification::CODE_ANNEE            => [    $this->_("Année"),           $this->_("Année")],
140 141 142 143 144 145 146 147 148
       Class_Codification::CODE_NOTES            => [    $this->_("Notes"),           $this->_("Notes")],
       Class_CodifPcdm4::CODE_FACETTE            => [    $this->_("Musique"),         $this->_("Musique")],
       Class_Codification::CODE_RESUME           => [    $this->_("Résumé"),          $this->_("Résumé")],
       Class_CodifSection::CODE_FACETTE          => [    $this->_("Section"),         $this->_("Section")],
       Class_TypeDoc::CODE_FACETTE               => [    $this->_("Type de document"),$this->_("Types de documents")],
       Class_CodifAnnexe::CODE_FACETTE           => [    $this->_("Site"),            $this->_("Site")],
       Class_CodifTags::CODE_FACETTE             => [    $this->_("Tag"),             $this->_("Tag(s)")],
       Class_Codification::CODE_URL              => [    $this->_("Lien internet"),   $this->_("Liens internet")],
       Class_Codification::CODE_AVAILABILITY     => [    $this->_("En rayon"),        $this->_("En rayon")],
149
       Class_Codification::CODE_NOUVEAUTE        => [    $this->_("Nouveauté"),       $this->_("Nouveauté")],
150
       Class_Codification::CODE_PRIX             => [    $this->_("Prix"),            $this->_("Prix")],
151
       Class_CodifEmplacement::CODE_FACETTE      => [    $this->_('Emplacement'),     $this->_('Emplacement')],
152
       Class_Codification::CODE_THUMBNAIL        => [    $this->_('Vignette'),        $this->_('Vignette')],
153
       Class_Codification::CODE_AUTHORITY_DATAS  => [    $this->_('Autorité'),        $this->_('Autorité')],];
Patrick Barroca's avatar
Patrick Barroca committed
154 155 156 157 158 159 160 161 162 163 164 165

    $this->addThesauriToNomChamps();
    $this->setFacetDisplayNames();
  }


  protected function setFacetDisplayNames() {
    $var_codes = ['FACETTE_PCDM4_LIBELLE' => Class_CodifPcdm4::CODE_FACETTE,
                  'FACETTE_DEWEY_LIBELLE' => Class_CodifDewey::CODE_FACETTE,
                  'FACETTE_TYPE_DOC_LIBELLE' => Class_TypeDoc::CODE_FACETTE,
                  'FACETTE_LANGUE_LIBELLE' => Class_CodifLangue::CODE_FACETTE,
                  'FACETTE_GENRE_LIBELLE' => Class_CodifGenre::CODE_FACETTE,
166
                  'FACETTE_SITE_LIBELLE' => Class_Bib::CODE_FACETTE,
Patrick Barroca's avatar
Patrick Barroca committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
                  'FACETTE_SECTION_LIBELLE' => Class_CodifSection::CODE_FACETTE,
                  'FACETTE_BIBLIOTHEQUE_LIBELLE' => Class_CodifAnnexe::CODE_FACETTE,
                  'FACETTE_AUTEUR_LIBELLE' => Class_CodifAuteur::CODE_FACETTE,
                  'FACETTE_INTERET_LIBELLE' => Class_CodifCentreInteret::CODE_FACETTE,
                  'FACETTE_MATIERE_LIBELLE' => Class_CodifMatiere::CODE_FACETTE,
                  'FACETTE_TAG_LIBELLE' => Class_CodifTags::CODE_FACETTE];

    foreach($var_codes as $var => $code) {
      $label = Class_AdminVar::get($var);
      if (trim($label)) {
        $this->_nom_champs[$code][0] = $label;
        $this->_nom_champs[$code][1] = $label;
      }
    }
  }


184 185 186 187
  public function addThesauriToNomChamps() {
    foreach (Class_CodifThesaurus::getFacettesThesauri() as $model) {
      $this->_nom_champs[$model->getFacetteIndex()] = [$model->getLibelleFacette(),
                                                       $model->getLibelleFacette()];
Patrick Barroca's avatar
Patrick Barroca committed
188 189 190 191 192
    }
  }


  function getNomChamp($code,$pluriel=0)  {
193 194
    if ($code[0] == Class_CodifThesaurus::CODE_FACETTE)
      $type = $code;
Patrick Barroca's avatar
Patrick Barroca committed
195
    else
196
      if (!$type = $code[0])
Patrick Barroca's avatar
Patrick Barroca committed
197 198 199 200
        return '';

    self::genereNomsChamps();

201
    if ($code == 'tous') {
Patrick Barroca's avatar
Patrick Barroca committed
202 203 204 205 206
      foreach($this->_nom_champs as $key => $valeur)
        $lib[$key]=$valeur[0];
      return $lib;
    }

207 208
    return isset($this->_nom_champs[$type][$pluriel]) ?
      $this->_nom_champs[$type][$pluriel] : '';
Patrick Barroca's avatar
Patrick Barroca committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
  }


  function getNomFacette($code) {
    return self::getNomChamp($code);
  }


  function genereNomsOnglets () {
    if (isset($this->_nom_onglets))
      return;

    $translate = Zend_Registry::get('translate');

    $this->_nom_onglets = [
Ghislain Loas's avatar
Ghislain Loas committed
224 225 226 227 228 229
                           "detail"        => Class_Onglet::forLibelleAndType($translate->_("Description du document"),'detail'),
                           "avis"          => Class_Onglet::forLibelleAndType($translate->_("Critiques"),'avis'),
                           "exemplaires"   => Class_Onglet::forLibelleAndType($translate->_("Exemplaires"),'exemplaires'),
                           "resume"        => Class_Onglet::forLibelleAndType($translate->_("Résumés"),'resume'),
                           "tags"          => Class_Onglet::forLibelleAndType($translate->_("Rebondir dans le catalogue"),'tags'),
                           "biographie"    => Class_Onglet::forLibelleAndType($translate->_("Biographie de l'auteur"),'biographie'),
230
                           "series"        => Class_Onglet::forLibelleAndType($translate->_("Documents de la même série"),'series')->setDisplayMethod('hasClefChapeau'),
Patrick Barroca's avatar
Patrick Barroca committed
231
//    "auteur"        => Class_Onglet::forLibelleAndType($translate->_("Documents du même auteur"),'auteur'),
Ghislain Loas's avatar
Ghislain Loas committed
232 233 234 235 236 237
                           "similaires"    => Class_Onglet::forLibelleAndType($translate->_("Documents similaires"),'similaires'),
                           "bibliographie" => Class_Onglet::forLibelleAndType($translate->_("Discographie"),'bibliographie'),
                           "morceaux"      => Class_Onglet::forLibelleAndType($translate->_("Morceaux"),'morceaux'),
                           "bandeAnnonce"  => Class_Onglet::forLibelleAndType($translate->_("Bande-annonce"),'bandeAnnonce'),
                           "photos"        => Class_Onglet::forLibelleAndType($translate->_("Photos"),'photos'),
                           "videos"        => Class_Onglet::forLibelleAndType($translate->_("Archives vidéo"),'videos'),
238
                           "resnumeriques" => Class_Onglet::forLibelleAndType($translate->_("Ressources numériques"),'resnumeriques')->setDisplayMethod('hasNumericRessources'),
Ghislain Loas's avatar
Ghislain Loas committed
239
                           "babeltheque"   => Class_Onglet::forLibelleAndType($translate->_('Babelthèque'),'babeltheque'),
240 241
                           'frbr'          => Class_Onglet::forLibelleAndType($translate->_('Notices liées'),'frbr')->setDisplayMethod('hasLinkedNotices'),
                           'recounts'      => Class_Onglet::forLibelleAndType($this->_('Contient'), 'recounts')->setDisplayMethod('hasRecounts')];
Patrick Barroca's avatar
Patrick Barroca committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
  }


  function getOnglet($onglet) {
    self::genereNomsOnglets();
    return $onglet ? $this->_nom_onglets[$onglet] : Class_Onglet::forLibelleAndType($onglet,$onglet);

  }


  function getAllOnglets() {
    self::genereNomsOnglets();
    return $this->_nom_onglets;
  }


  function getNomOnglet($onglet)  {
    self::genereNomsOnglets();
    return $onglet ? $this->_nom_onglets[$onglet]->getLibelle() : $this->_nom_onglets;
  }


  public static function getLibelleForSerie($notice) {
265 266 267
    if(!$notice)
      return '';

Laurent's avatar
Laurent committed
268 269 270 271 272 273 274 275 276
    $prefix = function($notice) {
      $me = new static();

      if ($notice->isDVD())
        return $me->_('Voir tous les épisodes');

      if (!$notice->isPeriodique())
        return $me->_('Voir tous les tomes');

277
      if ($notice->isFirstItemTypeSerialArticle())
Laurent's avatar
Laurent committed
278 279 280 281 282
        return $me->_('Voir tous les articles de ce numéro');

      return $me->_('Voir tous les numéros');
    };

283

Laurent's avatar
Laurent committed
284 285
    return self::concatLibelleWithTitreChapeau($prefix($notice),
                                               $notice->getTitreChapeau());
Patrick Barroca's avatar
Patrick Barroca committed
286
  }
287 288


Patrick Barroca's avatar
Patrick Barroca committed
289 290 291 292 293 294
  public static function concatLibelleWithTitreChapeau($libelle,$chapeau) {
    $first_letter = substr($chapeau, 0, 1);
    if (in_array($first_letter, ['H','E','A','I','O','U']))
      return $libelle . ' d\'' . $chapeau;
    return $libelle . ' de ' . $chapeau;
  }
295 296


Patrick Barroca's avatar
Patrick Barroca committed
297
  public function cleanDeletedFacets($concat_facets) {
298 299 300 301
    $codes = [];
    $facets = $this->getCodesLibellesFacette($concat_facets);
    foreach ($facets as $facet) {
      if (!$label = $facet->getLibelle())
Patrick Barroca's avatar
Patrick Barroca committed
302
        continue;
303 304

      $codes[] = $facet->getCode();
Patrick Barroca's avatar
Patrick Barroca committed
305
    }
306

307 308
    return implode(';', $codes);
  }
Patrick Barroca's avatar
Patrick Barroca committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348


  public function getCodesFor($type) {
    if ('libelles' == $type)
      return $this->getNomChamp('tous');

    if ('liste' == $type)
      return $this->getCodesForList();

    if ('facettes' == $type)
      return $this->getCodesForFacets();

    if ('tags' == $type)
      return $this->getCodesForTags();

    if ('champs' == $type)
      return $this->getCodesForFields();

    if (in_array($type, ['type_tags', 'champs_tags']))
      return $this->getCodesForTypeOrFieldTags();

    return [];
  }


  public function getCodesForList() {
    return [static::CODE_TITRE,
            Class_TypeDoc::CODE_FACETTE,
            Class_CodifAuteur::CODE_FACETTE,
            static::CODE_ANNEE,
            static::CODE_EDITEUR,
            static::CODE_COLLECTION,
            static::CODE_RESUME,
            static::CODE_NOUVEAUTE,
            Class_CodifCentreInteret::CODE_FACETTE,
            static::CODE_URL];
  }


  public function getCodesForFacets() {
349 350 351 352 353 354 355 356 357 358 359 360 361
    $facets = [Class_CodifAuteur::CODE_FACETTE,
               Class_CodifCentreInteret::CODE_FACETTE,
               Class_CodifMatiere::CODE_FACETTE,
               Class_CodifEmplacement::CODE_FACETTE,
               Class_CodifDewey::CODE_FACETTE,
               Class_CodifPcdm4::CODE_FACETTE,
               Class_CodifLangue::CODE_FACETTE,
               Class_CodifGenre::CODE_FACETTE,
               Class_CodifSection::CODE_FACETTE,
               Class_Bib::CODE_FACETTE,
               Class_CodifAnnexe::CODE_FACETTE,
               Class_CodifTags::CODE_FACETTE,
               static::CODE_AVAILABILITY];
Patrick Barroca's avatar
Patrick Barroca committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405

    return array_merge($facets,
                       Class_CodifThesaurus::getFacettesIndex());
  }


  public function getCodesForFields() {
    return [Class_TypeDoc::CODE_FACETTE,
            static::CODE_TITRE,
            Class_CodifAuteur::CODE_FACETTE,
            Class_CodifMatiere::CODE_FACETTE,
            Class_CodifDewey::CODE_FACETTE,
            Class_CodifPcdm4::CODE_FACETTE,
            Class_CodifLangue::CODE_FACETTE,
            Class_CodifGenre::CODE_FACETTE,
            Class_CodifSection::CODE_FACETTE,
            Class_Bib::CODE_FACETTE,
            static::CODE_EDITEUR,
            static::CODE_COLLECTION,
            static::CODE_ANNEE,
            static::CODE_RESUME,
            static::CODE_NOUVEAUTE,
            Class_CodifCentreInteret::CODE_FACETTE];
  }


  public function getCodesForTags() {
    return [Class_CodifAuteur::CODE_FACETTE,
            Class_CodifCentreInteret::CODE_FACETTE,
            Class_CodifMatiere::CODE_FACETTE,
            Class_CodifDewey::CODE_FACETTE,
            Class_CodifPcdm4::CODE_FACETTE,
            Class_CodifTags::CODE_FACETTE];
  }


  public function getCodesForTypeOrFieldTags() {
    return [Class_CodifAuteur::CODE_FACETTE,
            Class_CodifMatiere::CODE_FACETTE,
            Class_CodifDewey::CODE_FACETTE,
            Class_CodifPcdm4::CODE_FACETTE,
            Class_CodifTags::CODE_FACETTE,
            Class_CodifAnnexe::CODE_FACETTE];
  }
406 407 408 409 410 411 412 413 414 415


  public function getId() {
    return '';
  }


  public function getLibelle() {
    return $this->_('Codification');
  }
llaffont's avatar
llaffont committed
416
}