CB Auto Actions

I am using Auto Actions with PHP eval.
I want to know:

1. How am I supposed to use substitutions within the PHP code?
Somthing simple like: $test = [username];
return $test;

2. How do I get access to a triggers function variables? For example trigger onBeforeDisplayUsersList has variable $allFields which I want to alter. What is complete code to access this variable?

1. How am I supposed to use substitutions within the PHP code?
Somthing simple like: $test = [username];
return $test;

Always treat substitutions in code as a string. It'll do the substitution before the PHP code is parsed and executed. So you'd need to do the below for example.

2. How do I get access to a triggers function variables? For example trigger onBeforeDisplayUsersList has variable $allFields which I want to alter. What is complete code to access this variable?

You need to use var1-10. So for example [var1] would be the first variable the trigger provides. Count to $allFields and that'd be the variable number to use next to var.

It is not clear to me what fields I can substitute, and how. I want to include the URL of the site in the resulting email, and have tried [cb:url location="..."] and [SITEURL], and neither work. Is there now a third form of CB variables at play here?

How / where can I look up what the variables are that can be substituted in CB Auto Actions?

krileon wrote:

1. How am I supposed to use substitutions within the PHP code?
Somthing simple like: $test = [username];
return $test;

Always treat substitutions in code as a string. It'll do the substitution before the PHP code is parsed and executed. So you'd need to do the below for example.

Code:

return '[username]';

2. How do I get access to a triggers function variables? For example trigger onBeforeDisplayUsersList has variable $allFields which I want to alter. What is complete code to access this variable?

You need to use var1-10. So for example [var1] would be the first variable the trigger provides. Count to $allFields and that'd be the variable number to use next to var.

This is not working as expected for me.
When I do a return [var4] or return '[var4]' with return var_dump it does not output the variable as requested. What am I doing wrong?

It is not clear to me what fields I can substitute, and how. I want to include the URL of the site in the resulting email, and have tried [cb:url location="..."] and [SITEURL], and neither work. Is there now a third form of CB variables at play here?

fields like name, username, email, and user_id are present in every install so I can only advise you on those, but you can substitute in generally any field within CB > Field Management. For all other substitution usage please see the below tutorial.

www.joomlapolis.com/support/tutorials/107-use-cases/18353-using-substitutions-throughout-cb

In your case for live site you'd use the below as shown in the above tutorial.

[cb:config param="live_site" /]

How / where can I look up what the variables are that can be substituted in CB Auto Actions?

For trigger variables you need to compare the trigger used against the below tutorial to see its variable list or find it in source.

www.joomlapolis.com/support/tutorials/120-api-usage/18358-using-cb-triggers

When I do a return [var4] or return '[var4]' with return var_dump it does not output the variable as requested. What am I doing wrong?

The coding is not the same as writing normal PHP. The output is surrounded by ob_start and ob_clean_end. This means the output is isolated to avoid conflicts or problems. So to actually return something you'll probably need to echo the results first then set the output parameter to return, var dump, etc.. Basically try the below.

krileon wrote: So to actually return something you'll probably need to echo the results first then set the output parameter to return, var dump, etc.. Basically try the below.

Code:

echo '[username]';

Still it is not working for me. Trying the above returns nothing, not even NULL. Trying to return '[username]' returns either "[username]" or string(10) "[username]". It never returns anything close like what I would expect.

Same for [var]. No matter what number I use it does not return anything usable. Instead it treats this expression as array or as string itself.

So I need to ask again:

1. How am I supposed to access a variable from a triggers function? I want to access it, manipulate it and return it.

2. How am I supposed to use substitutions within PHP code?