TextPlaceSearchRequest::getQuery() - Code Metrics - Inspection of "[Service] Add Place support" - egeloen/ivory-google-map - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — place-services ( fedba7 )

by Eric

created 2016-08-27 19:38 UTC

TextPlaceSearchRequest::getQuery() A

↳ Parent: TextPlaceSearchRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the Ivory Google Map package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Ivory\GoogleMap\Service\Place\Search\Request;

/**
 * @author GeLo <[email protected]>
 */
class TextPlaceSearchRequest extends AbstractPlaceSearchRequest
{
    /**
     * @var string
     */
    private $query;

    /**
     * @param string $query
     */
    public function __construct($query)
    {
        $this->setQuery($query);
    }

    /**
     * @return string
     */
    public function getQuery()
    {
        return $this->query;
    }

    /**
     * @param string $query
     */
    public function setQuery($query)
    {
        $this->query = $query;
    }

    /**
     * {@inheritdoc}
     */
    public function buildContext()
    {
        return 'textsearch';
    }

    /**
     * {@inheritdoc}
     */
    public function buildQuery()
    {
        $query = parent::buildQuery();
        $query['query'] = $this->query;

        return $query;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php
2
3			/*
4			* This file is part of the Ivory Google Map package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Ivory\GoogleMap\Service\Place\Search\Request;
13
14			/**
15			* @author GeLo <[email protected]>
16			*/
17			class TextPlaceSearchRequest extends AbstractPlaceSearchRequest
18			{
19			/**
20			* @var string
21			*/
22			private $query;
23
24			/**
25			* @param string $query
26			*/
27			public function __construct($query)
28			{
29			$this->setQuery($query);
30			}
31
32			/**
33			* @return string
34			*/
35			public function getQuery()
36			{
37			return $this->query;
38			}
39
40			/**
41			* @param string $query
42			*/
43			public function setQuery($query)
44			{
45			$this->query = $query;
46			}
47
48			/**
49			* {@inheritdoc}
50			*/
51			public function buildContext()
52			{
53			return 'textsearch';
54			}
55
56			/**
57			* {@inheritdoc}
58			*/
59			public function buildQuery()
60			{
61			$query = parent::buildQuery();
62			$query['query'] = $this->query;
63
64			return $query;
			0 ignored issues – show Bug Best Practice introduced 2016-08-27 19:42 UTC by Report Bug Copy Issue Report The return type of `return $query;` (`array<string,string>`) is incompatible with the return type declared by the interface `Ivory\GoogleMap\Service\...stInterface::buildQuery` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
65			}
66			}
67

egeloen / ivory-google-map

GitHub Access Token became invalid

Push — place-services ( fedba7 )

TextPlaceSearchRequest::getQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like