Snippets et bonnes pratiques ?

Version imprimable

Bonjour à tous.

J'ai un certain nombre de fonctions php simples, des snippets en quelque sorte, que je réutilise un peu partout dans mon appli.

Je précise que ces fonctions ne concernent pas que la vue, elle servent par exemple au niveau du contrôleur pour générer des documents en PDF.
Elles ne peuvent donc pas être remplacées pas des macros ou des extensions Twig.

J'ai créé donc une classe Tools, qui contient mes fonctions sous la forme de méthodes statiques.
Ces fonctions devant être accessibles pour plusieurs bundles, j'ai placé la classe à la racine de l'application :
Code:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 // /src/MyApp/Tools/Tools.php namespace MyApp\Tools; class Tools { // ... static function age($date) { if ($date == null) return ''; $date = $date->format('Y-m-d H:i:s'); $age = date('Y') - date('Y', strtotime($date)); if (date('md') < date('md', strtotime($date))) { return $age - 1; } return $age; } static function formatNumeroSecu($numeroSecu) { $tmp = preg_match('/^([12])([0-9][0-9])(0[1-9]|1[0-2])(0[1-9]|[13456789][0-9]|2[023456789AB])([0-9][0-9][0-9])([0-9][0-9][0-9])([0-9][0-9])$/', $numeroSecu, $matches); unset($matches[0]); return implode(" ", $matches); } // ... }
Ainsi, je peux l'utiliser comme suit :
Code:

1 2 3 4 5 6 use MyApp\Tools\Tools; // ... $age = Tools::age($dateNaissance); $formatedNumeroSecu = Tools::formatNumeroSecu($numeroSecu);
J'ai procédé ainsi car j'ai vu plusieurs personnes utiliser des solutions semblables en cherchant sur le net.

Mais avant d'aller trop loin sur cette voie, pouvez vous m'indiquer si cette méthode est valable, ou si c'est une pratique à éviter? Dans ce cas, comment procédez-vous?

Je vous remercie par avance,

Soobook.

30/04/2013, 17h55
stephan.78

Bonjour,

je t'invites à regarder du coté des services. C'est exactement fait pour ce que tu exécutes.
01/05/2013, 13h45
Soobook

Merci beaucoup pour ta réponse stephan. :ccool:

Je ne maîtrise pas encore les services à fond mais j'ai creusé un peu dans ce sens, et c'est en effet ce qu'il me fallait. C'est en plus facile à mettre en oeuvre. Je résolute donc!

Voici le lien vers la doc.
A noter qu'il est possible de définir un service hors d'un bundle en rajoutant une clef services dans /app/config/config.yml.

C'est plutôt simpliste, mais pour ceux que ça intéresse, voici comment j'ai fait.

Création de la classe et du service :

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# /src/MyApp/Tools/Tools.php
 
namespace MyApp\Tools;
 
class Tools {
 
    public function doSomething() {
        // ...
    }
 
}
 
#/app/config/config.yml
 
services:
    myapp.tools:
        class: MyApp\Tools\Tools
 
# Utilisation (dans un contrôleur, par exemple) :
 
$tools = $this->container->get('myapp.tools');
$tools->doSomething();

Ce service peut également être injecté où l'on veut, par exemple pour créer une extension Twig :

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# /src/MyApp/MyBundle/Twig/MyExtension.php
 
namespace MyApp\MyBundle\Twig;
 
class MyExtension extends \Twig_Extension {
 
    protected $tools;
 
    public function __construct(\MyApp\Tools\Tools $tools) {
        $this->tools = $tools;
    }
 
    public function getName() {
        return 'my_extension';
    }
 
    public function getFilters() {
        return array(
            'myfilter' => new \Twig_Filter_Method($this, 'myFilter'),
        );
    }
 
    public function myFilter($var) {
        return $this->tools->doSomething($var);
    }
 
}
 
#/src/MyApp/MyBundle/Resources/config/services.yml
 
services:
    myapp.mybundle.twig.my_extension:
        class: MyApp\MyBundle\Twig\MyExtension
        arguments: ["@myapp.tools"]
        tags:
            - { name: twig.extension }
 
# Utilisation (dans un template) :
 
{{ myvar|myfilter }}