Velocity Tools

$_.locate

Locate an asset at the given path, with the specified type, and optionally inside of a site with the specified siteName.

$_.locateBlock

Locate a Block at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateBlock("blocks/index/all-events", "Calendar")

$_.locateFile

Locate a File at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateFile("files/logo.png", "Cascade University")

$_.locateFolder

Locate a Folder at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateFolder("articles/2019", "News")

$_.locateFormat

Locate a Format at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateFormat("_cms/formats/banner", "Cascade University")

$_.locateLinkable

Locate a Page, File, or External Link at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateLinkable("student-life/student-portal-link", "Cascade University")

$_.locatePage

Locate a Page at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locatePage("about-us/contact", "Cascade University")

$_.locateReference

Locate a Reference at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateReference("about-us/contact", "Cascade University")

$_.locateSymlink

Locate an External Link at the given path and optionally inside of a site with the specified siteName.

Example:

$_.locateSymlink("student-life/student-portal-link", "Cascade University")

$_.query()

Creates the query object.

Example:

$_.query()

$_.query().byContentType

Return assets using the Content Type at the path provided.

Notes:

• Can't be used in conjunction with  byMetadataSet() or byDataDefinition().
• Querying byContentType() will return only page assets.

Examples:

$_.query().byContentType("Event").execute()

$_.query().byContentType("site://Calendar/Event").execute()

$_.query().byMetadataSet

Return assets using the Metadata Set at the path provided.

Notes:

• Can't be used in conjunction with  byContentType().

Examples:

$_.query().byMetadataSet("Article").execute()

$_.query().byMetadataSet("site://News/Article").execute()

$_.query().byDataDefinition

Return assets using the Data Definition at the path provided.

Notes:

• Can't be used in conjunction with byContentType().
• Querying byDataDefinition() may return page or structured data block assets.

Examples:

$_.query().byDataDefinition("Person").execute()

$_.query().byDataDefinition("site://Directory/Person").execute()

$_.query().bySiteName

Return assets from the specified site in the query results. If not specified, assets from the current site will be returned.

Notes:

• Can't be used in conjunction with  searchAcrossAllSites().
• This parameter applies only to the location of the assets returned, and does not apply to the location of the Content Type or Metadata Set being queried.

Examples:

$_.query().byContentType("Event").bySiteName("Calendar").execute()

$_.query().byContentType("site://Calendar/Event").bySiteName("Athletics").execute()

$_.query().byFolderPath

Return assets within the given folder path (including descendants).

Notes:

• A % sign can be used as a wildcard to match multiple folder paths (e.g. departments/b%)

Example:

$_.query().byContentType("Person").byFolderPath("departments/biology").execute()

$_.query().hasAnyPaths

Return assets with the specific paths provided

Example:

$_.query().byContentType("Person").hasAnyPaths(["departments/biology","departments/math"]).execute()

$_.query().hasMetadata

Return assets with metadata where name is set to value.

Example:

$_.query().byMetadataSet("Article").hasMetadata("department","Biology").execute()

$_.query().hasAnyMetadataValues

Return assets with metadata where name is set to any of values.

Example:

$_.query().byMetadataSet("Article").hasAnyMetadataValues("department",["English", "Communications"]).execute()

$_.query().hasStructuredData

Return assets with structured data where structuredDataFieldPath is set to structuredDataFieldValue.

Example:

$_.query().byContentType("Person").hasStructuredData("contact/building","Hannon Hall").execute()

$_.query().hasAnyStructuredDataValues

Return assets with structured data where structuredDataFieldPath has one of the given structuredDataFieldValues.

Example:

$_.query().byContentType("Person").hasAnyStructuredDataValues("contact/building", ["Hannon Hall","Hill Hall"]).execute()

$_.query().hasStructuredDataByFieldId

Return assets with structured data field with structuredDataFieldId is set to structuredDataFieldValue.

Example:

$_.query().byContentType("Person").hasStructuredDataByFieldId("9fac6f9dac1e001b075cc4e8a8d4e5ec","Hannon Hall").execute()

$_.query().hasAnyStructuredDataValuesByFieldId

Return assets with structured data field with structuredDataFieldId has one of the given structuredDataFieldValue.

Example:

$_.query().byContentType("Person").hasAnyStructuredDataValuesByFieldId("9fac6f9dac1e001b075cc4e8a8d4e5ec",["Hannon Hall","Hill Hall"]).execute()

$_.query().hasTag

Return assets that have at least tag assigned.

Example:

$_.query().byMetadataSet("Event").hasTag("Campus Events").execute()

$_.query().hasAnyTags

Return assets that have any of tags assigned.

Example:

$_.query().byMetadataSet("Event").hasAnyTags(["Campus Events", "Academics"]).execute()

$_.query().includeBlocks

Include Block assets in the query results.

Example:

$_.query().byMetadataSet("Default").includeBlocks(true).execute()

$_.query().blocksOnly

Include only Block assets in the query results.

Example:

$_.query().byMetadataSet("Default").blocksOnly().execute()

$_.query().includeFiles

Include File assets in the query results.

Example:

$_.query().byMetadataSet("Default").includeFiles(true).execute()

$_.query().filesOnly

Include only File assets in the query results.

Example:

$_.query().byMetadataSet("Default").filesOnly().execute()

$_.query().includeFolders

Include Folder assets in the query results.

Example:

$_.query().byMetadataSet("Default").includeFolders(true).execute()

$_.query().foldersOnly

Include only Folder assets in the query results.

Example:

$_.query().byMetadataSet("Default").foldersOnly().execute()

$_.query().includePages

Include Page assets in the query results.

Example:

$_.query().byMetadataSet("Default").includePages(true).execute()

$_.query().pagesOnly

Include only Page assets in the query results.

Example:

$_.query().byMetadataSet("Default").pagesOnly().execute()

$_.query().includeSymlinks

Include External Link assets in the query results.

Example:

$_.query().byMetadataSet("Default").includeSymlinks(true).execute()

$_.query().symlinksOnly

Include only Symlink assets in the query results.

Example:

$_.query().byMetadataSet("Default").symlinksOnly().execute()

$_.query().indexableOnly

Include only assets enabled for indexing in the query results.

Notes:

• Assets disabled for indexing by their folder hierarchy but not at the individual asset level will still be returned.
• When set to true, results must also have an empty Start Date or a Start Date in the past and an empty End Date or an End Date in the future.

Example:

$_.query().byContentType("Event").indexableOnly(true).execute()

$_.query().maxResults

Limit the number of assets returned by the query to the amount specified.

Notes:

• Default is 100 assets.
• Maximum is 2,000 assets when using execute() method.
• Maximum is 100,000 assets when using #queryexecute directive.
• The number of assets to be queried is not limited, but the maximum number of assets that can be returned from the results of the query execution is limited to 2,000, and the maximum number of assets that can be iterated by the query execution directive is limited to 100,000.

Example:

$_.query().byContentType("Article").maxResults(5).execute()

$_.query().preloadDynamicMetadata

Query will preload dynamic metdata so that accessing that data does not cause additional database trips or slowdowns.

Notes:

Example:

$_.query().byContentType("Event").preloadDynamicMetadata().execute()

$_.query().preloadStructuredData

Query will preload structured data so that accessing that data does not cause additional database trips or slowdowns. Note: 

Notes:

Example:

$_.query().byContentType("Event").preloadStructuredData().execute()

$_.query().publishableOnly

Include only assets enabled for publishing in the query results.

Notes:

• Assets disabled for publishing by their folder hierarchy but not at the individual asset level will still be returned.

Example:

$_.query().byContentType("Article").publishableOnly(true).execute()

$_.query().searchAcrossAllSites

Return assets from any site in the query results. If not specified, assets from the current site will be returned.

Notes:

• Can't be used in conjunction with  siteName().
• This parameter applies only to the location of the assets returned, and does not apply to the location of the Content Type or Metadata Set being queried.

Examples:

$_.query().byContentType("Event").searchAcrossAllSites().execute()

$_.query().byContentType("site://Calendar/Event").searchAcrossAllSites().execute()

$_.query().sortBy

Sort the query results by the specified field.

Notes:

• Only one sortBy() call is used per query.
• Use in conjunction with sortDirection() to specify direction of sort.

Example:

$_.query().byContentType("Profile").sortBy("title").execute()

$_.query().sortDirection

Used in conjunction with sortBy(), specify the direction of the sort.

Notes:

• Only one  sortDirection() call is used per query.

Example:

$_.query().byContentType("Article").sortBy("startDate").sortDirection("desc").execute()

$_.query().siteName (deprecated)

See $_.query().bySiteName

#queryfilter

Executes body logic on each asset matching a given query before maxResults() is applied. If body logic returns true, the asset will be included in the results.

Example:

#set ($query = $_.query().byContentType("Event"))
#queryfilter($query, $asset)
  $asset.path.contains("index")
#end

#querysortvalue

Executes body logic on each asset matching a given query to determine by which value the resulting list should be sorted before maxResults() is applied. This directive is often used in conjunction with the #queryexecute directive, although it can also be used with the .execute() method and is an alternative to .sortBy() . 

Example:

#set ($query = $_.query().byContentType("Event"))
#querysortvalue($query, $asset)
  $asset.metadata.title
#end

#queryexecute

Given logic is executed on each asset and a result is outputted. This directive can replace the .execute() method and it allows for .maxResults() to be up to as many as 100,000 (whereas .execute() has a hard max of 2,000 results).

Example:

#set ($query = $_.query().byContentType("Event"))
#queryexecute($query, $asset) 
   $asset.metadata.title
#end

$_DateTool.difference

Returns a Comparison representing the difference between now and then.

Examples:

$_DateTool.difference(1578526435000, 1577836800000)
## Expected output: -1 week

#set ($pubDate = $currentPage.lastPublishedOn)
$_DateTool.difference($_DateTool.getDate(), $pubDate)
## Expected output: -2 weeks

$_DateTool.format

Returns a String representing a date in a specified format.

Examples:

$_DateTool.format('medium', $date)

$_DateTool.format('EEEE MM/dd/yy', $date)

$_DateTool.getCalendar

Returns the current date as a Calendar.

Example:

$_DateTool.getCalendar()

$_DateTool.getDate

Returns a date or the current date as a Date.

Examples:

$_DateTool.getDate()

#set ($page = $_XPathTool.selectSingleNode($contentRoot, "//calling-page/system-page"))
#set ($pubDate = $page.getChild("last-published-on").value)
$_DateTool.getDate($pubDate)

$_DateTool.getDay

Returns a Number representing the day in a date or the current date.

Example:

$_DateTool.getDay()

$_DateTool.getMonth

Returns a Number representing the month in a date or the current date.

Note: In Java, the first month of the year in the Gregorian and Julian calendars is JANUARY which is 0.

Example:

$_DateTool.getMonth()

$_DateTool.getTime

Returns a Number representing the current time.

Example:

$_DateTool.getTime()

$_DateTool.getValue

Returns an Integer representing the value for the field in the date.

Example:

$_DateTool.getValue(1, $date)

$_DateTool.getYear

Returns a Number representing the year in a date or the current date.

Example:

$_DateTool.getYear()

$_DateTool.toDate

Returns a date in the specified format as a Date.

Example:

#set ($date = $currentPage.getStructuredDataNode("date").textValue)
#set ($date = $_DateTool.toDate("MM-dd-yyyy",$date))
$_DateTool.format("EEEE, MMMM dd, yyyy", $date)

$_DateTool.toDays

Returns a Number representing the number of days between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toDays(1577836800000)
## Expected output: 18262

$_DateTool.toHours

Returns a Number representing the number of hours between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toHours(1577836800000)
## Expected output: 438288

$_DateTool.toMinutes

Returns a Number representing the number of minutes between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toMinutes(1577836800000)
## Expected output: 26297280

$_DateTool.toMonths

Returns a Number representing the number of months between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toMonths(1577836800000)
## Expected output: 608

$_DateTool.toSeconds

Returns a Number representing the number of seconds between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toSeconds(1577836800000)
## Expected output: 1577836800

$_DateTool.toWeeks

Returns a Number representing the number of weeks between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toWeeks(1577836800000)
## Expected output: 2608

$_DateTool.toYears

Returns a Number representing the number of years between Unix Time 0 (midnight UTC/GMT on January 1, 1970) and a time.

Example:

$_DateTool.toYears(1577836800000)
## Expected output: 50

$_DateTool.whenIs

Returns a Comparison representing the difference between  now and  then or between the current time and then.

Examples:

$_DateTool.whenIs(1578526435000, 1577836800000)
## Expected output: 1 week earlier

#set ($currentDate = $_DateTool.getDate())
#set ($pubDate = $currentPage.lastPublishedOn)
$_DateTool.whenIs($currentDate, $pubDate)
## Expected output: 2 weeks earlier

$_DisplayTool.alt

Returns the value of the object if defined, otherwise returns null or alternate.

Example:

$_DisplayTool.alt($title,"No title provided.")

$_DisplayTool.br

Returns a String in which new line characters (\n) are prepended with HTML line break tags (<br/>).

Example:

$_DisplayTool.br("Here is a String with
                  a line break.")
## Expected output: Here is a string with<br/>a line break.

$_DisplayTool.capitalize

Returns a String in which the first letter is capitalized.

Example:

$_DisplayTool.capitalize("here is a String.")
## Expected output: Here is a String.

$_DisplayTool.cell

Returns a String that is truncated or padded to length and appended with an optional suffix if truncated.

Example:

$_DisplayTool.cell("Here is a String over 10 characters long.",10,"...")
## Expected output: Here is...

$_DisplayTool.list

Returns String representing a list separated by a separator and optional lastSeparator.

Example:

$_DisplayTool.list(["A", "B", "C"], ", ", ", or ")
## Expected output: A, B, or C

$_DisplayTool.message

Returns String message formatted with values.

Example:

$_DisplayTool.message("{0}, {1}, or {2}", "A", "B", "C")
## Expected output: A, B, or C

$_DisplayTool.plural

Returns a singular or plural word depending on the amount. If an alternative plural is not provided, basic rules of English pluralization will be used.

Example:

$_DisplayTool.plural(3,"mouse","mice")
## Expected output: mice

$_DisplayTool.space

Returns a String containing the specified number of spaces.

Example:

$_DisplayTool.space(3)

$_DisplayTool.stripTags

Returns a String without HTML tags or with only specified allowedTags.

Example:

$_DisplayTool.stripTags("<p>Here is a <code>String</code> with <strong>HTML</strong> tags.</p>","p","code")
## Expected output: <p>Here is a <code>String</code> with HTML tags.</p>

$_DisplayTool.truncate

Returns a String truncated to 30 characters or the specified length, appended with "..." or an optional suffix if truncated, and optionally truncated at the end of a word.

Example:

$_DisplayTool.truncate("Here is a truncated String.",15,"...",true)
## Expected output: Here is a...

$_DisplayTool.uncapitalize

Returns a String in which the first letter is uncapitalized.

Example:

$_DisplayTool.uncapitalize("Here is a String.")
## Expected output: here is a String.

$_EscapeTool.getB / $_EscapeTool.getBackslash

Returns a backslash.

Example:

$_EscapeTool.getB()
## Expected output: \

$_EscapeTool.getD / $_EscapeTool.getDollar

Returns a dollar sign.

Example:

$_EscapeTool.getD()
## Expected output: $

$_EscapeTool.getE / $_EscapeTool.getExclamation

Returns an exclamation mark.

Example:

$_EscapeTool.getE()
## Expected output: !

$_EscapeTool.getH / $_EscapeTool.getHash

Returns a hash / pound sign.

Example:

$_EscapeTool.getH()
## Expected output: #

$_EscapeTool.getN / $_EscapeTool.getNewLine

Returns a new line character.

Example:

$_EscapeTool.getN()
## Expected output: \n

$_EscapeTool.getQ / $_EscapeTool.getQuote

Returns a quotation mark.

Example:

$_EscapeTool.getQ()
## Expected output: "

$_EscapeTool.getS / $_EscapeTool.getSingleQuote

Returns a single quote / apostrophe.

Example:

$_EscapeTool.getS()
## Expected output: '

$_EscapeTool.html

Returns an escaped HTML String.

Notes:

• Due to Cascade CMS's XHTML validation, using $_EscapeTool.xml() is recommended even when escaping content for HTML output.

Example:

$_EscapeTool.html('Here is a String with an ampersand (&).')
## Expected output: Here is a String with an ampersand (&).

$_EscapeTool.javascript

Returns an escaped JavaScript String.

Example:

$_EscapeTool.javascript('Here is a String with "quotation marks".')
## Expected output: Here is a String with \"quotation marks\".

$_EscapeTool.unescapeHtml

Returns an unescaped String containing HTML.

Example:

$_EscapeTool.unescapeHtml('Here is a String with an  escaped ampersand (&).')
## Expected output: Here is a String with an escaped ampersand (&).

$_EscapeTool.unescapeJavaScript

Returns an unescaped String containing JavaScript.

Example:

$_EscapeTool.unescapeJavaScript('if (i === \"foo\")')
## Expected output: if (i === "foo").

$_EscapeTool.unescapeXml

Returns an unescaped String containing XML.

Example:

$_EscapeTool.unescapeXml('<foo>bar</foo>')
## Expected output: <foo>bar</foo>

$_EscapeTool.unicode

Returns a String representing a Unicode character.

Example:

$_EscapeTool.unicode('004D')
## Expected output: M

$_EscapeTool.url

Returns an escaped URL String.

Example:

$_EscapeTool.url('www.example.com/page?key=value')
## Expected output: www.example.com%2Fpage%3Fkey%3Dvalue

$_EscapeTool.xml

Returns an escaped XML String.

Example:

$_EscapeTool.html('Here is a String with an ampersand (&).')
## Expected output: Here is a String with an ampersand (&).

$_FieldTool.in

Returns a Classes' public static variables.

Examples:

$_FieldTool.in($_DateTool.getCalendar()).JANUARY
## Expected output: 0

Example adding time to a Calendar:

#set ($date = $_DateTool.getDate())
#set ($calendar = $_DateTool.getCalendar())
$calendar.add($_FieldTool.in($calendar).DAY_OF_YEAR, 1)
<p>Today = ${date}</p>
<p>Tomorrow = ${calendar.getTime()}</p>

$_ListTool.removeNull

Removes items from a List that either do not have a given propertyName or it is null.

Notes:

• Set this to a variable to retain the removed items for processing.

Example:

#set ($articles = $_.query().byContentType("Article").execute())
#set ($removed = $_ListTool.removeNull($articles, "metadata.startDate"))

$_ListTool.reverse

Reverses a List.

Example:

$_ListTool.reverse(["A","B","C"])
## Expected output: [C, B, A]

$_ListTool.shuffle

Shuffles a List.

Example:

$_ListTool.shuffle(["A","B","C"])
## Expected output: [B, A, C]

$_ListTool.toList

Converts an Array to a List.

Example:

#set ($categories = $currentPage.metadata.getDynamicField("categories"))
#set ($categories = $_ListTool.toList($categories.values))

$_MathTool.abs

Returns the absolute value of a number.

Example:

$_MathTool.abs(-3)
## Expected output: 3

$_MathTool.add

Returns the sum of numbers.

Example:

$_MathTool.add(12,30)
## Expected output: 42

$_MathTool.ceil

Returns the smallest integer that is not less than the given number.

Example:

$_MathTool.ceil(3.14159)
## Expected output: 4

$_MathTool.div

Returns the quotient of numbers or null if any denominator equals zero.

Example:

$_MathTool.div(9,3)
## Expected output: 3

$_MathTool.floor

Returns the integer portion of number.

Example:

$_MathTool.floor(3.14159)
## Expected output: 3

$_MathTool.getRandom

Returns a pseudo-random Double greater than or equal to 0.0 and less than 1.0.

Example:

$_MathTool.getRandom()

$_MathTool.idiv

Returns the result of performing integer division on number1 and number2.

Example:

$_MathTool.idiv(9.33,3.14)
## Expected output: 3

$_MathTool.max

Returns the maximum of numbers.

Example:

$_MathTool.max(7,23,11)
## Expected output: 23

$_MathTool.min

Returns the minimum of numbers.

Example:

$_MathTool.min(7,23,11)
## Expected output: 7

$_MathTool.mod

Returns the result of performing integer modulus on number1 and number2.

Example:

$_MathTool.mod(9.33,3.14)
## Expected output: 0

$_MathTool.mul

Returns the product of numbers.

Example:

$_MathTool.mul(6,7)
## Expected output: 42

$_MathTool.pow

Returns the result of number1 to the power of number2.

Example:

$_MathTool.pow(3,3)
## Expected output: 27

$_MathTool.random

Returns a pseudo-random number greater than or equal to number1 and less than number2.

Notes:

• If both arguments are whole numbers then the returned number will also be, otherwise a Double will be returned.

Example:

$_MathTool.random(1,10)

$_MathTool.round

Returns number rounded to the nearest whole integer.

Example:

$_MathTool.round(3.14159)
## Expected output: 3

$_MathTool.roundTo

Returns number rounded to the specified number of decimalPlaces.

Example:

$_MathTool.roundTo(2,3.14159)
## Expected output: 3.14

$_MathTool.sub

Returns the difference of numbers (subtracted in order).

Example:

$_MathTool.sub(10,7)
## Expected output: 3

$_MathTool.toDouble

Returns number as a Double.

Example:

$_MathTool.toDouble(3)
## Expected output: 3.0

$_MathTool.toInteger

Returns number as an Integer.

Example:

$_MathTool.toInteger(3.14159)
## Expected output: 3

$_MathTool.toNumber

Returns number as a Number.

Example:

$_MathTool.toNumber("3")
## Expected output: 3

$_NumberTool.currency

Returns a String representing object formatted as currency.

Example:

$_NumberTool.currency(3.14159)
## Expected output: $3.14

$_NumberTool.format

Returns a String representing object in the given format.

Example:

$_NumberTool.format("integer",3.14159)
## Expected output: 3

$_NumberTool.integer

Returns a String representing object formatted as an integer.

Example:

$_NumberTool.integer(3.14159)
## Expected output: 3

$_NumberTool.isNumeric

Returns true if a given object is numeric.

Example:

$_NumberTool.isNumeric("3")
## Expected output: true

$_NumberTool.number

Returns a String representing object formatted as a number.

Example:

$_NumberTool.number(3.14159)
## Expected output: 3.142

$_NumberTool.percent

Returns a String representing object formatted as a percentage.

Example:

$_NumberTool.percent(3.14159)
## Expected output: 314%

$_NumberTool.toNumber

Returns a Number representing object in the given format or null if no conversion is possible.

Example:

$_NumberTool.toNumber("percent","314%")
## Expected output: 3.14

$_NumberTool.withPadding

Returns a String representing number prefixed with zeroes (0) to match minDigits. Useful for sorting of string-based numbers.

Example:

$_NumberTool.withPadding(1, 3)
## Expected output: 001

$_PropertyTool.isArray

Returns true if the object is an array, otherwise false.

Example:

$_PropertyTool.isArray($category.values)

$_PropertyTool.isIterable

Returns true if the object is an iterable data type (i.e. can be used with a Velocity #foreach loop), otherwise false.

Example:

$_PropertyTool.isIterable($category.selectedFieldItems)

$_PropertyTool.isList

Returns true if the object is a list, otherwise false.

Example:

$_PropertyTool.isList($currentPage.tags)

$_PropertyTool.isMap

Returns true if the object is a map, otherwise false.

Example:

$_PropertyTool.isMap({ "test": "testing" })

$_PropertyTool.isSet

Returns true if the object is a set, otherwise false.

$_PropertyTool.isString

Returns true if the object is a string, otherwise false.

Example:

$_PropertyTool.isString("testing")

$_PropertyTool.isEmpty

Returns  true if the object is null, an empty string, or contains only whitespace characters, otherwise  false.

Example:

$_PropertyTool.isEmpty($category.values[0])

$_PropertyTool.isNotEmpty

Returns  false if the object is null or an empty string, otherwise  true.

Example:

$_PropertyTool.isNotEmpty($category.values[0])

$_PropertyTool.isNull

Returns  true if object is null, otherwise  false.

Example:

$_PropertyTool.isNull($category)

$_PropertyTool.isNotNull

Returns  true if object is not null, otherwise  false.

Example:

$_PropertyTool.isNotNull($category)

$_PropertyTool.outputFirstNotEmpty

Returns a string of the first non-empty property in the list of properties provided.

Example:

$_PropertyTool.outputFirstNotEmpty($currentPage.metadata.title, $currentPage.getStructuredDataNode("heading").textValue, $currentPage.name)

$_PropertyTool.outputProperties

Return a list of all available properties and methods an object exposes as well its type.

Example:

$_PropertyTool.outputProperties($currentPage)

$_RegexTool.compile

Returns a Pattern object   representing a valid regular expression.

Examples:

$_RegexTool.compile("^[a-zA-Z0-9]*$")

#set ($text = "A string to search for links containing the pattern https:// .")
#set ($patternString = ".*https://.*")
#set ($pattern = $_RegexTool.compile($patternString))
#set ($matcher = $pattern.matcher($text))
#set ($matches = $matcher.matches())
## Expected output: true

$_SerializerTool.serialize

Returns a String representing element as XML.

Example:

<wysiwyg> 
   <p>Here is a <strong>WYSIWYG</strong> element.</p>
   <p>It has multiple lines.</p>
</wysiwyg>

#set ($wysiwyg = $_XPathTool.selectSingleNode($contentRoot, "//wysiwyg"))
#set ($serialized = $_SerializerTool.serialize($wysiwyg,true))
## Expected output:
<p>Here is a <strong>WYSIWYG</strong> element.</p>
<p>It has multiple lines.</p>

$_SerializerTool.toJson

Serialize XML to JSON

Returns a String representing element or xml String as JSON.

Example:

<a>
   <b>B</b>
   <c>C</c>
</a>

#set ($a = $_XPathTool.selectSingleNode($contentRoot, "//a"))
$_SerializerTool.toJson($a, true)
## Expected output:
{"b":"B","c":"C"}

Serialize Map to JSON

Returns a String representing a Map as JSON.

Example:

#set ($a = {"test": "testing", "array": [1, 2, 3]})
$_SerializerTool.toJson($a)
## Expected output:
{"test":"testing","array":[1,2,3]}

$_SortTool.addSortCriterion

Adds a new set of parameters to be used during the next sort().

Notes:

• Defaults will be used if input values are not recognized.
• This method can be called multiple times to apply any number of criteria.

Example:

$_SortTool.addSortCriterion("title", "en", "text", "ascending", "upper-first")

$_SortTool.sort

Returns a sorted List based on the values from  addSortCriterion(), otherwise defaults are used.

Examples:

$_SortTool.addSortCriterion("name", "en", "text", "ascending", "upper-first")
$_SortTool.sort($pages)

#set ($currentFolderChildren = $currentPage.parentFolder.children)
#set ($sorted = $_SortTool.sort($currentFolderChildren,"name"))

$_SortTool.sort($courses, "metadata.dynamicField(course-number).value")

$_SortTool.sort($articles,"structuredDataNode(main/header).textValue:desc")

$_StringTool.generateUUID

Returns a String that represents a randomly generated UUID.

Example:

$_StringTool.generateUUID()
## Sample output: 29ecf0f3-7db4-41b5-94a2-3e170338c3b5

$_StringTool.getStringBuilder

Returns a new StringBuilder instance.

Example:

#set ($stringBuilder = $_StringTool.getStringBuilder())
#set ($_void = $stringBuilder.append("foo"))
#set ($_void = $stringBuilder.append("+"))
#set ($_void = $stringBuilder.append("bar"))
$stringBuilder
## Sample output: foo+bar

$_StringTool.substringAfter

Returns a String that exists after the needle in the haystack.

Example:

$_StringTool.substringAfter("aaabbbccc", "bbb")
## Expected output: ccc

$_StringTool.substringBefore

Returns a String that exists before the needle in the haystack.

Example:

$_StringTool.substringBefore("aaabbbccc", "bbb")
## Expected output: aaa

$_XPathTool.selectNodes

Returns a List of nodes matching a given xpath expression within content.

Example:

#set ($pages = $_XPathTool.selectNodes($contentRoot,"//system-page"))

$_XPathTool.selectSingleNode

Returns a Node matching a given xpath expression within content.

Example:

#set ($currentPage = $_XPathTool.selectSingleNode($contentRoot,"//system-page[@current]"))