Gitter\Resources\Groups

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	all()	0	4	1
A	rooms()	0	4	1
A	getIterator()	0	8	2

<?php declare(strict_types=1);
/**
 * This file is part of GitterApi package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Gitter\Resources;

use Gitter\Route;

/**
 * Group schema
 *  - id:           Group ID.
 *  - name:         Group name.
 *  - uri:          Group URI on Gitter.
 *  - backedBy:     Security descriptor. Describes the backing object we get permissions from.
 *      - type:         [null|'ONE_TO_ONE'|'GH_REPO'|'GH_ORG'|'GH_USER']
 *      - linkPath:     Represents how we find the backing object given the type
 *  - avatarUrl:    Base avatar URL (add s parameter to size)
 *
 * @package Gitter\Resources
 */
class Groups extends AbstractResource implements \IteratorAggregate
{
    const TYPE_ONE_TO_ONE   = 'ONE_TO_ONE';
    const TYPE_GITHUB_REPO  = 'GH_REPO';
    const TYPE_GITHUB_ORG   = 'GH_ORG';
    const TYPE_GITHUB_USER  = 'GH_USER';

    /**
     * List groups the current user is in.
     * Parameters: none
     *
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     */
    public function all(): array
    {
        return $this->fetch(Route::get('groups'));
    }

    /**
     * List of rooms nested under the specified group.
     *
     * @param string $groupId
     * @return array
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     */
    public function rooms(string $groupId): array
    {
        return $this->fetch(Route::get('groups/{groupId}/rooms')->with('groupId', $groupId));
    }

    /**
     * @return \Generator
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     */
    public function getIterator(): \Generator
    {
        $groups = $this->all();

        foreach ($groups as $i => $group) {
            yield $i => $group;
        }
    }
}