, (*1)
Utility to format whole Input using provided rules, (*2)
Installation
Install via composer into your project:, (*3)
composer require anekdotes/formatter
Usage
To use the formatter, include its namespace through Composer, then call its namespace and provide it with an data input and a rule input., (*4)
Exemple :, (*5)
use Anekdotes\Formatter\Formatter;
$input = ["formPhoneNumber" => "1234567890"];
$rules = ["formPhoneNumber" => ["phoneNumber"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["formPhoneNumber" => "(123) 456-7890"]
Rules
Here's a list of the usable rules :, (*6)
postalCode
Convert into a postal code following this format : A1A 1A1, (*7)
use Anekdotes\Formatter\Formatter;
$input = ["form" => "j6z1b2"];
$rules = ["form" => ["postalCode"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["formPhoneNumber" => "J6Z 1B2"]
phoneNumber
Convert into a phone number following the format 111, 111-1111 or (111) 111-1111, (*8)
use Anekdotes\Formatter\Formatter;
$input = ["formPhoneNumber" => "1234567890"];
$rules = ["formPhoneNumber" => ["phoneNumber"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["form" => "(123) 456-7890"]
float
Cuts the characters following a float, (*9)
use Anekdotes\Formatter\Formatter;
$input = ["form" => "122.2abc"];
$rules = ["form" => ["float"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["form" => "122.2"]
int
Cuts the character following an integer, (*10)
use Anekdotes\Formatter\Formatter;
$input = ["form" => "122.2abc"];
$rules = ["form" => ["int"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["form" => 122]
integer
use Anekdotes\Formatter\Formatter;
$input = ["form" => "122.2abc"];
$rules = ["form" => ["integer"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["form" => 122]
website
Append an http:// to a website., (*11)
use Anekdotes\Formatter\Formatter;
$input = ["form" => "www.anekdotes.com"];
$rules = ["form" => ["website"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["form" => "http://www.anekdotes.com"]
Combining Rules
You can chain multiple rules to apply them on top of each other, (*12)
use Anekdotes\Formatter\Formatter;
$input = ["formPhoneNumber" => "1234567890abcsefg"];
$rules = ["formPhoneNumber" => ["int", "phoneNumber"]];
$formattedOutput = Formatter::make($input, $rules);
// $formattedOutput is now ["form" => "(123) 456-7890"]