Part-DB-server/src/Services/UserCacheKeyGenerator.php
Jan Böhmer e557bdedd5 Added an PHP CS fixer config file and applied it to files.
We now use the same the same style as the symfony project, and it allows us to simply fix the style by executing php_cs_fixer fix in the project root.
2019-11-09 00:47:20 +01:00

65 lines
2.1 KiB
PHP

<?php
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
* Copyright (C) 2019 Jan Böhmer (https://github.com/jbtronics)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
namespace App\Services;
use App\Entity\UserSystem\User;
use Symfony\Component\Security\Core\Security;
/**
* Purpose of this service is to generate a key unique for a user, to use in Cache keys and tags.
*/
class UserCacheKeyGenerator
{
protected $security;
public function __construct(Security $security)
{
$this->security = $security;
}
/**
* Generates a key for the given user.
*
* @param User|null $user The user for which the key should be generated. When set to null, the currently logged in
* user is used.
*
* @return string
*/
public function generateKey(User $user = null): string
{
$locale = \Locale::getDefault();
//If no user was specified, use the currently used one.
if (null === $user) {
$user = $this->security->getUser();
}
//If the user is null, then treat it as anonymous user.
//When the anonymous user is passed as user then use this path too.
if (null === $user || User::ID_ANONYMOUS === $user->getID()) {
return 'user$_'.User::ID_ANONYMOUS;
}
//In the most cases we can just use the username (its unique)
return 'user_'.$user->getUsername().'_'.$locale;
}
}