Proyectos de Subversion Moodle

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4: */

// +----------------------------------------------------------------------+

// | PHP version 4.0                                                      |

// +----------------------------------------------------------------------+

// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group             |

// +----------------------------------------------------------------------+

// | This source file is subject to version 2.0 of the PHP license,       |

// | that is bundled with this package in the file LICENSE, and is        |

// | available at through the world-wide-web at                           |

// | http://www.php.net/license/2_02.txt.                                 |

// | If you did not receive a copy of the PHP license and are unable to   |

// | obtain it through the world-wide-web, please send a note to          |

// | license@php.net so we can mail you a copy immediately.               |

// +----------------------------------------------------------------------+

// | Authors: Adam Daniel <adaniel1@eesus.jnj.com>                        |

// |          Bertrand Mansion <bmansion@mamasam.com>                     |

// +----------------------------------------------------------------------+

//

// $Id$

require_once('HTML/Common.php');

/**

 * Static utility methods.

 */

require_once('HTML/QuickForm/utils.php');

/**

 * Base class for form elements

 *

 * @author       Adam Daniel <adaniel1@eesus.jnj.com>

 * @author       Bertrand Mansion <bmansion@mamasam.com>

 * @version      1.3

 * @since        PHP4.04pl1

 * @access       public

 * @abstract

 */

class HTML_QuickForm_element extends HTML_Common

{

    // {{{ properties

    /**

     * Label of the field

     * @var       string

     * @since     1.3

     * @access    private

     */

    var $_label = '';

    /**

     * Form element type

     * @var       string

     * @since     1.0

     * @access    private

     */

    var $_type = '';

    /**

     * Flag to tell if element is frozen

     * @var       boolean

     * @since     1.0

     * @access    private

     */

    var $_flagFrozen = false;

    /**

     * Does the element support persistant data when frozen

     * @var       boolean

     * @since     1.3

     * @access    private

     */

    var $_persistantFreeze = false;

    // }}}

    // {{{ constructor

    /**

     * Class constructor

     *

     * @param    string     Name of the element

     * @param    mixed      Label(s) for the element

     * @param    mixed      Associative array of tag attributes or HTML attributes name="value" pairs

     * @since     1.0

     * @access    public

     * @return    void

     */

    public function __construct($elementName=null, $elementLabel=null, $attributes=null) {

        parent::__construct($attributes);

        if (isset($elementName)) {

            $this->setName($elementName);

        }

        if (isset($elementLabel)) {

            $this->setLabel($elementLabel);

        }

    } //end constructor

    /**

     * Old syntax of class constructor. Deprecated in PHP7.

     *

     * @deprecated since Moodle 3.1

     */

    public function HTML_QuickForm_element($elementName=null, $elementLabel=null, $attributes=null) {

        debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);

        self::__construct($elementName, $elementLabel, $attributes);

    }

    // }}}

    // {{{ apiVersion()

    /**

     * Returns the current API version

     *

     * @since     1.0

     * @access    public

     * @return    float

     */

    function apiVersion()

    {

        return 2.0;

    } // end func apiVersion

    // }}}

    // {{{ getType()

    /**

     * Returns element type

     *

     * @since     1.0

     * @access    public

     * @return    string

     */

    function getType()

    {

        return $this->_type;

    } // end func getType

    // }}}

    // {{{ setName()

    /**

     * Sets the input field name

     *

     * @param     string    $name   Input field name attribute

     * @since     1.0

     * @access    public

     * @return    void

     */

    function setName($name)

    {

        // interface method

    } //end func setName

    // }}}

    // {{{ getName()

    /**

     * Returns the element name

     *

     * @since     1.0

     * @access    public

     * @return    string

     */

    function getName()

    {

        // interface method

    } //end func getName

    // }}}

    // {{{ setValue()

    /**

     * Sets the value of the form element

     *

     * @param     string    $value      Default value of the form element

     * @since     1.0

     * @access    public

     * @return    void

     */

    function setValue($value)

    {

        // interface

    } // end func setValue

    // }}}

    // {{{ getValue()

    /**

     * Returns the value of the form element

     *

     * @since     1.0

     * @access    public

     * @return    mixed

     */

    function getValue()

    {

        // interface

        return null;

    } // end func getValue

    // }}}

    // {{{ freeze()

    /**

     * Freeze the element so that only its value is returned

     *

     * @access    public

     * @return    void

     */

    function freeze()

    {

        $this->_flagFrozen = true;

    } //end func freeze

    // }}}

    // {{{ unfreeze()

   /**

    * Unfreezes the element so that it becomes editable

    *

    * @access public

    * @return void

    * @since  3.2.4

    */

    function unfreeze()

    {

        $this->_flagFrozen = false;

    }

    // }}}

    // {{{ getFrozenHtml()

    /**

     * Returns the value of field without HTML tags

     *

     * @since     1.0

     * @access    public

     * @return    string

     */

    function getFrozenHtml()

    {

        $value = $this->getValue();

        return ('' != $value? htmlspecialchars($value): ' ') .

               $this->_getPersistantData();

    } //end func getFrozenHtml

    // }}}

    // {{{ _getPersistantData()

   /**

    * Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on

    *

    * @access private

    * @return string

    */

    function _getPersistantData()

    {

        if (!$this->_persistantFreeze) {

            return '';

        } else {

            $id = $this->getAttribute('id');

            if (isset($id)) {

                // Id of persistant input is different then the actual input.

                $id = array('id' => $id . '_persistant');

            } else {

                $id = array();

            }

            return '<input' . $this->_getAttrString(array(

                       'type'  => 'hidden',

                       'name'  => $this->getName(),

                       'value' => $this->getValue()

                   ) + $id) . ' />';

        }

    }

    // }}}

    // {{{ isFrozen()

    /**

     * Returns whether or not the element is frozen

     *

     * @since     1.3

     * @access    public

     * @return    bool

     */

    function isFrozen()

    {

        return $this->_flagFrozen;

    } // end func isFrozen

    // }}}

    // {{{ setPersistantFreeze()

    /**

     * Sets wether an element value should be kept in an hidden field

     * when the element is frozen or not

     *

     * @param     bool    $persistant   True if persistant value

     * @since     2.0

     * @access    public

     * @return    void

     */

    function setPersistantFreeze($persistant=false)

    {

        $this->_persistantFreeze = $persistant;

    } //end func setPersistantFreeze

    // }}}

    // {{{ setLabel()

    /**

     * Sets display text for the element

     *

     * @param     string    $label  Display text for the element

     * @since     1.3

     * @access    public

     * @return    void

     */

    function setLabel($label)

    {

        $this->_label = $label;

    } //end func setLabel

    // }}}

    // {{{ getLabel()

    /**

     * Returns display text for the element

     *

     * @since     1.3

     * @access    public

     * @return    string

     */

    function getLabel()

    {

        return $this->_label;

    } //end func getLabel

    // }}}

    // {{{ _findValue()

    /**

     * Tries to find the element value from the values array

     *

     * @since     2.7

     * @access    private

     * @return    mixed

     */

    function _findValue(&$values)

    {

        if (empty($values)) {

            return null;

        }

        $elementName = $this->getName() ?? '';

        if (isset($values[$elementName])) {

            return $values[$elementName];

        } elseif (strpos($elementName, '[')) {

            $keys = str_replace(

                array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),

                $elementName

            );

            $arrayKeys = explode("']['", $keys);

            return HTML_QuickForm_utils::recursiveValue($values, $arrayKeys);

        } else {

            return null;

        }

    } //end func _findValue

    // }}}

    // {{{ onQuickFormEvent()

    /**

     * Called by HTML_QuickForm whenever form event is made on this element

     *

     * @param     string    $event  Name of event

     * @param     mixed     $arg    event arguments

     * @param     object    $caller calling object

     * @since     1.0

     * @access    public

     * @return    void

     */

    function onQuickFormEvent($event, $arg, &$caller)

    {

        switch ($event) {

            case 'createElement':

                static::__construct($arg[0], $arg[1], $arg[2], $arg[3], $arg[4], $arg[5]);

                if ($caller->getAttribute('data-random-ids') && !$this->getAttribute('id')) {

                    $this->_generateId();

                    $attributes = $this->getAttributes();

                    $attributes['id'] = $this->getAttribute('id') . '_' . random_string();

                    $this->updateAttributes($attributes);

                }

                break;

            case 'addElement':

                $this->onQuickFormEvent('createElement', $arg, $caller);

                $this->onQuickFormEvent('updateValue', null, $caller);

                break;

            case 'updateValue':

                // constant values override both default and submitted ones

                // default values are overriden by submitted

                $value = $this->_findValue($caller->_constantValues);

                if (null === $value) {

                    $value = $this->_findValue($caller->_submitValues);

                    if (null === $value) {

                        $value = $this->_findValue($caller->_defaultValues);

                    }

                }

                if (null !== $value) {

                    $this->setValue($value);

                }

                break;

            case 'setGroupValue':

                $this->setValue($arg);

        }

        return true;

    } // end func onQuickFormEvent

    // }}}

    // {{{ accept()

   /**

    * Accepts a renderer

    *

    * @param object     An HTML_QuickForm_Renderer object

    * @param bool       Whether an element is required

    * @param string     An error message associated with an element

    * @access public

    * @return void

    */

    function accept(&$renderer, $required=false, $error=null)

    {

        $renderer->renderElement($this, $required, $error);

    } // end func accept

    // }}}

    // {{{ _generateId()

   /**

    * Automatically generates and assigns an 'id' attribute for the element.

    *

    * Currently used to ensure that labels work on radio buttons and

    * checkboxes. Per idea of Alexander Radivanovich.

    *

    * @access private

    * @return void

    */

    function _generateId() {

        if ($this->getAttribute('id')) {

            return;

        }

        $id = $this->getName() ?? '';

        $id = 'id_' . str_replace(array('qf_', '[', ']'), array('', '_', ''), $id);

        $id = clean_param($id, PARAM_ALPHANUMEXT);

        $this->updateAttributes(array('id' => $id));

    }

    // }}}

    // {{{ exportValue()

   /**

    * Returns a 'safe' element's value

    *

    * @param  array   array of submitted values to search

    * @param  bool    whether to return the value as associative array

    * @access public

    * @return mixed

    */

    function exportValue(&$submitValues, $assoc = false)

    {

        $value = $this->_findValue($submitValues);

        if (null === $value) {

            $value = $this->getValue();

        }

        return $this->_prepareValue($value, $assoc);

    }

    // }}}

    // {{{ _prepareValue()

   /**

    * Used by exportValue() to prepare the value for returning

    *

    * @param  mixed   the value found in exportValue()

    * @param  bool    whether to return the value as associative array

    * @access private

    * @return mixed

    */

    function _prepareValue($value, $assoc)

    {

        if (null === $value) {

            return null;

        } elseif (!$assoc) {

            return $value;

        } else {

            $name = $this->getName();

            if (!strpos($name, '[')) {

                return array($name => $value);

            } else {

                $keys = str_replace(

                    array('\\', '\'', ']', '['), array('\\\\', '\\\'', '', "']['"),

                    $name

                );

                $keysArray = explode("']['", $keys);

                return HTML_QuickForm_utils::recursiveBuild($keysArray, $value);

            }

        }

    }

    // }}}

} // end class HTML_QuickForm_element

?>