idlab/helper-bundle

Idlab helpers

0.1.0 2022-08-29 13:18 UTC

Requires

• php: >=8.1
• phpmyadmin/sql-parser: ^5.5
• symfony/config: ^5.4|^6.0
• symfony/dependency-injection: ^5.4|^6.0
• symfony/http-kernel: ^5.4|^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.8
• symfony/phpunit-bridge: ^6.1

MIT

• Michael Vetterli

README

This bundle provides helper methods which we use in most of our projects. These helpers can format phone numbers or check EAN validity, sanitize a string or remove accents, you name it. Check both src/Service/Helper.php and src/SetaticHelper.php to see all available helpers

INFO : src/Service/Helper.php is intended for helper who need the container and support injection. Right now there are not such helpers

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require idlab/helper-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require idlab/helper-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Idlab\ComposerChangelogBundle\IdlabHelperBundle::class => ['all' => true],
];

Usage example

use \Idlab\HelperBundle\StaticHelper;

//...

$phone = StaticHelper::cleanPhoneNumber($uglyPhoneNumber);

Will transform 0041-22 621.12.32 to [phone]

Configuration

Right now there is no useful configuration. If the file has not yet been generated, create a new config/packages/idlab_helper.yaml file. The defaulf values are

idlab_helper:
    # future parameters go here...

NB: to see the configuration reference, run $ php bin/console config:dump idlab_helper

Contribute

Please always run CS fixer before sumbitting a merge request (PHP CS Fixer lives in the ./vendors directory)

$ php ./vendor/bin/php-cs-fixer fix