Filelist / dr Blob

Un article de Typo3 CMS / Documentation Typo3 / Support Typo3.

EXT : Filelist

Clé d'extension : dr_blob Version : 1.4.0

Copyright 2000-2002, Daniel.Regelein@diehl-informatik.de, <Daniel.Regelein@diehl-informatik.de>

Ce document est publié sous licence Open Content disponible sur http://www.opencontent.org/opl.shtml

Le contenu de ce document est relatif à TYPO3 -Gnu/GPL CMS/Framework disponible sur www.typo3.com

[modifier] Introduction

[modifier] A quoi ça sert ?

Cette extension ajoute un plugin frontend pour afficher une liste de fichiers (Objets binaires). Les enregistrements sont administrés dans le Backend.

Pour le moment ce n'est pas un problème, mais les extensions font un peu plus de choses que ce que vous voyez : Les fichiers ne sont pas stockés dans le système de fichier mais dans la base de données, dans un champ blob (BLOb = Binary Large Object, Objet Binaire large).

A chaque fois qu'un enregistrement de type dr_blob est créé, le fichier téléchargé est noté et stocké dans une colonne de base de données.

Vous pouvez stocker jusqu'à 2 ^ 32 byte par case ; Ce qui fait 4GB (!) dans chaque case, suivant votre espace disque et les configurations d'upload dans php.ini et my.cnf.

Stocker les fichiers dans la base de données possède les avantages suivants :
1.Il est très facile de restreindre l'accés de ces enregistrements (par exemple avec FE-Groups).
2.Les enregistrements font partis du backup de la base de données du serveur.
3.L'espace disque de l'application serveur n'est pas beaucoup utilisé.
4.Le fichier n'existe pas physiquement sur le disque dur ...
5.... donc il est impossible de récuperer le fichier via URL-Hacking.

La liste d'enregistrements affichés peux être rétrécie en utilisant le dispositif standard de Typo3 starttime, endtime, hide et restrict access to a fe-group (restreindre l'accés à un groupe frontend).

Vous pouvez choisir, dans le frontend, entre une liste d'enregistrements commune et une liste d'objets spéciaux customizable (objets « VIP Â»), comparable au LASTEST-view dans tt_news.

Depuis la version 1.1.0 une fonction de recherche est incluse.

L'extension offre une liberté de design complète assurée en utilisant le template du moteur intégré de Typo3.

J'ai essayé de garder l'extension aussi dynamique que possible, donc presque tout le rendement est configurable via Typoscript ou via des templates.

Cette extension utilise des flexforms et n'étend pas le tt_content.

Depuis la version 1.4.0 un nouveau mode appelé Personnel est inclus. Ce mode permet aux utilisateurs frontend autorisés de souscrire à plusieurs listes de fichiers sur plusieurs pages pour afficher une liste des enregistrements de leur intérêt? Par conséquent uniquement les derniers enregistrements sont affichés. En utilisant cette fonction il est possible d'afficher des lites personnalisées pour chaque utilisateur.

[modifier] Photos d'écran

• Liste commune d'objets dans le frontend

• Liste d'objets spéciaux (VIP) dans le frontend

• Liste d'objets dans le Backend

• Masque d'entrée pour un enregistrement simple

• Recherche d'enregistrements

[modifier] Manuel de l'utilisateur

[modifier] Créer un nouvel enregistrement

Pour créer de nouveaux enregistrements vous devez sélectionner le Mode Liste. Sélectionnez le dossier système contenant les enregistrements à partir duquel le Plugin Frontend reçoit ses données. Ensuite cliquez simplement le lien 'Create new record' (créer un nouel enregistrement) ou cliquez le bouton correspondant :

Après avoir choisi 'Add new document' le masque suivant apparaitra :

Les champs marqués avec le point d'exclamation doivent être remplis.

[modifier] Champs d'un enregistrement.

Titre
Ce champ contient les titres des enregistrements et doit être rempli.

Description
C'est le texte principal de votre enregistrement. Selon votre éditeur de composant il est possible que l'éditeur montré dans les images ci-dessus varient du votre.

Nom de fichier
Le nom de fichier est uniquement necessaire si un fichier est attaché. Le champ est rempli automatiquement quand l'enregistrement est sauvegardé pour la première fois. Si l'enregistrement est déjà sauvegardé vous pouvez mettre un nom à votre convenance ici.

Taille du fichier
La taille du fichier est configuré automatiquement quand un fichier est attaché à l'enregistrement. Il contient le nombre de bytes contenus dans le fichier. Vous ne pouvez pas éditer ce champ.

Type de fichier
Le champ type de fichier est configuré automatiquement quand un fichier est attaché à l'enregistrement. Il contient le type de contenu du fichier attaché. Vous ne pouvez pas éditer ce champ.

Fichier
Ce champ est utilisé pour sélectionner le fichier pouvant être attaché au document. Pour sélectionner le fichier à partir du disque dur, cliquez sur le bouton correspondant 'parcourir' et choisissez le fichier. Quand l'enregistrement est sauvegardé, les champs Nom de fichier, Taille de fichier et Type de fichier sont configuré automatiquement.

Enregistrement VIP (Vip Record)
Cette zone cochable prépare l'enregistrement pour être montré sur le Top de la liste de votre site web. Si l'hameçon n'est pas configuré, l'enregistrement ne sera pas listé dans la Top liste.

Cacher (Hide)
Ce champ est l'un des quatre champs pour contrôler la visibilité d'un enregistrement. L'enregistrement ne sera pas affiché s'il est en mode caché.

Moment de départ (Startime)
Ce champ est l'un des quatre champs pour contrôler la visibilité d'un enregistrement. L'enregistrement ne sera pas affiché si la valeur du Moment de départ est un point dans le futur.

Moment de fin (Endtime)
Ce champ est l'un des quatre champs pour contrôler la visibilité d'un enregistrement. L'enregistrement ne sera pas affiché si la valeur du Moment de fin est un point dans le passé.

Accès
Ce champ est l'un des quatre champs pour contrôler la visibilité d'un enregistrement. L'enregistrement ne sera pas affiché si l'utilisateur actuel du fronted n'est pas un membre du groupe sélectionné ici. Vous pouvez aussi configurer cet enregistrement pour n'être apparent que si un utilisateur est connecté (indépendamment de l'affiliation à un groupe) ou si aucun utilisateur n'est connecté.

[modifier] Administration

[modifier] Configuration (système) nécessaire

Le tableau suivant montre les versions des différents systèmes nécessaire pour cette extension.

L'extension n'a pas été testée avec d'autres systèmes de management de bases de données pour le moment. Si vous le faites, n'hésitez pas à me signaler les résultats.

[modifier] Mise à jour

Rappelez vous de mettre à jour les Templates que vous avez configurés via la configuration TypoScript ou via la Configuration Plugin pour s'assurer d'avoir les marqueurs pour le mode PERSONNEL (PERSONAL-Mode)

[modifier] Installation

Installez cette extension simplement comme les autres extensions, en utilisant le manager d'extension. Ouvrez le manager d'extension en cliquant le bouton correspondant et sélectionnez le fichier de téléchargement d'extension. Cliquez Install Extension pour débuter l'installation.

Cliquez le bouton Make Updates (faire la mise à jour) pour faire les taches de mises à jour nécessaires. [effectuer les taches de mises à jour nécessaire]

Le plugin est maintenant installé et peux être sélectionné dans le manager de Plugin.

[modifier] Configuration du serveur

[modifier] Limites d'Upload de fichier

Ces configurations définissent si l'application serveur php accepte l'upload de fichier et de quel taille peuvent être ces fichiers.

php.ini

my.cnf

[modifier] Ajout de nouvelle liste de fichier à votre site web

Pour insérer un nouvel Element-Blob-liste de fichier dans une page, effectuez les étapes suivantes :

1.Allez à la page ou la liste de fichier doit être insérée et cliquez sur le bouton Create page content (Créer un contenu de page).
2.Sélectionnez l'option (Contenu de page) Pagecontent -->Click here for a wizard !

3.Sélectionnez le Plugin Liste d'Objet Binaire.Le nombre d'éléments listé ici varie de la votre.

4.Sélectionnez ou placer le plugin

5.Entrez un en-tête pour le plugin et cliquez sur le bouton sauvegarder.

6.Pour s'assurer que votre backend est propre vous pouvez créer une page avec le type Sysfolder comme entrée du stockage de données de la liste de fichier.

[modifier] Configuration du plugin

[modifier] Source de donnée

Sélectionnez le sysfolder / les pages ou se trouvent stockés les enregistrements en les sélectionnant dans le champ startingpoint (Moment de départ). Le niveau récursif configure le niveau des sous fichiers qui sont également inclus.

[modifier] Configurations

Ce qui devrait être affiché
Configurer quel type de .... hmmm, disons 'vue' ... pour placer sur cette page.

Le TOP-Mode est une liste d'objets pouvant être stockés dans dix dossiers différents. Le mode prends tout les objets visible pour l'utilisateur actuel et ou le flag 'Est Enregistré VIP' est configuré. J'ai eu besoin de ce mode pour sélectionner le meilleur document parmi un lot de dossiers et les afficher sur la page de départ. Ainsi vous pouvez sélectionner quelques enregistrements parmi une pile de contenu géante pour accrocher le regard par exemple. Ce mode trille les dates de création des objets.

Le LIST-Mode affiche une liste d'objets visibles à l'utilisateur actuel.

Le SINGLE-Mode affiche un objet unique identifié par un Flag dans l'URL. Cela n'a pas de sens qu'une page contienne ce type de vue de contenue autonome. Il s'agit plus de lier une page ou les enregistrements sont envoyés à partir du TOP – ou la LIST-Mode.

Le SEARCH-mode affiche une barre de recherche. Si quelqu'un recherche les sources de données pour un String, le champ titre, description et nom de fichier sont recherchés pour la valeur de recherche. La liste de résultat utilise les configurations et templates pour le mode liste.

Le PERSONAL-mode affiche une liste qui reçoit son contenu d'une liste de dossiers que chaque utilisateur connecté peux choisir pour lui même. Donc c'est une liste personnalisée de documents.

La valeur par défaut est le LIST-Mode.

Fichier Template
Vous donne la possibilité d'Uploader un fichier template pour les trois modes. Un Template d'exemple est placé dans le sous répertoire res dans le dossier racine de l'extension. Si aucun template n'est uploadé l'extension utiliseras ses propres templates standards.

Page ou afficher des objets seuls
Vous pouvez configurer sur quelle page un enregistrement devrait être affiché. Cette page nécessite aussi d'avoir un plugin de type dr_blob. Si rien n'est sélectionné, le plugin envoie l'enregistrement sur la page actuelle. Cette information n'a un sens que sur les pages ayant le plugin dr_blob et le type de vue TOP ou LIST.

Page ou revenir
Vous pouvez sélectionner sur quelle page le mode objet seul devrait revenir. Cette page nécessite aussi d'avoir un plugin de type dr_blob. Si rien n'est sélectionné, le plugin envoie l'enregistrement sur la page actuelle. Cette information n'a un sens que sur les pages ayant le plugin dr_blob et le type de vue SINGLE.

«Commandé par» ce champ (MODE LIST)
Configurez l'assortiment par défaut des enregistrements dans le mode LIST (Ainsi donc que la liste de résultats du mode recherche)

Croissant ou Décroissant
Configurez la direction de sortie par défaut des enregistrements dans le mode LIST (ainsi donc que la liste de résultats du mode recherche)

Nombre d'objets dans les modes LIST et TOP
Configurez le nombre d'objets des modes LIST et TOP que contiens la liste (ainsi donc que la liste de résultats du mode recherche)

Afficher «Ajouter au Panier Personnel» (Mode LIST)
Si cette valeur est configurée et que le mode de plugin actuel est le mode list, les utilisateurs autorisés trouveront un bouton leur donnant la possibilité d'ajouter les sources de données du plugin actuel à leur liste d'objet personnel les intéressant. Une fois que ce bouton est cliqué, il se transforme lui même en Retirer la sélection de ce dossier.

[modifier] Autorisation des éditeurs

Les champs suivant d'un enregistrement seul sont des champs d'exclusion et permettent ainsi une restriction d'accés.

[modifier] Utilisation du plugin

[modifier] La vue TOP (TOP-View)

La Vue-TOP affiche les objets ou le champ is_vip est configuré sur 1. J'ai eu besoin de cette fonction parce que j'avais pleins de pages contenant beaucoup d'enregistrements, stockés dans différents sysfolders. Donc j'avais besoin d'une fonction pour afficher le BestOf de ces Sysfolders.

[modifier] La vue PERSONNEL (PERSONAL-View)

Le mode PERSONNEL est une liste d'objets qui sont stockés dans le sysfolders que chaque utilisateur autorisé peux combiner selon ses besoins personnel. Les plugins utilisant le mode LIST peuvent être configurés pour afficher un bouton permettant à l'utilisateur d'ajouter ce sysfolder de plugin à ses favoris.

[modifier] La fonction RECHERCHE (SEARCH)

Premièrement ... : La fonction de recherche est toujours très inconfortable à utiliser. Ce sera actualisé avec la prochaine mise à jour. Pour utiliser le mode recherche, ajoutez simplement le plugin à une page et configurez le champ What to display (quoi afficher) pour rechercher (SEARCH). Déterminez le sysfolders que la fonction recherchera en utilisant la source de données – et le champ récursif. Les fonctions recherches le titre des colonnes, le nom de fichier et la description. Dans la prochaine version de cet extension, les champs dans lesquels rechercher seront configurable via typoscript. Les fonctionsaffichent une barre de recherche. Si quelqu'un recherche quelque chose, les résultats de la recherche sont affichés dans le mode List, donc il utilise les templates pour le mode LIST ainsi que les paramètres Tuposcript pour le mode liste.

[modifier] Configuration

[modifier] Templates

Si vous n'attachez pas de template dans la configuration du plugin et n'entrez pas de fichier de template dans le Setup de TypoScript, le pluginutilise quelques templates standards. Voir priorité de fichier Template (Template file priority) pour les information supplémentaires. Ce fichier est localisé dans le dossier res dans le répertoire racine d'extension. Il y a un template pour chaque type de vue (list, top, single).

[modifier] Priorité de fichier template

Il y a trois moyens possibles pour le plugin d'afficher un template : Sélectionner un fichier template en utilisant la configuration plugin (flexform), sélectionner un template en utilisant le Setup de TypoScript, ou laisser les deux vides pour utiliser les fichiers de template standard. Pour éviter d'avoir les fichiers templates j'ai défini une hiérarchie plate (de la plus haute priorité 1 jusqu'à la basse priorité 3) :

Si les deux (Configuration plugin et Setup TypoScript) sont laissé vide, l'extension utilisera les Templates standards internes, localisés dans le répertoire res de l'extension. Si un fichier template valide est entré dans la configuration plugin, ce fichier sera utilisé. Il recouvrira les configurations fait dans le Setup de TypoScript.

[modifier] Référence Template

Il y a aussi un fichier appelé dr_blob.tmpl, contenant les templates par défaut pour tout les modes possibles. Je vous suggère de construire vos templates en modifiant ce fichier. Il est localisé dans le sous dossier res sous le répértoire racine de l'extension, habituellement typo3conf/ext/dr_blob/res. Le mode recherche possède ses propre marqueur de template, appelé ###TEMPLATE_SEARCH###. Les retours des résultats de recherches sont affichés dans le mode list ( ###TEMPLATE_LIST### ), et ainsi le template pour le mode list est aussi utilisé. Si une recherche ne retourne aucune résultat, le marqueur ###TEMPLATE_SEARCH_NOITEMS### est utilisé.

[modifier] Sous parties de Template

[modifier] Marqueur de template

Ce chapitre montre quels marqueurs sont disponibles pour les quatres types de template différents (LIST, TOP, SINGLE, SEARCH)

LIST, PERSONAL, SINGLE, TOP

Recherche (SEARCH)

Ajout Personnel / Retrait Personnel (PERSONAL_ADD / PERSONAL_REMOVE)

[modifier] Référence TypoScript

 plugin.tx_drblob_pi1 {
   templateFile = fileadmin/template.tmpl
  }

Vue de liste (ListView) Les options listées ci-dessous sont modifiées en utilisant l'objet TS plugin.tx_drblob_pi1.listView

 plugin.tx_drblob_pi1.listView {
   date_sdtWrap = d.m.Y h:i
 }

[plugin.tx_drblob_pi1.listView]

Vue Personnel (Personal-View) Les options listées ci-dessous sont modifiées en utilisant l'objet TS plugin.tx_drblob_pi1.personalView

 plugin.tx_drblob_pi1.listView {
   date_sdtWrap = d.m.Y h:i
 }

[plugin.tx_drblob_pi1.personalView]

Vue seule (Single View) Les options listées ci-dessous sont modifiées en utilisant l'objet TS plugin.tx_drblob_pi1.singleView

   plugin.tx_drblob_pi1.listView {
     date_sdtWrap = d.m.Y h:i
   }

[plugin.tx_drblob_pi1.singleView]

Vue Top (Top-View) Les options listées ci-dessous sont modifiées en utilisant l'objet TS plugin.tx_drblob_pi1.topView

 plugin.tx_drblob_pi1.listView {
   date_sdtWrap = d.m.Y h:i
 }

[plugin.tx_drblob_pi1.topView]

Exemple

 plugin {
   tx_drblob_pi1 {
     templateFile = fileadmin/template.tmpl
 
     listView {
       showButtonValue = <img src="fileadmin/pictures/icons/show.gif" border="0" />
       downloadButtonValue = [ get File ]
       date_stdWrap = d.m.Y
       alternatingLayouts = 2
     }
 
     singleView {
       date_stdWrap = d.m.Y
     }
 
     topView {
       lengthOfDescription = 250
       date_stdWrap = d.m.Y H:i
       alternatingLayouts = 2
     }
 
     personalView {
       lengthOfDescription = 250
       date_stdWrap = d.m.Y H:i
       alternatingLayouts = 2
     }
   }
 }

[modifier] Problèmes connus

• Les enregistrement localisés montrent toujours le contenu de l'enregistrement en accord à celui par défaut. Ainsi le contenu de fichier est stocké dans la base de données, c'est très très moche...
• Télécharger un fichier en utilisant IE6 et https provoque une erreur. Merci à Gabi Breitmeier pour l'avertissement.

[modifier] Choses à faire

Moyenne priorité

• Créer un fichier attaché effaçable.
• Permettre .LOCAL_LANG.xx pour Typo Script.
• Simplifier le code source, consolider plusieurs méthodes.

faible priorité

• Classer les enregistrements par catégories.
• Les dispositifs de template et marqueurs doivent être plus confortable et professionnels.

[modifier] Liste des Modifications