Completed
Push — master ( 70622d...3359b7 )
by Seth
04:38
created

SearchSource::jsonSerialize()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 5
nc 1
nop 0
1
<?php
2
3
namespace smtech\StMarksSearch;
4
5
use JsonSerializable;
6
7
/**
8
 * An object representing a simplified description of a search result's source
9
 * search domain
10
 *
11
 * @author Seth Battis <[email protected]>
12
 */
13
class SearchSource extends ParameterArrayConstructor implements JsonSerializable
14
{
15
    /**
16
     * Human-readable name
17
     * @var string
18
     */
19
    protected $name;
20
21
    /**
22
     * URL to source home page
23
     * @var string
24
     */
25
    protected $url;
26
27
    protected $icon;
28
29
    /**
30
     * Construct a SearchSource from a search domain
31
     *
32
     * @param AbstractSearchDomain $domain
33
     */
34
    public function __construct(AbstractSearchDomain $domain)
35
    {
36
        parent::__construct([
37
            'name' => $domain->getName(),
1 ignored issue
show
Documentation Bug introduced by
The method getName does not exist on object<smtech\StMarksSearch\AbstractSearchDomain>? 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...
38
            'url' => $domain->getUrl(),
1 ignored issue
show
Documentation Bug introduced by
The method getUrl does not exist on object<smtech\StMarksSearch\AbstractSearchDomain>? 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...
39
            'icon' => $domain->getIcon()
1 ignored issue
show
Documentation Bug introduced by
The method getIcon does not exist on object<smtech\StMarksSearch\AbstractSearchDomain>? 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...
40
        ]);
41
    }
42
43
    public function jsonSerialize()
44
    {
45
        return [
46
            'name' => $this->getName(),
1 ignored issue
show
Documentation Bug introduced by
The method getName does not exist on object<smtech\StMarksSearch\SearchSource>? 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...
47
            'url' => $this->getUrl(),
1 ignored issue
show
Documentation Bug introduced by
The method getUrl does not exist on object<smtech\StMarksSearch\SearchSource>? 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...
48
            'icon' => $this->getIcon()
1 ignored issue
show
Documentation Bug introduced by
The method getIcon does not exist on object<smtech\StMarksSearch\SearchSource>? 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...
49
        ];
50
    }
51
}
52