seregazhuk\PinterestBot\Api\Providers\Boards

Complexity

Total Complexity

15

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Importance

Changes	7
Bugs	2	Features	2

11 Methods

Rating	Name	Duplication	Size	Complexity
A	my()	0	3	1
A	info()	0	9	1
A	titleSuggestionsFor()	0	3	1
A	leave()	0	11	1
A	pins()	0	4	1
A	update()	0	14	2
A	formatBoardName()	0	4	2
A	forMe()	0	9	2
A	forUser()	0	10	2
A	create()	0	9	1
A	createPrivate()	0	3	1

<?php

namespace seregazhuk\PinterestBot\Api\Providers;

use seregazhuk\PinterestBot\Helpers\Pagination;
use seregazhuk\PinterestBot\Helpers\UrlBuilder;
use seregazhuk\PinterestBot\Api\Traits\Searchable;
use seregazhuk\PinterestBot\Api\Traits\CanBeDeleted;
use seregazhuk\PinterestBot\Api\Traits\BoardInvites;
use seregazhuk\PinterestBot\Api\Traits\SendsMessages;
use seregazhuk\PinterestBot\Api\Traits\ResolvesCurrentUser;
use seregazhuk\PinterestBot\Api\Providers\Core\FollowableProvider;

class Boards extends FollowableProvider
{
    use CanBeDeleted, Searchable, SendsMessages, ResolvesCurrentUser, BoardInvites;

The trait seregazhuk\PinterestBot\Api\Traits\BoardInvites requires the property $user which is not provided by seregazhuk\PinterestBot\Api\Providers\Boards.

    const BOARD_PRIVACY_PUBLIC = 'public';
    const BOARD_PRIVACY_PRIVATE = 'secret';

    /**
     * @var array
     */
    protected $loginRequiredFor = [
        'my',
        'forMe',
        'create',
    ];

    protected $searchScope  = 'boards';
    protected $entityIdName = 'board_id';
    protected $followersFor = 'board_id';

    protected $followUrl    = UrlBuilder::RESOURCE_FOLLOW_BOARD;
    protected $unFollowUrl  = UrlBuilder::RESOURCE_UNFOLLOW_BOARD;
    protected $deleteUrl    = UrlBuilder::RESOURCE_DELETE_BOARD;
    protected $followersUrl = UrlBuilder::RESOURCE_BOARD_FOLLOWERS;

    protected $messageEntityName = 'board';

    /**
     * Get boards for user by username.
     *
     * @param string $username
     *
     * @return array
     */
    public function forUser($username)
    {
        $options = [
            'username' => $username,
            'field_set_key' => 'detailed',
        ];

        $result = $this->get(UrlBuilder::RESOURCE_GET_BOARDS, $options);

        return $result ?: [];

The expression return $result ?: array() also could return the type true which is incompatible with the documented return type array.

    }

    /**
     * Get boards for current logged in user.
     *
     * @return array
     */
    public function forMe()
    {
        $currentUserName = $this->resolveCurrentUsername();

        if (!$currentUserName) {
            return [];
        }

        return $this->forUser($currentUserName);
    }

    /**
     * @return array
     */
    public function my()
    {
        return $this->forMe();
    }

    /**
     * Get info about user's board.
     *
     * @param string $username
     * @param string $board
     *
     * @return array|bool
     */
    public function info($username, $board)
    {
        $requestOptions = [
            'slug' => $this->formatBoardName($board),
            'username' => $username,
            'field_set_key' => 'detailed',
        ];

        return $this->get(UrlBuilder::RESOURCE_GET_BOARD, $requestOptions);
    }

    /**
     * @param string $board
     * @return string
     */
    protected function formatBoardName($board)
    {
        $nameWithRemovedSpaces = str_replace(' ', '-', $board);
        return function_exists('mb_strtolower') ? mb_strtolower($nameWithRemovedSpaces) : strtolower($nameWithRemovedSpaces);
    }

    /**
     * Get pins from board by boardId.
     *
     * @param int $boardId
     * @param int $limit
     *
     * @return Pagination
     */
    public function pins($boardId, $limit = Pagination::DEFAULT_LIMIT)
    {
        return $this->paginate(
            UrlBuilder::RESOURCE_GET_BOARD_FEED, ['board_id' => $boardId], $limit
        );
    }

    /**
     * Update board info. Gets boardId and an associative array as params. Available keys of the array are:
     * 'name', 'category', 'description', 'privacy'.
     *
     * - 'privacy' can be 'public' or 'secret'. 'public' by default.
     * - 'category' is 'other' by default.
     *
     * @param $boardId
     * @param $attributes
     * @return mixed
     */
    public function update($boardId, $attributes)
    {
        if (isset($attributes['name'])) {
            $attributes['name'] = $this->formatBoardName($attributes['name']);
        }

        $requestOptions = array_merge(
            [
                'board_id' => $boardId,
                'category' => 'other',
            ], $attributes
        );

        return $this->post(UrlBuilder::RESOURCE_UPDATE_BOARD, $requestOptions);
    }

    /**
     * Create a new board.
     *
     * @param string $name
     * @param string $description
     * @param string $privacy Can be 'public' or 'secret'. 'public' by default.
     *
     * @return bool
     */
    public function create($name, $description, $privacy = self::BOARD_PRIVACY_PUBLIC)
    {
        $requestOptions = [
            'name' => $name,
            'description' => $description,
            'privacy' => $privacy,
        ];

        return $this->post(UrlBuilder::RESOURCE_CREATE_BOARD, $requestOptions);

The expression return $this->post(seregazhuk\PinterestBot\Helpers\UrlBuilder::RESOURCE_CREATE_BOARD, $requestOptions) also could return the type array which is incompatible with the documented return type boolean.

    }

    /**
     * Create a new board.
     *
     * @param string $name
     * @param string $description
     *
     * @return bool
     */
    public function createPrivate($name, $description)
    {
        return $this->create($name, $description, self::BOARD_PRIVACY_PRIVATE);
    }

    /**
     * Returns title suggestions for pin.
     *
     * @param string $pinId
     * @return array|bool
     */
    public function titleSuggestionsFor($pinId)
    {
        return $this->get(UrlBuilder::RESOURCE_TITLE_SUGGESTIONS, ['pin_id' => $pinId]);
    }

    /**
     * @param string $boardId
     * @return array|bool
     */
    public function leave($boardId)
    {
        $requestOptions = [
            'ban' => false,
            'board_id' => (string)$boardId,
            'field_set_key' => 'boardEdit',
            'invited_user_id' => (string)$this->resolveCurrentUserId(),
        ];
        print_r($requestOptions);

        return $this->post(UrlBuilder::RESOURCE_LEAVE_BOARD, $requestOptions);
    }
}