Merge pull request #3296 from paulbalandan/phpdocs-filters

Fix PHPDocs for Filters

Author: michalsn

system/Filters/CSRF.php

@@ -70,6 +70,7 @@ class CSRF implements FilterInterface
 	 * @param RequestInterface|\CodeIgniter\HTTP\IncomingRequest $request
 	 *
 	 * @return mixed
+	 * @throws \CodeIgniter\Security\Exceptions\SecurityException
 	 */
 	public function before(RequestInterface $request)
 	{

system/Filters/Exceptions/FilterException.php

@@ -1,15 +1,72 @@
-<?php namespace CodeIgniter\Filters\Exceptions;
+<?php
+
+/**
+ * CodeIgniter
+ *
+ * An open source application development framework for PHP
+ *
+ * This content is released under the MIT License (MIT)
+ *
+ * Copyright (c) 2014-2019 British Columbia Institute of Technology
+ * Copyright (c) 2019-2020 CodeIgniter Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @package    CodeIgniter
+ * @author     CodeIgniter Dev Team
+ * @copyright  2019-2020 CodeIgniter Foundation
+ * @license    https://opensource.org/licenses/MIT	MIT License
+ * @link       https://codeigniter.com
+ * @since      Version 4.0.0
+ * @filesource
+ */
+
+namespace CodeIgniter\Filters\Exceptions;
 
 use CodeIgniter\Exceptions\ConfigException;
 use CodeIgniter\Exceptions\ExceptionInterface;
 
+/**
+ * FilterException
+ */
 class FilterException extends ConfigException implements ExceptionInterface
 {
+	/**
+	 * Thrown when the provided alias is not within
+	 * the list of configured filter aliases.
+	 *
+	 * @param string $alias
+	 *
+	 * @return static
+	 */
 	public static function forNoAlias(string $alias)
 	{
 		return new static(lang('Filters.noFilter', [$alias]));
 	}
 
+	/**
+	 * Thrown when the filter class does not implement FilterInterface.
+	 *
+	 * @param string $class
+	 *
+	 * @return static
+	 */
 	public static function forIncorrectInterface(string $class)
 	{
 		return new static(lang('Filters.incorrectInterface', [$class]));

system/Filters/Filters.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * CodeIgniter
  *
@@ -38,7 +39,6 @@
 
 namespace CodeIgniter\Filters;
 
-use CodeIgniter\Config\BaseConfig;
 use CodeIgniter\Filters\Exceptions\FilterException;
 use CodeIgniter\HTTP\RequestInterface;
 use CodeIgniter\HTTP\ResponseInterface;
@@ -63,7 +63,7 @@ class Filters
 	/**
 	 * The original config file
 	 *
-	 * @var BaseConfig
+	 * @var \Config\Filters
 	 */
 	protected $config;
 
@@ -101,14 +101,14 @@ class Filters
 	/**
 	 * Constructor.
 	 *
-	 * @param type              $config
+	 * @param \Config\Filters   $config
 	 * @param RequestInterface  $request
 	 * @param ResponseInterface $response
 	 */
 	public function __construct($config, RequestInterface $request, ResponseInterface $response)
 	{
 		$this->config  = $config;
-		$this->request = & $request;
+		$this->request = &$request;
 		$this->setResponse($response);
 	}
 
@@ -119,7 +119,7 @@ public function __construct($config, RequestInterface $request, ResponseInterfac
 	 */
 	public function setResponse(ResponseInterface $response)
 	{
-		$this->response = & $response;
+		$this->response = &$response;
 	}
 
 	//--------------------------------------------------------------------
@@ -337,6 +337,8 @@ public function enableFilter(string $name, string $when = 'before')
 	/**
 	 * Returns the arguments for a specified key, or all.
 	 *
+	 * @param string|null $key
+	 *
 	 * @return mixed
 	 */
 	public function getArguments(string $key = null)
@@ -352,8 +354,9 @@ public function getArguments(string $key = null)
 	/**
 	 * Add any applicable (not excluded) global filter settings to the mix.
 	 *
-	 * @param  string $uri
-	 * @return type
+	 * @param string $uri
+	 *
+	 * @return void
 	 */
 	protected function processGlobals(string $uri = null)
 	{
@@ -369,6 +372,7 @@ protected function processGlobals(string $uri = null)
 			'before',
 			'after',
 		];
+
 		foreach ($sets as $set)
 		{
 			if (isset($this->config->globals[$set]))
@@ -394,6 +398,7 @@ protected function processGlobals(string $uri = null)
 					{
 						$alias = $rules; // simple name of filter to apply
 					}
+
 					if ($keep)
 					{
 						$this->filters[$set][] = $alias;
@@ -408,7 +413,7 @@ protected function processGlobals(string $uri = null)
 	/**
 	 * Add any method-specific flters to the mix.
 	 *
-	 * @return type
+	 * @return void
 	 */
 	protected function processMethods()
 	{
@@ -432,8 +437,9 @@ protected function processMethods()
 	/**
 	 * Add any applicable configured filters to the mix.
 	 *
-	 * @param  string $uri
-	 * @return type
+	 * @param string $uri
+	 *
+	 * @return void
 	 */
 	protected function processFilters(string $uri = null)
 	{
@@ -456,6 +462,7 @@ protected function processFilters(string $uri = null)
 					$this->filters['before'][] = $alias;
 				}
 			}
+
 			if (isset($settings['after']))
 			{
 				$path = $settings['after'];
@@ -470,9 +477,10 @@ protected function processFilters(string $uri = null)
 	/**
 	 * Check paths for match for URI
 	 *
-	 * @param  string $uri   URI to test against
-	 * @param  mixed  $paths The path patterns to test
-	 * @return boolean		True if any of the paths apply to the URI
+	 * @param string $uri   URI to test against
+	 * @param mixed  $paths The path patterns to test
+	 *
+	 * @return boolean True if any of the paths apply to the URI
 	 */
 	private function pathApplies(string $uri, $paths)
 	{
@@ -501,6 +509,7 @@ private function pathApplies(string $uri, $paths)
 				return true;
 			}
 		}
+
 		return false;
 	}
 

system/Filters/Honeypot.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * CodeIgniter
  *
@@ -56,7 +57,6 @@ class Honeypot implements FilterInterface
 	 * @param \CodeIgniter\HTTP\RequestInterface $request
 	 *
 	 * @return void
-	 *
 	 * @throws \CodeIgniter\Honeypot\Exceptions\HoneypotException
 	 */
 	public function before(RequestInterface $request)