server/apps/files_external/service/usertrait.php
Robin McCorkell a6a69ef1df Introduce UserGlobalStoragesService
UserGlobalStoragesService reads the global storage configuration,
cherry-picking storages applicable to a user. Writing storages through
this service is forbidden, on punishment of throwing an exception.
Storage IDs may also be config hashes when retrieved from this service,
as it is unable to update the storages with real IDs.

As UserGlobalStoragesService and UserStoragesService share a bit of code
relating to users, that has been split into UserTrait. UserTrait also
allows for the user set to be overridden, rather than using the user
from IUserSession.

Config\ConfigAdapter has been reworked to use UserStoragesService and
UserGlobalStoragesService instead of
OC_Mount_Config::getAbsoluteMountPoints(), further reducing dependance
on that horrible static class.
2015-08-19 10:05:11 +01:00

74 lines
1.5 KiB
PHP

<?php
/**
* @author Robin McCorkell <rmccorkell@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @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 OCA\Files_External\Service;
use \OCP\IUserSession;
use \OCP\IUser;
/**
* Trait for getting user information in a service
*/
trait UserTrait {
/** @var IUserSession */
protected $userSession;
/**
* User override
*
* @var IUser|null
*/
private $user = null;
/**
* @return IUser|null
*/
protected function getUser() {
if ($this->user) {
return $this->user;
}
return $this->userSession->getUser();
}
/**
* Override the user from the session
* Unset with ->resetUser() when finished!
*
* @param IUser
* @return self
*/
public function setUser(IUser $user) {
$this->user = $user;
return $this;
}
/**
* Reset the user override
*
* @return self
*/
public function resetUser() {
$this->user = null;
return $this;
}
}