API15:JHTMLBehavior/mootools

Description

Method to load the mootools framework into the document head

<! removed transcluded page call, red link never existed >

Syntax

mootools($debug=null)

Parameter Name	Default Value	Description
$debug	null	$debug Is debugging mode on? [optional]

Returns

void

Defined in

libraries/joomla/html/html/behavior.php

Importing

jimport( 'joomla.html.html.behavior' );

Source Body

function mootools($debug = null)
{
        static $loaded;

        // Only load once
        if ($loaded) {
                return;
        }

        // If no debugging value is set, use the configuration setting
        if ($debug === null) {
                $config = &JFactory::getConfig();
                $debug = $config->getValue('config.debug');
        }

        // TODO NOTE: Here we are checking for Konqueror - If they fix thier issue with compressed, we will need to update this
        $konkcheck = isset($_SERVER['HTTP_USER_AGENT']) ? strpos(strtolower($_SERVER['HTTP_USER_AGENT']), "konqueror") : null;

        if ($debug || $konkcheck) {
                JHTML::script('mootools-uncompressed.js', 'media/system/js/', false);
        } else {
                JHTML::script('mootools.js', 'media/system/js/', false);
        }
        $loaded = true;
        return;
}

<! removed transcluded page call, red link never existed >

Code Examples

A typical example of loading MooTools

// This example depends on mootools
JHTML::_('behavior.mootools');

// Do something after page has loaded
$document =& JFactory::getDocument();
$document->addScriptDeclaration("window.addEvent('load', function() { doSomething(); })");

Chris Davenport 01:07, 22 April 2010 (EDT) Edit comment