Moodle in English: Which is the best way to insert a javascript script?

Which is the best way to insert a javascript script?

by Hrvoje G - Monday, November 24, 2014, 10:17 PM

Hi everyone!

I'd developing a block that would contain a list of user "bookmarks" that will be used to jump to a certain part of a text within Moodle Book chapter. The block by itself is simple and jumpers will be created as simple <a href="#jump_to_bookmark_33"> elements.

The question is what is the best way to insert a script that would contain a logic for new bookmarks creation (from text selection)? I see I can pass a script through the block I'm developing using
$this->page->requires->js_init_call(...

or I can also inherit the theme and include the script using
$THEME->javascripts_footer

or any other idea? Which is the best?

Thanks a lot
- Hrvoje

Re: Which is the best way to insert a javascript script?

by Tim Hunt - Monday, November 24, 2014, 11:16 PM

$this->page->requires is the best method. (The various other methods are legacy things, that we really ought to be cleaned up and removed at some point.)

Average of ratings: -

Re: Which is the best way to insert a javascript script?

by Hrvoje G - Tuesday, November 25, 2014, 3:33 PM

Thank you very much for your answer. I should do this that way then.

Also, I was just wondering should I include this script within the block class or somewhere else? Where would it be?

I'm asking because the block doesn't really need to exists for a functionality of "bookmarks" creation but only for "bookmarks" listing. In other words, the script for creation doesn't require block. But if there is no block, there will be no script.

Hope I explained well. I'm really wondering. Thanks a lot.

- Hrvoje

Average of ratings: -

Re: Which is the best way to insert a javascript script?

by Tim Hunt - Tuesday, November 25, 2014, 4:37 PM

It is fine to put extra scripts in your block plugin (or any type of Moodle plugin). I just picked a block at random from the plugins DB: https://github.com/deraadt/moodle-block_progress, and that has a separate script overview.php.

Average of ratings: -

Re: Which is the best way to insert a javascript script?

by Hrvoje G - Tuesday, November 25, 2014, 6:42 PM

Tnx

Average of ratings: -

General developer forum

Which is the best way to insert a javascript script?