<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Application
 *
 * @copyright   Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

JLoader::discover('JInput', dirname(__FILE__).'/input');

jimport('joomla.filter.filterinput');

/**
 * Joomla! Input Base Class
 *
 * This is an abstracted input class used to manage retrieving data from the application environment.
 *
 * @package     Joomla.Platform
 * @subpackage  Application
 * @since       11.1
 */
class JInput
{
    /**
     * @var    array  Options array for the JInput instance.
     * @since  11.1
     */
    protected $options = array();

    /**
     * @var    JFilterInput  Filter object to use.
     * @since  11.1
     */
    protected $filter = null;

    /**
     * @var    array  Input data.
     * @since  11.1
     */
    protected $data = array();

    /**
     * @var    array  Input objects.
     * @since  11.1
     */
    protected $inputs = array();

    /**
     * Constructor.
     *
     * @param   array  $source   Source data (Optional, default is $_REQUEST)
     * @param   array  $options  Array of configuration parameters (Optional)
     *
     * @return  void
     *
     * @since   11.1
     */
    public function __construct($source = null, $options = array())
    {
        if (isset ($options['filter'])) {
            $this->filter = $options['filter'];
        } else {
            $this->filter = JFilterInput::getInstance();
        }

        if (is_null($source)) {
            $this->data = & $_REQUEST;
        } else {
            $this->data = & $source;
        }

        // Set the options for the class.
        $this->options = $options;
    }

    /**
     * Magic method to get an input object
     *
     * @param   mixed   $name  Name of the input object to retrieve.
     *
     * @return  JInput  The request input object
     *
     * @since   11.1
     */
    public function __get($name)
    {
        if (isset ($this->inputs[$name])) {
            return $this->inputs[$name];
        }

        $className = 'JInput'.$name;
        if (class_exists($className)) {
            $this->inputs[$name] = new $className (null, $this->options);
            return $this->inputs[$name];
        }

        $superGlobal = '_'.strtoupper($name);
        if (isset ($GLOBALS[$superGlobal])) {
            $this->inputs[$name] = new JInput($GLOBALS[$superGlobal], $this->options);
            return $this->inputs[$name];
        }

        // TODO throw an exception
    }

    /**
     * Gets a value from the input data.
     *
     * @param   string  $name     Name of the value to get.
     * @param   mixed   $default  Default value to return if variable does not exist.
     * @param   string  $filter   Filter to apply to the value.
     *
     * @return  mixed  The filtered input value.
     *
     * @since   11.1
     */
    public function get($name, $default = null, $filter = 'cmd')
    {
        if (isset ($this->data[$name])) {
            return $this->filter->clean($this->data[$name], $filter);
        }

        return $default;
    }

    /**
     * Gets an array of values from the request.
     *
     * @param   array   $vars        Associative array of keys and filter types to apply.
     * @param   mixed   $datasource  Array to retrieve data from, or null
     *
     * @return  mixed  The filtered input data.
     *
     * @since   11.1
     */
    public function getArray($vars, $datasource = null)
    {
        $results = array();

        foreach ($vars AS $k => $v)
        {
            if (is_array($v)) {
                if (is_null($datasource)) {
                    $results[$k] = $this->getArray($v, $this->get($k, null, 'array'));
                } else {
                    $results[$k] = $this->getArray($v, $datasource[$k]);
                }
            } else {
                if (is_null($datasource)) {
                    $results[$k] = $this->get($k, null, $v);
                } else {
                    $results[$k] = $this->filter->clean($datasource[$k], $v);
                }
            }
        }
        return $results;
    }

    /**
     * Sets a value
     *
     * @param   string  $name   Name of the value to set.
     * @param   mixed   $value  Value to assign to the input.
     *
     * @return  void
     *
     * @since   11.1
     */
    public function set($name, $value)
    {
        $this->data[$name] = $value;
    }

    /**
     * Magic method to get filtered input data.
     *
     * @param   mixed    $name     Name of the value to get.
     * @param   string   $default  Default value to return if variable does not exist.
     *
     * @return  bool     The filtered boolean input value.
     *
     * @since   11.1
     */
    public function __call($name, $arguments)
    {
        if (substr($name, 0, 3) == 'get') {

            $filter = substr($name, 3);

            $default = null;
            if (isset ($arguments[1])) {
                $default = $arguments[1];
            }

            return $this->get($arguments[0], $default, $filter);
        }
    }

    /**
     * Gets the request method.
     *
     * @return  string     The request method.
     *
     * @since   11.1
     */
    public function getMethod($name, $arguments)
    {
        $method = strtoupper($_SERVER['REQUEST_METHOD']);
        return $method;
    }
}