Using AJAX in a custom module - how to do it?

Question

I think this might be useful in future for many others. First of all, I know that there's com_ajax for this kind of a job, but I do not want to use it. Is there an alternative?

What I got:

default.php

<form method="post" name="filterForm">
    <input type="checkbox" name="checkboxList[]" value="1">value1</input>
    <input type="checkbox" name="checkboxList[]" value="2">value2</input>
    <input type="checkbox" name="checkboxList[]" value="3">value3</input>
</form>


jQuery(function($) { // DOM is now ready

    $("input[type=checkbox]").on("change", function() {
        var data = $("filterForm").serialize();
        $.ajax({
            url: "/modules/mod_mymodule/mymodule.php",
            type: "POST",
            async: true,
            cache: false,
            data: ({data: data}),
            dataType: "text",
        });
    });

});

mymodule.php

//defined('_JEXEC') or die; <-- So it's possible to access this file
print_r($_POST);

I get an empty array. What is wrong?

Answer 1

I don't understand why you are trying to bypass the framework. I know it is resources wise but it opens you up to security risks. The other thing is that you can't use framework classes/functions as easily. What I would do is:

• Instead of using a direct URL to the module file, use current URI (JURI::current() as far as I remember). This will direct a POST data to a view where your module was executed so you have the access to it from your module.
• Then use JFactory::getApplication()->input in your module to access the post data sent by jQuery request. That way you're in the framework, all the security/filtering options are available and working.
• Depending on what you want to do with the data you can store it in the database, file or send it by email.
• If you need to let jQuery know about the result of your actions with the data you can exit the application JFactory::getApplication()->close("OK") then just check the response in jQuery.

Answer 2

Relates to Sending POST data within module - AJAX

And I've posted answer there already.

In a two words: use com_ajax.

How to? Check answer in post mentioned above. Or look into the code of com_ajax It's pretty simple: you'll send requests to index.php?option=com_ajax&ignoreMessages&module=YMODULE&method=YMETHOD&format=json Description of module logic is in the post above.

And I'll add call plugin description here:

index.php?option=com_ajax&ignoreMessages&plugin=EVENT&group=PLUGINGROUP&format=json

it will load plugins of group PUGINGROUP (ajax group is default) and trigger the event onAjaxEVENT()

Answer 3

if you do not want to use com_ajax you can create your own component to handle the ajax calls, another solution is to use a system plugin which would catch your URL and process it.

if you decide to use your own php file instead of processing it via joomla's main index.php, this could lead to lot's of security issues especially if you distribute your module to various customers/users.

the ideal php firewall would detect php executables, whereas in the ideal site there would be just the index.php. thus disallowing executables outside the 2 index.php in joomla is one of the best security measures in joomla world.