API16:JHtmlBehavior/modal

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

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

Syntax

static modal($selector='a.modal', $params=array())

Parameter Name	Default Value	Description
$selector	'a.modal'
$params	array()

Defined in

libraries/joomla/html/html/behavior.php

Importing

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

Source Body

public static function modal($selector='a.modal', $params = array())
{
        static $modals;
        static $included;
 
        $document = &JFactory::getDocument();
 
        // Load the necessary files if they haven't yet been loaded
        if (!isset($included)) {
                // Load the javascript and css
                JHtml::_('behavior.framework');
                JHTML::_('script','system/modal.js', false, true);
                JHTML::_('stylesheet','system/modal.css', array(), true);
 
                $included = true;
        }
 
        if (!isset($modals)) {
                $modals = array();
        }
 
        $sig = md5(serialize(array($selector,$params)));
        if (isset($modals[$sig]) && ($modals[$sig])) {
                return;
        }
 
        // Setup options object
        $opt['ajaxOptions']     = (isset($params['ajaxOptions']) && (is_array($params['ajaxOptions']))) ? $params['ajaxOptions'] : null;
        $opt['size']            = (isset($params['size']) && (is_array($params['size']))) ? $params['size'] : null;
        $opt['shadow']          = (isset($params['shadow'])) ? $params['shadow'] : null;
        $opt['onOpen']          = (isset($params['onOpen'])) ? $params['onOpen'] : null;
        $opt['onClose']         = (isset($params['onClose'])) ? $params['onClose'] : null;
        $opt['onUpdate']        = (isset($params['onUpdate'])) ? $params['onUpdate'] : null;
        $opt['onResize']        = (isset($params['onResize'])) ? $params['onResize'] : null;
        $opt['onMove']          = (isset($params['onMove'])) ? $params['onMove'] : null;
        $opt['onShow']          = (isset($params['onShow'])) ? $params['onShow'] : null;
        $opt['onHide']          = (isset($params['onHide'])) ? $params['onHide'] : null;
 
        $options = JHtmlBehavior::_getJSObject($opt);
 
        // Attach modal behavior to document
        $document->addScriptDeclaration("
        window.addEvent('domready', function() {
 
                SqueezeBox.initialize(".$options.");
                SqueezeBox.assign($$('".$selector."'), {
                        parse: 'rel'
                });
        });");
 
        // Set static array
        $modals[$sig] = true;
        return;
}

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

Examples

<CodeExamplesForm />