Hello,
I'm trying to implement sending email (to multiple users) from a block using simple action link but I'm not sure how to do it. I tried some combinations with action_link and add_action but didn't make it.
I would like my link to call my function on click. Can somebody point me in the right direction please?
Could you elaborate a bit further? Is this action executing some third party script? If yes let us see it.
Action link offers 3 possible actions:
component_action - used to attach custom javascript method to action
confirm_action - used to display confirmation dialog before executing link
popup_action - used to open new window based on the supplied parameters
Example of popup action would be this:
// print's a popup link to your custom page
echo $OUTPUT->action_link('/path/to/custompage.php', 'clickit', new popup_action('click', '/path/to/custompage.php'));
This action should execute a function which will send email to users registered as a teacher on a specific course.
If I am using code like this can i declare send_email function in my lib.php file?
$action=new component_action('click','send_email',array($USER->id);
You got it wrong. component_action works only with javascript. It expects a name of an existing javascript function and set of parameters.
What you need here is something else. You need a javascript function that will issue ajax call to custom php file which will in turn send those emails.
To do this you need:
// Place this in new js file located in your block
function block_myblock_sendemail(e) {
e.preventDefault();
Y.log('Enetered method');
var ioconfig = {
method: 'POST',
data: {'sesskey' : M.cfg.sesskey},
on: {
success: function (o, response) {
//OK
var data = Y.JSON.parse(response.responseText);
if (data.result) {
alert('Result is OK!');
}
},
failure: function (o, response) {
alert('Not OK!');
}
}
};
Y.io(M.cfg.wwwroot + '/blocks/myblock/myajaxscript.php', ioconfig);
}
// Create new php file called myajaxscript.php and place it with your block
define('AJAX_SCRIPT', true);
require_once('/path/to/config.php');
require_login(null, false, null, false, true);
require_sesskey();
//Do your thing here
$result = true;
echo $OUTPUT->header();
echo json_encode(array('result' => $result));
// Finally add this to your get_content method of the block:
$this->page->requires->js('/blocks/myblock/myscript.js');
//some other code
$this->content->text = $OUTPUT->action_link('/blocks/myblock/myajaxscript.php', 'clickit', new component_action('click', 'block_myblock_sendemail'));
Thank you very much Darko, your post is excellent lesson for me!
Help needed again. After I've done what you wrote, I get the following error:
{"error":"A required parameter (sesskey) was missing","stacktrace":"* line 463 of \/lib\/setuplib.php: moodle_exception thrown\n* line 545 of \/lib\/moodlelib.php: call to print_error()\n* line 70 of \/lib\/sessionlib.php: call to required_param()\n* line 81 of \/lib\/sessionlib.php: call to confirm_sesskey()\n* line 7 of \/blocks\/helpdesk\/sendemail.php: call to require_sesskey()\n","debuginfo":"\nError code: missingparam","reproductionlink":"http:\/\/localhost:8888\/moodle\/"}I'm working on a local MAMP platform
The error is clear:
A required parameter (sesskey) was missingTry changing the data part of AJAX defintion to look like this:
data: 'sesskey=' + M.cfg.sesskey,
Worked like a charm, thank you!
Additional question to this. Can I return true/false variable from JS to block php file?
No. If you need to present something to the user as a result of click you should do it in javascript, use simple alert like in the example I posted or alter html of block itself. For example if you want to add new message inside block than you need to add it dynamically. See this example in YUI docs
Similar to this:
$PAGE->set_url('/mod/book/tool/validator/bcindex.html', array('cmid'=>$cmid, 'chapterid'=>$chapterid));
In this part of action link url:
'/blocks/myblock/myajaxscript.php'
Of course.
// Change in link generation code.
echo $OUTPUT->action_link(new moodle_url('#'), 'clickit', new component_action('click', 'block_myblock_sendemail', array('param' => 123, 'param2' => 223)));
// Change in Javascript
function block_myblock_sendemail(e, args) {
e.preventDefault();
//....
var ioconfig = {
method: 'POST',
data: 'sesskey=' + M.cfg.sesskey +
'¶m=' + encodeURIComponent(args.param) +
'¶m2=' + encodeURIComponent(args.param2),
//....
}