owncloud/core

View on GitHub
lib/public/App/ManagerEvent.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/**
 * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCP\App;

use Symfony\Contracts\EventDispatcher\Event;

/**
 * Class ManagerEvent
 *
 * @package OCP\APP
 * @since 9.0.0
 */
class ManagerEvent extends Event {
    public const EVENT_APP_ENABLE = 'OCP\App\IAppManager::enableApp';
    public const EVENT_APP_ENABLE_FOR_GROUPS = 'OCP\App\IAppManager::enableAppForGroups';
    public const EVENT_APP_DISABLE = 'OCP\App\IAppManager::disableApp';

    /** @var string */
    protected $event;
    /** @var string */
    protected $appID;
    /** @var \OCP\IGroup[] */
    protected $groups;

    /**
     * DispatcherEvent constructor.
     *
     * @param string $event
     * @param $appID
     * @param \OCP\IGroup[] $groups
     * @since 9.0.0
     */
    public function __construct($event, $appID, array $groups = null) {
        $this->event = $event;
        $this->appID = $appID;
        $this->groups = $groups;
    }

    /**
     * @return string
     * @since 9.0.0
     */
    public function getEvent() {
        return $this->event;
    }

    /**
     * @return string
     * @since 9.0.0
     */
    public function getAppID() {
        return $this->appID;
    }

    /**
     * returns the group Ids
     * @return string[]
     * @since 9.0.0
     */
    public function getGroups() {
        return \array_map(function ($group) {
            /** @var \OCP\IGroup $group */
            return $group->getGID();
        }, $this->groups);
    }
}