mirror of
https://github.com/atlanticbiomedical/portal-legacy.git
synced 2025-07-02 01:47:28 -04:00
initial commit
This commit is contained in:
Chris Sewell
442
lib/symfony/request/sfRequest.class.php
Executable file
442
lib/symfony/request/sfRequest.class.php
Executable file
@ -0,0 +1,442 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the symfony package.
|
||||
* (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* (c) 2004-2006 Sean Kerr.
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
/**
|
||||
* sfRequest provides methods for manipulating client request information such
|
||||
* as attributes, errors and parameters. It is also possible to manipulate the
|
||||
* request method originally sent by the user.
|
||||
*
|
||||
* @package symfony
|
||||
* @subpackage request
|
||||
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
||||
* @author Sean Kerr <skerr@mojavi.org>
|
||||
* @version SVN: $Id: sfRequest.class.php 4266 2007-06-19 12:44:54Z fabien $
|
||||
*/
|
||||
abstract class sfRequest
|
||||
{
|
||||
/**
|
||||
* Process validation and execution for only GET requests.
|
||||
*
|
||||
*/
|
||||
const GET = 2;
|
||||
|
||||
/**
|
||||
* Skip validation and execution for any request method.
|
||||
*
|
||||
*/
|
||||
const NONE = 1;
|
||||
|
||||
/**
|
||||
* Process validation and execution for only POST requests.
|
||||
*
|
||||
*/
|
||||
const POST = 4;
|
||||
|
||||
/**
|
||||
* Process validation and execution for only PUT requests.
|
||||
*
|
||||
*/
|
||||
const PUT = 5;
|
||||
|
||||
/**
|
||||
* Process validation and execution for only DELETE requests.
|
||||
*
|
||||
*/
|
||||
const DELETE = 6;
|
||||
|
||||
/**
|
||||
* Process validation and execution for only HEAD requests.
|
||||
*
|
||||
*/
|
||||
const HEAD = 7;
|
||||
|
||||
protected
|
||||
$errors = array(),
|
||||
$context = null,
|
||||
$method = null,
|
||||
$parameterHolder = null,
|
||||
$config = null,
|
||||
$attributeHolder = null;
|
||||
|
||||
/**
|
||||
* Extracts parameter values from the request.
|
||||
*
|
||||
* @param array An indexed array of parameter names to extract
|
||||
*
|
||||
* @return array An associative array of parameters and their values. If
|
||||
* a specified parameter doesn't exist an empty string will
|
||||
* be returned for its value
|
||||
*/
|
||||
public function & extractParameters($names)
|
||||
{
|
||||
$array = array();
|
||||
|
||||
$parameters =& $this->parameterHolder->getAll();
|
||||
foreach ($parameters as $key => &$value)
|
||||
{
|
||||
if (in_array($key, $names))
|
||||
{
|
||||
$array[$key] =& $value;
|
||||
}
|
||||
}
|
||||
|
||||
return $array;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an error message.
|
||||
*
|
||||
* @param string An error name
|
||||
*
|
||||
* @return string An error message, if the error exists, otherwise null
|
||||
*/
|
||||
public function getError($name, $catalogue = 'messages')
|
||||
{
|
||||
$retval = null;
|
||||
|
||||
if (isset($this->errors[$name]))
|
||||
{
|
||||
$retval = $this->errors[$name];
|
||||
|
||||
// translate error message if needed
|
||||
if (sfConfig::get('sf_i18n'))
|
||||
{
|
||||
$retval = $this->context->getI18N()->__($retval, null, $catalogue);
|
||||
}
|
||||
}
|
||||
|
||||
return $retval;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an array of error names.
|
||||
*
|
||||
* @return array An indexed array of error names
|
||||
*/
|
||||
public function getErrorNames()
|
||||
{
|
||||
return array_keys($this->errors);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an array of errors.
|
||||
*
|
||||
* @return array An associative array of errors
|
||||
*/
|
||||
public function getErrors()
|
||||
{
|
||||
return $this->errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves this request's method.
|
||||
*
|
||||
* @return int One of the following constants:
|
||||
* - sfRequest::GET
|
||||
* - sfRequest::POST
|
||||
*/
|
||||
public function getMethod()
|
||||
{
|
||||
return $this->method;
|
||||
}
|
||||
|
||||
/**
|
||||
* Indicates whether or not an error exists.
|
||||
*
|
||||
* @param string An error name
|
||||
*
|
||||
* @return boolean true, if the error exists, otherwise false
|
||||
*/
|
||||
public function hasError($name)
|
||||
{
|
||||
return array_key_exists($name, $this->errors);
|
||||
}
|
||||
|
||||
/**
|
||||
* Indicates whether or not any errors exist.
|
||||
*
|
||||
* @return boolean true, if any error exist, otherwise false
|
||||
*/
|
||||
public function hasErrors()
|
||||
{
|
||||
return (count($this->errors) > 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes this sfRequest.
|
||||
*
|
||||
* @param sfContext A sfContext instance
|
||||
* @param array An associative array of initialization parameters
|
||||
* @param array An associative array of initialization attributes
|
||||
*
|
||||
* @return boolean true, if initialization completes successfully, otherwise false
|
||||
*
|
||||
* @throws <b>sfInitializationException</b> If an error occurs while initializing this Request
|
||||
*/
|
||||
public function initialize($context, $parameters = array(), $attributes = array())
|
||||
{
|
||||
$this->context = $context;
|
||||
|
||||
// initialize parameter and attribute holders
|
||||
$this->parameterHolder = new sfParameterHolder();
|
||||
$this->attributeHolder = new sfParameterHolder();
|
||||
|
||||
$this->parameterHolder->add($parameters);
|
||||
$this->attributeHolder->add($attributes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the current application context.
|
||||
*
|
||||
* @return sfContext Current application context
|
||||
*/
|
||||
public function getContext()
|
||||
{
|
||||
return $this->context;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a new sfRequest implementation instance.
|
||||
*
|
||||
* @param string A sfRequest implementation name
|
||||
*
|
||||
* @return sfRequest A sfRequest implementation instance
|
||||
*
|
||||
* @throws <b>sfFactoryException</b> If a request implementation instance cannot be created
|
||||
*/
|
||||
public static function newInstance($class)
|
||||
{
|
||||
// the class exists
|
||||
$object = new $class();
|
||||
|
||||
if (!($object instanceof sfRequest))
|
||||
{
|
||||
// the class name is of the wrong type
|
||||
$error = 'Class "%s" is not of the type sfRequest';
|
||||
$error = sprintf($error, $class);
|
||||
|
||||
throw new sfFactoryException($error);
|
||||
}
|
||||
|
||||
return $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes an error.
|
||||
*
|
||||
* @param string An error name
|
||||
*
|
||||
* @return string An error message, if the error was removed, otherwise null
|
||||
*/
|
||||
public function & removeError($name)
|
||||
{
|
||||
$retval = null;
|
||||
|
||||
if (isset($this->errors[$name]))
|
||||
{
|
||||
$retval =& $this->errors[$name];
|
||||
|
||||
unset($this->errors[$name]);
|
||||
}
|
||||
|
||||
return $retval;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets an error.
|
||||
*
|
||||
* @param string An error name
|
||||
* @param string An error message
|
||||
*
|
||||
*/
|
||||
public function setError($name, $message)
|
||||
{
|
||||
if (sfConfig::get('sf_logging_enabled'))
|
||||
{
|
||||
$this->getContext()->getLogger()->info('{sfRequest} error in form for parameter "'.$name.'" (with message "'.$message.'")');
|
||||
}
|
||||
|
||||
$this->errors[$name] = $message;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets an array of errors
|
||||
*
|
||||
* If an existing error name matches any of the keys in the supplied
|
||||
* array, the associated message will be overridden.
|
||||
*
|
||||
* @param array An associative array of errors and their associated messages
|
||||
*
|
||||
*/
|
||||
public function setErrors($errors)
|
||||
{
|
||||
$this->errors = array_merge($this->errors, $errors);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the request method.
|
||||
*
|
||||
* @param int One of the following constants:
|
||||
*
|
||||
* - sfRequest::GET
|
||||
* - sfRequest::POST
|
||||
* - sfRequest::PUT
|
||||
* - sfRequest::DELETE
|
||||
* - sfRequest::HEAD
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws <b>sfException</b> - If the specified request method is invalid
|
||||
*/
|
||||
public function setMethod($methodCode)
|
||||
{
|
||||
$available_methods = array(self::GET, self::POST, self::PUT, self::DELETE, self::HEAD, self::NONE);
|
||||
if (in_array($methodCode, $available_methods))
|
||||
{
|
||||
$this->method = $methodCode;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// invalid method type
|
||||
$error = 'Invalid request method: %s';
|
||||
$error = sprintf($error, $methodCode);
|
||||
|
||||
throw new sfException($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the parameters for the current request.
|
||||
*
|
||||
* @return sfParameterHolder The parameter holder
|
||||
*/
|
||||
public function getParameterHolder()
|
||||
{
|
||||
return $this->parameterHolder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the attributes holder.
|
||||
*
|
||||
* @return sfParameterHolder The attribute holder
|
||||
*/
|
||||
public function getAttributeHolder()
|
||||
{
|
||||
return $this->attributeHolder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an attribute from the current request.
|
||||
*
|
||||
* @param string Attribute name
|
||||
* @param string Default attribute value
|
||||
* @param string Namespace for the current request
|
||||
*
|
||||
* @return mixed An attribute value
|
||||
*/
|
||||
public function getAttribute($name, $default = null, $ns = null)
|
||||
{
|
||||
return $this->attributeHolder->get($name, $default, $ns);
|
||||
}
|
||||
|
||||
/**
|
||||
* Indicates whether or not an attribute exist for the current request.
|
||||
*
|
||||
* @param string Attribute name
|
||||
* @param string Namespace for the current request
|
||||
*
|
||||
* @return boolean true, if the attribute exists otherwise false
|
||||
*/
|
||||
public function hasAttribute($name, $ns = null)
|
||||
{
|
||||
return $this->attributeHolder->has($name, $ns);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets an attribute for the request.
|
||||
*
|
||||
* @param string Attribute name
|
||||
* @param string Value for the attribute
|
||||
* @param string Namespace for the current request
|
||||
*
|
||||
*/
|
||||
public function setAttribute($name, $value, $ns = null)
|
||||
{
|
||||
$this->attributeHolder->set($name, $value, $ns);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a paramater for the current request.
|
||||
*
|
||||
* @param string Parameter name
|
||||
* @param string Parameter default value
|
||||
* @param string Namespace for the current request
|
||||
*
|
||||
*/
|
||||
public function getParameter($name, $default = null, $ns = null)
|
||||
{
|
||||
return $this->parameterHolder->get($name, $default, $ns);
|
||||
}
|
||||
|
||||
/**
|
||||
* Indicates whether or not a parameter exist for the current request.
|
||||
*
|
||||
* @param string Parameter name
|
||||
* @param string Namespace for the current request
|
||||
*
|
||||
* @return boolean true, if the paramater exists otherwise false
|
||||
*/
|
||||
public function hasParameter($name, $ns = null)
|
||||
{
|
||||
return $this->parameterHolder->has($name, $ns);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a parameter for the current request.
|
||||
*
|
||||
* @param string Parameter name
|
||||
* @param string Parameter value
|
||||
* @param string Namespace for the current request
|
||||
*
|
||||
*/
|
||||
public function setParameter($name, $value, $ns = null)
|
||||
{
|
||||
$this->parameterHolder->set($name, $value, $ns);
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the shutdown procedure.
|
||||
*
|
||||
*/
|
||||
abstract function shutdown();
|
||||
|
||||
/**
|
||||
* Overloads a given method.
|
||||
*
|
||||
* @param string Method name
|
||||
* @param string Method arguments
|
||||
*
|
||||
* @return mixed User function callback
|
||||
*
|
||||
* @throws <b>sfException</b> if call fails
|
||||
*/
|
||||
public function __call($method, $arguments)
|
||||
{
|
||||
if (!$callable = sfMixer::getCallable('sfRequest:'.$method))
|
||||
{
|
||||
throw new sfException(sprintf('Call to undefined method sfRequest::%s', $method));
|
||||
}
|
||||
|
||||
array_unshift($arguments, $this);
|
||||
|
||||
return call_user_func_array($callable, $arguments);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user