Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ tests/lista_de_arquivos_test.php
lista_de_arquivos.txt
lista_de_arquivos_tests.txt
add_static_to_providers.php
patch_docblocks.php
patch_docblocks.py

# KaririCode Devkit — generated configs and build artifacts
.kcode/
4 changes: 4 additions & 0 deletions src/Rule/Brazilian/FormatCepRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Formats a CEP: 63100000 → 63100-000.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class FormatCepRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Brazilian/FormatCnpjRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Formats a CNPJ number: 11222333000181 → 11.222.333/0001-81.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class FormatCnpjRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Brazilian/FormatCpfRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
*
* If the input is already formatted, normalizes it.
* If the digit count is not 11, returns as-is.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class FormatCpfRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Date/NormalizeDateRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Normalizes a date string to a standard format.
*
* Parameters: from (string, default 'd/m/Y'), to (string, default 'Y-m-d').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class NormalizeDateRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Date/TimestampToDateRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Converts a Unix timestamp to a formatted date string.
*
* Parameters: format (string, default 'Y-m-d H:i:s'), timezone (string, default 'UTC').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class TimestampToDateRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Filter/AlphaOnlyRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Strips all non-letter characters (Unicode-aware via \pL).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class AlphaOnlyRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Filter/AlphanumericOnlyRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Strips all non-alphanumeric characters (Unicode-aware).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class AlphanumericOnlyRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Filter/DigitsOnlyRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Strips all non-digit characters from a string.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class DigitsOnlyRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Filter/EmailFilterRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Sanitizes an email address: trims, lowercases, removes illegal chars.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class EmailFilterRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Html/HtmlDecodeRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Decodes HTML entities back to characters.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class HtmlDecodeRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Html/HtmlEncodeRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Encodes HTML special characters for XSS prevention.
*
* Parameters: flags (int, default ENT_QUOTES|ENT_SUBSTITUTE), encoding (string, default 'UTF-8').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class HtmlEncodeRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Html/HtmlPurifyRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
*
* Applies: strip_tags → html_entity_decode → trim.
* Parameters: allowed (string, tags to preserve).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class HtmlPurifyRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Html/StripTagsRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Strips HTML/PHP tags from a string.
*
* Parameters: allowed (string, e.g. '<b><i><a>').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class StripTagsRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Html/UrlEncodeRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* URL-encodes a string value.
*
* Parameters: raw (bool, default false). If true, uses rawurlencode (RFC 3986).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class UrlEncodeRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Numeric/ClampRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Clamps a numeric value to [min, max] bounds.
*
* Parameters: min (int|float), max (int|float).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ClampRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Numeric/RoundRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Rounds a numeric value to specified decimal places.
*
* Parameters: precision (int, default 2), mode ('round'|'ceil'|'floor', default 'round').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class RoundRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Numeric/ToFloatRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Casts a value to float. Non-castable values return as-is.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ToFloatRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Numeric/ToIntRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Casts a value to integer. Non-castable values return 0.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ToIntRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/CapitalizeRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Capitalizes the first letter of each word (mb-safe).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class CapitalizeRule implements SanitizationRule
{
Expand Down
7 changes: 7 additions & 0 deletions src/Rule/String/LowerCaseRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
use KaririCode\Sanitizer\Contract\SanitizationContext;
use KaririCode\Sanitizer\Contract\SanitizationRule;

/**
* Converts a string to lowercase (mb-safe, UTF-8).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class LowerCaseRule implements SanitizationRule
{
#[\Override]
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/NormalizeLineEndingsRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Normalizes line endings to Unix LF.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class NormalizeLineEndingsRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/NormalizeWhitespaceRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Collapses multiple whitespace characters into a single space.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class NormalizeWhitespaceRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/PadRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Pads a string to a given length.
*
* Parameters: length (int), pad (string, default ' '), side ('left'|'right'|'both', default 'right').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class PadRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/RegexReplaceRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Regex-based search-and-replace.
*
* Parameters: pattern (string), replacement (string, default '').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class RegexReplaceRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/ReplaceRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Simple string search-and-replace.
*
* Parameters: search (string), replace (string, default '').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ReplaceRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/SlugRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
*
* Transliterates common accented characters, lowercases,
* replaces non-alphanumeric with hyphens, collapses multiple hyphens.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class SlugRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/StripNonPrintableRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Removes non-printable control characters (preserves \n, \r, \t).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class StripNonPrintableRule implements SanitizationRule
{
Expand Down
7 changes: 7 additions & 0 deletions src/Rule/String/TrimRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
use KaririCode\Sanitizer\Contract\SanitizationContext;
use KaririCode\Sanitizer\Contract\SanitizationRule;

/**
* Trims leading and trailing characters from a string.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class TrimRule implements SanitizationRule
{
#[\Override]
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/String/TruncateRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
* Truncates a string to a maximum length.
*
* Parameters: max (int, default 255), suffix (string, default '...').
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class TruncateRule implements SanitizationRule
{
Expand Down
7 changes: 7 additions & 0 deletions src/Rule/String/UpperCaseRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
use KaririCode\Sanitizer\Contract\SanitizationContext;
use KaririCode\Sanitizer\Contract\SanitizationRule;

/**
* Converts a string to uppercase (mb-safe, UTF-8).
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class UpperCaseRule implements SanitizationRule
{
#[\Override]
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Type/ToArrayRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Wraps a non-array value into a single-element array.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ToArrayRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Type/ToBoolRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Casts to boolean. Recognizes '1','true','yes','on' as true, '0','false','no','off' as false.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ToBoolRule implements SanitizationRule
{
Expand Down
4 changes: 4 additions & 0 deletions src/Rule/Type/ToStringRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

/**
* Casts scalars to string. Non-scalar values return as-is.
*
* @author Walmir Silva <walmir.silva@kariricode.org>
*
* @since 3.1.0 ARFA 1.3
*/
final readonly class ToStringRule implements SanitizationRule
{
Expand Down