Skip to content

Commit 0daf8c3

Browse files
saimazsaimaz
committed
Merge pull request #11 from linasmo/ongr_cs_fixes
CS fixes by ongr-strict-standard
2 parents 8844e86 + 6084102 commit 0daf8c3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+233
-186
lines changed

‎Controller/ManagerController.php

+5-2
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,15 @@
1616
use Symfony\Component\HttpFoundation\Request;
1717
use Symfony\Component\HttpFoundation\Response;
1818

19+
/**
20+
* Class ManagerController.
21+
*/
1922
class ManagerController extends Controller
2023
{
2124
/**
2225
* Renders view with filter manager response.
2326
*
24-
* @param Request $request
27+
* @param Request $request Request.
2528
* @param string $managerName Filter manager name.
2629
* @param string $template Template name.
2730
*
@@ -38,7 +41,7 @@ public function managerAction(Request $request, $managerName, $template)
3841
/**
3942
* Returns search response results from filter manager.
4043
*
41-
* @param Request $request
44+
* @param Request $request Request.
4245
* @param string $name Filter manager name.
4346
*
4447
* @return array

‎DependencyInjection/Configuration.php

+38-21
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
use Symfony\Component\Config\Definition\ConfigurationInterface;
1818

1919
/**
20-
* This is the class that validates and merges configuration from app/config files
20+
* This is the class that validates and merges configuration from app/config files.
2121
*/
2222
class Configuration implements ConfigurationInterface
2323
{
@@ -77,14 +77,16 @@ private function addFiltersSection(ArrayNodeDefinition $rootNode)
7777
->children()
7878
->arrayNode('filters')
7979
->validate()
80-
->ifTrue(function ($v) {
80+
->ifTrue(
81+
function ($v) {
8182
$v = array_filter($v);
8283

8384
return empty($v);
84-
})
85+
}
86+
)
8587
->thenInvalid('At least single filter must be configured.')
8688
->end()
87-
// TODO: validate if filter names are unique
89+
// TODO: validate if filter names are unique.
8890
->isRequired()
8991
->append($this->buildFilterTree('choice'))
9092
->append($this->buildFilterTree('match'))
@@ -97,7 +99,7 @@ private function addFiltersSection(ArrayNodeDefinition $rootNode)
9799
}
98100

99101
/**
100-
* Builds filter config tree for given filter name
102+
* Builds filter config tree for given filter name.
101103
*
102104
* @param string $filterName
103105
*
@@ -131,14 +133,18 @@ private function buildFilterTree($filterName)
131133
->arrayNode('choices')
132134
->prototype('array')
133135
->beforeNormalization()
134-
->ifTrue(function ($v) {
136+
->ifTrue(
137+
function ($v) {
135138
return empty($v['label']);
136-
})
137-
->then(function ($v) {
139+
}
140+
)
141+
->then(
142+
function ($v) {
138143
$v['label'] = $v['field'];
139144

140145
return $v;
141-
})
146+
}
147+
)
142148
->end()
143149
->children()
144150
->scalarNode('label')->end()
@@ -164,6 +170,9 @@ private function buildFilterTree($filterName)
164170
->end()
165171
->end();
166172
break;
173+
default:
174+
// Should not happen.
175+
break;
167176
}
168177

169178
return $filter;
@@ -182,28 +191,36 @@ private function buildRelationsTree($relationType)
182191

183192
$filter
184193
->validate()
185-
->ifTrue(function ($v) {
186-
return empty($v['include']) && empty($v['exclude']);
187-
})
194+
->ifTrue(
195+
function ($v) {
196+
return empty($v['include']) && empty($v['exclude']);
197+
}
198+
)
188199
->thenInvalid('Relation must have "include" or "exclude" fields specified.')
189200
->end()
190201
->validate()
191-
->ifTrue(function ($v) {
192-
return !empty($v['include']) && !empty($v['exclude']);
193-
})
202+
->ifTrue(
203+
function ($v) {
204+
return !empty($v['include']) && !empty($v['exclude']);
205+
}
206+
)
194207
->thenInvalid('Relation must have only "include" or "exclude" fields specified.')
195208
->end()
196209
->children()
197210
->arrayNode('include')
198-
->beforeNormalization()->ifString()->then(function ($v) {
199-
return array($v);
200-
})->end()
211+
->beforeNormalization()->ifString()->then(
212+
function ($v) {
213+
return [$v];
214+
}
215+
)->end()
201216
->prototype('scalar')->end()
202217
->end()
203218
->arrayNode('exclude')
204-
->beforeNormalization()->ifString()->then(function ($v) {
205-
return array($v);
206-
})->end()
219+
->beforeNormalization()->ifString()->then(
220+
function ($v) {
221+
return [$v];
222+
}
223+
)->end()
207224
->prototype('scalar')->end()
208225
->end()
209226
->end();

‎DependencyInjection/ONGRFilterManagerExtension.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public function load(array $configs, ContainerBuilder $container)
7676
'ONGR\FilterManagerBundle\Search\FiltersManager',
7777
[
7878
$filtersContainer,
79-
new Reference(sprintf('es.manager.%s.%s', $config['es_manager'], $manager['repository']))
79+
new Reference(sprintf('es.manager.%s.%s', $config['es_manager'], $manager['repository'])),
8080
]
8181
);
8282

‎Filters/FilterInterface.php

+15-12
Original file line numberDiff line numberDiff line change
@@ -18,46 +18,49 @@
1818
use Symfony\Component\HttpFoundation\Request;
1919

2020
/**
21-
* this interface defines required methods for single filter
21+
* This interface defines required methods for single filter.
2222
*/
2323
interface FilterInterface extends RelationsAwareInterface
2424
{
25-
2625
/**
27-
* Resolves filter state by given request
26+
* Resolves filter state by given request.
2827
*
2928
* @param Request $request
29+
*
3030
* @return FilterState
3131
*/
3232
public function getState(Request $request);
3333

3434
/**
35-
* Modifies search request by given state. Usually should be used to add query or post_filter parameters
35+
* Modifies search request by given state. Usually should be used to add query or post_filter parameters.
3636
*
37-
* @param Search $search Search request
38-
* @param FilterState $state Current filter state
39-
* @param SearchRequest $request State of all filters
37+
* @param Search $search Search request.
38+
* @param FilterState $state Current filter state.
39+
* @param SearchRequest $request State of all filters.
4040
*/
4141
public function modifySearch(Search $search, FilterState $state = null, SearchRequest $request = null);
4242

4343
/**
4444
* Modifies search request by given state and related search. Usually is used to add aggregations into query.
45+
*
4546
* Related search does not include conditions from not related filters. Conditions made by filter
4647
* itself are also excluded on $relatedSearch. This method normally is called after modifySearch just before search
4748
* query execution
4849
*
49-
* @param Search $search
50-
* @param Search $relatedSearch
50+
* @param Search $search
51+
* @param Search $relatedSearch
5152
* @param FilterState $state
53+
*
5254
* @return mixed
5355
*/
5456
public function preProcessSearch(Search $search, Search $relatedSearch, FilterState $state = null);
5557

5658
/**
57-
* Prepares all needed filter data to pass into view
59+
* Prepares all needed filter data to pass into view.
60+
*
61+
* @param DocumentIterator $result Search results.
62+
* @param ViewData $data Initial view data.
5863
*
59-
* @param DocumentIterator $result Search results
60-
* @param ViewData $data Initial view data
6164
* @return ViewData
6265
*/
6366
public function getViewData(DocumentIterator $result, ViewData $data);

‎Filters/FilterState.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace ONGR\FilterManagerBundle\Filters;
1313

1414
/**
15-
* This class defines data structure to represent filter state
15+
* This class defines data structure to represent filter state.
1616
*/
1717
class FilterState
1818
{
@@ -37,15 +37,15 @@ class FilterState
3737
private $name;
3838

3939
/**
40-
* @return boolean
40+
* @return bool
4141
*/
4242
public function isActive()
4343
{
4444
return $this->active;
4545
}
4646

4747
/**
48-
* @param boolean $active
48+
* @param bool $active
4949
*/
5050
public function setActive($active)
5151
{

‎Filters/Helper/FieldAwareInterface.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace ONGR\FilterManagerBundle\Filters\Helper;
1313

1414
/**
15-
* this interface define structure for elasticsearch field aware filters
15+
* This interface define structure for elasticsearch field aware filters.
1616
*/
1717
interface FieldAwareInterface
1818
{

‎Filters/Helper/FieldAwareTrait.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace ONGR\FilterManagerBundle\Filters\Helper;
1313

1414
/**
15-
* this trait defines methods for elasticsearch field value aware filters
15+
* This trait defines methods for elasticsearch field value aware filters.
1616
*/
1717
trait FieldAwareTrait
1818
{

‎Filters/Helper/ViewDataFactoryInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
use ONGR\FilterManagerBundle\Filters\ViewData;
1515

1616
/**
17-
* This interface allows user to provide custom instance of view data object
17+
* This interface allows user to provide custom instance of view data object.
1818
*/
1919
interface ViewDataFactoryInterface
2020
{
2121
/**
22-
* Creates instance of specific ViewData
22+
* Creates instance of specific ViewData.
2323
*
2424
* @return ViewData
2525
*/

‎Filters/Relations/RelationsAwareInterface.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414
use ONGR\FilterManagerBundle\Relations\RelationInterface;
1515

1616
/**
17-
* this interface defines types of relations filter may have
17+
* This interface defines types of relations filter may have.
1818
*/
1919
interface RelationsAwareInterface
2020
{
2121
/**
22-
* Returns relation to other filters in terms of search conditions
22+
* Returns relation to other filters in terms of search conditions.
2323
*
2424
* @return RelationInterface
2525
*/
2626
public function getSearchRelation();
2727

2828
/**
29-
* Returns relation to other filters in terms of filter reset url parameters
29+
* Returns relation to other filters in terms of filter reset url parameters.
3030
*
3131
* @return RelationInterface
3232
*/

‎Filters/Relations/RelationsAwareTrait.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use ONGR\FilterManagerBundle\Relations\RelationInterface;
1515

1616
/**
17-
* This trait provides properties for standard filter relations
17+
* This trait provides properties for standard filter relations.
1818
*/
1919
trait RelationsAwareTrait
2020
{

‎Filters/ViewData.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace ONGR\FilterManagerBundle\Filters;
1313

1414
/**
15-
* This class defines data structure passed into view by single filter
15+
* This class defines data structure passed into view by single filter.
1616
*/
1717
class ViewData
1818
{
@@ -22,21 +22,21 @@ class ViewData
2222
private $state;
2323

2424
/**
25-
* Url parameters representing current filter state
25+
* Url parameters representing current filter state.
2626
*
2727
* @var array
2828
*/
2929
private $urlParameters;
3030

3131
/**
32-
* Url parameters to reset filter
32+
* Url parameters to reset filter.
3333
*
3434
* @var array
3535
*/
3636
private $resetUrlParameters;
3737

3838
/**
39-
* Filter name
39+
* Filter name.
4040
*
4141
* @var string
4242
*/

‎Filters/ViewData/Choice.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
namespace ONGR\FilterManagerBundle\Filters\ViewData;
1313

1414
/**
15-
* This class holds data for filter choice
15+
* This class holds data for filter choice.
1616
*/
1717
class Choice
1818
{
@@ -27,7 +27,7 @@ class Choice
2727
private $default = false;
2828

2929
/**
30-
* holds set or unset parameters depending on state
30+
* Holds set or unset parameters depending on state.
3131
*
3232
* @var array
3333
*/
@@ -39,22 +39,22 @@ class Choice
3939
private $label;
4040

4141
/**
42-
* Represents document count for option
42+
* Represents document count for option.
4343
*
4444
* @var int
4545
*/
4646
private $count = 0;
4747

4848
/**
49-
* @return boolean
49+
* @return bool
5050
*/
5151
public function isActive()
5252
{
5353
return $this->active;
5454
}
5555

5656
/**
57-
* @param boolean $active
57+
* @param bool $active
5858
*/
5959
public function setActive($active)
6060
{

‎Filters/ViewData/ChoicesAwareViewData.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use ONGR\FilterManagerBundle\Filters\ViewData;
1515

1616
/**
17-
* This class represents view data with choices
17+
* This class represents view data with choices.
1818
*/
1919
class ChoicesAwareViewData extends ViewData
2020
{

0 commit comments

Comments
 (0)