Merge branch 'release/0.6.5'

Author: ljonesfl

README.md

@@ -1,6 +1,9 @@
-# Routing
+[![Build Status](https://app.travis-ci.com/Neuron-PHP/routing.svg?token=F8zCwpT7x7Res7J2N4vF&branch=master)](https://app.travis-ci.com/Neuron-PHP/routing)
+# Neuron-PHP Routing
 
-The neuron router is a lightweight router/dispatcher is the vein of Ruby's Sinatra 
+## Overview
+
+The neuron router is a lightweight router/dispatcher is the vein of Ruby's Sinatra
 or Python's Flask. It allows for a very quick method for creating an app
 using restful routes or to add them to an existing application.
 
@@ -11,21 +14,12 @@ using restful routes or to add them to an existing application.
 
 ## Installation
 
-The best way to install Notion is via [Composer](http://getcomposer.org)
-
-Our package is located [here](https://packagist.org/packages/neuron-php/routing)
-
-Install Composer
-
-    curl -sS https://getcomposer.org/installer | php
+Install php composer from https://getcomposer.org/
 
-Add the Routing Package
+Install the neuron routing component:
 
-    php composer.phar require neuron-php/routing
+    composer require neuron-php/routing
 
-Install Later Updates
-
-    composer.phar update
 
 ## .htaccess
 This example .htaccess file shows how to get and pass the route
@@ -43,7 +37,7 @@ Here is an example of a fully functional application that processes
 several routes including one with a variable.
 
     <?php
-    require_once '../vendor/autoload.php';
+    require_once 'vendor/autoload.php';
 
     Route::get( '/',
             function()
@@ -85,3 +79,7 @@ several routes including one with a variable.
 
 If present, the extra element is merged into the parameters array
 before it is passed to the routes closure.
+
+# More Information
+
+You can read more about the Neuron components at [neuronphp.com](http://neuronphp.com)

VERSIONLOG.md

@@ -1,3 +1,7 @@
+## 0.6.5
+
+## 0.6.4
+
 ## 0.6.3 2024-11-27
 * Updated route signatures.
 * Added logging.

src/Routing/Request.php

@@ -60,7 +60,7 @@ public function getRoute()
 	 * @param $Name
 	 * @return mixed
 	 */
-	public function getUrlParam( $Name )
+	public function getUrlParam( $Name ): mixed
 	{
 		return $this->_Get->filterScalar( $Name );
 	}
@@ -69,7 +69,7 @@ public function getUrlParam( $Name )
 	 * @param $Name
 	 * @return mixed
 	 */
-	public function getPostParam( $Name )
+	public function getPostParam( $Name ): mixed
 	{
 		return $this->_Post->filterScalar( $Name );
 	}
@@ -78,7 +78,7 @@ public function getPostParam( $Name )
 	 * @param $Name
 	 * @return mixed
 	 */
-	public function getRequest( $Name )
+	public function getRequest( $Name ): mixed
 	{
 		$Result = $this->get( $Name );
 

src/Routing/Route.php

@@ -7,36 +7,58 @@
  */
 class Route
 {
+	/**
+	 * @throws \Exception
+	 */
 	public static function delete( string $Route, $Function ) : RouteMap
 	{
+		/** @var Router $Router */
 		$Router = Router::getInstance();
 
 		return $Router->delete( $Route, $Function );
 	}
 
+	/**
+	 * @throws \Exception
+	 */
 	public static function get( string $Route, $Function ) : RouteMap
 	{
+		/** @var Router $Router */
 		$Router = Router::getInstance();
 
 		return $Router->get( $Route, $Function );
 	}
 
+	/**
+	 * @throws \Exception
+	 */
 	public static function post( string $Route, $Function ) : RouteMap
 	{
+		/** @var Router $Router */
 		$Router = Router::getInstance();
 
 		return $Router->post( $Route, $Function );
 	}
 
+	/**
+	 * @throws \Exception
+	 */
 	public static function put( string $Route, $Function ) : RouteMap
 	{
+		/** @var Router $Router */
 		$Router = Router::getInstance();
 
 		return $Router->put( $Route, $Function );
 	}
 
+	/**
+	 * @throws \Exception
+	 */
 	public static function dispatch( array $Params )
 	{
-		return Router::getInstance()->run( $Params );
+		/** @var Router $Router */
+		$Router = Router::getInstance();
+
+		return $Router->run( $Params );
 	}
 }

src/Routing/RouteMap.php

@@ -2,6 +2,8 @@
 
 namespace Neuron\Routing;
 
+use Exception;
+
 class RouteMap
 {
 	public string $Path;
@@ -16,14 +18,14 @@ class RouteMap
 	 * @param $Path string route path i.e. /part/new or /part/:id
 	 * @param $Function callable the function to call on a matching route.
 	 * @param $Filter string the name of the filter to match with this route.
-	 * @throws \Exception
+	 * @throws Exception
 	 */
 
 	public function __construct( string $Path, callable $Function, string $Filter = '' )
 	{
 		if( !is_callable( $Function ) )
 		{
-			throw new \Exception( 'RouteMap: function not callable.' );
+			throw new Exception( 'RouteMap: function not callable.' );
 		}
 
 		$this->Path       = $Path;
@@ -127,10 +129,10 @@ public function setName( $Name ) : RouteMap
 	/**
 	 * Extracts the template array from the route definition.
 	 * @return array
-	 * @throws \Exception
+	 * @throws Exception
 	 */
 
-	public function parseParams()
+	public function parseParams(): array
 	{
 		$Details = [];
 
@@ -167,7 +169,7 @@ public function parseParams()
 	 * @throws RouteParamException
 	 */
 
-	protected function checkForDuplicateParams( $Param, $Params )
+	protected function checkForDuplicateParams( $Param, $Params ): void
 	{
 		foreach( $Params as $Current )
 		{
@@ -181,7 +183,7 @@ protected function checkForDuplicateParams( $Param, $Params )
 	/**
 	 * @param Router $Router
 	 * @return mixed
-	 * @throws \Exception
+	 * @throws Exception
 	 */
 	public function execute( Router $Router ): mixed
 	{

version.json

@@ -1 +1 @@
-{"major":0,"minor":6,"patch":3,"build":0}
+{"major":0,"minor":6,"patch":5,"build":0}