seboettg /
citeproc-php
| Conditions | 11 |
| Paths | 40 |
| Total Lines | 31 |
| Code Lines | 22 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 55 | public function render($data) |
||
| 56 | { |
||
| 57 | $lang = (isset($data->language) && $data->language != 'en') ? $data->language : 'en'; |
||
| 58 | |||
| 59 | $renderedText = ""; |
||
| 60 | switch ($this->toRenderType) { |
||
| 61 | case 'value': |
||
| 62 | $renderedText = $this->applyTextCase($this->toRenderTypeValue, $lang); |
||
| 63 | break; |
||
| 64 | case 'variable': |
||
| 65 | // check if there is an attribute with prefix short or long e.g. shortTitle or longAbstract |
||
| 66 | // test case group_ShortOutputOnly.json |
||
| 67 | if (in_array($this->form, ["short", "long"])) { |
||
| 68 | $attrWithPrefix = $this->form . ucfirst($this->toRenderTypeValue); |
||
| 69 | if (isset($data->{$attrWithPrefix}) && !empty($data->{$attrWithPrefix})) { |
||
| 70 | $renderedText = $this->applyTextCase($data->{$attrWithPrefix}, $lang); |
||
| 71 | } |
||
| 72 | } |
||
| 73 | if (isset($data->{$this->toRenderTypeValue})) { |
||
| 74 | $renderedText = $this->applyTextCase($data->{$this->toRenderTypeValue}, $lang); |
||
| 75 | } |
||
| 76 | break; |
||
| 77 | case 'macro': |
||
| 78 | $renderedText = CiteProc::getContext()->getMacro($this->toRenderTypeValue)->render($data); |
||
| 79 | break; |
||
| 80 | case 'term': |
||
| 81 | $renderedText = $this->applyTextCase(CiteProc::getContext()->getLocale()->filter("terms", $this->toRenderTypeValue, $this->form)->single, $lang); |
||
| 82 | } |
||
| 83 | $text = $this->format($renderedText); |
||
| 84 | return $this->addAffixes($text, $this->quotes); |
||
|
|
|||
| 85 | } |
||
| 86 | } |
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.