Completed
Push — location_multi_load ( e5e305...41e541 )
by André
51:38 queued 33:21
created

getUserPreferenceByUserIdAndName()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 24

Duplication

Lines 24
Ratio 100 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 2
dl 24
loc 24
rs 9.536
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
5
 * @license For full copyright and license information view LICENSE file distributed with this source code.
6
 */
7
declare(strict_types=1);
8
9
namespace eZ\Publish\Core\Persistence\Cache;
10
11
use eZ\Publish\SPI\Persistence\UserPreference\UserPreferenceSetStruct;
12
use eZ\Publish\SPI\Persistence\UserPreference\Handler;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, eZ\Publish\Core\Persistence\Cache\Handler.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
13
use eZ\Publish\SPI\Persistence\UserPreference\UserPreference;
14
15
/**
16
 * SPI cache for UserPreference Handler.
17
 *
18
 * @see \eZ\Publish\SPI\Persistence\UserPreference\Handler
19
 */
20
class UserPreferenceHandler extends AbstractHandler implements Handler
21
{
22
    /**
23
     * {@inheritdoc}
24
     */
25 View Code Duplication
    public function setUserPreference(UserPreferenceSetStruct $setStruct): UserPreference
26
    {
27
        $this->logger->logCall(__METHOD__, [
28
            'setStruct' => $setStruct,
29
        ]);
30
31
        $this->cache->invalidateTags([
32
            'user-preference-count-' . $setStruct->userId,
33
            'user-preference-' . $setStruct->userId . '-' . $setStruct->name,
34
        ]);
35
36
        return $this->persistenceHandler->userPreferenceHandler()->setUserPreference($setStruct);
37
    }
38
39
    /**
40
     * {@inheritdoc}
41
     */
42 View Code Duplication
    public function countUserPreferences(int $userId): int
43
    {
44
        $cacheItem = $this->cache->getItem('ez-user-preference-count-' . $userId);
45
46
        $count = $cacheItem->get();
47
        if ($cacheItem->isHit()) {
48
            return $count;
49
        }
50
51
        $this->logger->logCall(__METHOD__, [
52
            'userId' => $userId,
53
        ]);
54
55
        $count = $this->persistenceHandler->userPreferenceHandler()->countUserPreferences($userId);
56
        $cacheItem->set($count);
57
        $cacheItem->tag(['user-preference-count-' . $userId]);
58
        $this->cache->save($cacheItem);
59
60
        return $count;
61
    }
62
63
    /**
64
     * {@inheritdoc}
65
     */
66 View Code Duplication
    public function getUserPreferenceByUserIdAndName(int $userId, string $name): UserPreference
67
    {
68
        $cacheItem = $this->cache->getItem('ez-user-preference-' . $userId . '-' . $name);
69
70
        $userPreference = $cacheItem->get();
71
        if ($cacheItem->isHit()) {
72
            return $userPreference;
73
        }
74
75
        $this->logger->logCall(__METHOD__, [
76
            'userId' => $userId,
77
            'name' => $name,
78
        ]);
79
80
        $userPreference = $this->persistenceHandler->userPreferenceHandler()->getUserPreferenceByUserIdAndName($userId, $name);
81
82
        $cacheItem->set($userPreference);
83
        $cacheItem->tag([
84
            'user-preference-' . $userId . '-' . $name,
85
        ]);
86
        $this->cache->save($cacheItem);
87
88
        return $userPreference;
89
    }
90
91
    /**
92
     * {@inheritdoc}
93
     */
94 View Code Duplication
    public function loadUserPreferences(int $userId, int $offset, int $limit): array
95
    {
96
        $this->logger->logCall(__METHOD__, [
97
            'userId' => $userId,
98
            'offset' => $offset,
99
            'limit' => $limit,
100
        ]);
101
102
        return $this->persistenceHandler->userPreferenceHandler()->loadUserPreferences($userId, $offset, $limit);
103
    }
104
}
105