Skip to content

#121 Magento2.Templates.HelperInTemplate Rule porposal #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 16, 2019
Merged

#121 Magento2.Templates.HelperInTemplate Rule porposal #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9ea4f74
#121 Magento2.Templates.HelperInTemplate Rule porposal
diazwatson Aug 1, 2019
60c7d87
#121 HelperInTemplate Rule porposal amends
diazwatson Aug 10, 2019
a50eae5
Merge branch 'develop' into 121_HelperInTemplateRule
lenaorobei Aug 12, 2019
a6c8184
#121 HelperInTemplate Rule porposal amends
diazwatson Aug 12, 2019
5ec4707
Merge branch 'develop' into 121_HelperInTemplateRule
diazwatson Aug 12, 2019
abdfcf5
#121 HelperInTemplate amends2
diazwatson Aug 15, 2019
71235db
Merge branch 'develop' of github.com:magento/magento-coding-standard …
lenaorobei Aug 16, 2019
5182dca
magento/magento-coding-standard#121: Magento2.Templates.HelperInTempl…
lenaorobei Aug 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Magento2/Sniffs/Templates/ThisInTemplateSniff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Replace `$this` with `$block`. If you use private or protected methods, make the

---

# Rule: Do not use `helpers` in templates
## Background
The use of helpers is in general discouraged. For template files, consider using a ViewModel instead.

## Reasoning
The use of helpers is in general discouraged therefore any `$this->helper(<helper_class>)` code used in PHTML templates should be refactored.

Expand All @@ -23,7 +27,7 @@ Consider using ViewModel instead.

Typical example of a helper being used in a PHTML:
```html
<?php $_incl = $block->helper(<helper_class>)->...; ?>
<?php $_incl = $this->helper(<helper_class>)->...; ?>
```

Once the ViewModel is created, call it in the PHTML as follow:
Expand Down
25 changes: 22 additions & 3 deletions Magento2/Sniffs/Templates/ThisInTemplateSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,33 @@
*/
class ThisInTemplateSniff implements Sniff
{
/**
* Warning violation code.
*
* @var string
*/
protected $warningCodeFoundHelper = 'FoundHelper';

/**
* String representation of warning.
*
* @var string
*/
protected $warningMessage = 'Usage of $this in template files is deprecated.';
protected $warningMessageFoundHelper = 'The use of helpers in templates is discouraged. Use ViewModel instead.';

/**
* Warning violation code.
*
* @var string
*/
protected $warningCode = 'FoundThis';
protected $warningCodeFoundThis = 'FoundThis';

/**
* String representation of warning.
*
* @var string
*/
protected $warningMessageFoundThis = 'The use of $this in templates is deprecated. Use $block instead.';

/**
* @inheritdoc
Expand All @@ -42,7 +56,12 @@ public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
if ($tokens[$stackPtr]['content'] === '$this') {
$phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode);
$position = $phpcsFile->findNext(T_STRING, $stackPtr, null, false, 'helper', true);
if ($position !== false) {
$phpcsFile->addWarning($this->warningMessageFoundHelper, $position, $this->warningCodeFoundHelper);
} else {
$phpcsFile->addWarning($this->warningMessageFoundThis, $stackPtr, $this->warningCodeFoundThis);
}
}
}
}