silverstripe /
silverstripe-comments
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 |
||
| 11 | abstract class CommentHandler extends Handler |
||
| 12 | { |
||
| 13 | protected $xhr = true; |
||
| 14 | |||
| 15 | protected $destructive = false; |
||
| 16 | |||
| 17 | /** |
||
| 18 | * @param HTTPRequest $request |
||
| 19 | * @return HTTPResponse |
||
| 20 | */ |
||
| 21 | View Code Duplication | public function index(HTTPRequest $request) |
|
| 22 | { |
||
| 23 | $ids = []; |
||
| 24 | |||
| 25 | foreach ($this->getRecords() as $comment) { |
||
| 26 | array_push($ids, $comment->ID); |
||
| 27 | $this->updateComment($comment); |
||
| 28 | } |
||
| 29 | |||
| 30 | $response = new HTTPResponse(Convert::raw2json([ |
||
| 31 | 'done' => true, |
||
| 32 | 'records' => $ids, |
||
| 33 | ])); |
||
| 34 | |||
| 35 | $response->addHeader('Content-Type', 'application/json'); |
||
| 36 | |||
| 37 | return $response; |
||
| 38 | } |
||
| 39 | |||
| 40 | /** |
||
| 41 | * @param Comment $comment |
||
| 42 | * |
||
| 43 | * @return Comment |
||
| 44 | */ |
||
| 45 | abstract public function updateComment($comment); |
||
| 46 | } |
||
| 47 |
Loading history...
Let’s assume that you have a directory layout like this:
. |-- OtherDir | |-- Bar.php | `-- Foo.php `-- SomeDir `-- Foo.phpand let’s assume the following content of
Bar.php:If both files
OtherDir/Foo.phpandSomeDir/Foo.phpare loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.phpHowever, as
OtherDir/Foo.phpdoes not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: