From 52c814525bfd9f6641288afe5bcf6f8c3e968256 Mon Sep 17 00:00:00 2001 From: "John Paul E. Balandan, CPA" <51850998+paulbalandan@users.noreply.github.com> Date: Sun, 18 Jul 2021 22:07:56 +0800 Subject: [PATCH] Fix tag casing and tag types (#4943) --- system/Commands/Utilities/Environment.php | 2 +- system/Entity/Cast/ArrayCast.php | 4 ++-- system/Entity/Cast/BooleanCast.php | 2 +- system/Entity/Cast/CSVCast.php | 4 ++-- system/Entity/Cast/DatetimeCast.php | 2 +- system/Entity/Cast/FloatCast.php | 2 +- system/Entity/Cast/IntegerCast.php | 2 +- system/Entity/Cast/JsonCast.php | 4 ++-- system/Entity/Cast/ObjectCast.php | 2 +- system/Entity/Cast/StringCast.php | 2 +- system/Entity/Cast/TimestampCast.php | 2 +- system/Entity/Cast/URICast.php | 2 +- utils/PhpCsFixer/CodeIgniter4.php | 2 ++ 13 files changed, 17 insertions(+), 15 deletions(-) diff --git a/system/Commands/Utilities/Environment.php b/system/Commands/Utilities/Environment.php index ede7ae2d8a..5b44ea02bd 100644 --- a/system/Commands/Utilities/Environment.php +++ b/system/Commands/Utilities/Environment.php @@ -69,7 +69,7 @@ final class Environment extends BaseCommand ]; /** - * @inheritDoc + * {@inheritDoc} * * @param array $params * diff --git a/system/Entity/Cast/ArrayCast.php b/system/Entity/Cast/ArrayCast.php index 64d200e1d0..67a18bd07e 100644 --- a/system/Entity/Cast/ArrayCast.php +++ b/system/Entity/Cast/ArrayCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class ArrayCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): array { @@ -29,7 +29,7 @@ class ArrayCast extends BaseCast } /** - * @inheritDoc + * {@inheritDoc} */ public static function set($value, array $params = []): string { diff --git a/system/Entity/Cast/BooleanCast.php b/system/Entity/Cast/BooleanCast.php index 1521170324..cca9d4f2cd 100644 --- a/system/Entity/Cast/BooleanCast.php +++ b/system/Entity/Cast/BooleanCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class BooleanCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): bool { diff --git a/system/Entity/Cast/CSVCast.php b/system/Entity/Cast/CSVCast.php index 0ebd43cc42..ee8a8764fe 100644 --- a/system/Entity/Cast/CSVCast.php +++ b/system/Entity/Cast/CSVCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class CSVCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): array { @@ -25,7 +25,7 @@ class CSVCast extends BaseCast } /** - * @inheritDoc + * {@inheritDoc} */ public static function set($value, array $params = []): string { diff --git a/system/Entity/Cast/DatetimeCast.php b/system/Entity/Cast/DatetimeCast.php index 4cfe0099bc..d805a4ea5c 100644 --- a/system/Entity/Cast/DatetimeCast.php +++ b/system/Entity/Cast/DatetimeCast.php @@ -21,7 +21,7 @@ use Exception; class DatetimeCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} * * @throws Exception */ diff --git a/system/Entity/Cast/FloatCast.php b/system/Entity/Cast/FloatCast.php index f7c063949c..b69bf74e14 100644 --- a/system/Entity/Cast/FloatCast.php +++ b/system/Entity/Cast/FloatCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class FloatCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): float { diff --git a/system/Entity/Cast/IntegerCast.php b/system/Entity/Cast/IntegerCast.php index 409a73a6a2..8d645bd53f 100644 --- a/system/Entity/Cast/IntegerCast.php +++ b/system/Entity/Cast/IntegerCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class IntegerCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): int { diff --git a/system/Entity/Cast/JsonCast.php b/system/Entity/Cast/JsonCast.php index f644e0bb6e..c892a4fd9d 100644 --- a/system/Entity/Cast/JsonCast.php +++ b/system/Entity/Cast/JsonCast.php @@ -21,7 +21,7 @@ use stdClass; class JsonCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []) { @@ -48,7 +48,7 @@ class JsonCast extends BaseCast } /** - * @inheritDoc + * {@inheritDoc} */ public static function set($value, array $params = []): string { diff --git a/system/Entity/Cast/ObjectCast.php b/system/Entity/Cast/ObjectCast.php index 86214e5888..fe5802c4d5 100644 --- a/system/Entity/Cast/ObjectCast.php +++ b/system/Entity/Cast/ObjectCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class ObjectCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): object { diff --git a/system/Entity/Cast/StringCast.php b/system/Entity/Cast/StringCast.php index 8eae036b70..d45327c437 100644 --- a/system/Entity/Cast/StringCast.php +++ b/system/Entity/Cast/StringCast.php @@ -17,7 +17,7 @@ namespace CodeIgniter\Entity\Cast; class StringCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): string { diff --git a/system/Entity/Cast/TimestampCast.php b/system/Entity/Cast/TimestampCast.php index 1cbb086dd2..8329c36200 100644 --- a/system/Entity/Cast/TimestampCast.php +++ b/system/Entity/Cast/TimestampCast.php @@ -19,7 +19,7 @@ use CodeIgniter\Entity\Exceptions\CastException; class TimestampCast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []) { diff --git a/system/Entity/Cast/URICast.php b/system/Entity/Cast/URICast.php index 010de58895..e6a00162d0 100644 --- a/system/Entity/Cast/URICast.php +++ b/system/Entity/Cast/URICast.php @@ -19,7 +19,7 @@ use CodeIgniter\HTTP\URI; class URICast extends BaseCast { /** - * @inheritDoc + * {@inheritDoc} */ public static function get($value, array $params = []): URI { diff --git a/utils/PhpCsFixer/CodeIgniter4.php b/utils/PhpCsFixer/CodeIgniter4.php index 322db68a2f..66c901aaf3 100644 --- a/utils/PhpCsFixer/CodeIgniter4.php +++ b/utils/PhpCsFixer/CodeIgniter4.php @@ -382,6 +382,8 @@ final class CodeIgniter4 extends AbstractRuleset 'phpdoc_separation' => true, 'phpdoc_single_line_var_spacing' => true, 'phpdoc_summary' => false, + 'phpdoc_tag_casing' => ['tags' => ['inheritDoc']], + 'phpdoc_tag_type' => ['tags' => ['inheritDoc' => 'inline']], 'phpdoc_trim' => true, 'phpdoc_trim_consecutive_blank_line_separation' => true, 'phpdoc_types' => ['groups' => ['simple', 'alias', 'meta']],