Joomla! Documentation™

Description

Displays a calendar control field

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

Syntax

static calendar($value, $name, $id, $format= '%Y-%m-%d', $attribs=null)

Parameter Name	Default Value	Description
$value		The date value
$name		The name of the text field
$id		The id of the text field
$format	'%Y-%m-%d'	The date format
$attribs	null	Additional html attributes

Defined in

libraries/joomla/html/html.php

Importing

jimport( 'joomla.html.html' );

Source Body

public static function calendar($value, $name, $id, $format = '%Y-%m-%d', $attribs = null)
{
        static $done;

        if ($done === null) {
                $done = array();
        }

        // Load the calendar behavior
        JHtml::_('behavior.calendar');

        $readonly=isset($attribs['readonly']) && $attribs['readonly']=='readonly';
        if (is_array($attribs)) {
                $attribs = JArrayHelper::toString($attribs);
        }

        // Only display the triggers once for each control.
        if (!in_array($id, $done) && !$readonly)
        {
                $document = &JFactory::getDocument();
                $document->addScriptDeclaration('window.addEvent(\'domready\', function() {Calendar.setup({
                inputField: "'.$id.'",          // id of the input field
                ifFormat: "'.$format.'",        // format of the input field
                button: "'.$id.'_img",          // trigger for the calendar (button ID)
                align: "Tl",                            // alignment (defaults to "Bl")
                singleClick: true
        });});');
                $done[] = $id;
        }

        return '<input type="text" name="'.$name.'" id="'.$id.'" value="'.htmlspecialchars($value, ENT_COMPAT, 'UTF-8').'" '.$attribs.' />'.
                        JHTML::_('image','system/calendar.png', JText::_('calendar'), array( 'class' => 'calendar', 'id' => $id.'_img'), true);
}

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