CL\Slack\Payload\GroupsArchivePayload

Complexity

Total Complexity

3

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setGroupId()	0	4	1
A	getGroupId()	0	4	1
A	getMethod()	0	4	1

<?php

/*
 * This file is part of the Slack API library.
 *
 * (c) Cas Leentfaar <info@casleentfaar.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CL\Slack\Payload;

/**
 * @author Cas Leentfaar <info@casleentfaar.com>
 *
 * @see    Official documentation at https://api.slack.com/methods/groups.archive
 */
class GroupsArchivePayload extends AbstractPayload
{
    /**
     * Slack seems to want to call this option "channel", but I can't agree with that (the format of the value is different),
     * and will just pretend to my users it's a "group" (ID).
     *
     * @var string
     */
    private $channel;

    /**
     * @param string $groupId
     */
    public function setGroupId($groupId)
    {
        $this->channel = $groupId;
    }

    /**
     * @return string ID of a private group to archive
     */
    public function getGroupId()
    {
        return $this->channel;
    }

    /**
     * @return string ID of a private group to archive
     */
    public function getMethod()
    {
        return 'groups.archive';
    }
}