Completed
Pull Request — master (#19)
by Sergey
03:50 queued 24s
created

FollowHelper::getEntityIdName()

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 1
nc 1
1
<?php
2
3
namespace seregazhuk\PinterestBot\Helpers\Providers;
4
5
trait FollowHelper
6
{
7
    use ProviderHelper;
8
9
    /**
10
     * Follow user by user_id
11
     *
12
     * @param $entityId
13
     * @return bool
14
     */
15
    public function follow($entityId)
16
    {
17
        return $this->followCall($entityId, $this->getFollowUrl());
18
    }
19
20
    /**
21
     * UnFollow user by user_id
22
     *
23
     * @param $entityId
24
     * @return bool
25
     */
26
    public function unFollow($entityId)
27
    {
28
        return $this->followCall($entityId, $this->getUnfFollowUrl());
29
    }
30
31
    /**
32
     * Make api call for follow/unfollow a entity (user/board)
33
     * @param int    $entityId
34
     * @param string $resourceUrl
35
     * @return bool
36
     */
37
    protected function followCall($entityId, $resourceUrl)
38
    {
39
        $this->getRequest()->checkLoggedIn();
40
        $response = $this->getRequest()->followMethodCall($entityId, $this->getEntityIdName(), $resourceUrl);
41
42
        return $this->getResponse()->checkErrorInResponse($response);
43
    }
44
45
    abstract function getEntityIdName();
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
46
47
    abstract function getFollowUrl();
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
48
49
    abstract function getUnfFollowUrl();
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
50
}