Documentation for ccm-cms-types-address.ftl

git-svn-id: https://svn.libreccm.org/ccm/trunk@6292 8810af33-2d31-482b-a856-94f89814c4df
master
jensp 2019-11-03 10:35:03 +00:00
parent 58efb03c7f
commit 571aa14d4f
1 changed files with 47 additions and 0 deletions

View File

@ -5,26 +5,73 @@
"ui": "http://www.arsdigita.com/ui/1.0"} "ui": "http://www.arsdigita.com/ui/1.0"}
> >
<#--filedoc
Functions for processing the special properties of content items of the
type address.
-->
<#--doc
Gets the value of the `address` text property of the provided address item.
@param item The address item to use.
@return The value of the `address` property of the provided address item.
-->
<#function getAddressText item> <#function getAddressText item>
<#return item["./address"]> <#return item["./address"]>
</#function> </#function>
<#--doc
Gets the value of the `city` property of the provided address item.
@param item The address item to use.
@return The value of the `city` property of the provided address item.
-->
<#function getCity item> <#function getCity item>
<#return item["./city"]> <#return item["./city"]>
</#function> </#function>
<#--doc
Gets the value of the `postalCode` property of the provided address item.
@param item The address item to use.
@return The value of the `postalCode` property of the provided address item.
-->
<#function getPostalCode item> <#function getPostalCode item>
<#return item["./postalCode"]> <#return item["./postalCode"]>
</#function> </#function>
<#--doc
Gets the value of the `state` property of the provided address item.
@param item The address item to use.
@return The value of the `state` property of the provided address item.
-->
<#function getState item> <#function getState item>
<#return item["./state"]> <#return item["./state"]>
</#function> </#function>
<#--doc
Gets the value of the `country` property of the provided address item.
@param item The address item to use.
@return The value of the `country` property of the provided address item.
-->
<#function getCountry item> <#function getCountry item>
<#return item["./country"]> <#return item["./country"]>
</#function> </#function>
<#--doc
Gets the value of the `isoCountryCode` property of the provided address item.
@param item The address item to use.
@return The value of the `isoCountryCode` property of the provided address item.
-->
<#function getIsoCountryCode item> <#function getIsoCountryCode item>
<#return item["./isoCountryCode"]> <#return item["./isoCountryCode"]>
</#function> </#function>