diff --git a/Aggregation/TopHitsAggregation.php b/Aggregation/TopHitsAggregation.php index 79a55efdb54097bb1f776db3d403cda335ecc64e..0dc099e8a532d97c5ee74b4ea0102a927fc50fb4 100644 --- a/Aggregation/TopHitsAggregation.php +++ b/Aggregation/TopHitsAggregation.php @@ -22,23 +22,17 @@ class TopHitsAggregation extends AbstractAggregation use MetricTrait; /** - * Number of top matching hits to return per bucket. - * - * @var int + * @var int Number of top matching hits to return per bucket. */ private $size; /** - * The offset from the first result you want to fetch. - * - * @var int + * @var int The offset from the first result you want to fetch. */ private $from; /** - * How the top matching hits should be sorted. - * - * @var Sorts + * @var Sorts How the top matching hits should be sorted. */ private $sort; diff --git a/Filter/AbstractFilter.php b/Filter/AbstractFilter.php index 662f85196ff5c566db1cd0a052e698084ecb8fd1..bf5d837a053d8674df945d53d739094a51fe5ae0 100644 --- a/Filter/AbstractFilter.php +++ b/Filter/AbstractFilter.php @@ -25,9 +25,9 @@ abstract class AbstractFilter protected $filters; /** - * @param array $boolParams Bool parameters. + * Initializes bool filter. * - * @internal param bool $filters Filters collection. + * @param array $boolParams Bool parameters. */ public function __construct($boolParams = []) { diff --git a/Filter/IndicesFilter.php b/Filter/IndicesFilter.php index a9c92dba497ce680d67aa8ba413cf557061c1edc..8e17a9cf521496b1fa96884dbee00078201cb840 100644 --- a/Filter/IndicesFilter.php +++ b/Filter/IndicesFilter.php @@ -19,12 +19,12 @@ use ONGR\ElasticsearchBundle\DSL\BuilderInterface; class IndicesFilter implements BuilderInterface { /** - * @var string[] $indices + * @var string[] */ private $indices; /** - * @var BuilderInterface $filter + * @var BuilderInterface */ private $filter; diff --git a/Highlight/Field.php b/Highlight/Field.php index de6360dd60c2eb9e48eb3adf5cf94344805b142e..51f9f47054b21ea8a2d46b0c09302b3eb64de507 100644 --- a/Highlight/Field.php +++ b/Highlight/Field.php @@ -23,63 +23,49 @@ class Field const TYPE_FVH = 'fvh'; /** - * Field name. - * - * @var string + * @var string Field name. */ protected $name; /** - * Highlighter type. By default 'plain'. - * - * @var string + * @var string Highlighter type. By default 'plain'. */ protected $type; /** - * Size of the highlighted fragment in characters. By default 100. - * - * @var int + * @var int Size of the highlighted fragment in characters. By default 100. */ protected $fragmentSize; /** - * Maximum number of fragments to return. By default 5. - * - * @var int + * @var int Maximum number of fragments to return. By default 5. */ protected $numberOfFragments; /** - * Combine matches on multiple fields to highlight a single field. - * - * @var array + * @var array Combine matches on multiple fields to highlight a single field. */ protected $matchedFields; /** - * Query to highlight. - * - * @var BuilderInterface + * @var BuilderInterface Query to highlight. */ protected $highlightQuery; /** - * Show part of string even if there are no matches to highlight. Defaults to 0. - * - * @var int + * @var int Show part of string even if there are no matches to highlight. Defaults to 0. */ protected $noMatchSize; /** - * Highlight fields based on the source. - * - * @var bool + * @var bool Highlight fields based on the source. */ protected $forceSource; /** - * @param string $name + * Creates a highlight for a field. + * + * @param string $name Field name. */ public function __construct($name) { diff --git a/Highlight/Highlight.php b/Highlight/Highlight.php index 683ffcc85c499ed373cbd64d16a37d07ebe5079d..ba283610ca9e779b721a318fa3019eee3427ed02 100644 --- a/Highlight/Highlight.php +++ b/Highlight/Highlight.php @@ -21,51 +21,37 @@ class Highlight const TYPE_FVH = 'fvh'; /** - * Holds fields to highlight. - * - * @var array + * @var array Holds fields to highlight. */ protected $fields = []; /** - * Holds html tag name and class that highlight will be put in (default 'em' tag). - * - * @var array + * @var array Holds html tag name and class that highlight will be put in (default 'em' tag). */ protected $tags = []; /** - * Holds tag schema name. 'styled' is the only option yet. - * - * @var string + * @var string Holds tag schema name. 'styled' is the only option yet. */ protected $tagsSchema = null; /** - * Fragments sort type. - * - * @var string + * @var string Fragments sort type. */ protected $order = null; /** - * Highlighter type. By default plain. - * - * @var string + * @var string Highlighter type. By default plain. */ protected $type = null; /** - * Size of the highlighted fragment in characters. By default 100. - * - * @var int + * @var int Size of the highlighted fragment in characters. By default 100. */ protected $fragmentSize = null; /** - * Maximum number of fragments to return. By default 5. - * - * @var int + * @var int Maximum number of fragments to return. By default 5. */ protected $numberOfFragments = null; diff --git a/Query/FilteredQuery.php b/Query/FilteredQuery.php index b32b96a37fac8c3e9142df9a51b327641e72afd3..e216d266560052276c5d3e3113d73bd999eb13ef 100644 --- a/Query/FilteredQuery.php +++ b/Query/FilteredQuery.php @@ -20,7 +20,7 @@ use ONGR\ElasticsearchBundle\DSL\Filter\AbstractFilter; class FilteredQuery extends AbstractFilter implements BuilderInterface { /** - * @var Query used inside filtered area. + * @var Query Used inside filtered area. */ private $query; diff --git a/Query/IndicesQuery.php b/Query/IndicesQuery.php index ac99ae2a768c7fd18d55a4328bf3b5f0e1c7ff6f..7b33ab35d86e95c9d526e74af3fede5fe97fb8a0 100644 --- a/Query/IndicesQuery.php +++ b/Query/IndicesQuery.php @@ -19,12 +19,12 @@ use ONGR\ElasticsearchBundle\DSL\BuilderInterface; class IndicesQuery implements BuilderInterface { /** - * @var string[] $indices + * @var string[] */ private $indices; /** - * @var BuilderInterface $query + * @var BuilderInterface */ private $query; diff --git a/Query/Query.php b/Query/Query.php index 26f07b6bd28bd78cbe1041e726cef07125d17cf4..82481166b915f6ca3b111506afe16955c221118c 100644 --- a/Query/Query.php +++ b/Query/Query.php @@ -20,7 +20,7 @@ use ONGR\ElasticsearchBundle\DSL\BuilderInterface; class Query implements BuilderInterface { /** - * @var BuilderInterface[] Queries + * @var BuilderInterface[] */ private $queries; diff --git a/Query/RangeQuery.php b/Query/RangeQuery.php index 6d06c81d8bf074dac7b0a04dadeb30caaba5ffd2..939212ac651d6bd06b4c8aeb1673d1899c9c376f 100644 --- a/Query/RangeQuery.php +++ b/Query/RangeQuery.php @@ -30,9 +30,7 @@ class RangeQuery implements BuilderInterface const GTE = 'gte'; /** - * Field name. - * - * @var string + * @var string Field name. */ private $field; diff --git a/Search.php b/Search.php index ee7140b5a54a38a816620d374945a5c6bad8624e..94316a4dd4ebfc1dc1bc15b90ed718d4f131eb9a 100644 --- a/Search.php +++ b/Search.php @@ -31,7 +31,7 @@ class Search const SCROLL_DURATION = '5m'; /** - * @var Query $query + * @var Query */ private $query; @@ -41,14 +41,12 @@ class Search private $boolQueryParams; /** - * @var BuilderInterface $filters + * @var BuilderInterface */ private $filters; /** - * Filters collection. - * - * @var BuilderInterface $postFilters + * @var BuilderInterface Filters collection. */ private $postFilters; diff --git a/Sort/GeoSort.php b/Sort/GeoSort.php index 1264ed926c002d9971a7ce807b41c33df5d24941..068de8c785afff9c4d7d61dd2c23b7404da09d49 100644 --- a/Sort/GeoSort.php +++ b/Sort/GeoSort.php @@ -29,9 +29,7 @@ class GeoSort extends AbstractSort protected $location; /** - * Units in which to measure distance. - * - * @var string + * @var string Units in which to measure distance. */ protected $unit; diff --git a/Sort/ScriptSort.php b/Sort/ScriptSort.php index 29e4cfd8ba1f95651bc04d848f78faa8cc67d75b..9611805909739331ab7c185235135533458536f3 100644 --- a/Sort/ScriptSort.php +++ b/Sort/ScriptSort.php @@ -20,16 +20,12 @@ namespace ONGR\ElasticsearchBundle\DSL\Sort; class ScriptSort extends AbstractSort { /** - * Script to execute. - * - * @var string + * @var string Script to execute. */ private $script; /** - * Type returned (number, string). - * - * @var string + * @var string Type returned (number, string). */ private $returnType; diff --git a/Sort/Sort.php b/Sort/Sort.php index b85770f8752d25f46adbe54acb175762096f1f60..04be3b21645a5b78a6b19f35177912152e37e0d0 100644 --- a/Sort/Sort.php +++ b/Sort/Sort.php @@ -19,9 +19,7 @@ use ONGR\ElasticsearchBundle\DSL\BuilderInterface; class Sort extends AbstractSort { /** - * Filter for sorting. - * - * @var BuilderInterface + * @var BuilderInterface Filter for sorting. */ private $nestedFilter; diff --git a/Sort/Sorts.php b/Sort/Sorts.php index 52616191b64b0b009ac05f0a14c7b131266636b8..f4bc32d7c6fef88c2c65e9b75ebcfea37833c845 100644 --- a/Sort/Sorts.php +++ b/Sort/Sorts.php @@ -19,9 +19,7 @@ use ONGR\ElasticsearchBundle\DSL\BuilderInterface; class Sorts implements BuilderInterface { /** - * Sorts collection. - * - * @var AbstractSort[] + * @var AbstractSort[] Sorts collection. */ private $sorts = []; diff --git a/Suggester/Completion.php b/Suggester/Completion.php index 767d6bb93ade6adddb6062b8753d44f60ba2435a..bd045e251dcfca4c9241d35fd16be387359d593e 100644 --- a/Suggester/Completion.php +++ b/Suggester/Completion.php @@ -87,7 +87,7 @@ class Completion extends AbstractSuggester $this->getName() => [ 'text' => $this->getText(), 'completion' => $completion, - ] + ], ]; } diff --git a/Suggester/Context.php b/Suggester/Context.php index 06c16108deccc5855f3108ad6deb61edebe74f04..af7ac4bce179ff2c7e98027d8c1adc0747b3d3a2 100644 --- a/Suggester/Context.php +++ b/Suggester/Context.php @@ -24,9 +24,7 @@ class Context extends AbstractSuggester private $context; /** - * Size of completion. - * - * @var int + * @var int Size of completion. */ private $size; @@ -93,7 +91,7 @@ class Context extends AbstractSuggester $this->getName() => [ 'text' => $this->getText(), 'completion' => $completion, - ] + ], ]; } diff --git a/Suggester/Context/AbstractContext.php b/Suggester/Context/AbstractContext.php index f9f0a7246e3f429d3f857ed2ef60231c5bf0b316..7dc69da853749ca850a95e37c6f0aa757c3d33df 100644 --- a/Suggester/Context/AbstractContext.php +++ b/Suggester/Context/AbstractContext.php @@ -17,16 +17,12 @@ namespace ONGR\ElasticsearchBundle\DSL\Suggester\Context; abstract class AbstractContext { /** - * Name of the context used. - * - * @var string + * @var string Name of the context used. */ private $name; /** - * Value of the context. - * - * @var string|array + * @var string|array Value of the context. */ private $value; diff --git a/Suggester/Phrase.php b/Suggester/Phrase.php index 7c2adb95c4bf3ad9e4bed8d846368d9121778031..95b182e40f8573c84a9f1de071eadd5722829783 100644 --- a/Suggester/Phrase.php +++ b/Suggester/Phrase.php @@ -85,7 +85,7 @@ class Phrase extends AbstractSuggester $this->getName() => [ 'text' => $this->getText(), 'phrase' => array_filter($phrase), - ] + ], ]; }