From 77d7d1bd3e35afb18f7df6536c9bba37c488b592 Mon Sep 17 00:00:00 2001 From: Abdul Malik Ikhsan Date: Tue, 1 Jun 2021 17:13:21 +0700 Subject: [PATCH 1/2] [Rector] Apply Rector: VarConstantCommentRector --- rector.php | 2 + system/Cache/Handlers/BaseHandler.php | 4 + system/Cache/Handlers/FileHandler.php | 2 + system/CodeIgniter.php | 2 + system/Cookie/CookieInterface.php | 2 + system/HTTP/ResponseInterface.php | 312 ++++++++++++++---- system/HTTP/URI.php | 2 + system/Log/Handlers/ErrorlogHandler.php | 4 + tests/system/Validation/FormatRulesTest.php | 8 +- ...rictParameterToFunctionParameterRector.php | 3 + 10 files changed, 281 insertions(+), 60 deletions(-) diff --git a/rector.php b/rector.php index 3872c24584f9..1a0e381acb84 100644 --- a/rector.php +++ b/rector.php @@ -12,6 +12,7 @@ use Rector\CodeQuality\Rector\Return_\SimplifyUselessVariableRector; use Rector\CodeQuality\Rector\Ternary\UnnecessaryTernaryExpressionRector; use Rector\CodeQualityStrict\Rector\Variable\MoveVariableDeclarationNearReferenceRector; +use Rector\CodingStyle\Rector\ClassConst\VarConstantCommentRector; use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector; use Rector\Core\Configuration\Option; use Rector\Core\ValueObject\PhpVersion; @@ -92,4 +93,5 @@ $services->set(TernaryToNullCoalescingRector::class); $services->set(ListToArrayDestructRector::class); $services->set(MoveVariableDeclarationNearReferenceRector::class); + $services->set(VarConstantCommentRector::class); }; diff --git a/system/Cache/Handlers/BaseHandler.php b/system/Cache/Handlers/BaseHandler.php index a5de4286f093..7d7b936940e8 100644 --- a/system/Cache/Handlers/BaseHandler.php +++ b/system/Cache/Handlers/BaseHandler.php @@ -24,11 +24,15 @@ abstract class BaseHandler implements CacheInterface /** * Reserved characters that cannot be used in a key or tag. * From https://github.com/symfony/cache-contracts/blob/c0446463729b89dd4fa62e9aeecc80287323615d/ItemInterface.php#L43 + * + * @var string */ public const RESERVED_CHARACTERS = '{}()/\@:'; /** * Maximum key length. + * + * @var int */ public const MAX_KEY_LENGTH = PHP_INT_MAX; diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php index c67b2180a643..95bdfa0995b8 100644 --- a/system/Cache/Handlers/FileHandler.php +++ b/system/Cache/Handlers/FileHandler.php @@ -22,6 +22,8 @@ class FileHandler extends BaseHandler { /** * Maximum key length. + * + * @var int */ public const MAX_KEY_LENGTH = 255; diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php index c19918aec1d9..dfef0bb27ce7 100644 --- a/system/CodeIgniter.php +++ b/system/CodeIgniter.php @@ -43,6 +43,8 @@ class CodeIgniter { /** * The current version of CodeIgniter Framework + * + * @var string */ const CI_VERSION = '4.1.2'; diff --git a/system/Cookie/CookieInterface.php b/system/Cookie/CookieInterface.php index 1dddb13a1426..1984432610be 100644 --- a/system/Cookie/CookieInterface.php +++ b/system/Cookie/CookieInterface.php @@ -22,6 +22,8 @@ interface CookieInterface * Cookies will be sent in all contexts, i.e in responses to both * first-party and cross-origin requests. If `SameSite=None` is set, * the cookie `Secure` attribute must also be set (or the cookie will be blocked). + * + * @var string */ public const SAMESITE_NONE = 'none'; diff --git a/system/HTTP/ResponseInterface.php b/system/HTTP/ResponseInterface.php index bfa493b99987..2098cc329a39 100644 --- a/system/HTTP/ResponseInterface.php +++ b/system/HTTP/ResponseInterface.php @@ -36,77 +36,271 @@ interface ResponseInterface /** * Constants for status codes. * From https://en.wikipedia.org/wiki/List_of_HTTP_status_codes + * + * @var int */ // Informational - const HTTP_CONTINUE = 100; + const HTTP_CONTINUE = 100; + /** + * @var int + */ const HTTP_SWITCHING_PROTOCOLS = 101; - const HTTP_PROCESSING = 102; - const HTTP_EARLY_HINTS = 103; + /** + * @var int + */ + const HTTP_PROCESSING = 102; + /** + * @var int + */ + const HTTP_EARLY_HINTS = 103; // Success - const HTTP_OK = 200; - const HTTP_CREATED = 201; - const HTTP_ACCEPTED = 202; + /** + * @var int + */ + const HTTP_OK = 200; + /** + * @var int + */ + const HTTP_CREATED = 201; + /** + * @var int + */ + const HTTP_ACCEPTED = 202; + /** + * @var int + */ const HTTP_NONAUTHORITATIVE_INFORMATION = 203; - const HTTP_NO_CONTENT = 204; - const HTTP_RESET_CONTENT = 205; - const HTTP_PARTIAL_CONTENT = 206; - const HTTP_MULTI_STATUS = 207; - const HTTP_ALREADY_REPORTED = 208; - const HTTP_IM_USED = 226; + /** + * @var int + */ + const HTTP_NO_CONTENT = 204; + /** + * @var int + */ + const HTTP_RESET_CONTENT = 205; + /** + * @var int + */ + const HTTP_PARTIAL_CONTENT = 206; + /** + * @var int + */ + const HTTP_MULTI_STATUS = 207; + /** + * @var int + */ + const HTTP_ALREADY_REPORTED = 208; + /** + * @var int + */ + const HTTP_IM_USED = 226; // Redirection - const HTTP_MULTIPLE_CHOICES = 300; - const HTTP_MOVED_PERMANENTLY = 301; - const HTTP_FOUND = 302; - const HTTP_SEE_OTHER = 303; - const HTTP_NOT_MODIFIED = 304; - const HTTP_USE_PROXY = 305; - const HTTP_SWITCH_PROXY = 306; + /** + * @var int + */ + const HTTP_MULTIPLE_CHOICES = 300; + /** + * @var int + */ + const HTTP_MOVED_PERMANENTLY = 301; + /** + * @var int + */ + const HTTP_FOUND = 302; + /** + * @var int + */ + const HTTP_SEE_OTHER = 303; + /** + * @var int + */ + const HTTP_NOT_MODIFIED = 304; + /** + * @var int + */ + const HTTP_USE_PROXY = 305; + /** + * @var int + */ + const HTTP_SWITCH_PROXY = 306; + /** + * @var int + */ const HTTP_TEMPORARY_REDIRECT = 307; + /** + * @var int + */ const HTTP_PERMANENT_REDIRECT = 308; // Client Error - const HTTP_BAD_REQUEST = 400; - const HTTP_UNAUTHORIZED = 401; - const HTTP_PAYMENT_REQUIRED = 402; - const HTTP_FORBIDDEN = 403; - const HTTP_NOT_FOUND = 404; - const HTTP_METHOD_NOT_ALLOWED = 405; - const HTTP_NOT_ACCEPTABLE = 406; - const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407; - const HTTP_REQUEST_TIMEOUT = 408; - const HTTP_CONFLICT = 409; - const HTTP_GONE = 410; - const HTTP_LENGTH_REQUIRED = 411; - const HTTP_PRECONDITION_FAILED = 412; - const HTTP_PAYLOAD_TOO_LARGE = 413; - const HTTP_URI_TOO_LONG = 414; - const HTTP_UNSUPPORTED_MEDIA_TYPE = 415; - const HTTP_RANGE_NOT_SATISFIABLE = 416; - const HTTP_EXPECTATION_FAILED = 417; - const HTTP_IM_A_TEAPOT = 418; - const HTTP_MISDIRECTED_REQUEST = 421; - const HTTP_UNPROCESSABLE_ENTITY = 422; - const HTTP_LOCKED = 423; - const HTTP_FAILED_DEPENDENCY = 424; - const HTTP_TOO_EARLY = 425; - const HTTP_UPGRADE_REQUIRED = 426; - const HTTP_PRECONDITION_REQUIRED = 428; - const HTTP_TOO_MANY_REQUESTS = 429; + /** + * @var int + */ + const HTTP_BAD_REQUEST = 400; + /** + * @var int + */ + const HTTP_UNAUTHORIZED = 401; + /** + * @var int + */ + const HTTP_PAYMENT_REQUIRED = 402; + /** + * @var int + */ + const HTTP_FORBIDDEN = 403; + /** + * @var int + */ + const HTTP_NOT_FOUND = 404; + /** + * @var int + */ + const HTTP_METHOD_NOT_ALLOWED = 405; + /** + * @var int + */ + const HTTP_NOT_ACCEPTABLE = 406; + /** + * @var int + */ + const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407; + /** + * @var int + */ + const HTTP_REQUEST_TIMEOUT = 408; + /** + * @var int + */ + const HTTP_CONFLICT = 409; + /** + * @var int + */ + const HTTP_GONE = 410; + /** + * @var int + */ + const HTTP_LENGTH_REQUIRED = 411; + /** + * @var int + */ + const HTTP_PRECONDITION_FAILED = 412; + /** + * @var int + */ + const HTTP_PAYLOAD_TOO_LARGE = 413; + /** + * @var int + */ + const HTTP_URI_TOO_LONG = 414; + /** + * @var int + */ + const HTTP_UNSUPPORTED_MEDIA_TYPE = 415; + /** + * @var int + */ + const HTTP_RANGE_NOT_SATISFIABLE = 416; + /** + * @var int + */ + const HTTP_EXPECTATION_FAILED = 417; + /** + * @var int + */ + const HTTP_IM_A_TEAPOT = 418; + /** + * @var int + */ + const HTTP_MISDIRECTED_REQUEST = 421; + /** + * @var int + */ + const HTTP_UNPROCESSABLE_ENTITY = 422; + /** + * @var int + */ + const HTTP_LOCKED = 423; + /** + * @var int + */ + const HTTP_FAILED_DEPENDENCY = 424; + /** + * @var int + */ + const HTTP_TOO_EARLY = 425; + /** + * @var int + */ + const HTTP_UPGRADE_REQUIRED = 426; + /** + * @var int + */ + const HTTP_PRECONDITION_REQUIRED = 428; + /** + * @var int + */ + const HTTP_TOO_MANY_REQUESTS = 429; + /** + * @var int + */ const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431; - const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451; - const HTTP_CLIENT_CLOSED_REQUEST = 499; + /** + * @var int + */ + const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451; + /** + * @var int + */ + const HTTP_CLIENT_CLOSED_REQUEST = 499; // Server Error - const HTTP_INTERNAL_SERVER_ERROR = 500; - const HTTP_NOT_IMPLEMENTED = 501; - const HTTP_BAD_GATEWAY = 502; - const HTTP_SERVICE_UNAVAILABLE = 503; - const HTTP_GATEWAY_TIMEOUT = 504; - const HTTP_HTTP_VERSION_NOT_SUPPORTED = 505; - const HTTP_VARIANT_ALSO_NEGOTIATES = 506; - const HTTP_INSUFFICIENT_STORAGE = 507; - const HTTP_LOOP_DETECTED = 508; - const HTTP_NOT_EXTENDED = 510; + /** + * @var int + */ + const HTTP_INTERNAL_SERVER_ERROR = 500; + /** + * @var int + */ + const HTTP_NOT_IMPLEMENTED = 501; + /** + * @var int + */ + const HTTP_BAD_GATEWAY = 502; + /** + * @var int + */ + const HTTP_SERVICE_UNAVAILABLE = 503; + /** + * @var int + */ + const HTTP_GATEWAY_TIMEOUT = 504; + /** + * @var int + */ + const HTTP_HTTP_VERSION_NOT_SUPPORTED = 505; + /** + * @var int + */ + const HTTP_VARIANT_ALSO_NEGOTIATES = 506; + /** + * @var int + */ + const HTTP_INSUFFICIENT_STORAGE = 507; + /** + * @var int + */ + const HTTP_LOOP_DETECTED = 508; + /** + * @var int + */ + const HTTP_NOT_EXTENDED = 510; + /** + * @var int + */ const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511; - const HTTP_NETWORK_CONNECT_TIMEOUT_ERROR = 599; + /** + * @var int + */ + const HTTP_NETWORK_CONNECT_TIMEOUT_ERROR = 599; /** * Gets the response status code. diff --git a/system/HTTP/URI.php b/system/HTTP/URI.php index 4eb1f39f0e73..fe55fe6be0ee 100644 --- a/system/HTTP/URI.php +++ b/system/HTTP/URI.php @@ -23,6 +23,7 @@ class URI * Sub-delimiters used in query strings and fragments. * * @const string + * @var string */ const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='; @@ -30,6 +31,7 @@ class URI * Unreserved characters used in paths, query strings, and fragments. * * @const string + * @var string */ const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~'; diff --git a/system/Log/Handlers/ErrorlogHandler.php b/system/Log/Handlers/ErrorlogHandler.php index fb5d1a478327..fd744138173e 100644 --- a/system/Log/Handlers/ErrorlogHandler.php +++ b/system/Log/Handlers/ErrorlogHandler.php @@ -22,11 +22,15 @@ class ErrorlogHandler extends BaseHandler * Message is sent to PHP's system logger, using the Operating System's * system logging mechanism or a file, depending on what the error_log * configuration directive is set to. + * + * @var int */ public const TYPE_OS = 0; /** * Message is sent directly to the SAPI logging handler. + * + * @var int */ public const TYPE_SAPI = 4; diff --git a/tests/system/Validation/FormatRulesTest.php b/tests/system/Validation/FormatRulesTest.php index 8154c6035882..dd3e013842a0 100644 --- a/tests/system/Validation/FormatRulesTest.php +++ b/tests/system/Validation/FormatRulesTest.php @@ -9,7 +9,13 @@ class FormatRulesTest extends CIUnitTestCase { - const ALPHABET = 'abcdefghijklmnopqrstuvwxyzABCDEFGHLIJKLMNOPQRSTUVWXYZ'; + /** + * @var string + */ + const ALPHABET = 'abcdefghijklmnopqrstuvwxyzABCDEFGHLIJKLMNOPQRSTUVWXYZ'; + /** + * @var string + */ const ALPHANUMERIC = 'abcdefghijklmnopqrstuvwxyzABCDEFGHLIJKLMNOPQRSTUVWXYZ0123456789'; /** diff --git a/utils/Rector/PassStrictParameterToFunctionParameterRector.php b/utils/Rector/PassStrictParameterToFunctionParameterRector.php index 0c406d70b24e..62d1877e8767 100644 --- a/utils/Rector/PassStrictParameterToFunctionParameterRector.php +++ b/utils/Rector/PassStrictParameterToFunctionParameterRector.php @@ -18,6 +18,9 @@ */ final class PassStrictParameterToFunctionParameterRector extends AbstractRector { + /** + * @var array + */ private const FUNCTION_WITH_ARG_POSITION = [ // position start from 0 'array_search' => 2, From 52a1823e589f6a9852af4efad180e8489e09403c Mon Sep 17 00:00:00 2001 From: Abdul Malik Ikhsan Date: Tue, 1 Jun 2021 17:43:57 +0700 Subject: [PATCH 2/2] remove @const --- system/HTTP/URI.php | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/system/HTTP/URI.php b/system/HTTP/URI.php index fe55fe6be0ee..509621eb307a 100644 --- a/system/HTTP/URI.php +++ b/system/HTTP/URI.php @@ -22,16 +22,14 @@ class URI /** * Sub-delimiters used in query strings and fragments. * - * @const string - * @var string + * @var string */ const CHAR_SUB_DELIMS = '!\$&\'\(\)\*\+,;='; /** * Unreserved characters used in paths, query strings, and fragments. * - * @const string - * @var string + * @var string */ const CHAR_UNRESERVED = 'a-zA-Z0-9_\-\.~';