CODEWITHSUNDEEP
javaapachevelocity
user747858
user747858

Reputation:

Calling Macro function in Velocity template

I am trying to figure out how to return a value from a velocity macro call and assign it to a varaible

my macro function looks something like this. its once in common shared macros files

#macro(getBookListLink, $readingTrackerResult)
   $readingTrackerResult.getBookListLink()
#end

I am need to assign the result of this macro to a variable in another velocity template file

I tried something like this

#set($book_list_link = #getBookListLink( $readingTrackerResult ))

but did not work. I tried with #,$ and with nothing in front of function getBookListLink. but nothing worked. Can not i return from a macro? something wrong with my macro?

But, As such if i call #getBookListLink( $readingTrackerResult ) separately in html file. it works and i can print the result to UI. But not able to assign to a variable.

Upvotes: 23

Views: 30272

Answers (6)

lgu
lgu

Reputation: 2460

Just another example to illustrate the principle :

Macro definition :

#macro ( getValue $flag )
#if ( $flag )
#set($value = "TRUE" )
#else
#set($value = "FALSE" )
#end
${value}## (ends with a comment to avoid "END-OF-LINE" in the resulting string)
#end

Call :

#set($myval = "#getValue( true )" )

Upvotes: 1

Axel Heider
Axel Heider

Reputation: 626

A macro parameter can be a list of objects. The called macro can extract each object from the list, manipulate it, and then the caller will see the changes.

#macro(call $something)
  #set($swallowOutput = $something)
#end

#macro(doSomething $out)
  #set($list=$out.get(0))
  #call($list.add("hallo-1")
  #call($list.add("hallo-2")
#end

#macro(doMoreComplexStuff)
  #set($myList=[])
  #doSomething([$myList])
  MyList now has $myList.size()) elements: $myList
#end

Upvotes: 0

Steffen
Steffen

Reputation: 31

Instead of living with the string limitations for 'return values', preferably an externally defined result variable can be passed 'by reference', e.g.:

#macro(getBookListLink $inTrackerResult $outBookListLink)
    #if ($outBookListLink)
        #set ($outBookListLink = $inTrackerResult.getBookListLink())
    #end
#end

#set ($myLink = "")
#getBookListLink($myTrackerResult $myLink)
myBookListLink = "$myLink"<br/>

Upvotes: 3

Fran&#231;ois Bachmann
Fran&#231;ois Bachmann

Reputation: 1

Or just write everything onto the same line: 

#macro( myMacro $param ) the_return_value #end

Upvotes: -1

Stefan Kleineikenscheidt
Stefan Kleineikenscheidt

Reputation: 71

To get rid of spaces and blank lines use multi-line comments (#* comment *#):

#macro( myMacro $param )#*
  *#the_return_value#*
*##end

Upvotes: 7

Nathan Bubna
Nathan Bubna

Reputation: 6933

Macros are not functions; they are for rendering output. However, if you don't mind losing the type and getting the result as text...

#set( $book_list_link = "#getBookListLink( $readingTrackerResult )" )

Upvotes: 33

Related Questions