Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
9 | class SystemMailer |
||
10 | { |
||
11 | /** |
||
12 | * @var ProviderInterface |
||
13 | */ |
||
14 | private $provider; |
||
15 | |||
16 | /** |
||
17 | * @var MailerInterface |
||
18 | */ |
||
19 | private $mailer; |
||
20 | |||
21 | /** |
||
22 | * @var ParserInterface |
||
23 | */ |
||
24 | private $parser; |
||
25 | |||
26 | /** |
||
27 | * @var string |
||
28 | */ |
||
29 | private $locale; |
||
30 | |||
31 | /** |
||
32 | * @var array |
||
33 | */ |
||
34 | private $defaults; |
||
35 | |||
36 | /** |
||
37 | * @param ProviderInterface $provider |
||
38 | * @param ParserInterface $parser |
||
39 | * @param MailerInterface $mailer |
||
40 | * @param string $locale |
||
41 | * @param array $defaults |
||
42 | */ |
||
43 | public function __construct(ProviderInterface $provider, ParserInterface $parser, MailerInterface $mailer, $locale, $defaults = []) |
||
51 | |||
52 | /** |
||
53 | * Sends out the system message |
||
54 | * |
||
55 | * Examples: |
||
56 | * <code> |
||
57 | * // sends out AppBundle/Resources/emails/registration/confirmUser.xml.twig |
||
58 | * $systemMailer->send('App:registration/confirmUser', ['user' => $user]); |
||
59 | * |
||
60 | * // force locale of mail |
||
61 | * $systemMailer->send('App:info-mail', ['user' => $user], 'de'); |
||
62 | * |
||
63 | * // attach file to mail |
||
64 | * $systemMailer->send('App:message-with-pdf', [], null, function (\Swift_Message $message) { |
||
65 | * $message->attach(\Swift_Attachment::fromPath('my-document.pdf')) |
||
66 | * }); |
||
67 | * </code> |
||
68 | * |
||
69 | * @param string $name The email to send out, format: YourBundle:emailXmlTemplateName |
||
70 | * @param array $parameters The parameters passed to your email template xml |
||
71 | * @param string $locale Overwrite default locale of session |
||
72 | * @param callable $messageModifier Pass Closure to modify message before it is send (to attach files i.e.) |
||
73 | */ |
||
74 | public function send($name, $parameters = [], $locale = null, \Closure $messageModifier = null) |
||
83 | |||
84 | /** |
||
85 | * Add default parameters when they are not provided from the MailDefinition |
||
86 | * |
||
87 | * @param ParsedMessage $parsedMessage |
||
88 | */ |
||
89 | protected function handleDefaults(ParsedMessage $parsedMessage) |
||
115 | } |
||
116 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.