LibreCCM
/
libreccm-legacy
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docuementation for the Freemarker functions provided by ccm-core 

git-svn-id: https://svn.libreccm.org/ccm/trunk@6118 8810af33-2d31-482b-a856-94f89814c4df
master
jensp 2019-06-08 09:18:45 +00:00
parent 7eb2728e49
commit b15ccb1b41
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
ccm-core/doc/freemarker/ccm-core.md → ccm-core/doc/freemarker/ccm-core/user-banner.md
View File

@ -1,43 +1,41 @@
# Freemarker functions provided by ccm-themedirector
## User Banner
# Freemarker functions for retrieving data from the user banner component.
Import Path
: `/ccm-core/user-banner.ftl`
### `String getGreeting()`
### `getGreeting(): String`
Retrieves to the greeting value provided by the _UserBanner_ component.
### `boolean isLoggedIn()`
### `isLoggedIn(): boolean`
Return `true` if the current user is logged and `false` otherwise.
### `boolean isNotLoggedIn()`
### `isNotLoggedIn(): boolean`
Return `true` if the current user is *not* logged and `false` otherwise.
### `String getChangePasswordUrl()`
### `getChangePasswordUrl(): String`
Returns the URL where a authenticated user can change his or her password.
### `String getLoginLink()`
### `getLoginLink(): String`
Returns the URL of the login page.
### `String getLogoutLink()`
### `getLogoutLink(): String`
Returns the URL for logging out.
### `String getScreenName()`
### `getScreenName(): String`
Returns the username of the current user. If the user is not authenticated the will return an empty string.
### `String getUserGivenName()`
### `getUserGivenName(): String`
Returns the given of the current user, if availabe. If the user is not authenticated the will return an empty string.
### `String getUserFamilyName()`
### `getUserFamilyName(): String`
Returns the given of the current user, if availabe. If the user is not authenticated the will return an empty string.