andrey-helldar/beautiful-phone

This package is abandoned and no longer maintained. The author suggests using the propaganistas/laravel-phone package instead.

Formatting a phone number into a beautiful view

v2.2.0 2020-09-17 14:41 UTC

Requires

• php: ^7.2
• ext-mbstring: *
• andrey-helldar/support: ^1.18
• illuminate/container: ^6.0|^7.0|^8.0

Requires (Dev)

• phpunit/phpunit: ^8.4|^9.0

Suggests

• symfony/thanks: Give thanks (in the form of a GitHub) to your fellow PHP package maintainers

MIT

• Andrey Helldar

• formatter
• phone
• beautiful
• beautiful-phone

README

Formatting a phone number into a beautiful view.

This package is abandoned and no longer maintained. The author suggests using the propaganistas/laravel-phone package instead.

Installation

To get the latest version of Beautiful Phone Formatter, simply require the project using Composer:

composer require andrey-helldar/beautiful-phone

Instead, you may of course manually update your require block and run composer update if you so choose:

{
    "require": {
        "andrey-helldar/beautiful-phone": "^2.1"
    }
}

Laravel

You can also publish the config file to change implementations (ie. interface to specific class):

php artisan vendor:publish --provider="Helldar\BeautifulPhone\ServiceProvider"

Lumen

This package is focused on Laravel development, but it can also be used in Lumen with some workarounds. Because Lumen works a little different, as it is like a barebone version of Laravel and the main configuration parameters are instead located in bootstrap/app.php, some alterations must be made.

You can install the package in app/Providers/AppServiceProvider.php, and uncommenting this line that registers the App Service Providers so it can properly load.

// $app->register(App\Providers\AppServiceProvider::class);

If you are not using that line, that is usually handy to manage gracefully multiple Lumen installations, you will have to add this line of code under the Register Service Providers section of your bootstrap/app.php.

$app->register(\Helldar\BeautifulPhone\ServiceProvider::class);

Using

Now you can use the universal phone() helper inside the Laravel Framework (phone() too working).

Or create a Phone instance:

use Helldar\BeautifulPhone\Services\Phone;

return (new Phone())->get(/*...params...*/);

Default parameters:

return phone('4567');
// returned: <a href='tel:4567'>4567</a>

return phone('fooba');
// returned: <a href='tel:[phone]'><span>+7 (812)</span> 3-66-22</a>

return phone('foobar');
// returned: <a href='tel:[phone]'><span>+7 (812)</span> 36-62-27</a>

return phone('123123');
// returned: <a href='tel:[phone]'><span>+7 (812)</span> 123-123</a>

return phone('31234567890');
// returned: <a href='tel:[phone]'><span>+3 (123)</span> 456-789-0</a>

return phone('[phone]');
// returned: <a href='tel:[phone]'><span>+3 (321)</span> 654-98-83</a>

return phone('[phone]');
// returned: <a href='tel:[phone]'><span>+3 (321)</span> 666-555-7</a>

return phone('[phone]');
// returned: <a href='tel:[phone]'><span>+7 (321)</span> 666-555-7</a>

return phone('[phone]');
// returned: <a href='tel:[phone]'><span>+7 (321)</span> 666-555-7</a>

With manual applying city code:

return phone('4567', 1234);
// returned: <a href='tel:4567'>4567</a>

return phone('fooba', 1234);
// returned: <a href='tel:[phone]'><span>+7 (1234)</span> 3-66-22</a>

return phone('foobar', 1234);
// returned: <a href='tel:[phone]'><span>+7 (1234)</span> 36-62-27</a>

return phone('123123', 1234);
// returned: <a href='tel:[phone]'><span>+7 (1234)</span> 123-123</a>

return phone('31234567890', 1234);
// returned: <a href='tel:[phone]'><span>+3 (1234)</span> 567-890</a>

return phone('[phone]', 1234);
// returned: <a href='tel:[phone]'><span>+3 (321)</span> 654-98-83</a>

return phone('[phone]', 1234);
// returned: <a href='tel:[phone]'><span>+3 (321)</span> 666-555-7</a>

return phone('[phone]', 1234);
// returned: <a href='tel:[phone]'><span>+7 (321)</span> 666-555-7</a>

return phone('[phone]', 1234);
// returned: <a href='tel:[phone]'><span>+7 (321)</span> 666-555-7</a>

With disabled html formatting into phone number:

return phone('4567', 0, false);
// returned: <a href='tel:4567'>4567</a>

return phone('fooba', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('foobar', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('123123', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('31234567890', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('[phone]', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('[phone]', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('[phone]', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

return phone('[phone]', 0, false);
// returned: <a href='tel:[phone]'>[phone]</a>

With enabled html formatting and disabled is_link parameter into phone number:

return phone('4567', 0, true, false);
// returned: 4567

return phone('fooba', 0, true, false);
// returned: <span>+7 (812)</span> 3-66-22

return phone('foobar', 0, true, false);
// returned: <span>+7 (812)</span> 36-62-27

return phone('123123', 0, true, false);
// returned: <span>+7 (812)</span> 123-123

return phone('31234567890', 0, true, false);
// returned: <span>+3 (123)</span> 456-789-0

return phone('[phone]', 0, true, false);
// returned: <span>+3 (321)</span> 654-98-83

return phone('[phone]', 0, true, false);
// returned: <span>+3 (321)</span> 666-555-7

return phone('[phone]', 0, true, false);
// returned: <span>+7 (321)</span> 666-555-7

return phone('[phone]', 0, true, false);
// returned: <span>+7 (321)</span> 666-555-7

With disabled html formatting and is_link parameter into phone number:

return phone('4567', 0, false, false);
// returned: 4567

return phone('fooba', 0, false, false);
// returned: [phone]

return phone('foobar', 0, false, false);
// returned: [phone]

return phone('123123', 0, false, false);
// returned: [phone]

return phone('31234567890', 0, false, false);
// returned: [phone]

return phone('[phone]', 0, false, false);
// returned: [phone]

return phone('[phone]', 0, false, false);
// returned: [phone]

return phone('[phone]', 0, false, false);
// returned: [phone]

return phone('[phone]', 0, false, false);
// returned: [phone]

With full clear attribute:

return phone('4567', 0, false, false, [], true);
// returned: 4567

return phone('fooba', 0, false, false, [], true);
// returned: [phone]

return phone('foobar', 0, false, false, [], true);
// returned: [phone]

return phone('123123', 0, false, false, [], true);
// returned: [phone]

return phone('31234567890', 0, false, false, [], true);
// returned: [phone]

return phone('[phone]', 0, false, false, [], true);
// returned: [phone]

return phone('[phone]', 0, false, false, [], true);
// returned: [phone]

return phone('[phone]', 0, false, false, [], true);
// returned: [phone]

return phone('[phone]', 0, false, false, [], true);
// returned: [phone]

With additional attributes:

$attributes = ["id" => "foo", "class" => "bar baz", "data-value" => "foo"];

// Default parameters:
return phone('foobar', 0, true, true, $attributes);
// returned: <a href="tel:[phone]" id="foo" class="bar baz" data-value="foo"><span>+7 (812)</span> 36-62-27</a>

// With manual applying city code:
return phone('foobar', 1234, true, true, $attributes);
// returned: <a href="tel:[phone]" id="foo" class="bar baz" data-value="foo"><span>+7 (1234)</span> 36-62-27</a>

// With disabled html formatting into phone number:
return phone('foobar', 0, false, true, $attributes);
// returned: <a href="tel:[phone]" id="foo" class="bar baz" data-value="foo">[phone]</a>

// With enabled html formatting and disabled `is_link` parameter into phone number:
return phone('foobar', 0, true, false, $attributes);
// returned: <span>+7 (812)</span> 36-62-27

// With disabled html formatting and `is_link` parameter into phone number:
return phone('foobar', 0, false, false, $attributes);
// returned: [phone]

Laravel/Lumen facade

If you are using the Laravel or Lumen framework, then you can use the Phone facade call:

use Helldar\BeautifulPhone\Facades\Phone;

return Phone::spanLink('foobar');
// returned: <a href='tel:[phone]'><span>+7 (812)</span> 36-62-27</a>

return Phone::cleanLink('foobar');
// returned: <a href='tel:[phone]'>[phone]</a>

return Phone::span('foobar');
// returned: <span>+7 (812)</span> 36-62-27

return Phone::clear('foobar');
// returned: [phone]

return Phone::fullClear('foobar');
// returned: [phone]

Copyright and License

Beautiful Phone Formatter was written by Andrey Helldar, and is released under the MIT LICENSE.