seregazhuk\PinterestBot\Api\Traits\Followable

Complexity

Total Complexity

15

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes	8
Bugs	4	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	follow()	0	4	1
A	unFollow()	0	4	1
A	followCall()	0	7	1
A	createFollowRequestQuery()	0	18	2
A	followers()	0	6	1
A	getFollowData()	0	6	1
	getPaginatedResponse()	0	1	?
A	getFollowUrl()	0	4	2
A	getUnFollowUrl()	0	4	2
A	getFollowersUrl()	0	4	2
A	getFollowersFor()	0	4	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 : '';

The property followersUrl does not exist. Did you maybe forget to declare it?

    }

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

The property followersFor does not exist. Did you maybe forget to declare it?

    }
}