README.md 7.23 KB
Newer Older
Alexis Piéplu's avatar
Alexis Piéplu committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# Velocty Snippets

Une liste de snippet utile pour velocity

## Documentations

### Variables utile

* [Variables disponible dans le thème][themeVariable]
* [Variables spécifique aux webcontent (template)][webContentReservedVariables]
* [Variables disponibles dans les templates][webContentVariables]
* [Velocity Objects][Velocity Objects]

### Documentaion liferay API

* [liferayApiDocs][liferayApiDocs]

### Notes utiles

### Introduction

Velocity est un langage qui utilise des objets Java.
Toutes les variables / objets sont des objets Java,
il est donc possible d'utiliser les methodes de ces dernière.

### $serviceLocator

Cette variable permet d'aller chercher des class de l'api de Liferay.
Cela est habituellement désactivé dans les projets, l'utiliser veux dire qu'il vaudrait mieux
faire cela avec un portlet, ou un "velcityHook".

### Les applications display template pour aggrégateur de contenu

Dans ce dernier les webcontent sont accéssibe par une liste de `AssetEntry`.
Cela permet d'accéder directement aux catégories ou tags, mais pas à ce que contiennent les webcontent.
Il faut récuprérer le `journalArticle` correspondant. (Recette plus bas)


---

## Champ personalisé


* Récupérer la valeur d'un champ personalisé d'une page, depuis les élément de navigation

```html
$nav_item.getLayout().getExpandoBridge().getAttribute('Nom du champ personalisé')

```

* Récupérer la valeur d'un champ personalisé de la page courante

```html
$theme_display.layout.expandoBridge.getAttribute('Nom du champ personalisé')

```


## Language

```html
#language("language.key")

```

### Accéder à un élément de type `TemplateNode` (structure / template)

```html
$element.data
<!-- ou -->
$element.getData()

```

## Accéder à un sous-élément `TemplateNode` (structure / template)

```html
$id_element.id_sous_element.data

```

## Accéder à des éléments/sous-élément `TemplateNode` (structure / template) répétable


```html
#foreach ($element in $elements.getSiblings())

    <span>$element.getData()</span>

    #foreach ( $sub_element in $element.sub_elements.getSiblings() )

        <span>$sub_element.getData()</span>

    #end

#end

```

## Récupérer et formater une date

```html
#set ( $date = "Thu, 24 Mar 2016 20:30:00 +0000" )
#set ( $dateObject = $dateTool.toDate("EEE, dd MMM yyyy hh:mm:ss Z", $date, $locale))
#set ( $date = $dateTool.format("MMMM yyyy", $dateObject, $locale))

```


## Récupérer les tags de l'article

```html
#set( $tagdataUtil = $serviceLocator.findService("com.liferay.portlet.asset.service.AssetTagLocalService") )

#set( $articlePrimKey = $journalLocalService.getArticle($getterUtil.getLong($request.theme-display.scope-group-id), $reserved-article-id.data).resourcePrimKey )
#set( $listTags = $tagdataUtil.getTags("com.liferay.portlet.journal.model.JournalArticle", $articlePrimKey) )

#foreach( $tag in $listTags )
    <span>$tag.getName()</span>
#end

```



## Récupérer les catégories de l'article

```html
#set( $journalLocalService = $serviceLocator.findService("com.liferay.portlet.journal.service.JournalArticleLocalService") )
#set( $catLocalService = $serviceLocator.findService("com.liferay.portlet.asset.service.AssetCategoryLocalService") )

#set( $scopeId = $request.theme-display.scope-group-id )
#set( $articlePrimKey = $journalLocalService.getArticle($getterUtil.getLong($scopeId), $reserved-article-id.data).resourcePrimKey )
#set( $articleCatNames = $catLocalService.getCategoryNames("com.liferay.portlet.journal.model.JournalArticle", $getterUtil.getLong($articlePrimKey)) )

#foreach( $categorie in $articleCatNames )
    <span>$categorie</span>
#end

```


## Récupérer l'objet "DFileEntry" d'un élément document et media

`$File` est l'élément de type "document_library"

```html
#set($DLFileEntryLocalService = $serviceLocator.findService("com.liferay.portlet.documentlibrary.service.DLFileEntryLocalService"))  

#set( $fileArray = $File.data.split("/")) <!-- $File.data : /documents/10182/0/ownCloud_User_Manual.pdf/0c909167 -->
#set( $gid = $getterUtil.getLong($fileArray.get(2)))  <!-- 10182 -->
#set( $fid = $getterUtil.getLong($fileArray.get(3)))  <!-- 0 -->
#set( $fileTitle = $fileArray.get(4))  <!-- ownCloud_User_Manual.pdf -->
#set( $fileEntry = $DLFileEntryLocalService.getFileEntry($gid, $fid, $fileTitle))  

<a href="$File.getData()">$fileTitle</a>
Version: <strong>$fileEntry.getLatestFileVersion(true).getVersion()</strong>
Last modified date : <strong>$fileEntry.getModifiedDate()</strong>

```



---


## Tri d'objets

```html
$sortTool.sort($entries, "publishDate:desc")

```

## Récupérer les éléments d'un Asset Entry (Asset publisher)

```html
#foreach ($entry in $entries)

    #set( $renderer = $entry.getAssetRenderer() )
    #set( $journalArticle = $renderer.getArticle() )
    #set( $document = $saxReaderUtil.read($journalArticle.getContent()) )
    #set( $rootElement = $document.getRootElement() )

    <!-- On récupère l'élément, puis sa valeur, où 'Element' est l'identifiant dans la structure -->
    #set( $xPath_element = $saxReaderUtil.createXPath("dynamic-element[@name='Element']/dynamic-content[@language-id='$locale']") )
    #set( $article_element = $xPath_element.selectSingleNode($rootElement).getStringValue() )

    <span> $article_element</span>

 #end

```

---


## Afficher les valeurs d'une dynamic data list

Où la dynamic data list contient les éléments `lettre` et `mot`

```html
<!-- ## Get content variables -->

<!-- Get the reference of DDL Record Service via serviceLocator, which is automatically set in the context -->
#set ($ddlRecordService = $serviceLocator.findService('com.liferay.portlet.dynamicdatalists.service.DDLRecordLocalService'))

<!-- $reserved_record_set_id is also an object set in the context and it has the value of the list id configured for the portlet instance -->
#set ($recordSetId = $getterUtil.getInteger($reserved_record_set_id, 0))

<!-- call to the retrieve all records of the list -->
#set ($records = $ddlRecordService.getRecords($recordSetId))

#foreach( $record in $records )
    <span>$record.getFieldValue("lettre", $locale)</span>
    <span>$record.getFieldValue("mot", $locale)</span>
#end

```


## Afficher les labels d'un 'select' de la structure d'une dynamic data list

`lettre` est un élément de type 'select' dans la dynamic data list

```html
<!-- ## Get structure fields variables -->

<!-- Get the structure DDL service -->
#set ($DDMStructureLocalService = $serviceLocator.findService("com.liferay.portlet.dynamicdatamapping.service.DDMStructureLocalService"))
#set ($StructureSetId = $getterUtil.getInteger($reserved_ddm_structure_id, 0))

<!-- Get the structure -->
#set ($structs = $DDMStructureLocalService.getStructure($StructureSetId))

#foreach($optionName in $structs.getChildrenFieldNames("lettre"))
    $structs.getFieldLabel($optionName, $locale))
#end
```



[themeVariable]: http://content.liferay.com/4.3/misc/theme-api-4.3.0.html
[webContentReservedVariables]:https://www.liferay.com/fr/community/wiki/-/wiki/Main/Velocity+Variables+Available+in+Web+Content
[webContentVariables]: https://dev.liferay.com/develop/tutorials/-/knowledge_base/6-1/available-variables
[Velocity Objects]: https://www.liferay.com/fr/community/wiki/-/wiki/Main/Access+Objects+from+Velocity

[liferayApiDocs]: https://docs.liferay.com/portal/6.1/javadocs/