azine /
email-bundle
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 |
||
| 6 | class AzineEmailTwigExtension extends \Twig_Extension |
||
| 7 | { |
||
| 8 | /** |
||
| 9 | * @var TemplateProviderInterface |
||
| 10 | */ |
||
| 11 | private $templateProvider; |
||
| 12 | |||
| 13 | /** |
||
| 14 | * @var TranslatorInterface |
||
| 15 | */ |
||
| 16 | private $translator; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * @var array |
||
| 20 | */ |
||
| 21 | private $domainsToTrack; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @param TemplateProviderInterface $templateProvider |
||
| 25 | * @param array of string $domainsToTrack |
||
| 26 | */ |
||
| 27 | 12 | public function __construct(TemplateProviderInterface $templateProvider, TranslatorInterface $translator, array $domainsToTrack = array()){ |
|
| 28 | 12 | $this->templateProvider = $templateProvider; |
|
| 29 | 12 | $this->translator = $translator; |
|
| 30 | 12 | $this->domainsToTrack = $domainsToTrack; |
|
| 31 | 12 | } |
|
| 32 | |||
| 33 | /** |
||
| 34 | * {@inheritdoc} |
||
| 35 | */ |
||
| 36 | 1 | public function getFilters() |
|
| 37 | { |
||
| 38 | 1 | $filters[] = new \Twig_SimpleFilter('textWrap', array($this, 'textWrap')); |
|
|
|
|||
| 39 | 1 | $filters[] = new \Twig_SimpleFilter('urlEncodeText', array($this, 'urlEncodeText'), array('is_safe' => array('html'))); |
|
| 40 | 1 | $filters[] = new \Twig_SimpleFilter('addCampaignParamsForTemplate', array($this, 'addCampaignParamsForTemplate'), array('is_safe' => array('html'))); |
|
| 41 | 1 | $filters[] = new \Twig_SimpleFilter('stripAndConvertTags', array($this, 'stripAndConvertTags'), array('is_safe' => array('html'))); |
|
| 42 | 1 | $filters[] = new \Twig_SimpleFilter('printVars', array($this, 'printVars')); |
|
| 43 | 1 | return $filters; |
|
| 44 | } |
||
| 45 | |||
| 46 | 1 | public function urlEncodeText($text) |
|
| 47 | { |
||
| 48 | 1 | $text = str_replace("%","%25", $text); |
|
| 49 | 1 | $text = str_replace(array( "\n", |
|
| 50 | 1 | " ", |
|
| 51 | 1 | "&", |
|
| 52 | 1 | "\\", |
|
| 53 | 1 | "<", |
|
| 54 | 1 | ">", |
|
| 55 | 1 | '"', |
|
| 56 | 1 | " ", |
|
| 57 | 1 | ), |
|
| 58 | 1 | array( "%0D%0A", |
|
| 59 | 1 | "%20", |
|
| 60 | 1 | "%26", |
|
| 61 | 1 | "%5C", |
|
| 62 | 1 | "%3D", |
|
| 63 | 1 | "%3E", |
|
| 64 | 1 | "%23", |
|
| 65 | 1 | "%09", |
|
| 66 | 1 | ), $text); |
|
| 67 | |||
| 68 | 1 | return $text; |
|
| 69 | } |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Wrap the text to the lineLength is not exeeded. |
||
| 73 | * @param string $text |
||
| 74 | * @param integer $lineLength default: 75 |
||
| 75 | * @return string the wrapped string |
||
| 76 | */ |
||
| 77 | 3 | public function textWrap($text, $lineLength = 75) |
|
| 81 | |||
| 82 | /** |
||
| 83 | * Returns the name of the extension. |
||
| 84 | * |
||
| 85 | * @return string The extension name |
||
| 86 | */ |
||
| 87 | public function getName() |
||
| 88 | { |
||
| 89 | return 'azine_email_bundle_twig_extension'; |
||
| 90 | } |
||
| 91 | |||
| 92 | public function addCampaignParamsForTemplate($html, $templateId, $templateParams){ |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Add the campaign-parameters to all URLs in the html |
||
| 99 | * @param string $html |
||
| 100 | * @param array $campaignParams |
||
| 101 | * @return string |
||
| 102 | */ |
||
| 103 | 4 | public function addCampaignParamsToAllUrls($html, $campaignParams) |
|
| 144 | |||
| 145 | /** |
||
| 146 | * Convert: |
||
| 147 | * - a-tags to show the link and if the link-text is not contained in the link, also the link-text |
||
| 148 | * - remove double-whitespaces and whitespaces at line beginnings and ends. |
||
| 149 | * - html-special chars to their original representation (php => htmlspecialchars_decode) |
||
| 150 | * and then remove all html-tags (php => strip_tags) |
||
| 151 | */ |
||
| 152 | public function stripAndConvertTags($html){ |
||
| 175 | |||
| 176 | public function printVars(array $vars, $allDetails = false, $indent = ""){ |
||
| 177 | $output = ""; |
||
| 178 | $defaultIndent = " "; |
||
| 179 | ksort($vars); |
||
| 198 | } |
||
| 199 |
Loading history...
Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.
Let’s take a look at an example:
As you can see in this example, the array
$myArrayis initialized the first time when the foreach loop is entered. You can also see that the value of thebarkey is only written conditionally; thus, its value might result from a previous iteration.This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.