SearchResult - Code Metrics - Inspection of "Refactor to Factories" - smtech/stmarks-search - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 071f6e...2ed909 )

by Seth

created 2017-04-25 03:21 UTC

SearchResult A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
wmc	4
lcom	0
cbo	1
dl	0
loc	87
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	sort()	0	12	3

<?php

namespace smtech\StMarksSearch;

/**
 * An object representing a single search result
 *
 * @author Seth Battis <[email protected]>
 */
class SearchResult extends ParameterArrayConstructor
{
    /**
     * URL of the search result
     * @var string
     */
    protected $url;

    /**
     * Description of result's relevance
     * @var Relevance
     */
    protected $relevance;

    /**
     * Human-readable title
     * @var string
     */
    protected $title;

    /**
     * Human-readable description
     *
     * Ideally 20-100 words, may be HTML-formatted (although links should be
     * stripped out).
     * @var string
     */
    protected $description;

    /**
     * Simplified description of search domain source of the result
     * @var SearchSource
     */
    protected $source;

    /**
     * Construct a SearchResult
     *
     * Expects an associative parameter array:
     *
     * ```
     * [
     *   'url' => URL of the search result as a string,
     *   'title' => Title of the search result as a string,
     *   'relevance' => instance of `Relevance`,
     *   'source' => instance of `SearchSource`,
     *   'description' => Optional: search result descriptin as a string
     * ]
     * ```
     *
     * @param mixed[string] $params

     */
    public function __construct($params)
    {
        $this->requireParameter($params, 'url');
        $this->requireParameter($params, 'title');
        $this->requireParameter($params, 'relevance', Relevance::class);
        $this->requireParameter($params, 'source', SearchSource::class);

        $this->defaultParameter($params, 'description', '[no description available]');

        $this->setUrl($params['url']);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setTitle($params['title']);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setRelevance($params['relevance']);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setSource($params['source']);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setDescription($params['description']);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Sort into order of descending relevance
     *
     * @param SearchResult[] $results
     * @return void
     */
    public static function sort(&$results)
    {
        usort($results, function (SearchResult $a, SearchResult $b) {
            if ($a->getRelevance()->getScore() < $b->getRelevance()->getScore()) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                return 1;
            } elseif ($a->getRelevance()->getScore() > $b->getRelevance()->getScore()) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                return -1;
            } else {
                return 0;
            }
        });
    }
}


1			<?php
2
3			namespace smtech\StMarksSearch;
4
5			/**
6			* An object representing a single search result
7			*
8			* @author Seth Battis <[email protected]>
9			*/
10			class SearchResult extends ParameterArrayConstructor
11			{
12			/**
13			* URL of the search result
14			* @var string
15			*/
16			protected $url;
17
18			/**
19			* Description of result's relevance
20			* @var Relevance
21			*/
22			protected $relevance;
23
24			/**
25			* Human-readable title
26			* @var string
27			*/
28			protected $title;
29
30			/**
31			* Human-readable description
32			*
33			* Ideally 20-100 words, may be HTML-formatted (although links should be
34			* stripped out).
35			* @var string
36			*/
37			protected $description;
38
39			/**
40			* Simplified description of search domain source of the result
41			* @var SearchSource
42			*/
43			protected $source;
44
45			/**
46			* Construct a SearchResult
47			*
48			* Expects an associative parameter array:
49			*
50			* ```
51			* [
52			* 'url' => URL of the search result as a string,
53			* 'title' => Title of the search result as a string,
54			* 'relevance' => instance of `Relevance`,
55			* 'source' => instance of `SearchSource`,
56			* 'description' => Optional: search result descriptin as a string
57			* ]
58			* ```
59			*
60			* @param mixed[string] $params
			1 ignored issue – show Documentation introduced 2017-04-20 20:16 UTC by Report Bug Copy Issue Report The doc-type `mixed[string]` could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
61			*/
62			public function __construct($params)
63			{
64			$this->requireParameter($params, 'url');
65			$this->requireParameter($params, 'title');
66			$this->requireParameter($params, 'relevance', Relevance::class);
67			$this->requireParameter($params, 'source', SearchSource::class);
68
69			$this->defaultParameter($params, 'description', '[no description available]');
70
71			$this->setUrl($params['url']);
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `setUrl` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
72			$this->setTitle($params['title']);
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `setTitle` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
73			$this->setRelevance($params['relevance']);
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `setRelevance` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
74			$this->setSource($params['source']);
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `setSource` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
75			$this->setDescription($params['description']);
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `setDescription` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
76			}
77
78			/**
79			* Sort into order of descending relevance
80			*
81			* @param SearchResult[] $results
82			* @return void
83			*/
84			public static function sort(&$results)
85			{
86			usort($results, function (SearchResult $a, SearchResult $b) {
87			if ($a->getRelevance()->getScore() < $b->getRelevance()->getScore()) {
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `getRelevance` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
88			return 1;
89			} elseif ($a->getRelevance()->getScore() > $b->getRelevance()->getScore()) {
			1 ignored issue – show Documentation Bug introduced 2017-04-25 03:46 UTC by Report Bug Copy Issue Report The method `getRelevance` does not exist on `object<smtech\StMarksSearch\SearchResult>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
90			return -1;
91			} else {
92			return 0;
93			}
94			});
95			}
96			}
97

smtech / stmarks-search

Push — master ( 071f6e...2ed909 )

SearchResult A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like