1
0
mirror of https://github.com/owncloudarchive/contacts.git synced 2024-11-29 11:24:11 +01:00

Contacts: PoC request.

This commit is contained in:
Thomas Tanghus 2013-03-26 12:33:44 +01:00
parent 334751a18b
commit ebca7c662d
2 changed files with 196 additions and 0 deletions

View File

@ -8,6 +8,7 @@ OC::$CLASSPATH['OCA\Contacts\PIMCollectionAbstract'] = 'contacts/lib/abstractpim
OC::$CLASSPATH['OCA\Contacts\PIMObjectAbstract'] = 'contacts/lib/abstractpimobject.php';
OC::$CLASSPATH['OCA\Contacts\VCard'] = 'contacts/lib/vcard.php';
OC::$CLASSPATH['OCA\Contacts\Hooks'] = 'contacts/lib/hooks.php';
OC::$CLASSPATH['OCA\Contacts\Request'] = 'contacts/lib/request.php';
OC::$CLASSPATH['OCA\Contacts\Utils\JSONSerializer'] = 'contacts/lib/utils/jsonserializer.php';
OC::$CLASSPATH['OCA\Contacts\Utils\Properties'] = 'contacts/lib/utils/properties.php';
OC::$CLASSPATH['OCA\Contacts\Backend\AbstractBackend'] = 'contacts/lib/backend/abstractbackend.php';

195
lib/request.php Normal file
View File

@ -0,0 +1,195 @@
<?php
/**
* ownCloud - Request
*
* @author Thomas Tanghus
* @copyright 2013 Thomas Tanghus (thomas@tanghus.net)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Contacts;
/**
* Class for accessing variables in the request.
* This class provides an immutable object with request variables.
*/
class Request extends OC_Request implements \ArrayAccess {
protected $items = array();
/**
* @param array $vars And associative array with the following optional values:
* @param array 'urlParams' the parameters which were matched from the URL
* @param array 'get' the $_GET array
* @param array 'post' the $_POST array
* @param array 'files' the $_FILES array
* @param array 'server' the $_SERVER array
* @param array 'env' the $_ENV array
* @param array 'session' the $_SESSION array
* @param array 'cookies' the $_COOKIE array
* @see http://www.php.net/manual/en/reserved.variables.php
*/
public function __construct(array $vars) {
foreach($vars as $name => $var) {
switch(strtolower($name)) {
case 'get':
$this->items[$name] = $var ? $var : $_GET;
break;
case 'post':
$this->items[$name] = $var ? $var : $_POST;
break;
case 'files':
$this->items[$name] = $var ? $var : $_FILES;
break;
case 'server':
$this->items[$name] = $var ? $var : $_SERVER;
break;
case 'env':
$this->items[$name] = $var ? $var : $_ENV;
break;
case 'session':
$this->items[$name] = $var ? $var : $_SESSION;
break;
case 'cookies':
$this->items[$name] = $var ? $var : $_COOKIE;
break;
case 'urlParams':
$this->items[$name] = $var ? $var : array();
break;
}
}
$this->items['parameters'] = array_merge(
$this->items['urlParams'],
$_REQUEST
);
}
/**
* ArrayAccess methods
*
* Gives access to the combined GET, POST and urlParams arrays
*
* Examples:
*
* $var = $request['myvar'];
*
* or
*
* if(!isset($request['myvar']) {
* // Do something
* }
*
* $request['myvar'] = 'something'; // This throws an exception.
*
* @param string offset The key to lookup
* @return string|null
*/
public function offsetExists($offset) {
return isset($this->items['parameters'][$offset]);
}
/**
* @see offsetExists
*/
public function offsetGet($offset) {
return isset($this->items['parameters'][$offset])
? $this->items['parameters'][$offset]
: null;
}
/**
* @see offsetExists
*/
public function offsetSet($offset, $value) {
throw new \Exception('You cannot change the contents of the request object');
}
/**
* @see offsetExists
*/
public function offsetUnset($offset) {
throw new \Exception('You cannot change the contents of the request object');
}
/**
* Get a value from a request variable or the default value e.g:
* $request->get('post', 'some_key', 'default value');
*
* @param string $vars Which variables to look in e.g. 'get', 'post, 'session'
*/
public function get($vars, $name, $default = null) {
if(isset($this->{$vars}) && isset($this->{$vars}[$name])) {
return $this->{$vars}[$name];
}
return $default;
}
// Magic property accessors
public function __set($name, $value) {
throw new \Exception('You cannot change the contents of the request object');
}
/**
* Access request variables by method and name.
* Examples:
*
* $request->post['myvar']; // Only look for POST variables
* $request->myvar; or $request->{'myvar'}; or $request->{$myvar}
* Looks in the combined GET, POST and urlParams array.
*
* if($request->method !== 'POST') {
* throw new Exception('This function can only be invoked using POST');
* }
*
* @param string $name The key to look for.
* @return mixed|null
*/
public function __get($name) {
switch(strtolower($name)) {
case 'get':
case 'post':
case 'files':
case 'server':
case 'env':
case 'session':
case 'cookies':
case 'parameters':
case 'urlParams':
return isset($this->items[$name])
? $this->items[$name]
: null;
break;
case 'method':
return $this->server['REQUEST_METHOD'];
break;
default;
return $this->parameters[$name];
break;
}
}
public function __isset($name) {
return isset($this->items['parameters'][$name]);
}
public function __unset($id) {
throw new \Exception('You cannot change the contents of the request object');
}
}