Completed
Push — master ( 438529...cc46cc )
by
unknown
10s
created

CommentsGridFieldBulkAction/CommentHandler.php (1 issue)

Check for conflicting imported classes with local classes

Bug Major

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace SilverStripe\Comments\Admin\CommentsGridFieldBulkAction;
4
5
use Colymba\BulkManager\BulkAction\Handler;
0 ignored issues
show
This use statement conflicts with another class in this namespace, SilverStripe\Comments\Ad...FieldBulkAction\Handler.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are 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.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/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:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
6
use SilverStripe\Comments\Model\Comment;
7
use SilverStripe\Core\Convert;
8
use SilverStripe\Control\HTTPRequest;
9
use SilverStripe\Control\HTTPResponse;
10
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