GridFieldFilterHeader   A
last analyzed

Complexity

Total Complexity 6

Size/Duplication

Total Lines 32
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 15
c 1
b 0
f 0
dl 0
loc 32
rs 10
wmc 6

2 Methods

Rating   Name   Duplication   Size   Complexity  
A getSearchContext() 0 11 3
A getSearchForm() 0 17 3
1
<?php
2
3
namespace ilateral\SilverStripe\ModelAdminPlus;
4
5
use SilverStripe\Control\Controller;
6
use SilverStripe\Forms\GridField\GridField;
7
use SilverStripe\Forms\GridField\GridFieldFilterHeader as SSGridFieldFilterHeader;
8
use TractorCow\AutoComplete\AutoCompleteField;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, ilateral\SilverStripe\Mo...nPlus\AutoCompleteField. Consider defining an alias.

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...
9
10
/**
11
 * Custom filter header that calls custom model admin search context
12
 */
13
class GridFieldFilterHeader extends SSGridFieldFilterHeader
14
{
15
    public function getSearchContext(GridField $gridField)
16
    {
17
        if (!$this->searchContext) {
18
            $this->searchContext = singleton($gridField->getModelClass())->getModelAdminSearchContext();
19
20
            if ($this->updateSearchContextCallback) {
0 ignored issues
show
Deprecated Code introduced by
The property SilverStripe\Forms\GridF...teSearchContextCallback has been deprecated: 4.3.0:5.0.0 Will be removed in 5.0 ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

20
            if (/** @scrutinizer ignore-deprecated */ $this->updateSearchContextCallback) {

This property has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.

Loading history...
21
                call_user_func($this->updateSearchContextCallback, $this->searchContext);
0 ignored issues
show
Deprecated Code introduced by
The property SilverStripe\Forms\GridF...teSearchContextCallback has been deprecated: 4.3.0:5.0.0 Will be removed in 5.0 ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

21
                call_user_func(/** @scrutinizer ignore-deprecated */ $this->updateSearchContextCallback, $this->searchContext);

This property has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead.

Loading history...
22
            }
23
        }
24
25
        return $this->searchContext;
26
    }
27
28
    public function getSearchForm(GridField $gridField)
29
    {
30
        $form = parent::getSearchForm($gridField);
31
32
        foreach ($form->Fields() as $field) {
33
            if (is_a($field, AutoCompleteField::class)) {
34
                $url = Controller::join_links(
35
                    $gridField->getForm()->getController()->Link(),
36
                    ModelAdminPlus::ACTION_SUGGEST,
37
                    '?n=' . $field->getName()
38
                );
39
40
                $field->setSuggestURL($url);
41
            }
42
        }
43
44
        return $form;
45
    }
46
}
47