This is a first cut of a new formslib.php a library of classes for creating and secur...

[moodle.git] / lib / form / dateselector.php

<?php
global $CFG;
require_once "$CFG->libdir/form/group.php";
require_once "$CFG->libdir/formslib.php";

/**
 * Class for a group of elements used to input a date.
 * 
 * Emulates moodle print_date_selector function 
 * 
 * @author Jamie Pratt <me@jamiep.org>
 * @access public
 */
class moodleform_date_selector extends moodleform_group
{
    /**
    * Control the fieldnames for form elements
    *
    * day => string day   fieldname
    * month => string month  fieldname
    * year => string year  fieldname
    * timezone => float/string timezone
    * applydst => apply users daylight savings adjustment?
    */
    var $_options = array('startyear'=>1970, 'stopyear'=>2020,
                    'timezone'=>99, 'applydst'=>true);

   /**
    * These complement separators, they are appended to the resultant HTML
    * @access   private
    * @var      array
    */
    var $_wrap = array('', '');

   /**
    * Class constructor
    * 
    * @access   public
    * @param    string  Element's name
    * @param    mixed   Label(s) for an element
    * @param    array   Options to control the element's display
    * @param    mixed   Either a typical HTML attribute string or an associative array
    */
    function moodleform_date_selector($elementName = null, $elementLabel = null, $options = array(), $attributes = null)
    {
        $this->HTML_QuickForm_element($elementName, $elementLabel, $attributes);
        $this->_persistantFreeze = true;
        $this->_appendName = true;
        $this->_type = 'date_selector';
        // set the options, do not bother setting bogus ones
        if (is_array($options)) {
            foreach ($options as $name => $value) {
                if (isset($this->_options[$name])) {
                    if (is_array($value) && is_array($this->_options[$name])) {
                        $this->_options[$name] = @array_merge($this->_options[$name], $value);
                    } else {
                        $this->_options[$name] = $value;
                    }
                }
            }
        }
    }

    // }}}
    // {{{ _createElements()

    function _createElements()
    {
        $this->_elements = array();
        for ($i=1; $i<=31; $i++) {
            $days[$i] = $i;
        }
        for ($i=1; $i<=12; $i++) {
            $months[$i] = userdate(gmmktime(12,0,0,$i,1,2000), "%B");
        }
        for ($i=$this->_options['startyear']; $i<=$this->_options['stopyear']; $i++) {
            $years[$i] = $i;
        }
        $this->_elements[] =& moodleform::createElement('select', 'day', null, $days, $this->getAttributes(), true);
        $this->_elements[] =& moodleform::createElement('select','month', null, $months, $this->getAttributes(), true);
        $this->_elements[] =& moodleform::createElement('select','year', null, $years, $this->getAttributes(), true);

    }

    // }}}
    // {{{ setValue()

    function setValue($value)
    {
        if (!($value)) {
            $value = time();
        }
        if (!is_array($value)) {
            $currentdate = usergetdate($value);
            $value = array(
                'day' => $currentdate['mday'],
                'month' => $currentdate['mon'],
                'year' => $currentdate['year']);
            
        }
        parent::setValue($value);
    }

    // }}}
    // {{{ toHtml()

    function toHtml()
    {
        include_once('HTML/QuickForm/Renderer/Default.php');
        $renderer =& new HTML_QuickForm_Renderer_Default();
        $renderer->setElementTemplate('{element}');
        parent::accept($renderer);
        return $this->_wrap[0] . $renderer->toHtml() . $this->_wrap[1];
    }

    // }}}
    // {{{ accept()

    function accept(&$renderer, $required = false, $error = null)
    {
        $renderer->renderElement($this, $required, $error);
    }

    // }}}
    // {{{ onQuickFormEvent()

    function onQuickFormEvent($event, $arg, &$caller)
    {
        if ('updateValue' == $event) {
            return HTML_QuickForm_element::onQuickFormEvent($event, $arg, $caller);
        } else {
            return parent::onQuickFormEvent($event, $arg, $caller);
        }
    }
    /**
     * Output a timestamp. Give it the name of the group.
     *
     * @param array $submitValues
     * @param bool $assoc
     * @return array
     */
    function exportValue(&$submitValues, $assoc = false)
    {
        $value = null;
        $valuearray = $this->_elements[0]->exportValue($submitValues[$this->getName()], true);
        $valuearray +=$this->_elements[1]->exportValue($submitValues[$this->getName()], true);
        $valuearray +=$this->_elements[2]->exportValue($submitValues[$this->getName()], true);
        $value[$this->getName()]=make_timestamp($valuearray['year'],
                               $valuearray['month'],
                               $valuearray['day'],
                               0,0,0,
                               $this->_options['timezone'],
                               $this->_options['applydst']);
        return $value;
    }

    // }}}
}
?>