Classe: Page

---

Classe permettant d'intéragir avec les pages.

Elle étend les enregistrements de type page.

---

Utilisation

Afficher une variable :

{{ page.id }}

Afficher la valeur de retour d'une fonction :

{{ page.renderPagination() }}

Récupérer la valeur de retour d'une fonction dans une variable :

{% set parent = page.getParent() %}

---

Variables

Liste des variables défini pour chaque page. A cela s'ajoute la liste des variables spécifiques au type de la page tel que défini dans GestiXi.

---

fields (array)

Liste des champs spécifique de la page.

---

className (string)

La class de la page.

exemple : page-1920

---

etag (timestamp)

La date de modification de la page

---

name (string)

Le nom du type de la page.

---

className (string)

La classe de la page telle que définie dans l'éditeur avancé.

---

url (string)

L'URL en absolu de la page.

---

absoluteUrl (string)

Alias de url.

---

relativeUrl (string)

L'URL en relatif de la page

---

showTitle (boolean)

true si le titre doit être affiché.

---

title (string)

Le titre de la page.

---

date (string)

La date de création de la page.

---

nestingLevel (number)

Le niveau d'imbrication de la page dans des menus.

Est défini par getChildren quand l'option recursive est true.

---

Méthodes

---

urlForEndpoint

Renvoi l'URL traduite pour une vue/action de la page.

Exemple :

{{ page.urlForEndpoint('cart') }}

---

getChildren

Permets de récupérer les pages d'une collection.

Si aucun argument n’est défini, toutes les pages sont renvoyées.

Arguments

• from : L'index de la première page à renvoyer. Si length n'est pas défini, mais que from est défini, from sera défini à 0 et length prendra la valeur de from. Valeur par défaut: 0.
• length : Le nombre de pages à renvoyer. Valeur page défaut: null.
• orderBy : Définis comment ordonner les pages. Accepte les valeurs order et date suivies des mots clés ASC et DESC pour définir la direction. Si la direction n'est pas spécifiée, le tri sera ascendant. La valeur par défaut est auto qui suit dans ce cas ce qui est défini dans le type de la page. Si la page est triée manuellement, order sera utilisé, sinon date DESC sera utilisé.
• options : Un objet d'options :
  • ignoreMenu : Ignore les pages de type menu. Defaut false.
  • recursive : Renvoi les pages et les sous-pages récursivement. Defaut false.

Valeur de retour

Un tableau contenant la liste des pages trouvées.

Exemple :

{% set pages = page.getChildren(10) %}

---

getFirstChildren

Renvoie le premier élément d'une collection.

Arguments

• options : Même options que pour la méthode getChildren.

Valeur de retour

Une instance de la classe Page.

Exemple :

{{ router.redirect(page.getFirstChildren({ 'ignoreMenu': true, 'recursive': true }).absoluteUrl) }}

---

getChildrenCount

Renvoie le nombre de pages enfant.

Valeur de retour

Un nombre.

Exemple :

{% set childCount = page.getChildrenCount() %}

---

getNextChildren

Permets de récupérer les éléments d'une collection. À utiliser avec la méthode renderPagination.

Arguments

• length : Le nombre de pages à renvoyer. Valeur par défaut : true.

Valeur de retour

Un tableau contenant les pages.

Exemple :

{% set pageLength = 15 %}
{% for item in page.getNextChildren(pageLength) %}
  <div>{{ item.title }}</div>
{% endfor %}

{{ page.renderPagination(pageLength) }}

---

getParent

Récupère la page parente.

Valeur de retour

Une page de type collection ou folder.

---

getParentCollection

Récupère la collection.

Valeur de retour

Une page de type collection.

---

renderBreadCrumb

Renvoie le fil d'ariane de la page si défini.

Exemple :

{{ page.renderBreadCrumb() }}

---

render

Génère le HTML de la page (pour l'instant limité aux pages de type "Module")

Valeur de retour

Le code HTML.

---

renderPagination

Affiche des liens permettant d'afficher les différentes pages de la collection.

Arguments

• length : Le nombre de pages par page.

Valeur de retour

Le code HTML.

Exemple :

{{ page.renderPagination(pageLength) }}

---

localizedUrl

Permets la traduction d'une URL dans une autre langue.

Arguments

• language : La langue dans laquelle traduire la page.

Valeur de retour

L'URL traduite.

Exemple :

{{ page.localizedUrl(language) }}

---

overrideMeta

Permets la modification des balises méta de la page.

Arguments

• meta : Un objet contenant les balises méta. Propriétés acceptées : title, description, keyword

Exemple :

{{ page.overrideMeta({ title: 'My title' }) }}