README.md 8.52 KB
Newer Older
Alexis Piéplu's avatar
Alexis Piéplu committed
1
2
3
4
5
# Velocty Snippets

Une liste de snippet utile pour velocity


Alexis Piéplu's avatar
Alexis Piéplu committed
6
## Notes utiles
Alexis Piéplu's avatar
Alexis Piéplu committed
7
8
9
10
11

### Introduction

Velocity est un langage qui utilise des objets Java.
Toutes les variables / objets sont des objets Java,
Alexis Piéplu's avatar
Alexis Piéplu committed
12
il est donc possible d'utiliser les méthodes de ces dernières.
Alexis Piéplu's avatar
Alexis Piéplu committed
13
14
15
16
17
18
19

### $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".

Alexis Piéplu's avatar
Alexis Piéplu committed
20
### Les applications display template pour agrégateur de contenu
Alexis Piéplu's avatar
Alexis Piéplu committed
21

Alexis Piéplu's avatar
Alexis Piéplu committed
22
Dans ce dernier les webcontent sont accessibles par une liste de `AssetEntry`.
Alexis Piéplu's avatar
Alexis Piéplu committed
23
Cela permet d'accéder directement aux catégories ou tags, mais pas à ce que contiennent les webcontent.
Alexis Piéplu's avatar
Alexis Piéplu committed
24
Il faut récupérer le `journalArticle` correspondant. (Recette plus bas)
Alexis Piéplu's avatar
Alexis Piéplu committed
25
26


Alexis Piéplu's avatar
Alexis Piéplu committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
---

## Documentations

### Variables utiles

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

### Documentation liferay API

* [liferayApiDocs][liferayApiDocs]
Alexis Piéplu's avatar
Alexis Piéplu committed
41
42
43
44
45
 

### Ressources utiles

* [Snippets ADT, liferay 7][SnippetsADTLiferay7]
Alexis Piéplu's avatar
Alexis Piéplu committed
46

Alexis Piéplu's avatar
Alexis Piéplu committed
47
48
---

Alexis Piéplu's avatar
Alexis Piéplu committed
49
## Champ personnalisé
Alexis Piéplu's avatar
Alexis Piéplu committed
50
51


Alexis Piéplu's avatar
Alexis Piéplu committed
52
* Récupérer la valeur d'un champ personnalisé d'une page, depuis les éléments de navigation
Alexis Piéplu's avatar
Alexis Piéplu committed
53
54
55
56
57
58

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

```

Alexis Piéplu's avatar
Alexis Piéplu committed
59
* Récupérer la valeur d'un champ personnalisé de la page courante
Alexis Piéplu's avatar
Alexis Piéplu committed
60
61

```html
Alexis Piéplu's avatar
Alexis Piéplu committed
62
$theme_display.layout.expandoBridge.getAttribute('Nom du champ personnalisé')
Alexis Piéplu's avatar
Alexis Piéplu committed
63
64
65
66
67
68
69
70
71
72
73

```


## Language

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

```

Alexis Piéplu's avatar
Alexis Piéplu committed
74
## Accéder à un élément de type `TemplateNode` (structure / template)
Alexis Piéplu's avatar
Alexis Piéplu committed
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

```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
Alexis Piéplu's avatar
Alexis Piéplu committed
107
#set ( $date = "Thu, 24 Mar 2016 20:30:00 +0000" ) <!-- $reserved-article-modified-date.data -->
Alexis Piéplu's avatar
Alexis Piéplu committed
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
#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

```

Alexis Piéplu's avatar
Alexis Piéplu committed
146
<a id="dlfileEntry"></a>
Alexis Piéplu's avatar
Alexis Piéplu committed
147
## Récupérer l'objet "DFileEntry" d'un élément document et média 
Alexis Piéplu's avatar
Alexis Piéplu committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

`$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>

```

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
## Afficher tout les documents d'un dossier

`$folderId` est un `templateNode`, id de dossier.

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

#set($gid = $getterUtil.getLong($request.get("theme-display").get("scope-group-id")))
#set($fid = $getterUtil.getLong($folderId.getData()))
#set($files = $service.getFileEntries($gid, $fid))

#foreach($doc in $files)
    #set($uet = $httpUtil.encodeURL($htmlUtil.unescape($doc.getTitle())))
    <a href="/documents/$gid/$fid/$uet">$doc.getTitle()</a>
#end

```
Alexis Piéplu's avatar
Alexis Piéplu committed
183
184
185
186
187
188
189
190
191
192
193
194


---


## Tri d'objets

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

```

195
196
197
198
199
200
201
202
203
204
205
206
207
208
## Afficher le WebContent (JournalArticle) avec son template par défault dans un Asset Publisher

```velocity
#if (!$entries.isEmpty())
	#foreach ($entry in $entries)
	    #set($renderer = $entry.getAssetRenderer())
	    #set($articleId = $renderer.getArticle().getArticleId())
	    #set($groupId = $entry.getGroupId())
	    #set($languageId = $locale.toString())
	    $journalContentUtil.getContent($groupId, $articleId, "VIEW", $languageId, $themeDisplay)
	#end
#end
```

Alexis Piéplu's avatar
Alexis Piéplu committed
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
## 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
Alexis Piéplu's avatar
Alexis Piéplu committed
281
[SnippetsADTLiferay7]: http://proliferay.com/important-code-snippets-for-liferay-asset-publisher-adt/
Alexis Piéplu's avatar
Alexis Piéplu committed
282
283

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