juliushaertl /
phpdoc-to-rst
| Conditions | 15 |
| Paths | 180 |
| Total Lines | 72 |
| Code Lines | 46 |
| Lines | 16 |
| Ratio | 22.22 % |
| Changes | 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 |
||
| 26 | public function render() { |
||
| 27 | $currentNamespaceFqsen = (string)$this->currentNamespace->getFqsen(); |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Find child namespaces for current namespace |
||
| 31 | */ |
||
| 32 | $childNamespaces = []; |
||
| 33 | /** @var Namespace_ $namespace */ |
||
| 34 | foreach ($this->namespaces as $namespace) { |
||
| 35 | // check if not root and doesn't start with current namespace |
||
| 36 | if ($currentNamespaceFqsen !== '\\' && strpos((string)$namespace->getFqsen(), $currentNamespaceFqsen . '\\') !== 0) { |
||
| 37 | continue; |
||
| 38 | } |
||
| 39 | if ( |
||
| 40 | strpos((string)$namespace->getFqsen(), $currentNamespaceFqsen) === 0 |
||
| 41 | && (string)$namespace->getFqsen() !== (string)$currentNamespaceFqsen |
||
| 42 | ) { |
||
| 43 | // only keep first level children |
||
| 44 | $childrenPath = substr((string)$namespace->getFqsen(), strlen((string)$this->currentNamespace->getFqsen())+1); |
||
| 45 | if (strpos($childrenPath, '\\') === false) { |
||
| 46 | $childNamespaces[] = $namespace; |
||
| 47 | } |
||
| 48 | } |
||
| 49 | } |
||
| 50 | |||
| 51 | if ($currentNamespaceFqsen !== '\\') { |
||
| 52 | $label = str_replace('\\', '-', $currentNamespaceFqsen); |
||
| 53 | $this->addLine('.. _namespace' . $label . ''); |
||
| 54 | $this->addH1(RstBuilder::escape($currentNamespaceFqsen)); |
||
| 55 | } else { |
||
| 56 | $label = 'root-namespace'; |
||
| 57 | $this->addLine('.. _namespace-' . $label . ''); |
||
| 58 | $this->addH1(RstBuilder::escape('\\')); |
||
| 59 | } |
||
| 60 | $this->addLine(); |
||
| 61 | |||
| 62 | $this->addH2('Namespaces'); |
||
| 63 | $this->addLine('.. toctree::'); |
||
| 64 | $this->addIndentLine(1, ':maxdepth: 1')->addLine(); |
||
| 65 | /** @var Namespace_ $namespace */ |
||
| 66 | foreach ($childNamespaces as $namespace) { |
||
| 67 | $this->addIndentLine(1, $namespace->getName() . ' <' . $namespace->getName() . '/index>'); |
||
| 68 | } |
||
| 69 | $this->addLine()->addLine(); |
||
| 70 | |||
| 71 | $this->addH2('Interfaces'); |
||
| 72 | $this->addLine('.. toctree::'); |
||
| 73 | $this->addIndentLine(1, ':maxdepth: 1')->addLine(); |
||
| 74 | /** @var Fqsen $entry */ |
||
| 75 | View Code Duplication | foreach ($this->currentNamespace->getInterfaces() as $entry) { |
|
|
|
|||
| 76 | $subPath = $entry; |
||
| 77 | if ($currentNamespaceFqsen !== '\\' && substr($entry, 0, strlen($currentNamespaceFqsen)) === $currentNamespaceFqsen) { |
||
| 78 | $subPath = substr($entry, strlen($currentNamespaceFqsen)); |
||
| 79 | } |
||
| 80 | $path = substr(str_replace("\\", "/", $subPath), 1); |
||
| 81 | $this->addIndentLine(1, $entry->getName() . ' <' . $path . '>'); |
||
| 82 | } |
||
| 83 | $this->addLine()->addLine(); |
||
| 84 | |||
| 85 | $this->addH2('Classes'); |
||
| 86 | $this->addLine('.. toctree::'); |
||
| 87 | $this->addIndentLine(1, ':maxdepth: 1')->addLine(); |
||
| 88 | /** @var Fqsen $entry */ |
||
| 89 | View Code Duplication | foreach ($this->currentNamespace->getClasses() as $entry) { |
|
| 90 | $subPath = $entry; |
||
| 91 | if ($currentNamespaceFqsen !== '\\' && substr($entry, 0, strlen($currentNamespaceFqsen)) === $currentNamespaceFqsen) { |
||
| 92 | $subPath = substr($entry, strlen($currentNamespaceFqsen)); |
||
| 93 | } |
||
| 94 | $path = substr(str_replace("\\", "/", $subPath), 1); |
||
| 95 | $this->addIndentLine(1,$entry->getName() . ' <' . $path . '>'); |
||
| 96 | } |
||
| 97 | $this->addLine()->addLine(); |
||
| 98 | |||
| 104 | } |
Loading history...
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.