rodrigojavornik/php-cleanup

A PHP Sanitation Library

v1.4.18 2023-08-29 18:47 UTC

Requires

• php: >=7.0.0

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Rodrigo Dais Javornik

• php
• library
• sanitation

README

A powerful sanitization library for PHP and Laravel. No dependencies

Installation

composer require rodrigojavornik/php-cleanup

Usage

use PHPCleanup\Sanitize;

Sanitize::input()->sanitize(' <h1>Hello World</h1> ');//Hello World
Sanitize::trim()->captalize()->sanitize(' string    ');//String
Sanitize::trim()->lowercase()->sanitize(' MY name IS    ');//my name is
Sanitize::onlyNumbers()->sanitize(' abc1234');//1234

Available filters

• captalize: Capitalize a string;
• captalizeAll: Capitalize all string;
• dateTime: Transform a string in DateTime object;
• email: Removes all characters not allowed in an email address;
• escape: Applies htmlspecialchars to value;
• formatNumber: Format a number with grouped thousands;
• input: Strip one whitespace from the beginning and end of a string and remove any HTML and PHP tags;
• keys: applies sanitaze to elements of an array;
• lowercase: Make a string lowercase;
• money: Formats a number as a monetary value;
• onlyAlpha: Removes any non-alphabetic characters;
• onlyLatinAlpha: Removes all non-Latin characters;
• onlyNumbers: Removes all non-numeric characters;
• removeAccentedCharacters: Replaces accented characters with non-accented ones;
• stripTags: Applies strip_tags to value;
• trim: Strip whitespace from the beginning and end of a string;
• upperCase: Make a string uppercase;

captalize

Capitalize a string Return: Sanitize object

Sanitize::capitalize()->sanitaze('is wednesday my dudes');
//output: Is wednesday my dudes

captalizeAll

Capitalize all string Return: Sanitaze object

Sanitize::captalizeAll()->sanitize('is wednesday my dudes');
//output: Is Wednesday My Dudes

dateTime

Transform a string in DateTime object Params: $dateFormat = 'Y-m-d H:i:s' Return: DateTime object or false

Sanitize::dateTime()->sanitize('2023-08-10 10:15:00')->getTimestamp();
Sanitize::dateTime()->sanitize('2023-08-10 10:15:00asfasdfdsf')->getTimestamp();
Sanitize::dateTime()->sanitize('2023-08-10 10:15:00 ')->getTimestamp();
Sanitize::dateTime('d/m/Y H:i:s')->sanitize(' 10/08/2023 10:15:00')->getTimestamp();
//output: DateTime object 

email

Removes all characters not allowed in an email address Return: Sanitize object

Sanitize::email()->sanitize('email#[e-mail] ');
//output: email#[e-mail]

Sanitize::email()->sanitize('[e-mail]');
//output: [e-mail]

Sanitize::email()->sanitize('email1@domain().com');
//output: [e-mail]

escape

Applies htmlspecialchars to value Return: Sanitize object

Sanitize::escape()->sanitize('<script>is wednesday my dudes &</script>')
//output: &lt;script&gt;is wednesday my dudes &amp;&lt;/script&gt;

formatNumber

Formats a number with thousands grouped Params: $decimalPlace = 2 , $decimalSeparator = '.' , $thousandsSeparator = '' Return: Sanitize object

Note: The onlyNumber filter is applied.

Sanitize::formatNumber(2, '.')->sanitize('123321123sdfasdf');
//output:123321123.00
Sanitize::formatNumber(2, ',')->sanitize('123321123sdfasdf');
//output:123321123,00
Sanitize::formatNumber(2, ',', '.')->sanitize('123321123sdfasdf');
//output:123.321.123,00
Sanitize::formatNumber(2, '.', ',')->sanitize('123321123sdfasdf');
//output:123,321,123.00
Sanitize::formatNumber(3, '.', ',')->sanitize('1987.7')
//output:1,987.700

input

Strip one whitespace from the beginning and end of a string and remove any HTML and PHP tags Return: Sanitize object

Sanitize::input()->sanitize(' <script>hello world &</script> ');
//output: hello world &

keys

Apply sanitaze to elements of an array Params: array Return: Sanitize object

$list = [
	'name' => ' carlos alberto ',
	'age' => '23r',
	'email' => ' ¨[e-mail] '
];

$result = Sanitize::keys([
	'name' => Sanitize::input()->uppercase(),
	'age' => Sanitize::input()->onlyNumbers(),
	'email' => Sanitize::input()->email()
])->sanitize($list);
/* output:
array(3) {
  ["name"]=>
  string(14) "CARLOS ALBERTO"
  ["age"]=>
  string(2) "23"
  ["email"]=>
  string(15) "[e-mail]"
}*/ 

lowercase

Strip one whitespace from the beginning and end of a string and remove any HTML and PHP tags Return: Sanitize object

Sanitize::lowercase()->sanitize('THE LIBRARY OF ALEXANDRIA');
//output: the library of alexandria

Money

Formats a number as a monetary value Params: $locale = 'en-US' Return: Sanitize object

Note: The onlyNumber filter is applied. You can check a complete list of currenty locale here.

Sanitize::money()->sanitize('123456');
//output: $123,654.00

Sanitize::money('pt_br')->sanitize('1236.54');
//output: R$ 1.236,54

onlyAlpha

Removes any non-alphabetic characters; Params: $additionalChars Return: Sanitize object

Sanitize::onlyAlpha()->sanitize('Home ç 1@#$%¨(873469');
//output: Home

Sanitize::onlyAlpha('ç', '1', ' ')->sanitize('Home ç 123456');
//output: Home ç 1

onlyLatinAlpha

Removes any non-alphabetic characters; Params: $additionalChars Return: Sanitize object

Sanitize::onlyLatinAlpha()->sanitize('Home ç 1@#$%¨(873469');
//output: Home ç ¨

Sanitize::onlyLatinAlpha()->sanitize('Home ç 123456');
//output: Home ç 

onlyNumbers

Removes all non-numeric characters Return: Sanitize object

Sanitize::onlyNumbers()->sanitize('Home ç 1@#$%¨(873469');
//output: 1873469

Sanitize::onlyNumbers()->sanitize('Home ç 123456');
//output: 123456 

removeAccentedCharacters

Replaces accented characters with non-accented ones Return: Sanitize object

Sanitize::removeAccentedCharacters()->sanitize("Qu'á çà, qu'á là, mon ami?");
//output: Qu'a ca, qu'a la, mon ami?

Sanitize::removeAccentedCharacters()->sanitize("Águas passadas não movem moinhos.")
//output: Aguas passadas nao movem moinhos.

stripTags

Applies strip_tags to value Params: $allowableTags Return: Sanitize object

Sanitize::stripTags()->sanitize('<html><h1>welcome</h1></html>');
//output: welcome

Sanitize::stripTags('<h1>')->sanitize('<html><h1>welcome</h1></html>')
//output: <h1>welcome</h1>

trim

Strip whitespace from the beginning and end of a string Return: Sanitize object

Sanitize::uppercase()->sanitize(' blablabla ');
//output: blablabla

trim

Make a string uppercase Return: Sanitize object

Sanitize::uppercase()->sanitize('home');
//output: HOME