Création / modification / suppression d'un objet

Définition

Un module est composé d'un ou plusieurs objets. Un « objet » est en fait la structure qui englobe les informations d'un élément. Ces informations sont structurées et définies avec des champs.

Création / modification

Lorsqu'un nouvel objet est créé et qu'il possède au moins 1 champ, il devient possible de créer de nouveaux éléments de cet objet.

Exemple : Pour le module « Actualités » on a un objet « Actualité » qui possède plusieurs champs (titre, catégorie, etc). Une fois cette structure mise en place, il est possible de créer des éléments « Actualité », chacun ayant des données spécifiques pour chaque champ : ce seront les différentes actualités affichées sur le site.

Le nombre d'objets par module n'est pas limité, cependant dans la pratique il est rare d'avoir plus de 5 objets pour un même module. Tout dépend de la structure de votre module.

Notez qu'un objet appartenant à un module ne peut pas être utilisé par un objet appartenant à un module différent. Cette information doit être prise en compte avant le développement de vos rangées.

Toutefois, si un plugin WYSIWYG est associé à un objet d'un module, ce plugin peut être disponible pour tous les champs de type texte, et pour tous les modules polymod. Voir la documentation associée au plugin WYSIWYG.

Suppression

Pour supprimer un objet il faut que cet objet ne possède pas de champs. Si un objet possède déjà des champs, il faut donc les supprimer avant de supprimer l'objet lui-même.

En supprimant un objet :

  • Vous rendez inaccessible l'ensemble des éléments qui ont été créés avec cet objet.
  • Les champs d'autres objets qui possèdent des liaisons avec l'objet supprimé ne seront plus disponibles.
  • Il faut supprimer toute référence à cet objet dans les rangées de vos pages, sans quoi les rangées pourraient appeler un objet inexistant et renvoyer des erreurs.

Propriétés

Formulaire de création

Lors de la création ou de de la modification d'un objet, un formulaire permet de renseigner les champs suivants :

  • Titre : Libellé de l'objet. Cette information apparaîtra lors de la création des éléments de cet objet. Par exemple « Actualité ».
  • Description : Permet de décrire l'objet plus en détail. Par exemple en décrivant sa fonction : pour « Actualité » nous pouvons indiquer « Représente une actualité publiée sur le site ».
  • Ressource : Indique le type de ressource de l'objet : 3 choix sont disponibles :
    • Ressource primaire : L'objet sera soumis au processus de validation : il y aura donc plusieurs statut pour chaque élément, notamment « en édition » et « publié ». Le changement de statut est soumis à validation.

    • A noter qu'1 seul objet par module peut posséder un type de ressource primaire.

    • Ressource secondaire : L'objet dépend d'un objet en ressource primaire : en cas de modifications de l'objet en ressource secondaire les changements ne seront appliqués qu'une fois que son parent, en ressource primaire, aura été validé. Il peut y avoir plusieurs objets en ressource secondaire par module.
    • Aucune ressource : L'objet n'est pas soumis au processus de validation : la notion de statut n'existe pas et toute modification d'un élément est prise en compte immédiatement.
  • Indexation : Ce champ est uniquement disponible si le module « Moteur de recherche » (ASE, Automne Search Engine) est installé.
    • Si la case est cochée, l'objet sera indexé par le moteur de recherche.

    • Attention : si l'objet en question appartient en tant que champ à un objet indexé (en tant que sous-objet d'un autre objet indexé), il est inutile de l'indexer.
    • La zone de texte « Adresse du lien vers l'objet » permet de définir une adresse dynamique qui sera utilisé par le lien dans la liste des résultats affichés par le moteur de recherche. Cette adresse est requise pour permettre de cliquer sur le résultat renvoyé par le moteur de recherche. Habituellement cette adresse pointe vers une page qui affiche le détail de l'élément.

Attention : les caractères spéciaux doivent être correctement encodés. Par exemple le « & » devient un « &».

A noter que l'indexation de l'objet est effectuée ici, mais il convient de définir également quels champs de l'objet seront indexés par le moteur de recherche, sans quoi le moteur ne saurait pas quelles données indexer. Voir la section Champs d'un objet polymod.

Formulaire de modification

Lors de la modification d'un objet les champs suivants sont disponibles, en plus de ceux précédemment cités :

  • Libellé composé : Permet de définir un libellé construit dynamiquement à partir des données des champs de l'objet. Par exemple pour l'objet « Actualité » nous pourrions souhaiter indiquer la mention « Actualité » et la date de publication de l'élément. Dans ce cas nous indiquerions le libellé suivant : « Actualité {Actualite:formatedDateStart|d/m/Y}». 
  • Adresse de prévisualisation : permet de définir l'adresse vers laquelle pointent les liens de prévisualisation, disponibles lorsqu'on affiche la liste des éléments côté administration d'Automne. Par exemple : « {page:14:url}?id={Actualite:id} » indique que le lien pointera vers la page 14 en passant l'identifiant de l'élément en paramètre.
  • Visible sur l'accueil du module : permet d'afficher ou non le lien vers l'administration des éléments côté administration. En laissant cette case décochée vous interdisez l'accès à la modification des éléments côté administration. Cette fonction peut être utile si vous ne souhaitez pas que certains utilisateurs accèdent à la modification de certains éléments.
  • Affichage des résultats côté admin : permet de définir un affichage personnalisé des éléments lorsqu'on les affiche en liste, côté administration d'Automne.

  • Notez que l'interface d'administration possède un affichage par défaut, et se base sur les paramètres des champs de chaque objet : tous les champs dont le paramètre « Visible dans les résultats d'une recherche » est activé s'afficheront dans l'interface. 

Résumé de l'objet

Lorsque l'objet est créé et sélectionné, un résumé de ses propriétés s'affiche :

  • Description : Affiche la description de l'objet
  • Ressource : Indique le type de ressource de l'objet (ressource primaire, secondaire, ou aucune ressource)
  • Visible sur l'accueil du module : Indique si l'objet sera accessible depuis l'interface d'administration du module.
  • Libellé composé : Indique si l'objet possède un libellé composé.
  • Utilisation de l'objet par d'autres objets : Indique si cet objet est utilisé par un autre objet.

Structure de l'objet

Lorsque l'objet est créé, sélectionné, et possède au moins 1 champ, il devient possible d'afficher sa structure. Cliquez sur le bouton « Structure » :

La structure affiche tous les champs de l'objet de façon arborescente, de façon à détailler la composition de l'objet de manière exhaustive. Certains champs sont en effet constitués d'autres objets appartenant au même module. Voir la documentation sur les champs polymod.

Apparaissent en grisés les champs qui sont au 3ème niveau ou plus dans l'arborescence de l'objet. Ces champs ne seront pas accessibles lors d'une recherche simple sur l'objet. Pour des raisons de performances ces sous-objets ne sont pas chargés automatiquement.

Cependant il est possible de forcer le chargement automatique de ces champs : c'est un paramètre qu'il faut activer.

Notez que cette fonction est rarement utilisée car elle peut causer de forts ralentissement dans le traitement des données. Voir la documentation sur les champs polymod.

Liste des champs de l'objet

Lorsqu'un objet est sélectionné tous ses champs sont affichés sous forme de tableau :

  • Titre : Libellé du champ.
  • Type de données : type de données, parmi ceux disponibles.
  • Description : description textuelle du champ.
  • Actions : Boutons pour supprimer ou modifier le champ.
  • Ordre : Vous permet de modifier l'ordre d'affichage des champs avec un glisser-déposer. Lorsque vous déplacez un champ, le bouton « Sauvegarder l'ordre le nouvel ordre » apparaît à la fin de la liste des champs. Ce bouton enregistre l'ordre actuellement visible.

Actions

  • Pour créer un objet cliquez sur « Nouveau ».
  • Vous pouvez également choisir de modifier un objet existant en le sélectionnant puis en cliquant sur « Modifier ».

 



Ajouter une contribution :

Les contributions servent à compléter la documentation en détaillant des points précis ou pour donner des exemples. Elles sont modérées et peuvent être supprimées sans préavis.
Pour poser des questions, merci d'employer le forum et pour rapporter un bug, le BugTracker est à votre disposition.








Vous pouvez employer les balises bbcode suivantes :
  • [code-xml] votre code ... [/code-xml] : Pour mettre en forme du code XML / XHTML
  • [code-php] votre code ... [/code-php] : Pour mettre en forme du code PHP
  • [code-js] votre code ... [/code-js] : Pour mettre en forme du code Javascript

Date de votre contribution : 20/10/2017   16:22:59

Haut