Followable::followers() - Code Metrics - Inspection of "upd: removed HasFollowers trait" - seregazhuk/php-pinterest-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#154)

by Sergey

created 2016-09-08 03:54 UTC

Followable::followers() A

↳ Parent: Followable

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php

namespace seregazhuk\PinterestBot\Api\Traits;

use Iterator;
use seregazhuk\PinterestBot\Api\Response;
use seregazhuk\PinterestBot\Helpers\UrlBuilder;

/**
 * Trait Followable
 * @package seregazhuk\PinterestBot\Api\Traits
 *
 * @property string $followUrl
 * @property string $unFollowUrl
 */
trait Followable
{
    use HandlesRequest, HasEntityIdName;

    /**
     * Follow user by user_id.
     *
     * @param $entityId
     *
     * @return bool
     */
    public function follow($entityId)
    {
        return $this->followCall($entityId, $this->getFollowUrl());
    }

    /**
     * UnFollow user by user_id.
     *
     * @param $entityId
     *
     * @return bool
     */
    public function unFollow($entityId)
    {
        return $this->followCall($entityId, $this->getUnFollowUrl());
    }

    /**
     * Make api call for follow/unFollow a entity (user/board).
     *
     * @param int    $entityId
     * @param string $resourceUrl
     *
     * @return bool
     */
    protected function followCall($entityId, $resourceUrl)
    {
        return $this
            ->getRequest()
            ->exec($resourceUrl, $this->createFollowRequestQuery($entityId))
            ->isOk();
    }

    /**
     * @param integer $entityId
     * @return mixed
     */
    public function createFollowRequestQuery($entityId)
    {
        $entityName = $this->getEntityIdName();

        $dataJson = [
            'options' => [
                $entityName => (string)$entityId,
            ],
            'context' => [],
        ];

        if ($entityName == 'interest_id') {
            $dataJson['options']['interest_list'] = 'favorited';
        }

        $post = ['data' => json_encode($dataJson, JSON_FORCE_OBJECT)];
        return UrlBuilder::buildRequestString($post);
    }

    /**
     * Get followers.
     *
     * @param string $for
     * @param int $limit
     *
     * @return Iterator
     */
    public function followers($for, $limit = 0)
    {
        return $this->getFollowData(
            [$this->getFollowersFor() => $for], $this->getFollowersUrl(), $limit
        );
    }

    /**
     * @param array  $data
     * @param string $resourceUrl
     * @param int $limit
     *
     * @return Iterator
     */
    public function getFollowData($data, $resourceUrl, $limit = 0)
    {
        $requestData = array_merge([$data, $resourceUrl]);

        return $this->getPaginatedResponse($requestData, $limit);
    }

    /**
     * @param array $params
     * @param int $limit
     * @param string $method
     * @return mixed
     */
    abstract protected function getPaginatedResponse(array $params, $limit, $method = 'getPaginatedData');

    /**
     * @return string
     */
    protected function getFollowUrl()
    {
        return property_exists($this, 'followUrl') ? $this->followUrl : '';
    }

    /**
     * @return string
     */
    protected function getUnFollowUrl()
    {
        return property_exists($this, 'followUrl') ? $this->unFollowUrl : '';
    }

    /**
     * @return string
     */
    protected function getFollowersUrl()
    {
        return property_exists($this, 'followersUrl') ? $this->followersUrl : '';
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @return string
     */
    protected function getFollowersFor()
    {
        return property_exists($this, 'followersFor') ? $this->followersFor : '';
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1			<?php
2
3			namespace seregazhuk\PinterestBot\Api\Traits;
4
5			use Iterator;
6			use seregazhuk\PinterestBot\Api\Response;
7			use seregazhuk\PinterestBot\Helpers\UrlBuilder;
8
9			/**
10			* Trait Followable
11			* @package seregazhuk\PinterestBot\Api\Traits
12			*
13			* @property string $followUrl
14			* @property string $unFollowUrl
15			*/
16			trait Followable
17			{
18			use HandlesRequest, HasEntityIdName;
19
20			/**
21			* Follow user by user_id.
22			*
23			* @param $entityId
24			*
25			* @return bool
26			*/
27			public function follow($entityId)
28			{
29			return $this->followCall($entityId, $this->getFollowUrl());
30			}
31
32			/**
33			* UnFollow user by user_id.
34			*
35			* @param $entityId
36			*
37			* @return bool
38			*/
39			public function unFollow($entityId)
40			{
41			return $this->followCall($entityId, $this->getUnFollowUrl());
42			}
43
44			/**
45			* Make api call for follow/unFollow a entity (user/board).
46			*
47			* @param int $entityId
48			* @param string $resourceUrl
49			*
50			* @return bool
51			*/
52			protected function followCall($entityId, $resourceUrl)
53			{
54			return $this
55			->getRequest()
56			->exec($resourceUrl, $this->createFollowRequestQuery($entityId))
57			->isOk();
58			}
59
60			/**
61			* @param integer $entityId
62			* @return mixed
63			*/
64			public function createFollowRequestQuery($entityId)
65			{
66			$entityName = $this->getEntityIdName();
67
68			$dataJson = [
69			'options' => [
70			$entityName => (string)$entityId,
71			],
72			'context' => [],
73			];
74
75			if ($entityName == 'interest_id') {
76			$dataJson['options']['interest_list'] = 'favorited';
77			}
78
79			$post = ['data' => json_encode($dataJson, JSON_FORCE_OBJECT)];
80			return UrlBuilder::buildRequestString($post);
81			}
82
83			/**
84			* Get followers.
85			*
86			* @param string $for
87			* @param int $limit
88			*
89			* @return Iterator
90			*/
91			public function followers($for, $limit = 0)
92			{
93			return $this->getFollowData(
94			[$this->getFollowersFor() => $for], $this->getFollowersUrl(), $limit
95			);
96			}
97
98			/**
99			* @param array $data
100			* @param string $resourceUrl
101			* @param int $limit
102			*
103			* @return Iterator
104			*/
105			public function getFollowData($data, $resourceUrl, $limit = 0)
106			{
107			$requestData = array_merge([$data, $resourceUrl]);
108
109			return $this->getPaginatedResponse($requestData, $limit);
110			}
111
112			/**
113			* @param array $params
114			* @param int $limit
115			* @param string $method
116			* @return mixed
117			*/
118			abstract protected function getPaginatedResponse(array $params, $limit, $method = 'getPaginatedData');
119
120			/**
121			* @return string
122			*/
123			protected function getFollowUrl()
124			{
125			return property_exists($this, 'followUrl') ? $this->followUrl : '';
126			}
127
128			/**
129			* @return string
130			*/
131			protected function getUnFollowUrl()
132			{
133			return property_exists($this, 'followUrl') ? $this->unFollowUrl : '';
134			}
135
136			/**
137			* @return string
138			*/
139			protected function getFollowersUrl()
140			{
141			return property_exists($this, 'followersUrl') ? $this->followersUrl : '';
			0 ignored issues – show Bug introduced 2016-09-08 03:56 UTC by Report Bug Copy Issue Report The property `followersUrl` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
142			}
143
144			/**
145			* @return string
146			*/
147			protected function getFollowersFor()
148			{
149			return property_exists($this, 'followersFor') ? $this->followersFor : '';
			0 ignored issues – show Bug introduced 2016-09-08 03:56 UTC by Report Bug Copy Issue Report The property `followersFor` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
150			}
151			}
152

seregazhuk / php-pinterest-bot

Pull Request — master (#154)

Followable::followers() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like