AssetManager::getModelClass()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
1
<?php
2
3
/*
4
 * This file is part of the slince/shopify-api-php
5
 *
6
 * (c) Slince <[email protected]>
7
 *
8
 * This source file is subject to the MIT license that is bundled
9
 * with this source code in the file LICENSE.
10
 */
11
12
namespace Slince\Shopify\Manager\Asset;
13
14
use Slince\Shopify\Common\Manager\AbstractManager;
15
16
class AssetManager extends AbstractManager implements AssetManagerInterface
17
{
18
    /**
19
     * {@inheritdoc}
20
     */
21
    public static function getServiceName()
22
    {
23
        return 'assets';
24
    }
25
26
    /**
27
     * {@inheritdoc}
28
     */
29
    public function getResourceName()
30
    {
31
        return 'asset';
32
    }
33
34
    /**
35
     * {@inheritdoc}
36
     */
37
    public function getModelClass()
38
    {
39
        return Asset::class;
40
    }
41
    
42
    /**
43
     * {@inheritdoc}
44
     */
45
    public function findAll($themeId)
46
    {
47
        $resource = $this->createPartialResourceUrlForList($themeId);
48
        $data = $this->client->get($resource);
49
50
        return $this->createMany(reset($data));
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->createMany(reset($data)); (Slince\Shopify\Common\Model\ModelInterface[]) is incompatible with the return type declared by the interface Slince\Shopify\Manager\A...nagerInterface::findAll of type Slince\Shopify\Manager\Asset\Asset[].

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...
51
    }
52
53
    /**
54
     * {@inheritdoc}
55
     */
56
    public function find($themeId, $key)
57
    {
58
        $resource = $this->createPartialResourceUrlForList($themeId);
59
        $data = $this->client->get($resource, [
60
            'asset' => [
61
                'key' => $key
62
            ]
63
        ]);
64
65
        return $this->fromArray(reset($data));
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->fromArray(reset($data)); (Slince\Shopify\Common\Model\ModelInterface) is incompatible with the return type declared by the interface Slince\Shopify\Manager\A...tManagerInterface::find of type Slince\Shopify\Manager\Asset\Asset.

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...
66
    }
67
68
    /**
69
     * {@inheritdoc}
70
     */
71
    public function update($themeId, array $data)
72
    {
73
        $resource = $this->createPartialResourceUrlForList($themeId);
74
        $data = $this->client->put($resource, [$this->getResourceName() => $data]);
75
76
        return $this->fromArray(reset($data));
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this->fromArray(reset($data)); (Slince\Shopify\Common\Model\ModelInterface) is incompatible with the return type declared by the interface Slince\Shopify\Manager\A...anagerInterface::update of type Slince\Shopify\Manager\Asset\Asset.

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...
77
    }
78
79
    /**
80
     * {@inheritdoc}
81
     */
82
    public function remove($themeId, $key)
83
    {
84
        $resource = $this->createPartialResourceUrlForList($themeId);
85
        $this->client->delete($resource, [
86
            'asset' => [
87
                'key' => $key
88
            ]
89
        ]);
90
    }
91
92
    /**
93
     * @param integer $themeId
94
     *
95
     * @return string
96
     */
97
    protected function createPartialResourceUrlForList($themeId)
98
    {
99
        return "themes/{$themeId}/assets";
100
    }
101
}