From 6329255a8beccb32fddcc0c09dafabb79b840f02 Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 6 Sep 2023 18:13:24 +0900 Subject: [PATCH 1/6] docs: add "see test" annotations --- system/Autoloader/Autoloader.php | 2 ++ system/Autoloader/FileLocator.php | 2 ++ system/CLI/CLI.php | 2 ++ system/CLI/Console.php | 2 ++ system/Cache/CacheFactory.php | 2 ++ system/Cache/Handlers/BaseHandler.php | 2 ++ system/Cache/Handlers/DummyHandler.php | 2 ++ system/Cache/Handlers/FileHandler.php | 2 ++ system/Cache/Handlers/MemcachedHandler.php | 2 ++ system/Cache/Handlers/PredisHandler.php | 2 ++ system/Cache/Handlers/RedisHandler.php | 2 ++ system/Cache/ResponseCache.php | 2 ++ system/CodeIgniter.php | 2 ++ system/Commands/Database/MigrateStatus.php | 2 ++ system/Commands/Database/ShowTableInfo.php | 2 ++ system/Commands/Utilities/Namespaces.php | 2 ++ system/Commands/Utilities/Routes/AutoRouteCollector.php | 2 ++ .../Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php | 2 ++ .../Routes/AutoRouterImproved/ControllerMethodReader.php | 2 ++ system/Commands/Utilities/Routes/ControllerFinder.php | 2 ++ system/Commands/Utilities/Routes/ControllerMethodReader.php | 2 ++ system/Commands/Utilities/Routes/FilterCollector.php | 2 ++ system/Commands/Utilities/Routes/FilterFinder.php | 2 ++ system/Commands/Utilities/Routes/SampleURIGenerator.php | 2 ++ system/Config/BaseConfig.php | 1 + system/Config/Config.php | 1 + system/Config/DotEnv.php | 2 ++ system/Config/Factories.php | 1 + system/Config/Services.php | 1 + system/Controller.php | 2 ++ system/Cookie/Cookie.php | 1 + system/Cookie/CookieStore.php | 1 + system/Database/BaseConnection.php | 1 + system/Database/Config.php | 2 ++ system/Database/ModelFactory.php | 1 + system/Database/RawSql.php | 3 +++ system/Debug/ExceptionHandler.php | 3 +++ system/Debug/Exceptions.php | 2 ++ system/Debug/Timer.php | 2 ++ system/Debug/Toolbar/Collectors/Database.php | 2 ++ system/Debug/Toolbar/Collectors/History.php | 2 ++ system/Email/Email.php | 2 ++ system/Encryption/Encryption.php | 2 ++ system/Encryption/Handlers/OpenSSLHandler.php | 2 ++ system/Encryption/Handlers/SodiumHandler.php | 1 + system/Entity/Entity.php | 2 ++ system/Events/Events.php | 2 ++ system/Files/File.php | 2 ++ system/Files/FileCollection.php | 1 + system/Filters/CSRF.php | 1 + system/Filters/DebugToolbar.php | 2 ++ system/Filters/Filters.php | 2 ++ system/Filters/Honeypot.php | 2 ++ system/Filters/InvalidChars.php | 2 ++ system/Filters/SecureHeaders.php | 2 ++ system/Format/Format.php | 2 ++ system/Format/JSONFormatter.php | 2 ++ system/Format/XMLFormatter.php | 2 ++ system/HTTP/CLIRequest.php | 2 ++ system/HTTP/CURLRequest.php | 2 ++ system/HTTP/ContentSecurityPolicy.php | 1 + system/HTTP/DownloadResponse.php | 2 ++ system/HTTP/Files/FileCollection.php | 2 ++ system/HTTP/Header.php | 2 ++ system/HTTP/IncomingRequest.php | 2 ++ system/HTTP/Message.php | 2 ++ system/HTTP/Negotiate.php | 1 + system/HTTP/OutgoingRequest.php | 2 ++ system/HTTP/RedirectResponse.php | 2 ++ system/HTTP/Request.php | 2 ++ system/HTTP/Response.php | 2 ++ system/HTTP/SiteURI.php | 2 ++ system/HTTP/SiteURIFactory.php | 2 ++ system/HTTP/URI.php | 2 ++ system/HTTP/UserAgent.php | 2 ++ system/Honeypot/Honeypot.php | 2 ++ system/HotReloader/DirectoryHasher.php | 1 + system/I18n/Time.php | 1 + system/I18n/TimeDifference.php | 2 ++ system/I18n/TimeLegacy.php | 1 + system/Images/Image.php | 2 ++ system/Language/Language.php | 2 ++ system/Log/Handlers/ChromeLoggerHandler.php | 1 + system/Log/Handlers/ErrorlogHandler.php | 2 ++ system/Log/Handlers/FileHandler.php | 2 ++ system/Log/Logger.php | 2 ++ system/Pager/Pager.php | 2 ++ system/Pager/PagerRenderer.php | 2 ++ system/Publisher/ContentReplacer.php | 2 ++ system/RESTful/ResourceController.php | 2 ++ system/RESTful/ResourcePresenter.php | 2 ++ system/Router/AutoRouterImproved.php | 2 ++ system/Router/DefinedRouteCollector.php | 2 ++ system/Router/RouteCollection.php | 1 + system/Router/Router.php | 2 ++ system/Security/Security.php | 2 ++ system/Session/Handlers/Database/MySQLiHandler.php | 2 ++ system/Session/Handlers/Database/PostgreHandler.php | 2 ++ system/Session/Session.php | 1 + system/Superglobals.php | 1 + system/Test/DOMParser.php | 2 ++ system/Test/Fabricator.php | 2 ++ system/Test/TestLogger.php | 3 +++ system/Test/TestResponse.php | 1 + system/Typography/Typography.php | 2 ++ system/Validation/CreditCardRules.php | 1 + system/Validation/DotArrayFilter.php | 3 +++ system/Validation/FileRules.php | 2 ++ system/Validation/FormatRules.php | 2 ++ system/Validation/Rules.php | 2 ++ system/Validation/StrictRules/CreditCardRules.php | 1 + system/Validation/StrictRules/FileRules.php | 2 ++ system/Validation/StrictRules/FormatRules.php | 2 ++ system/Validation/StrictRules/Rules.php | 2 ++ system/Validation/Validation.php | 2 ++ system/View/Cell.php | 2 ++ system/View/Parser.php | 2 ++ system/View/Table.php | 2 ++ system/View/View.php | 2 ++ 119 files changed, 219 insertions(+) diff --git a/system/Autoloader/Autoloader.php b/system/Autoloader/Autoloader.php index d5c155685e12..dcddec1d2976 100644 --- a/system/Autoloader/Autoloader.php +++ b/system/Autoloader/Autoloader.php @@ -53,6 +53,8 @@ * // register the autoloader * $loader->register(); * ``` + * + * @see \CodeIgniter\Autoloader\AutoloaderTest */ class Autoloader { diff --git a/system/Autoloader/FileLocator.php b/system/Autoloader/FileLocator.php index a4f7c67677d0..bc18bd31b980 100644 --- a/system/Autoloader/FileLocator.php +++ b/system/Autoloader/FileLocator.php @@ -14,6 +14,8 @@ /** * Allows loading non-class files in a namespaced manner. * Works with Helpers, Views, etc. + * + * @see \CodeIgniter\Autoloader\FileLocatorTest */ class FileLocator { diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php index 112a662d35ac..7e0376e6b6f1 100644 --- a/system/CLI/CLI.php +++ b/system/CLI/CLI.php @@ -33,6 +33,8 @@ * The wait() method is mostly testable, as long as you don't give it * an argument of "0". * These have been flagged to ignore for code coverage purposes. + * + * @see \CodeIgniter\CLI\CLITest */ class CLI { diff --git a/system/CLI/Console.php b/system/CLI/Console.php index 01c15eea3fad..0ea7eae22c7f 100644 --- a/system/CLI/Console.php +++ b/system/CLI/Console.php @@ -17,6 +17,8 @@ /** * Console + * + * @see \CodeIgniter\CLI\ConsoleTest */ class Console { diff --git a/system/Cache/CacheFactory.php b/system/Cache/CacheFactory.php index 0810653b7318..95e07ef813c8 100644 --- a/system/Cache/CacheFactory.php +++ b/system/Cache/CacheFactory.php @@ -18,6 +18,8 @@ /** * A factory for loading the desired + * + * @see \CodeIgniter\Cache\CacheFactoryTest */ class CacheFactory { diff --git a/system/Cache/Handlers/BaseHandler.php b/system/Cache/Handlers/BaseHandler.php index 74a4482cd4d9..c12b330bc469 100644 --- a/system/Cache/Handlers/BaseHandler.php +++ b/system/Cache/Handlers/BaseHandler.php @@ -19,6 +19,8 @@ /** * Base class for cache handling + * + * @see \CodeIgniter\Cache\Handlers\BaseHandlerTest */ abstract class BaseHandler implements CacheInterface { diff --git a/system/Cache/Handlers/DummyHandler.php b/system/Cache/Handlers/DummyHandler.php index 4349db4f39a5..d2d4fb068bba 100644 --- a/system/Cache/Handlers/DummyHandler.php +++ b/system/Cache/Handlers/DummyHandler.php @@ -15,6 +15,8 @@ /** * Dummy cache handler + * + * @see \CodeIgniter\Cache\Handlers\DummyHandlerTest */ class DummyHandler extends BaseHandler { diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php index aea0a605c47f..e22543d27891 100644 --- a/system/Cache/Handlers/FileHandler.php +++ b/system/Cache/Handlers/FileHandler.php @@ -18,6 +18,8 @@ /** * File system cache handler + * + * @see \CodeIgniter\Cache\Handlers\FileHandlerTest */ class FileHandler extends BaseHandler { diff --git a/system/Cache/Handlers/MemcachedHandler.php b/system/Cache/Handlers/MemcachedHandler.php index a998ad30386f..e8658906392a 100644 --- a/system/Cache/Handlers/MemcachedHandler.php +++ b/system/Cache/Handlers/MemcachedHandler.php @@ -20,6 +20,8 @@ /** * Mamcached cache handler + * + * @see \CodeIgniter\Cache\Handlers\MemcachedHandlerTest */ class MemcachedHandler extends BaseHandler { diff --git a/system/Cache/Handlers/PredisHandler.php b/system/Cache/Handlers/PredisHandler.php index e549a7422c91..4e06b85bc8ce 100644 --- a/system/Cache/Handlers/PredisHandler.php +++ b/system/Cache/Handlers/PredisHandler.php @@ -20,6 +20,8 @@ /** * Predis cache handler + * + * @see \CodeIgniter\Cache\Handlers\PredisHandlerTest */ class PredisHandler extends BaseHandler { diff --git a/system/Cache/Handlers/RedisHandler.php b/system/Cache/Handlers/RedisHandler.php index d86d9f980d41..9d1ddf3c15d4 100644 --- a/system/Cache/Handlers/RedisHandler.php +++ b/system/Cache/Handlers/RedisHandler.php @@ -19,6 +19,8 @@ /** * Redis cache handler + * + * @see \CodeIgniter\Cache\Handlers\RedisHandlerTest */ class RedisHandler extends BaseHandler { diff --git a/system/Cache/ResponseCache.php b/system/Cache/ResponseCache.php index 44da42947633..3f66284a6cf5 100644 --- a/system/Cache/ResponseCache.php +++ b/system/Cache/ResponseCache.php @@ -19,6 +19,8 @@ /** * Web Page Caching + * + * @see \CodeIgniter\Cache\ResponseCacheTest */ final class ResponseCache { diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php index 6ef3ab8261b2..e017d6b9ccc2 100644 --- a/system/CodeIgniter.php +++ b/system/CodeIgniter.php @@ -46,6 +46,8 @@ * This class is the core of the framework, and will analyse the * request, route it to a controller, and send back the response. * Of course, there are variations to that flow, but this is the brains. + * + * @see \CodeIgniter\CodeIgniterTest */ class CodeIgniter { diff --git a/system/Commands/Database/MigrateStatus.php b/system/Commands/Database/MigrateStatus.php index 8b0885a659b1..af3cbacf772c 100644 --- a/system/Commands/Database/MigrateStatus.php +++ b/system/Commands/Database/MigrateStatus.php @@ -17,6 +17,8 @@ /** * Displays a list of all migrations and whether they've been run or not. + * + * @see \CodeIgniter\Commands\Database\MigrateStatusTest */ class MigrateStatus extends BaseCommand { diff --git a/system/Commands/Database/ShowTableInfo.php b/system/Commands/Database/ShowTableInfo.php index 4666a54ca888..07aa60c961ca 100644 --- a/system/Commands/Database/ShowTableInfo.php +++ b/system/Commands/Database/ShowTableInfo.php @@ -18,6 +18,8 @@ /** * Get table data if it exists in the database. + * + * @see \CodeIgniter\Commands\Database\ShowTableInfoTest */ class ShowTableInfo extends BaseCommand { diff --git a/system/Commands/Utilities/Namespaces.php b/system/Commands/Utilities/Namespaces.php index b8193c219572..ef37736c56b8 100644 --- a/system/Commands/Utilities/Namespaces.php +++ b/system/Commands/Utilities/Namespaces.php @@ -20,6 +20,8 @@ * Lists namespaces set in Config\Autoload with their * full server path. Helps you to verify that you have * the namespaces setup correctly. + * + * @see \CodeIgniter\Commands\Utilities\NamespacesTest */ class Namespaces extends BaseCommand { diff --git a/system/Commands/Utilities/Routes/AutoRouteCollector.php b/system/Commands/Utilities/Routes/AutoRouteCollector.php index a2fa46c497e9..ee331332291b 100644 --- a/system/Commands/Utilities/Routes/AutoRouteCollector.php +++ b/system/Commands/Utilities/Routes/AutoRouteCollector.php @@ -13,6 +13,8 @@ /** * Collects data for auto route listing. + * + * @see \CodeIgniter\Commands\Utilities\Routes\AutoRouteCollectorTest */ final class AutoRouteCollector { diff --git a/system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php b/system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php index 2b6096016f7e..0b9089ce2ade 100644 --- a/system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php +++ b/system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php @@ -16,6 +16,8 @@ /** * Collects data for Auto Routing Improved. + * + * @see \CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\AutoRouteCollectorTest */ final class AutoRouteCollector { diff --git a/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php b/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php index c91219c13a8e..74b268befe7d 100644 --- a/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php +++ b/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php @@ -16,6 +16,8 @@ /** * Reads a controller and returns a list of auto route listing. + * + * @see \CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\ControllerMethodReaderTest */ final class ControllerMethodReader { diff --git a/system/Commands/Utilities/Routes/ControllerFinder.php b/system/Commands/Utilities/Routes/ControllerFinder.php index e7d828c0fe57..f801d531fa92 100644 --- a/system/Commands/Utilities/Routes/ControllerFinder.php +++ b/system/Commands/Utilities/Routes/ControllerFinder.php @@ -16,6 +16,8 @@ /** * Finds all controllers in a namespace for auto route listing. + * + * @see \CodeIgniter\Commands\Utilities\Routes\ControllerFinderTest */ final class ControllerFinder { diff --git a/system/Commands/Utilities/Routes/ControllerMethodReader.php b/system/Commands/Utilities/Routes/ControllerMethodReader.php index 27bdad046a99..eb0152dec623 100644 --- a/system/Commands/Utilities/Routes/ControllerMethodReader.php +++ b/system/Commands/Utilities/Routes/ControllerMethodReader.php @@ -16,6 +16,8 @@ /** * Reads a controller and returns a list of auto route listing. + * + * @see \CodeIgniter\Commands\Utilities\Routes\ControllerMethodReaderTest */ final class ControllerMethodReader { diff --git a/system/Commands/Utilities/Routes/FilterCollector.php b/system/Commands/Utilities/Routes/FilterCollector.php index 71bbd1b083b3..fcb9b1512835 100644 --- a/system/Commands/Utilities/Routes/FilterCollector.php +++ b/system/Commands/Utilities/Routes/FilterCollector.php @@ -19,6 +19,8 @@ /** * Collects filters for a route. + * + * @see \CodeIgniter\Commands\Utilities\Routes\FilterCollectorTest */ final class FilterCollector { diff --git a/system/Commands/Utilities/Routes/FilterFinder.php b/system/Commands/Utilities/Routes/FilterFinder.php index 0cdea8c42744..2e5da617e795 100644 --- a/system/Commands/Utilities/Routes/FilterFinder.php +++ b/system/Commands/Utilities/Routes/FilterFinder.php @@ -20,6 +20,8 @@ /** * Finds filters. + * + * @see \CodeIgniter\Commands\Utilities\Routes\FilterFinderTest */ final class FilterFinder { diff --git a/system/Commands/Utilities/Routes/SampleURIGenerator.php b/system/Commands/Utilities/Routes/SampleURIGenerator.php index 984e50abd0e2..38b333fd33c2 100644 --- a/system/Commands/Utilities/Routes/SampleURIGenerator.php +++ b/system/Commands/Utilities/Routes/SampleURIGenerator.php @@ -16,6 +16,8 @@ /** * Generate a sample URI path from route key regex. + * + * @see \CodeIgniter\Commands\Utilities\Routes\SampleURIGeneratorTest */ final class SampleURIGenerator { diff --git a/system/Config/BaseConfig.php b/system/Config/BaseConfig.php index d2c396dc36ba..87166737e746 100644 --- a/system/Config/BaseConfig.php +++ b/system/Config/BaseConfig.php @@ -28,6 +28,7 @@ * These can be set within the .env file. * * @phpstan-consistent-constructor + * @see \CodeIgniter\Config\BaseConfigTest */ class BaseConfig { diff --git a/system/Config/Config.php b/system/Config/Config.php index 3008865b29fa..90a6b7cadef5 100644 --- a/system/Config/Config.php +++ b/system/Config/Config.php @@ -13,6 +13,7 @@ /** * @deprecated Use CodeIgniter\Config\Factories::config() + * @see \CodeIgniter\Config\ConfigTest */ class Config { diff --git a/system/Config/DotEnv.php b/system/Config/DotEnv.php index 0275b5c4b9c3..05ecab900c3e 100644 --- a/system/Config/DotEnv.php +++ b/system/Config/DotEnv.php @@ -15,6 +15,8 @@ /** * Environment-specific configuration + * + * @see \CodeIgniter\Config\DotEnvTest */ class DotEnv { diff --git a/system/Config/Factories.php b/system/Config/Factories.php index 6db25549dca9..b455969049e2 100644 --- a/system/Config/Factories.php +++ b/system/Config/Factories.php @@ -26,6 +26,7 @@ * * @method static BaseConfig|null config(...$arguments) * @method static Model|null models(string $alias, array $options = [], ?ConnectionInterface &$conn = null) + * @see \CodeIgniter\Config\FactoriesTest */ class Factories { diff --git a/system/Config/Services.php b/system/Config/Services.php index 720bb3c487ce..10972bd84ff0 100644 --- a/system/Config/Services.php +++ b/system/Config/Services.php @@ -104,6 +104,7 @@ * * @see http://blog.ircmaxell.com/2015/11/simple-easy-risk-and-change.html * @see http://www.infoq.com/presentations/Simple-Made-Easy + * @see \CodeIgniter\Config\ServicesTest */ class Services extends BaseService { diff --git a/system/Controller.php b/system/Controller.php index 038bc8ee7a78..45fe0e499565 100644 --- a/system/Controller.php +++ b/system/Controller.php @@ -22,6 +22,8 @@ /** * Class Controller + * + * @see \CodeIgniter\ControllerTest */ class Controller { diff --git a/system/Cookie/Cookie.php b/system/Cookie/Cookie.php index 08dfff2c303f..69e40017bb65 100644 --- a/system/Cookie/Cookie.php +++ b/system/Cookie/Cookie.php @@ -39,6 +39,7 @@ * ``` * * @template-implements ArrayAccess + * @see \CodeIgniter\Cookie\CookieTest */ class Cookie implements ArrayAccess, CloneableCookieInterface { diff --git a/system/Cookie/CookieStore.php b/system/Cookie/CookieStore.php index 6bf7f003194e..d893a4add116 100644 --- a/system/Cookie/CookieStore.php +++ b/system/Cookie/CookieStore.php @@ -21,6 +21,7 @@ * The CookieStore object represents an immutable collection of `Cookie` value objects. * * @implements IteratorAggregate + * @see \CodeIgniter\Cookie\CookieStoreTest */ class CookieStore implements Countable, IteratorAggregate { diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php index 670dd0494984..1116d3966439 100644 --- a/system/Database/BaseConnection.php +++ b/system/Database/BaseConnection.php @@ -50,6 +50,7 @@ * @template TResult * * @implements ConnectionInterface + * @see \CodeIgniter\Database\BaseConnectionTest */ abstract class BaseConnection implements ConnectionInterface { diff --git a/system/Database/Config.php b/system/Database/Config.php index f34d0395bc69..62fa79202d26 100644 --- a/system/Database/Config.php +++ b/system/Database/Config.php @@ -17,6 +17,8 @@ /** * Class Config + * + * @see \CodeIgniter\Database\ConfigTest */ class Config extends BaseConfig { diff --git a/system/Database/ModelFactory.php b/system/Database/ModelFactory.php index ae088124d9f7..76a30e6c1d30 100644 --- a/system/Database/ModelFactory.php +++ b/system/Database/ModelFactory.php @@ -19,6 +19,7 @@ * @deprecated Use CodeIgniter\Config\Factories::models() * * @codeCoverageIgnore + * @see \CodeIgniter\Database\ModelFactoryTest */ class ModelFactory { diff --git a/system/Database/RawSql.php b/system/Database/RawSql.php index 7ecb7fd378ae..efa97d30736c 100644 --- a/system/Database/RawSql.php +++ b/system/Database/RawSql.php @@ -11,6 +11,9 @@ namespace CodeIgniter\Database; +/** + * @see \CodeIgniter\Database\RawSqlTest + */ class RawSql { /** diff --git a/system/Debug/ExceptionHandler.php b/system/Debug/ExceptionHandler.php index 1eaa05aceeaa..33b114e30341 100644 --- a/system/Debug/ExceptionHandler.php +++ b/system/Debug/ExceptionHandler.php @@ -20,6 +20,9 @@ use Config\Paths; use Throwable; +/** + * @see \CodeIgniter\Debug\ExceptionHandlerTest + */ final class ExceptionHandler extends BaseExceptionHandler implements ExceptionHandlerInterface { use ResponseTrait; diff --git a/system/Debug/Exceptions.php b/system/Debug/Exceptions.php index 3c2c7902c687..f3a69c32b29a 100644 --- a/system/Debug/Exceptions.php +++ b/system/Debug/Exceptions.php @@ -27,6 +27,8 @@ /** * Exceptions manager + * + * @see \CodeIgniter\Debug\ExceptionsTest */ class Exceptions { diff --git a/system/Debug/Timer.php b/system/Debug/Timer.php index 216b10bab758..d43bf1c5a32a 100644 --- a/system/Debug/Timer.php +++ b/system/Debug/Timer.php @@ -18,6 +18,8 @@ * * Provides a simple way to measure the amount of time * that elapses between two points. + * + * @see \CodeIgniter\Debug\TimerTest */ class Timer { diff --git a/system/Debug/Toolbar/Collectors/Database.php b/system/Debug/Toolbar/Collectors/Database.php index f487af59cef4..4b2ff96fe8b5 100644 --- a/system/Debug/Toolbar/Collectors/Database.php +++ b/system/Debug/Toolbar/Collectors/Database.php @@ -17,6 +17,8 @@ /** * Collector for the Database tab of the Debug Toolbar. + * + * @see \CodeIgniter\Debug\Toolbar\Collectors\DatabaseTest */ class Database extends BaseCollector { diff --git a/system/Debug/Toolbar/Collectors/History.php b/system/Debug/Toolbar/Collectors/History.php index 9645bd91863a..a639e35a4ebd 100644 --- a/system/Debug/Toolbar/Collectors/History.php +++ b/system/Debug/Toolbar/Collectors/History.php @@ -15,6 +15,8 @@ /** * History collector + * + * @see \CodeIgniter\Debug\Toolbar\Collectors\HistoryTest */ class History extends BaseCollector { diff --git a/system/Email/Email.php b/system/Email/Email.php index b2f6874c32c9..c5b043922938 100644 --- a/system/Email/Email.php +++ b/system/Email/Email.php @@ -20,6 +20,8 @@ * CodeIgniter Email Class * * Permits email to be sent using Mail, Sendmail, or SMTP. + * + * @see \CodeIgniter\Email\EmailTest */ class Email { diff --git a/system/Encryption/Encryption.php b/system/Encryption/Encryption.php index fda9906240cb..6a0517b1d116 100644 --- a/system/Encryption/Encryption.php +++ b/system/Encryption/Encryption.php @@ -20,6 +20,8 @@ * Provides two-way keyed encryption via PHP's Sodium and/or OpenSSL extensions. * This class determines the driver, cipher, and mode to use, and then * initializes the appropriate encryption handler. + * + * @see \CodeIgniter\Encryption\EncryptionTest */ class Encryption { diff --git a/system/Encryption/Handlers/OpenSSLHandler.php b/system/Encryption/Handlers/OpenSSLHandler.php index 8324b36718ea..0d8f10758b3c 100644 --- a/system/Encryption/Handlers/OpenSSLHandler.php +++ b/system/Encryption/Handlers/OpenSSLHandler.php @@ -15,6 +15,8 @@ /** * Encryption handling for OpenSSL library + * + * @see \CodeIgniter\Encryption\Handlers\OpenSSLHandlerTest */ class OpenSSLHandler extends BaseHandler { diff --git a/system/Encryption/Handlers/SodiumHandler.php b/system/Encryption/Handlers/SodiumHandler.php index 95dcdfb6c8b0..c483dfe90c3a 100644 --- a/system/Encryption/Handlers/SodiumHandler.php +++ b/system/Encryption/Handlers/SodiumHandler.php @@ -17,6 +17,7 @@ * SodiumHandler uses libsodium in encryption. * * @see https://github.com/jedisct1/libsodium/issues/392 + * @see \CodeIgniter\Encryption\Handlers\SodiumHandlerTest */ class SodiumHandler extends BaseHandler { diff --git a/system/Entity/Entity.php b/system/Entity/Entity.php index dd4f54c928bf..65898c012dc9 100644 --- a/system/Entity/Entity.php +++ b/system/Entity/Entity.php @@ -33,6 +33,8 @@ /** * Entity encapsulation, for use with CodeIgniter\Model + * + * @see \CodeIgniter\Entity\EntityTest */ class Entity implements JsonSerializable { diff --git a/system/Events/Events.php b/system/Events/Events.php index ff8c92822e52..b240dc29e1ca 100644 --- a/system/Events/Events.php +++ b/system/Events/Events.php @@ -16,6 +16,8 @@ /** * Events + * + * @see \CodeIgniter\Events\EventsTest */ class Events { diff --git a/system/Files/File.php b/system/Files/File.php index 67e098da1a93..4e4ee388047e 100644 --- a/system/Files/File.php +++ b/system/Files/File.php @@ -20,6 +20,8 @@ /** * Wrapper for PHP's built-in SplFileInfo, with goodies. + * + * @see \CodeIgniter\Files\FileTest */ class File extends SplFileInfo { diff --git a/system/Files/FileCollection.php b/system/Files/FileCollection.php index ab0ab357329c..87f987eb8f1e 100644 --- a/system/Files/FileCollection.php +++ b/system/Files/FileCollection.php @@ -25,6 +25,7 @@ * filtering, and ordering them. * * @template-implements IteratorAggregate + * @see \CodeIgniter\Files\FileCollectionTest */ class FileCollection implements Countable, IteratorAggregate { diff --git a/system/Filters/CSRF.php b/system/Filters/CSRF.php index 2548dd026454..23e6e2540eca 100644 --- a/system/Filters/CSRF.php +++ b/system/Filters/CSRF.php @@ -24,6 +24,7 @@ * This filter is not intended to be used from the command line. * * @codeCoverageIgnore + * @see \CodeIgniter\Filters\CSRFTest */ class CSRF implements FilterInterface { diff --git a/system/Filters/DebugToolbar.php b/system/Filters/DebugToolbar.php index ae4c09c8bf9c..75662d841ade 100644 --- a/system/Filters/DebugToolbar.php +++ b/system/Filters/DebugToolbar.php @@ -17,6 +17,8 @@ /** * Debug toolbar filter + * + * @see \CodeIgniter\Filters\DebugToolbarTest */ class DebugToolbar implements FilterInterface { diff --git a/system/Filters/Filters.php b/system/Filters/Filters.php index ccd8283b0121..d0c67845466f 100644 --- a/system/Filters/Filters.php +++ b/system/Filters/Filters.php @@ -21,6 +21,8 @@ /** * Filters + * + * @see \CodeIgniter\Filters\FiltersTest */ class Filters { diff --git a/system/Filters/Honeypot.php b/system/Filters/Honeypot.php index 419c2b47e75a..e30e90f8d9fd 100644 --- a/system/Filters/Honeypot.php +++ b/system/Filters/Honeypot.php @@ -19,6 +19,8 @@ /** * Honeypot filter + * + * @see \CodeIgniter\Filters\HoneypotTest */ class Honeypot implements FilterInterface { diff --git a/system/Filters/InvalidChars.php b/system/Filters/InvalidChars.php index 42aa15b19675..93124fdb4e9f 100644 --- a/system/Filters/InvalidChars.php +++ b/system/Filters/InvalidChars.php @@ -23,6 +23,8 @@ * invalid characters: * - invalid UTF-8 characters * - control characters except line break and tab code + * + * @see \CodeIgniter\Filters\InvalidCharsTest */ class InvalidChars implements FilterInterface { diff --git a/system/Filters/SecureHeaders.php b/system/Filters/SecureHeaders.php index fd656af6a80f..952926b95714 100644 --- a/system/Filters/SecureHeaders.php +++ b/system/Filters/SecureHeaders.php @@ -16,6 +16,8 @@ /** * Add Common Security Headers + * + * @see \CodeIgniter\Filters\SecureHeadersTest */ class SecureHeaders implements FilterInterface { diff --git a/system/Format/Format.php b/system/Format/Format.php index db05aca146d5..6b4eb73f1f3a 100644 --- a/system/Format/Format.php +++ b/system/Format/Format.php @@ -16,6 +16,8 @@ /** * The Format class is a convenient place to create Formatters. + * + * @see \CodeIgniter\Format\FormatTest */ class Format { diff --git a/system/Format/JSONFormatter.php b/system/Format/JSONFormatter.php index b4a80822e8be..146fd5330aa6 100644 --- a/system/Format/JSONFormatter.php +++ b/system/Format/JSONFormatter.php @@ -16,6 +16,8 @@ /** * JSON data formatter + * + * @see \CodeIgniter\Format\JSONFormatterTest */ class JSONFormatter implements FormatterInterface { diff --git a/system/Format/XMLFormatter.php b/system/Format/XMLFormatter.php index 23ed57fadf84..51b3003e974e 100644 --- a/system/Format/XMLFormatter.php +++ b/system/Format/XMLFormatter.php @@ -17,6 +17,8 @@ /** * XML data formatter + * + * @see \CodeIgniter\Format\XMLFormatterTest */ class XMLFormatter implements FormatterInterface { diff --git a/system/HTTP/CLIRequest.php b/system/HTTP/CLIRequest.php index ef10d101e05b..22e55100649a 100644 --- a/system/HTTP/CLIRequest.php +++ b/system/HTTP/CLIRequest.php @@ -25,6 +25,8 @@ * originally made available under. * * http://fuelphp.com + * + * @see \CodeIgniter\HTTP\CLIRequestTest */ class CLIRequest extends Request { diff --git a/system/HTTP/CURLRequest.php b/system/HTTP/CURLRequest.php index 1f02cec983b0..0604c3367b7a 100644 --- a/system/HTTP/CURLRequest.php +++ b/system/HTTP/CURLRequest.php @@ -18,6 +18,8 @@ /** * A lightweight HTTP client for sending synchronous HTTP requests via cURL. + * + * @see \CodeIgniter\HTTP\CURLRequestTest */ class CURLRequest extends OutgoingRequest { diff --git a/system/HTTP/ContentSecurityPolicy.php b/system/HTTP/ContentSecurityPolicy.php index 2a90c3c6473b..37b0ce650ff7 100644 --- a/system/HTTP/ContentSecurityPolicy.php +++ b/system/HTTP/ContentSecurityPolicy.php @@ -22,6 +22,7 @@ * @see http://www.html5rocks.com/en/tutorials/security/content-security-policy/ * @see http://content-security-policy.com/ * @see https://www.owasp.org/index.php/Content_Security_Policy + * @see \CodeIgniter\HTTP\ContentSecurityPolicyTest */ class ContentSecurityPolicy { diff --git a/system/HTTP/DownloadResponse.php b/system/HTTP/DownloadResponse.php index c2fdcff0799f..14dc3fec1421 100644 --- a/system/HTTP/DownloadResponse.php +++ b/system/HTTP/DownloadResponse.php @@ -18,6 +18,8 @@ /** * HTTP response when a download is requested. + * + * @see \CodeIgniter\HTTP\DownloadResponseTest */ class DownloadResponse extends Response { diff --git a/system/HTTP/Files/FileCollection.php b/system/HTTP/Files/FileCollection.php index 605d3a134aea..f01cc69f5902 100644 --- a/system/HTTP/Files/FileCollection.php +++ b/system/HTTP/Files/FileCollection.php @@ -18,6 +18,8 @@ * Class FileCollection * * Provides easy access to uploaded files for a request. + * + * @see \CodeIgniter\HTTP\Files\FileCollectionTest */ class FileCollection { diff --git a/system/HTTP/Header.php b/system/HTTP/Header.php index e9bebe960097..67c6cb0636d3 100644 --- a/system/HTTP/Header.php +++ b/system/HTTP/Header.php @@ -15,6 +15,8 @@ * Class Header * * Represents a single HTTP header. + * + * @see \CodeIgniter\HTTP\HeaderTest */ class Header { diff --git a/system/HTTP/IncomingRequest.php b/system/HTTP/IncomingRequest.php index 0ce55f789abc..458e8ef88043 100755 --- a/system/HTTP/IncomingRequest.php +++ b/system/HTTP/IncomingRequest.php @@ -42,6 +42,8 @@ * - Query string arguments (generally via $_GET, or as parsed via parse_str()) * - Upload files, if any (as represented by $_FILES) * - Deserialized body binds (generally from $_POST) + * + * @see \CodeIgniter\HTTP\IncomingRequestTest */ class IncomingRequest extends Request { diff --git a/system/HTTP/Message.php b/system/HTTP/Message.php index 01496d780c1a..9d0b517778a4 100644 --- a/system/HTTP/Message.php +++ b/system/HTTP/Message.php @@ -13,6 +13,8 @@ /** * An HTTP message + * + * @see \CodeIgniter\HTTP\MessageTest */ class Message implements MessageInterface { diff --git a/system/HTTP/Negotiate.php b/system/HTTP/Negotiate.php index dcaf41d1dbbb..b1d5fdfa93a3 100644 --- a/system/HTTP/Negotiate.php +++ b/system/HTTP/Negotiate.php @@ -21,6 +21,7 @@ * server wants. * * @see http://tools.ietf.org/html/rfc7231#section-5.3 + * @see \CodeIgniter\HTTP\NegotiateTest */ class Negotiate { diff --git a/system/HTTP/OutgoingRequest.php b/system/HTTP/OutgoingRequest.php index 6a339038ea0c..698cde263bc1 100644 --- a/system/HTTP/OutgoingRequest.php +++ b/system/HTTP/OutgoingRequest.php @@ -13,6 +13,8 @@ /** * Representation of an outgoing, client-side request. + * + * @see \CodeIgniter\HTTP\OutgoingRequestTest */ class OutgoingRequest extends Message implements OutgoingRequestInterface { diff --git a/system/HTTP/RedirectResponse.php b/system/HTTP/RedirectResponse.php index 1c0e354bb1d9..d6f234ca9f68 100644 --- a/system/HTTP/RedirectResponse.php +++ b/system/HTTP/RedirectResponse.php @@ -17,6 +17,8 @@ /** * Handle a redirect response + * + * @see \CodeIgniter\HTTP\RedirectResponseTest */ class RedirectResponse extends Response { diff --git a/system/HTTP/Request.php b/system/HTTP/Request.php index 26b7b8f460c8..afb0b22ad5d0 100644 --- a/system/HTTP/Request.php +++ b/system/HTTP/Request.php @@ -16,6 +16,8 @@ /** * Representation of an incoming, server-side HTTP request. + * + * @see \CodeIgniter\HTTP\RequestTest */ class Request extends OutgoingRequest implements RequestInterface { diff --git a/system/HTTP/Response.php b/system/HTTP/Response.php index a0d5658fd8a9..bc37e7418632 100644 --- a/system/HTTP/Response.php +++ b/system/HTTP/Response.php @@ -28,6 +28,8 @@ * - Status code and reason phrase * - Headers * - Message body + * + * @see \CodeIgniter\HTTP\ResponseTest */ class Response extends Message implements ResponseInterface { diff --git a/system/HTTP/SiteURI.php b/system/HTTP/SiteURI.php index 362c8ee32362..3a163bdac428 100644 --- a/system/HTTP/SiteURI.php +++ b/system/HTTP/SiteURI.php @@ -18,6 +18,8 @@ /** * URI for the application site + * + * @see \CodeIgniter\HTTP\SiteURITest */ class SiteURI extends URI { diff --git a/system/HTTP/SiteURIFactory.php b/system/HTTP/SiteURIFactory.php index e250c559058c..36b9d705b28c 100644 --- a/system/HTTP/SiteURIFactory.php +++ b/system/HTTP/SiteURIFactory.php @@ -19,6 +19,8 @@ * Creates SiteURI using superglobals. * * This class also updates superglobal $_SERVER and $_GET. + * + * @see \CodeIgniter\HTTP\SiteURIFactoryTest */ final class SiteURIFactory { diff --git a/system/HTTP/URI.php b/system/HTTP/URI.php index a149c4102f34..c6fd64ae4418 100644 --- a/system/HTTP/URI.php +++ b/system/HTTP/URI.php @@ -18,6 +18,8 @@ /** * Abstraction for a uniform resource identifier (URI). + * + * @see \CodeIgniter\HTTP\URITest */ class URI { diff --git a/system/HTTP/UserAgent.php b/system/HTTP/UserAgent.php index 02797b2d20c3..77e7cb4392fc 100644 --- a/system/HTTP/UserAgent.php +++ b/system/HTTP/UserAgent.php @@ -15,6 +15,8 @@ /** * Abstraction for an HTTP user agent + * + * @see \CodeIgniter\HTTP\UserAgentTest */ class UserAgent { diff --git a/system/Honeypot/Honeypot.php b/system/Honeypot/Honeypot.php index 6e08c9df8bfe..c2f3cf67cc7b 100644 --- a/system/Honeypot/Honeypot.php +++ b/system/Honeypot/Honeypot.php @@ -19,6 +19,8 @@ /** * class Honeypot + * + * @see \CodeIgniter\Honeypot\HoneypotTest */ class Honeypot { diff --git a/system/HotReloader/DirectoryHasher.php b/system/HotReloader/DirectoryHasher.php index 3d9914d8c8f8..ba8d2bfbb891 100644 --- a/system/HotReloader/DirectoryHasher.php +++ b/system/HotReloader/DirectoryHasher.php @@ -19,6 +19,7 @@ /** * @internal + * @see \CodeIgniter\HotReloader\DirectoryHasherTest */ final class DirectoryHasher { diff --git a/system/I18n/Time.php b/system/I18n/Time.php index aedd00e71616..520f38eb90d1 100644 --- a/system/I18n/Time.php +++ b/system/I18n/Time.php @@ -20,6 +20,7 @@ * Requires the intl PHP extension. * * @property string $date + * @see \CodeIgniter\I18n\TimeTest */ class Time extends DateTimeImmutable { diff --git a/system/I18n/TimeDifference.php b/system/I18n/TimeDifference.php index 4b0e1aa595c1..c797a422d8c7 100644 --- a/system/I18n/TimeDifference.php +++ b/system/I18n/TimeDifference.php @@ -16,6 +16,8 @@ /** * Class TimeDifference + * + * @see \CodeIgniter\I18n\TimeDifferenceTest */ class TimeDifference { diff --git a/system/I18n/TimeLegacy.php b/system/I18n/TimeLegacy.php index 87d16fcd527d..7be9f80fac20 100644 --- a/system/I18n/TimeLegacy.php +++ b/system/I18n/TimeLegacy.php @@ -23,6 +23,7 @@ * @property string $date * * @deprecated Use Time instead. + * @see \CodeIgniter\I18n\TimeLegacyTest */ class TimeLegacy extends DateTime { diff --git a/system/Images/Image.php b/system/Images/Image.php index bb348a7ca1b8..291ad002a6f2 100644 --- a/system/Images/Image.php +++ b/system/Images/Image.php @@ -16,6 +16,8 @@ /** * Encapsulation of an Image file + * + * @see \CodeIgniter\Images\ImageTest */ class Image extends File { diff --git a/system/Language/Language.php b/system/Language/Language.php index d5781b8c6e37..70d109e2319b 100644 --- a/system/Language/Language.php +++ b/system/Language/Language.php @@ -18,6 +18,8 @@ * Handle system messages and localization. * * Locale-based, built on top of PHP internationalization. + * + * @see \CodeIgniter\Language\LanguageTest */ class Language { diff --git a/system/Log/Handlers/ChromeLoggerHandler.php b/system/Log/Handlers/ChromeLoggerHandler.php index 3354e5fb2db8..b04d6f69238c 100644 --- a/system/Log/Handlers/ChromeLoggerHandler.php +++ b/system/Log/Handlers/ChromeLoggerHandler.php @@ -21,6 +21,7 @@ * Requires the ChromeLogger extension installed in your browser. * * @see https://craig.is/writing/chrome-logger + * @see \CodeIgniter\Log\Handlers\ChromeLoggerHandlerTest */ class ChromeLoggerHandler extends BaseHandler { diff --git a/system/Log/Handlers/ErrorlogHandler.php b/system/Log/Handlers/ErrorlogHandler.php index a3c9dfabb6e8..d9f3fc4e0a20 100644 --- a/system/Log/Handlers/ErrorlogHandler.php +++ b/system/Log/Handlers/ErrorlogHandler.php @@ -15,6 +15,8 @@ /** * Log handler that writes to PHP's `error_log()` + * + * @see \CodeIgniter\Log\Handlers\ErrorlogHandlerTest */ class ErrorlogHandler extends BaseHandler { diff --git a/system/Log/Handlers/FileHandler.php b/system/Log/Handlers/FileHandler.php index e80a6121c676..88e384781a70 100644 --- a/system/Log/Handlers/FileHandler.php +++ b/system/Log/Handlers/FileHandler.php @@ -16,6 +16,8 @@ /** * Log error messages to file system + * + * @see \CodeIgniter\Log\Handlers\FileHandlerTest */ class FileHandler extends BaseHandler { diff --git a/system/Log/Logger.php b/system/Log/Logger.php index 9643a82191c6..b1583f5d789c 100644 --- a/system/Log/Logger.php +++ b/system/Log/Logger.php @@ -28,6 +28,8 @@ * The context array can contain arbitrary data, the only assumption that * can be made by implementors is that if an Exception instance is given * to produce a stack trace, it MUST be in a key named "exception". + * + * @see \CodeIgniter\Log\LoggerTest */ class Logger implements LoggerInterface { diff --git a/system/Pager/Pager.php b/system/Pager/Pager.php index 3a9f5a772f0a..648bb1e5e4de 100644 --- a/system/Pager/Pager.php +++ b/system/Pager/Pager.php @@ -24,6 +24,8 @@ * pagination links and reading the current url's query variable, "page" * to determine the current page. This class can support multiple * paginations on a single page. + * + * @see \CodeIgniter\Pager\PagerTest */ class Pager implements PagerInterface { diff --git a/system/Pager/PagerRenderer.php b/system/Pager/PagerRenderer.php index 024ffd095673..454ac9f1cd93 100644 --- a/system/Pager/PagerRenderer.php +++ b/system/Pager/PagerRenderer.php @@ -19,6 +19,8 @@ * This class is passed to the view that describes the pagination, * and is used to get the link information and provide utility * methods needed to work with pagination. + * + * @see \CodeIgniter\Pager\PagerRendererTest */ class PagerRenderer { diff --git a/system/Publisher/ContentReplacer.php b/system/Publisher/ContentReplacer.php index 76cef11336f1..accfdd716695 100644 --- a/system/Publisher/ContentReplacer.php +++ b/system/Publisher/ContentReplacer.php @@ -15,6 +15,8 @@ /** * Replace Text Content + * + * @see \CodeIgniter\Publisher\ContentReplacerTest */ class ContentReplacer { diff --git a/system/RESTful/ResourceController.php b/system/RESTful/ResourceController.php index 5c55bf5abac7..03ba4d314613 100644 --- a/system/RESTful/ResourceController.php +++ b/system/RESTful/ResourceController.php @@ -16,6 +16,8 @@ /** * An extendable controller to provide a RESTful API for a resource. + * + * @see \CodeIgniter\RESTful\ResourceControllerTest */ class ResourceController extends BaseResource { diff --git a/system/RESTful/ResourcePresenter.php b/system/RESTful/ResourcePresenter.php index 5aedb28d4ad8..8c39bd8a0050 100644 --- a/system/RESTful/ResourcePresenter.php +++ b/system/RESTful/ResourcePresenter.php @@ -15,6 +15,8 @@ /** * An extendable controller to help provide a UI for a resource. + * + * @see \CodeIgniter\RESTful\ResourcePresenterTest */ class ResourcePresenter extends BaseResource { diff --git a/system/Router/AutoRouterImproved.php b/system/Router/AutoRouterImproved.php index b6b81c70f2ef..0a26fc12f865 100644 --- a/system/Router/AutoRouterImproved.php +++ b/system/Router/AutoRouterImproved.php @@ -19,6 +19,8 @@ /** * New Secure Router for Auto-Routing + * + * @see \CodeIgniter\Router\AutoRouterImprovedTest */ final class AutoRouterImproved implements AutoRouterInterface { diff --git a/system/Router/DefinedRouteCollector.php b/system/Router/DefinedRouteCollector.php index 9d211415a8a0..2b317d4cbc2a 100644 --- a/system/Router/DefinedRouteCollector.php +++ b/system/Router/DefinedRouteCollector.php @@ -16,6 +16,8 @@ /** * Collect all defined routes for display. + * + * @see \CodeIgniter\Router\DefinedRouteCollectorTest */ final class DefinedRouteCollector { diff --git a/system/Router/RouteCollection.php b/system/Router/RouteCollection.php index 8383280114b5..63b7397dbc4c 100644 --- a/system/Router/RouteCollection.php +++ b/system/Router/RouteCollection.php @@ -23,6 +23,7 @@ /** * @todo Implement nested resource routing (See CakePHP) + * @see \CodeIgniter\Router\RouteCollectionTest */ class RouteCollection implements RouteCollectionInterface { diff --git a/system/Router/Router.php b/system/Router/Router.php index bd57435f8020..0013d7cdf920 100644 --- a/system/Router/Router.php +++ b/system/Router/Router.php @@ -21,6 +21,8 @@ /** * Request router. + * + * @see \CodeIgniter\Router\RouterTest */ class Router implements RouterInterface { diff --git a/system/Security/Security.php b/system/Security/Security.php index c67c13ce0c1c..648856321363 100644 --- a/system/Security/Security.php +++ b/system/Security/Security.php @@ -30,6 +30,8 @@ * * Provides methods that help protect your site against * Cross-Site Request Forgery attacks. + * + * @see \CodeIgniter\Security\SecurityTest */ class Security implements SecurityInterface { diff --git a/system/Session/Handlers/Database/MySQLiHandler.php b/system/Session/Handlers/Database/MySQLiHandler.php index fabaae451e6a..380041aab67b 100644 --- a/system/Session/Handlers/Database/MySQLiHandler.php +++ b/system/Session/Handlers/Database/MySQLiHandler.php @@ -15,6 +15,8 @@ /** * Session handler for MySQLi + * + * @see \CodeIgniter\Session\Handlers\Database\MySQLiHandlerTest */ class MySQLiHandler extends DatabaseHandler { diff --git a/system/Session/Handlers/Database/PostgreHandler.php b/system/Session/Handlers/Database/PostgreHandler.php index 963aa27cdb35..0c140fea70c3 100644 --- a/system/Session/Handlers/Database/PostgreHandler.php +++ b/system/Session/Handlers/Database/PostgreHandler.php @@ -17,6 +17,8 @@ /** * Session handler for Postgre + * + * @see \CodeIgniter\Session\Handlers\Database\PostgreHandlerTest */ class PostgreHandler extends DatabaseHandler { diff --git a/system/Session/Session.php b/system/Session/Session.php index fcdaee1ebce8..ba4388472c3e 100644 --- a/system/Session/Session.php +++ b/system/Session/Session.php @@ -27,6 +27,7 @@ * variables in app/config/App.php * * @property string $session_id + * @see \CodeIgniter\Session\SessionTest */ class Session implements SessionInterface { diff --git a/system/Superglobals.php b/system/Superglobals.php index b126af130f34..c4386353315b 100644 --- a/system/Superglobals.php +++ b/system/Superglobals.php @@ -15,6 +15,7 @@ * Superglobals manipulation. * * @internal + * @see \CodeIgniter\SuperglobalsTest */ final class Superglobals { diff --git a/system/Test/DOMParser.php b/system/Test/DOMParser.php index 54762643e38d..100b14b72dff 100644 --- a/system/Test/DOMParser.php +++ b/system/Test/DOMParser.php @@ -19,6 +19,8 @@ /** * Load a response into a DOMDocument for testing assertions based on that + * + * @see \CodeIgniter\Test\DOMParserTest */ class DOMParser { diff --git a/system/Test/Fabricator.php b/system/Test/Fabricator.php index 6c9e82ff5c00..3a28f281d127 100644 --- a/system/Test/Fabricator.php +++ b/system/Test/Fabricator.php @@ -25,6 +25,8 @@ * * Bridge class for using Faker to create example data based on * model specifications. + * + * @see \CodeIgniter\Test\FabricatorTest */ class Fabricator { diff --git a/system/Test/TestLogger.php b/system/Test/TestLogger.php index 989fb6ef5c13..240f5c6d95b5 100644 --- a/system/Test/TestLogger.php +++ b/system/Test/TestLogger.php @@ -13,6 +13,9 @@ use CodeIgniter\Log\Logger; +/** + * @see \CodeIgniter\Test\TestLoggerTest + */ class TestLogger extends Logger { protected static $op_logs = []; diff --git a/system/Test/TestResponse.php b/system/Test/TestResponse.php index d66728c5d0db..956b32188ac8 100644 --- a/system/Test/TestResponse.php +++ b/system/Test/TestResponse.php @@ -31,6 +31,7 @@ * @internal * * @mixin DOMParser + * @see \CodeIgniter\Test\TestResponseTest */ class TestResponse extends TestCase { diff --git a/system/Typography/Typography.php b/system/Typography/Typography.php index fb05b68faefe..fd763cd52e86 100644 --- a/system/Typography/Typography.php +++ b/system/Typography/Typography.php @@ -15,6 +15,8 @@ /** * Typography Class + * + * @see \CodeIgniter\Typography\TypographyTest */ class Typography { diff --git a/system/Validation/CreditCardRules.php b/system/Validation/CreditCardRules.php index 8b0e3842a128..61f59d7bfe86 100644 --- a/system/Validation/CreditCardRules.php +++ b/system/Validation/CreditCardRules.php @@ -17,6 +17,7 @@ * Provides validation methods for common credit-card inputs. * * @see http://en.wikipedia.org/wiki/Credit_card_number + * @see \CodeIgniter\Validation\CreditCardRulesTest */ class CreditCardRules { diff --git a/system/Validation/DotArrayFilter.php b/system/Validation/DotArrayFilter.php index cead4f6bb414..43cb19370784 100644 --- a/system/Validation/DotArrayFilter.php +++ b/system/Validation/DotArrayFilter.php @@ -11,6 +11,9 @@ namespace CodeIgniter\Validation; +/** + * @see \CodeIgniter\Validation\DotArrayFilterTest + */ final class DotArrayFilter { /** diff --git a/system/Validation/FileRules.php b/system/Validation/FileRules.php index ba054d134b6b..756c7c7536b6 100644 --- a/system/Validation/FileRules.php +++ b/system/Validation/FileRules.php @@ -21,6 +21,8 @@ /** * File validation rules + * + * @see \CodeIgniter\Validation\FileRulesTest */ class FileRules { diff --git a/system/Validation/FormatRules.php b/system/Validation/FormatRules.php index 485b9efec2df..5089f5a0961f 100644 --- a/system/Validation/FormatRules.php +++ b/system/Validation/FormatRules.php @@ -15,6 +15,8 @@ /** * Format validation Rules. + * + * @see \CodeIgniter\Validation\FormatRulesTest */ class FormatRules { diff --git a/system/Validation/Rules.php b/system/Validation/Rules.php index e85b7443088e..b7c585f56c30 100644 --- a/system/Validation/Rules.php +++ b/system/Validation/Rules.php @@ -16,6 +16,8 @@ /** * Validation Rules. + * + * @see \CodeIgniter\Validation\RulesTest */ class Rules { diff --git a/system/Validation/StrictRules/CreditCardRules.php b/system/Validation/StrictRules/CreditCardRules.php index 2cbc1438cf17..2ceacdc6fc37 100644 --- a/system/Validation/StrictRules/CreditCardRules.php +++ b/system/Validation/StrictRules/CreditCardRules.php @@ -21,6 +21,7 @@ * Provides validation methods for common credit-card inputs. * * @see http://en.wikipedia.org/wiki/Credit_card_number + * @see \CodeIgniter\Validation\StrictRules\CreditCardRulesTest */ class CreditCardRules { diff --git a/system/Validation/StrictRules/FileRules.php b/system/Validation/StrictRules/FileRules.php index 401771cf6cfa..e86b84e99bfe 100644 --- a/system/Validation/StrictRules/FileRules.php +++ b/system/Validation/StrictRules/FileRules.php @@ -17,6 +17,8 @@ /** * File validation rules + * + * @see \CodeIgniter\Validation\StrictRules\FileRulesTest */ class FileRules extends NonStrictFileRules { diff --git a/system/Validation/StrictRules/FormatRules.php b/system/Validation/StrictRules/FormatRules.php index facb28664b2a..c186a75b2694 100644 --- a/system/Validation/StrictRules/FormatRules.php +++ b/system/Validation/StrictRules/FormatRules.php @@ -17,6 +17,8 @@ /** * Format validation Rules. + * + * @see \CodeIgniter\Validation\StrictRules\FormatRulesTest */ class FormatRules { diff --git a/system/Validation/StrictRules/Rules.php b/system/Validation/StrictRules/Rules.php index cdc20f5e2e4e..7043646c1f58 100644 --- a/system/Validation/StrictRules/Rules.php +++ b/system/Validation/StrictRules/Rules.php @@ -18,6 +18,8 @@ /** * Validation Rules. + * + * @see \CodeIgniter\Validation\StrictRules\RulesTest */ class Rules { diff --git a/system/Validation/Validation.php b/system/Validation/Validation.php index bfb89cef5649..b40bc91048bc 100644 --- a/system/Validation/Validation.php +++ b/system/Validation/Validation.php @@ -24,6 +24,8 @@ /** * Validator + * + * @see \CodeIgniter\Validation\ValidationTest */ class Validation implements ValidationInterface { diff --git a/system/View/Cell.php b/system/View/Cell.php index 223d694f6308..f654e97a376d 100644 --- a/system/View/Cell.php +++ b/system/View/Cell.php @@ -43,6 +43,8 @@ * class Class { * function method(array $params=null) * } + * + * @see \CodeIgniter\View\CellTest */ class Cell { diff --git a/system/View/Parser.php b/system/View/Parser.php index 84ff821540cb..120570079d2b 100644 --- a/system/View/Parser.php +++ b/system/View/Parser.php @@ -22,6 +22,8 @@ * * @phpstan-type ParserCallable (callable(mixed): mixed) * @phpstan-type ParserCallableString (callable(mixed): mixed)&string + * + * @see \CodeIgniter\View\ParserTest */ class Parser extends View { diff --git a/system/View/Table.php b/system/View/Table.php index e2bacac17938..df0fbebd2bc5 100644 --- a/system/View/Table.php +++ b/system/View/Table.php @@ -17,6 +17,8 @@ * HTML Table Generating Class * * Lets you create tables manually or from database result objects, or arrays. + * + * @see \CodeIgniter\View\TableTest */ class Table { diff --git a/system/View/View.php b/system/View/View.php index 6c633482fcce..e8fdf5f18f7e 100644 --- a/system/View/View.php +++ b/system/View/View.php @@ -23,6 +23,8 @@ /** * Class View + * + * @see \CodeIgniter\View\ViewTest */ class View implements RendererInterface { From ef15d933e5cdced5623fd83c9401094fc44f88b8 Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 6 Sep 2023 18:22:17 +0900 Subject: [PATCH 2/6] chore: replace deprecated sets --- rector.php | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/rector.php b/rector.php index fc00f27e0c4e..e653fade902f 100644 --- a/rector.php +++ b/rector.php @@ -38,6 +38,8 @@ use Rector\Php71\Rector\FuncCall\CountOnNullRector; use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector; use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector; +use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector; +use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector; use Rector\PHPUnit\Set\PHPUnitSetList; use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector; use Rector\Set\ValueObject\LevelSetList; @@ -51,9 +53,8 @@ $rectorConfig->sets([ SetList::DEAD_CODE, LevelSetList::UP_TO_PHP_74, - PHPUnitSetList::PHPUNIT_SPECIFIC_METHOD, + PHPUnitSetList::PHPUNIT_CODE_QUALITY, PHPUnitSetList::PHPUNIT_80, - PHPUnitSetList::REMOVE_MOCKS, ]); $rectorConfig->parallel(240, 8, 1); @@ -77,12 +78,18 @@ __DIR__ . '/tests/_support', JsonThrowOnErrorRector::class, StringifyStrNeedlesRector::class, + YieldDataProviderRector::class, RemoveUnusedPrivateMethodRector::class => [ // private method called via getPrivateMethodInvoker __DIR__ . '/tests/system/Test/ReflectionHelperTest.php', ], + ConstructClassMethodToSetUpTestCaseRector::class => [ + // breaks the constructor + __DIR__ . '/system/Test/TestResponse.php', + ], + RemoveUnusedConstructorParamRector::class => [ // there are deprecated parameters __DIR__ . '/system/Debug/Exceptions.php', From d669efa9b8d71e5c53fd70bc300a1efcb53d312c Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 6 Sep 2023 19:32:55 +0900 Subject: [PATCH 3/6] chore: use PPHPUnitLevelSetList::UP_TO_PHPUNIT_100 instead of PHPUnitSetList::PHPUNIT_80 --- rector.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rector.php b/rector.php index e653fade902f..030a2df10962 100644 --- a/rector.php +++ b/rector.php @@ -40,6 +40,7 @@ use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector; use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector; use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector; +use Rector\PHPUnit\Set\PHPUnitLevelSetList; use Rector\PHPUnit\Set\PHPUnitSetList; use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector; use Rector\Set\ValueObject\LevelSetList; @@ -53,8 +54,8 @@ $rectorConfig->sets([ SetList::DEAD_CODE, LevelSetList::UP_TO_PHP_74, + PHPUnitLevelSetList::UP_TO_PHPUNIT_100, PHPUnitSetList::PHPUNIT_CODE_QUALITY, - PHPUnitSetList::PHPUNIT_80, ]); $rectorConfig->parallel(240, 8, 1); From 94d546b9a8fcaae46fa100a44e2735242c4758df Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 7 Sep 2023 15:49:48 +0900 Subject: [PATCH 4/6] chore: add system/Test/ControllerResponse.php to skip list It caused an error. Warning: Undefined array key 1852 in /home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/Internal/TokenStream.php on line 209 Error: ] Could not process "/home/runner/work/CodeIgniter4/CodeIgniter4/system/Test/ControllerResp onse.php" file, due to: "System error: "PhpParser\Internal\TokenStream::getIndentationBefore(): Return value must be of type int, null returned" Run Rector with "--debug" option and post the report here: https://github.com/rectorphp/rector/issues/new". On line: 209 Error: Process completed with exit code 1. --- rector.php | 1 + 1 file changed, 1 insertion(+) diff --git a/rector.php b/rector.php index 030a2df10962..536cecfe1fc8 100644 --- a/rector.php +++ b/rector.php @@ -73,6 +73,7 @@ // is there a file you need to skip? $rectorConfig->skip([ __DIR__ . '/system/Debug/Toolbar/Views/toolbar.tpl.php', + __DIR__ . '/system/Test/ControllerResponse.php', __DIR__ . '/system/ThirdParty', __DIR__ . '/tests/system/Config/fixtures', __DIR__ . '/tests/system/Filters/fixtures', From f75e33d57b6e4742e909cc207aa7af6177ddfc8d Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 7 Sep 2023 15:51:15 +0900 Subject: [PATCH 5/6] chore: change PHPUnitLevelSetList::UP_TO_PHPUNIT_100 to PHPUnitSetList::PHPUNIT_100 It does not work for us. See https://github.com/codeigniter4/CodeIgniter4/pull/7904#discussion_r1318145952 --- rector.php | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/rector.php b/rector.php index 536cecfe1fc8..aba0f41e9c67 100644 --- a/rector.php +++ b/rector.php @@ -40,7 +40,6 @@ use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector; use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector; use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector; -use Rector\PHPUnit\Set\PHPUnitLevelSetList; use Rector\PHPUnit\Set\PHPUnitSetList; use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector; use Rector\Set\ValueObject\LevelSetList; @@ -54,8 +53,8 @@ $rectorConfig->sets([ SetList::DEAD_CODE, LevelSetList::UP_TO_PHP_74, - PHPUnitLevelSetList::UP_TO_PHPUNIT_100, PHPUnitSetList::PHPUNIT_CODE_QUALITY, + PHPUnitSetList::PHPUNIT_100, ]); $rectorConfig->parallel(240, 8, 1); From 0276d89290fa8f578bba88d1e2cef74bde3ff833 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 8 Sep 2023 17:39:55 +0900 Subject: [PATCH 6/6] chore: skip the specific rule See https://github.com/codeigniter4/CodeIgniter4/pull/7904#discussion_r1318507172 --- rector.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rector.php b/rector.php index aba0f41e9c67..61ca28b47045 100644 --- a/rector.php +++ b/rector.php @@ -72,7 +72,6 @@ // is there a file you need to skip? $rectorConfig->skip([ __DIR__ . '/system/Debug/Toolbar/Views/toolbar.tpl.php', - __DIR__ . '/system/Test/ControllerResponse.php', __DIR__ . '/system/ThirdParty', __DIR__ . '/tests/system/Config/fixtures', __DIR__ . '/tests/system/Filters/fixtures', @@ -89,6 +88,8 @@ ConstructClassMethodToSetUpTestCaseRector::class => [ // breaks the constructor __DIR__ . '/system/Test/TestResponse.php', + // See https://github.com/rectorphp/rector/issues/8188 + __DIR__ . '/system/Test/ControllerResponse.php', ], RemoveUnusedConstructorParamRector::class => [