Completed
Pull Request — master (#1051)
by Karel
07:59
created

TransformedFinder   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 95
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 8

Test Coverage

Coverage 100%
Metric Value
wmc 8
lcom 1
cbo 8
dl 0
loc 95
ccs 27
cts 27
cp 1
rs 10

7 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A find() 0 6 1
A findHybrid() 0 6 1
A moreLikeThis() 0 7 1
A search() 0 10 2
A findPaginated() 0 7 1
A createPaginatorAdapter() 0 6 1
1
<?php
2
3
namespace FOS\ElasticaBundle\Finder;
4
5
use Elastica\Document;
6
use FOS\ElasticaBundle\Transformer\ElasticaToModelTransformerInterface;
7
use FOS\ElasticaBundle\Paginator\TransformedPaginatorAdapter;
8
use FOS\ElasticaBundle\Paginator\FantaPaginatorAdapter;
9
use Pagerfanta\Pagerfanta;
10
use Elastica\SearchableInterface;
11
use Elastica\Query;
12
13
/**
14
 * Finds elastica documents and map them to persisted objects.
15
 */
16
class TransformedFinder implements PaginatedFinderInterface
17
{
18
    protected $searchable;
19
    protected $transformer;
20
21 5
    public function __construct(SearchableInterface $searchable, ElasticaToModelTransformerInterface $transformer)
22
    {
23 5
        $this->searchable  = $searchable;
24 5
        $this->transformer = $transformer;
25 5
    }
26
27
    /**
28
     * Search for a query string.
29
     *
30
     * @param string  $query
31
     * @param integer $limit
32
     * @param array   $options
33
     *
34
     * @return array of model objects
35
     **/
36 1
    public function find($query, $limit = null, $options = array())
37
    {
38 1
        $results = $this->search($query, $limit, $options);
39
40 1
        return $this->transformer->transform($results);
41
    }
42
43 1
    public function findHybrid($query, $limit = null, $options = array())
44
    {
45 1
        $results = $this->search($query, $limit, $options);
46
47 1
        return $this->transformer->hybridTransform($results);
48
    }
49
50
    /**
51
     * Find documents similar to one with passed id.
52
     *
53
     * @param integer $id
54
     * @param array   $params
55
     * @param array   $query
56
     *
57
     * @return array of model objects
58
     **/
59 1
    public function moreLikeThis($id, $params = array(), $query = array())
60
    {
61 1
        $doc = new Document($id);
62 1
        $results = $this->searchable->moreLikeThis($doc, $params, $query)->getResults();
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Elastica\SearchableInterface as the method moreLikeThis() does only exist in the following implementations of said interface: Elastica\Type.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
63
64 1
        return $this->transformer->transform($results);
65
    }
66
67
    /**
68
     * @param $query
69
     * @param null|int $limit
70
     * @param array    $options
71
     *
72
     * @return array
73
     */
74 1
    protected function search($query, $limit = null, $options = array())
75
    {
76 1
        $queryObject = Query::create($query);
77 1
        if (null !== $limit) {
78 1
            $queryObject->setSize($limit);
79
        }
80 1
        $results = $this->searchable->search($queryObject, $options)->getResults();
81
82 1
        return $results;
83
    }
84
85
    /**
86
     * Gets a paginator wrapping the result of a search.
87
     *
88
     * @param string $query
89
     * @param array  $options
90
     *
91
     * @return Pagerfanta
92
     */
93 1
    public function findPaginated($query, $options = array())
94
    {
95 1
        $queryObject = Query::create($query);
96 1
        $paginatorAdapter = $this->createPaginatorAdapter($queryObject, $options);
97
98 1
        return new Pagerfanta(new FantaPaginatorAdapter($paginatorAdapter));
99
    }
100
101
    /**
102
     * {@inheritdoc}
103
     */
104 1
    public function createPaginatorAdapter($query, $options = array())
105
    {
106 1
        $query = Query::create($query);
107
108 1
        return new TransformedPaginatorAdapter($this->searchable, $query, $options, $this->transformer);
109
    }
110
}
111