Finally, rename all HTTP to Http

Sowapps · Jan 13, 2022 · 031ffb0 · 031ffb0
1 parent 84c2596
commit 031ffb0
Show file tree

Hide file tree

Showing 11 changed files with 55 additions and 54 deletions.
diff --git a/src/Rest/Controller/Api/EntityRestController.php b/src/Rest/Controller/Api/EntityRestController.php
@@ -11,7 +11,7 @@
 use Orpheus\Exception\ForbiddenException;
 use Orpheus\Exception\NotFoundException;
 use Orpheus\InputController\ControllerRoute;
-use Orpheus\InputController\HTTPController\HTTPRequest;
+use Orpheus\InputController\HttpController\HttpRequest;
 use Orpheus\Publisher\Exception\FieldNotFoundException;
 
 /**
@@ -47,7 +47,7 @@ abstract class EntityRestController extends RestController {
 	protected $pathItemId = 'itemId';
 
 	/**
-	 * @param HTTPRequest $request
+	 * @param HttpRequest $request
 	 * @return null
 	 * @throws ForbiddenException
 	 * @throws FieldNotFoundException

diff --git a/src/Rest/Controller/Api/RestController.php b/src/Rest/Controller/Api/RestController.php
@@ -8,18 +8,18 @@
 use Orpheus\EntityDescriptor\User\AbstractUser;
 use Orpheus\EntityDescriptor\User\UserApiConnectible;
 use Orpheus\Exception\UserException;
-use Orpheus\InputController\HTTPController\HTTPController;
-use Orpheus\InputController\HTTPController\HTTPRequest;
-use Orpheus\InputController\HTTPController\HTTPResponse;
-use Orpheus\InputController\HTTPController\JSONHTTPResponse;
+use Orpheus\InputController\HttpController\HttpController;
+use Orpheus\InputController\HttpController\HttpRequest;
+use Orpheus\InputController\HttpController\HttpResponse;
+use Orpheus\InputController\HttpController\JSONHttpResponse;
 use Throwable;
 
 /**
  * Class RestController
  *
  * @package Orpheus\Rest\Controller\Api
  */
-abstract class RestController extends HTTPController {
+abstract class RestController extends HttpController {
 
 	const HEADER_AUTHORIZATION = 'Authorization';
 	const HEADER_ALT_AUTHORIZATION = 'X-Auth';
@@ -31,7 +31,7 @@ abstract class RestController extends HTTPController {
 	protected static $authenticatedUserId;
 
 	/**
-	 * @param HTTPRequest $request
+	 * @param HttpRequest $request
 	 * @return null
 	 */
 	public function preRun($request) {
@@ -72,15 +72,15 @@ public function getUserAccess() {
 	}
 
 	public function renderOutput($data) {
-		return new JSONHTTPResponse($data);
+		return new JSONHttpResponse($data);
 	}
 
-	public function processException(Throwable $exception, $values = []): HTTPResponse {
-		return JSONHTTPResponse::generateFromException($exception);
+	public function processException(Throwable $exception, $values = []): HttpResponse {
+		return JSONHttpResponse::generateFromException($exception);
 	}
 
-	public function processUserException(UserException $exception, $values = []): HTTPResponse {
-		return JSONHTTPResponse::generateFromUserException($exception, $values);
+	public function processUserException(UserException $exception, $values = []): HttpResponse {
+		return JSONHttpResponse::generateFromUserException($exception, $values);
 	}
 
 	/**
@@ -89,4 +89,5 @@ public function processUserException(UserException $exception, $values = []): HT
 	public static function getAuthenticatedUserId() {
 		return self::$authenticatedUserId;
 	}
+
 }
diff --git a/src/Rest/Controller/Api/RestCreateController.php b/src/Rest/Controller/Api/RestCreateController.php
@@ -6,7 +6,7 @@
 namespace Orpheus\Rest\Controller\Api;
 
 use Orpheus\EntityDescriptor\Exception\DuplicateException;
-use Orpheus\InputController\HTTPController\JSONHTTPResponse;
+use Orpheus\InputController\HttpController\JSONHttpResponse;
 use Orpheus\InputController\InputRequest;
 use Orpheus\InputController\OutputResponse;
 
@@ -41,6 +41,6 @@ public function run($request): HttpResponse {
 
 		$data = $this->entityService->extractPublicArray($item, $output);
 
-		return new JSONHTTPResponse($data);
+		return new JSONHttpResponse($data);
 	}
 }
diff --git a/src/Rest/Controller/Api/RestListController.php b/src/Rest/Controller/Api/RestListController.php
@@ -6,8 +6,8 @@
 namespace Orpheus\Rest\Controller\Api;
 
 use Orpheus\EntityDescriptor\PermanentEntity;
-use Orpheus\InputController\HTTPController\HTTPRequest;
-use Orpheus\InputController\HTTPController\JSONHTTPResponse;
+use Orpheus\InputController\HttpController\HttpRequest;
+use Orpheus\InputController\HttpController\JSONHttpResponse;
 use Orpheus\InputController\OutputResponse;
 
 /**
@@ -20,7 +20,7 @@ class RestListController extends EntityRestController {
 	/**
 	 * Run this controller
 	 *
-	 * @param HTTPRequest $request
+	 * @param HttpRequest $request
 	 * @return OutputResponse|null
 	 */
 	public function run($request): HttpResponse {
@@ -37,6 +37,6 @@ public function run($request): HttpResponse {
 			$data[$item->id()] = $this->entityService->extractPublicArray($item, $output);
 		}
 
-		return new JSONHTTPResponse($data);
+		return new JSONHttpResponse($data);
 	}
 }
diff --git a/src/Rest/Controller/Api/RestReadController.php b/src/Rest/Controller/Api/RestReadController.php
@@ -5,7 +5,7 @@
 
 namespace Orpheus\Rest\Controller\Api;
 
-use Orpheus\InputController\HTTPController\JSONHTTPResponse;
+use Orpheus\InputController\HttpController\JSONHttpResponse;
 use Orpheus\InputController\InputRequest;
 
 /**
@@ -19,13 +19,13 @@ class RestReadController extends EntityRestController {
 	 * Run this controller
 	 *
 	 * @param InputRequest $request
-	 * @return JSONHTTPResponse
+	 * @return JSONHttpResponse
 	 */
 	public function run($request): HttpResponse {
 		$output = $request->getParameter('output', 'all');
 
 		$data = $this->entityService->extractPublicArray($this->item, $output);
 
-		return new JSONHTTPResponse($data);
+		return new JSONHttpResponse($data);
 	}
 }
diff --git a/src/Rest/Controller/Api/RestUpdateController.php b/src/Rest/Controller/Api/RestUpdateController.php
@@ -5,7 +5,7 @@
 
 namespace Orpheus\Rest\Controller\Api;
 
-use Orpheus\InputController\HTTPController\JSONHTTPResponse;
+use Orpheus\InputController\HttpController\JSONHttpResponse;
 use Orpheus\InputController\InputRequest;
 use Orpheus\InputController\OutputResponse;
 
@@ -30,6 +30,6 @@ public function run($request): HttpResponse {
 
 		$data = $this->entityService->extractPublicArray($this->item, $output);
 
-		return new JSONHTTPResponse($data);
+		return new JSONHttpResponse($data);
 	}
 }
diff --git a/src/Rest/Controller/RestApiWadlController.php b/src/Rest/Controller/RestApiWadlController.php
@@ -5,20 +5,20 @@
 
 namespace Orpheus\Rest\Controller;
 
-use Orpheus\InputController\HTTPController\HTTPController;
-use Orpheus\InputController\HTTPController\HTTPRoute;
+use Orpheus\InputController\HttpController\HttpController;
+use Orpheus\InputController\HttpController\HttpRoute;
 use Orpheus\InputController\InputRequest;
 use Orpheus\Rest\RestApiGenerator;
 use Orpheus\Rest\RestRouteGenerator;
-use Orpheus\Rest\XMLHTTPResponse;
+use Orpheus\Rest\XMLHttpResponse;
 use SimpleXMLElement;
 
 /**
  * Class RestApiWadlController
  *
  * @package Orpheus\Rest\Controller
  */
-class RestApiWadlController extends HTTPController {
+class RestApiWadlController extends HttpController {
 
 	const ATTR_ID = 'id';
 	const ATTR_NAME = 'name';
@@ -57,7 +57,7 @@ class RestApiWadlController extends HTTPController {
 	 * Run this controller
 	 *
 	 * @param InputRequest $request
-	 * @return XMLHTTPResponse
+	 * @return XMLHttpResponse
 	 */
 	public function run($request): HttpResponse {
 
@@ -90,7 +90,7 @@ public function run($request): HttpResponse {
 			$this->addResource($resourceList, $outsiderKey, $outsiderConfig->path, $outsiderConfig->method, $this->convertKeyToName($outsiderKey));
 		}
 
-		return new XMLHTTPResponse($xml->asXML());
+		return new XMLHttpResponse($xml->asXML());
 	}
 
 	protected function addTitle(SimpleXMLElement $xml, $title) {
@@ -144,7 +144,7 @@ protected function addAllEntityResources(SimpleXMLElement $xml, $entityKey, $ent
 			$method->addAttribute(self::ATTR_ID, $this->concatSlug($itemKey, $actionKey));
 			$method->addAttribute(self::ATTR_NAME, $action->getMethod());
 			$this->addTitle($method, $actionName);
-			if( $action->getMethod() === HTTPRoute::METHOD_PUT ) {
+			if( $action->getMethod() === HttpRoute::METHOD_PUT ) {
 				// Only POST & PUT allow input
 				$this->addJsonRepresentation($method->addChild(self::TAG_REQUEST));
 			}
@@ -170,7 +170,7 @@ protected function addEntityResource(SimpleXMLElement $xml, $entityKey, $entityP
 			$method->addAttribute(self::ATTR_ID, $entityKey . '-' . $actionKey);
 			$method->addAttribute(self::ATTR_NAME, $action->getMethod());
 			$this->addTitle($method, $actionName);
-			if( $action->getMethod() === HTTPRoute::METHOD_POST ) {
+			if( $action->getMethod() === HttpRoute::METHOD_POST ) {
 				// Only POST & PUT allow input
 				$this->addJsonRepresentation($method->addChild(self::TAG_REQUEST));
 			}
@@ -202,7 +202,7 @@ protected function addResource(SimpleXMLElement $xml, $key, $path, $methods, $na
 			$method->addAttribute(self::ATTR_ID, $key . '-' . $methodKey);
 			$method->addAttribute(self::ATTR_NAME, $methodKey);
 			$this->addTitle($method, $methodName);
-			if( in_array($method, [HTTPRoute::METHOD_POST, HTTPRoute::METHOD_PUT], true) ) {
+			if( in_array($method, [HttpRoute::METHOD_POST, HttpRoute::METHOD_PUT], true) ) {
 				// Only POST & PUT allow input
 				$this->addJsonRepresentation($method->addChild(self::TAG_REQUEST));
 			}

diff --git a/src/Rest/Controller/UserLoginRestController.php b/src/Rest/Controller/UserLoginRestController.php
@@ -8,7 +8,7 @@
 use Orpheus\EntityDescriptor\User\AbstractUser;
 use Orpheus\EntityDescriptor\User\UserApiConnectible;
 use Orpheus\Exception\ForbiddenException;
-use Orpheus\InputController\HTTPController\JSONHTTPResponse;
+use Orpheus\InputController\HttpController\JSONHttpResponse;
 use Orpheus\InputController\InputRequest;
 use Orpheus\InputController\OutputResponse;
 use Orpheus\Rest\Controller\Api\RestController;
@@ -22,7 +22,7 @@ class UserLoginRestController extends RestController {
 
 	/**
 	 * @param InputRequest $request
-	 * @return JSONHTTPResponse|OutputResponse|null
+	 * @return JSONHttpResponse|OutputResponse|null
 	 * @throws ForbiddenException
 	 */
 	public function run($request): HttpResponse {

diff --git a/src/Rest/RestApiGenerator.php b/src/Rest/RestApiGenerator.php
@@ -7,7 +7,7 @@
 
 use Exception;
 use Orpheus\Config\YAML\YAML;
-use Orpheus\InputController\HTTPController\HTTPRoute;
+use Orpheus\InputController\HttpController\HttpRoute;
 
 /**
  * Class RestApiGenerator
@@ -42,12 +42,12 @@ class RestApiGenerator {
 	public function __construct($entityPath = '/%s') {
 		$this->entityPath = $entityPath;
 		$this->entityActions = [];
-		$this->entityActions['list'] = new RestRouteGenerator(HTTPRoute::METHOD_GET, 'Orpheus\Rest\Controller\Api\RestListController');
-		$this->entityActions['create'] = new RestRouteGenerator(HTTPRoute::METHOD_POST, 'Orpheus\Rest\Controller\Api\RestCreateController');
+		$this->entityActions['list'] = new RestRouteGenerator(HttpRoute::METHOD_GET, 'Orpheus\Rest\Controller\Api\RestListController');
+		$this->entityActions['create'] = new RestRouteGenerator(HttpRoute::METHOD_POST, 'Orpheus\Rest\Controller\Api\RestCreateController');
 		$this->itemActions = [];
-		$this->itemActions['read'] = new RestRouteGenerator(HTTPRoute::METHOD_GET, 'Orpheus\Rest\Controller\Api\RestReadController');
-		$this->itemActions['update'] = new RestRouteGenerator(HTTPRoute::METHOD_PUT, 'Orpheus\Rest\Controller\Api\RestUpdateController');
-		$this->itemActions['delete'] = new RestRouteGenerator(HTTPRoute::METHOD_DELETE, 'Orpheus\Rest\Controller\Api\RestDeleteController');
+		$this->itemActions['read'] = new RestRouteGenerator(HttpRoute::METHOD_GET, 'Orpheus\Rest\Controller\Api\RestReadController');
+		$this->itemActions['update'] = new RestRouteGenerator(HttpRoute::METHOD_PUT, 'Orpheus\Rest\Controller\Api\RestUpdateController');
+		$this->itemActions['delete'] = new RestRouteGenerator(HttpRoute::METHOD_DELETE, 'Orpheus\Rest\Controller\Api\RestDeleteController');
 	}
 
 	public function getAllActions() {
@@ -191,7 +191,7 @@ public function getApiConfig() {
 					throw new Exception('Invalid path provided for outsider ' . $outsiderKey);
 				}
 				if( !isset($outsiderConfig->method) ) {
-					$outsiderConfig->method = [HTTPRoute::METHOD_GET];
+					$outsiderConfig->method = [HttpRoute::METHOD_GET];
 
 				} elseif( $outsiderConfig->method ) {
 					$outsiderConfig->method = explode('|', $outsiderConfig->method);

diff --git a/src/Rest/RestRouteGenerator.php b/src/Rest/RestRouteGenerator.php
@@ -14,7 +14,7 @@ class RestRouteGenerator {
 
 	/**
 	 * @var string The method
-	 * @see constants in HTTPRoute
+	 * @see constants in HttpRoute
 	 */
 	private $method;
 

diff --git a/src/Rest/XMLHTTPResponse.php b/src/Rest/XMLHTTPResponse.php
@@ -5,15 +5,15 @@
 use Exception;
 use Orpheus\Exception\UserException;
 use Orpheus\Exception\UserReportsException;
-use Orpheus\InputController\HTTPController\HTTPResponse;
+use Orpheus\InputController\HttpController\HttpResponse;
 use Throwable;
 
 /**
- * Class XMLHTTPResponse
+ * Class XMLHttpResponse
  *
  * @package Orpheus\Rest
  */
-class XMLHTTPResponse extends HTTPResponse {
+class XMLHttpResponse extends HttpResponse {
 
 	/**
 	 * The data of the XML response
@@ -49,7 +49,7 @@ public function getData() {
 	 * Set the data
 	 *
 	 * @param mixed $data
-	 * @return XMLHTTPResponse
+	 * @return XMLHttpResponse
 	 */
 	public function setData($data) {
 		$this->data = $data;
@@ -60,8 +60,8 @@ public function setData($data) {
 	 * Get a response with the given $data
 	 *
 	 * @param mixed $data
-	 * @return XMLHTTPResponse
-	 * @see XMLHTTPResponse::render()
+	 * @return XMLHttpResponse
+	 * @see XMLHttpResponse::render()
 	 */
 	public static function returnData($data) {
 		// Return success with data
@@ -75,7 +75,7 @@ public static function returnData($data) {
 	 *
 	 * @param Exception $exception
 	 * @param string $action
-	 * @return XMLHTTPResponse
+	 * @return XMLHttpResponse
 	 */
 	public static function generateFromException(Throwable $exception, $action = 'Handling the request') {
 		$code = $exception->getCode();
@@ -100,8 +100,8 @@ public static function generateFromException(Throwable $exception, $action = 'Ha
 	 * @param mixed $other
 	 * @param string $domain
 	 * @param string $description
-	 * @return XMLHTTPResponse
-	 * @see XMLHTTPResponse::returnData()
+	 * @return XMLHttpResponse
+	 * @see XMLHttpResponse::returnData()
 	 *
 	 * We recommend to use returnData() to return data, that is more RESTful and to use this method only for errors
 	 */
@@ -116,7 +116,7 @@ public static function render($textCode, $other = null, $domain = 'global', $des
 	 * @param mixed $other
 	 * @param string $domain
 	 * @param string $description
-	 * @see HTTPResponse::collectFrom()
+	 * @see HttpResponse::collectFrom()
 	 */
 	public function collectFrom($textCode, $other = null, $domain = 'global', $description = null) {
 	}
@@ -126,7 +126,7 @@ public function collectFrom($textCode, $other = null, $domain = 'global', $descr
 	 *
 	 * @param UserException $exception
 	 * @param array $values
-	 * @return XMLHTTPResponse
+	 * @return XMLHttpResponse
 	 */
 	public static function generateFromUserException(UserException $exception, $values = []) {
 		$code = $exception->getCode();