horros / agavi2

src/request/RequestDataHolder.class.php

<?php

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

namespace Agavi\Request;

use Agavi\Util\Inflector;
use Agavi\Util\ParameterHolder;
use InvalidArgumentException;

/**
 * RequestDataHolder provides methods for retrieving client request
 * information parameters.
 *
 * @package    agavi
 * @subpackage request
 *
 * @author     Dominik del Bondio <ddb@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.11.0
 *
 * @version    $Id$
 */
class RequestDataHolder extends ParameterHolder implements ParametersRequestDataHolderInterface
{
    /**
     * @constant   Constant for source name of parameters.
     */
    const SOURCE_PARAMETERS = 'parameters';

    /*
	 * @var        array An array of source names and references to their data
	 *                   containers. Unset again after construction is complete.
	 */
    private $sources = array();

    /*
	 * @var        array An array of plural source names and their singular forms.
	 */
    private $sourceNames = array();

    /**
     * Merge in parameters from another request data holder.
     *
     * @param      RequestDataHolder $other The other request data holder.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function mergeParameters(RequestDataHolder $other)
    {
        $this->setParameters($other->getParameters());
    }

    /**
     * Checks if there is a value of a parameter is empty.
     *
     * @param      string $field The field name.
     *
     * @return     bool The result.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function isParameterValueEmpty($field)
    {
        return !$this->hasParameter($field);
    }
    
    /**
     * Deletes all fields in a given source.
     *
     * @param      string $source The name of the source to operate on.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function clear($source)
    {
        if (isset($this->$source)) {
            $funcname = 'clear' . $source;
            $this->$funcname();
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . ' specified');
        }
    }

    /**
     * Deletes all fields in all sources.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function clearAll()
    {
        foreach ($this->sourceNames as $sourceName => $source) {
            $funcname = 'clear' . $sourceName;
            $this->$funcname();
        }
    }

    /**
     * Retrieves a field from one of the stored data types.
     *
     * @param      string $source The name of the source to operate on.
     * @param      string $field A field name.
     * @param      mixed  $default A default value.
     *
     * @return     mixed The field value.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function &get($source, $field, $default = null)
    {
        if (isset($this->$source)) {
            $funcname = 'get' . $this->sourceNames[$source];
            return $this->$funcname($field, $default);
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . 'specified');
        }
    }

    /**
     * Retrieves all fields of a stored data types.
     *
     * @param      string $source The name of the source to operate on.
     *
     * @return     mixed The values.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function &getAll($source)
    {
        if (isset($this->$source)) {
            $funcname = 'get' . $source;
            return $this->$funcname();
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . 'specified');
        }
    }

    /**
     * Checks if a field exists.
     *
     * @param      string $source The name of the source to operate on.
     * @param      string $field A field name.
     *
     * @return     bool The result.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function has($source, $field)

This method seems to be duplicated in your project.

    {
        if (isset($this->$source)) {
            $funcname = 'has' . $this->sourceNames[$source];
            return $this->$funcname($field);
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . 'specified');
        }
    }

    /**
     * Checks if a field has no value (In web context this would only return true
     * when the strings length is 0 or the field is not set.
     *
     * @param      string $source The name of the source to operate on.
     * @param      string $field A field name.
     *
     * @return     bool The result.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function isValueEmpty($source, $field)

This method seems to be duplicated in your project.

    {
        if (isset($this->$source)) {
            $funcname = 'is' . $this->sourceNames[$source] . 'ValueEmpty';
            return $this->$funcname($field);
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . 'specified');
        }
    }

    /**
     * Removes a field.
     *
     * @param      string $source The name of the source to operate on.
     * @param      string $field A field name.
     *
     * @return     mixed The removed value.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function &remove($source, $field)

This method seems to be duplicated in your project.

    {
        if (isset($this->$source)) {
            $funcname = 'remove' . $this->sourceNames[$source];
            return $this->$funcname($field);
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . 'specified');
        }
    }

    /**
     * Sets a field.
     *
     * @param      string $source The name of the source to operate on.
     * @param      string $field  A field name.
     * @param      mixed  $value  A value.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function set($source, $field, $value)
    {
        if (isset($this->$source)) {
            $funcname = 'set' . $this->sourceNames[$source];
            $this->$funcname($field, $value);
        } else {
            throw new InvalidArgumentException('Unknown source ' . $source . 'specified');
        }
    }
    
    /**
     * Register a source with the holder. Must be called in constructors, and
     * prior to calling the parent ctor.
     *
     * @param      string $name The source name, typically passed using a constant.
     * @param      array  $holder The variable that will hold the data for the source.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    final protected function registerSource($name, array &$holder)
    {
        $this->sources[$name] =& $holder;
        $this->sourceNames[$name] = Inflector::singularize($name);
    }
    
    /**
     * Merge in another request data holder.
     *
     * This method calls mergeSourcename for each source.
     *
     * @param      RequestDataHolder $other The other request data holder.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function merge(RequestDataHolder $other)
    {
        foreach (array_keys($this->sourceNames) as $source) {
            $fn = 'merge' . $source; // plural form!
            $this->$fn($other);
        }
    }
    
    /**
     * Returns all the registered source names.
     *
     * @return     array A list of source names.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    final public function getSourceNames()
    {
        return array_keys($this->sourceNames);
    }

    /**
     * Constructor
     *
     * @param      array $data An associative array of request data source names and
     *                   data arrays.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function __construct(array $data = array())
    {
        $this->registerSource(self::SOURCE_PARAMETERS, $this->parameters);
        
        foreach ($this->sources as $name => &$container) {
            if (isset($data[$name]) && is_array($data[$name])) {
                $container = $data[$name];
            } else {
                $container = array();
            }
        }
        
        // unset it to clean up references that otherwise would mess up cloning
        unset($this->sources);
    }
}