KarmaService.php 4.91 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<?php

namespace T3o\Karma\Service;

use T3o\Karma\Domain\Model\FrontendUser;
use T3o\Karma\Domain\Repository\FrontendUserRepository;
use T3o\Karma\Domain\Repository\LedgerEntryRepository;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2018
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

class KarmaService implements \TYPO3\CMS\Core\SingletonInterface
{
    /**
     * @var LedgerEntryRepository
     */
    protected $ledgerEntryRepository;

    /**
     * @var FrontendUserRepository
     */
    protected $frontendUserRepository;

    /**
     * @param LedgerEntryRepository $ledgerEntryRepository
     */
    public function injectLedgerEntryRepository(LedgerEntryRepository $ledgerEntryRepository)
    {
        $this->ledgerEntryRepository = $ledgerEntryRepository;
    }

    /**
     * @param FrontendUserRepository $frontendUserRepository
     */
    public function injectFrontendUserRepository(FrontendUserRepository $frontendUserRepository)
    {
        $this->frontendUserRepository = $frontendUserRepository;
    }

    /**
     * Get the imimmutable karma total from the user
     *
     * @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUser $frontendUser
     * @param bool $ignoreCache Fetch value directly from ledger
     * @param bool $updateCacheEntry Update the user's cache entry if we're ignoring cache. Will also update immutable cache.
     * @return int Immutable Karma Total
     */
    public function getImmutableKarmaForUser(\TYPO3\CMS\Extbase\Domain\Model\FrontendUser $frontendUser, $ignoreCache = false, $updateCacheEntry = true)
    {
        $frontendUser = $this->ensureCorrectFrontendUserSubclass($frontendUser);

        if (!$ignoreCache) {
            return $frontendUser->getKarmaImmutableValue();
        }

        $immutableKarma = $this->ledgerEntryRepository->calculateImmutableKarmaTotalForUser($frontendUser);

mabolek's avatar
mabolek committed
78
        if ($updateCacheEntry) {
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
            $immutableKarma = $this->getMutableKarmaForUser($frontendUser, true, false);

            $frontendUser->setKarmaImmutableValue($immutableKarma);
            $frontendUser->setKarmaImmutableValue($immutableKarma);
            $frontendUser->setKarmaCacheTimestamp(time());

            $this->frontendUserRepository->update($frontendUser);
        }

        return $immutableKarma;
    }

    /**
     * Get the mutable karma total from the user
     *
     * @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUser $frontendUser
     * @param bool $ignoreCache Fetch value directly from ledger
     * @param bool $updateCacheEntry Update the user's cache entry if we're ignoring cache. Will also update mutable cache.
     * @return int Mutable Karma Total
     */
    public function getMutableKarmaForUser(\TYPO3\CMS\Extbase\Domain\Model\FrontendUser $frontendUser, $ignoreCache = false, $updateCacheEntry = true)
    {
        $frontendUser = $this->ensureCorrectFrontendUserSubclass($frontendUser);

        if (!$ignoreCache) {
            return $frontendUser->getKarmaMutableValue();
        }

        $mutableKarma = $this->ledgerEntryRepository->calculateMutableKarmaTotalForUser($frontendUser);

mabolek's avatar
mabolek committed
109
        if ($updateCacheEntry) {
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
            $mutableKarma = $this->getImmutableKarmaForUser($frontendUser, true, false);

            $frontendUser->setKarmaMutableValue($mutableKarma);
            $frontendUser->setKarmaMutableValue($mutableKarma);
            $frontendUser->setKarmaCacheTimestamp(time());

            $this->frontendUserRepository->update($frontendUser);
        }

        return $mutableKarma;
    }

    /**
     * Will take any FrontendUser object and return a karma extension FrontendUser subclass with the data we need
     *
     * @param \TYPO3\CMS\Extbase\Domain\Model\FrontendUser $frontendUser
     * @return FrontendUser
     * @internal
     */
mabolek's avatar
mabolek committed
129
130
    public function ensureCorrectFrontendUserSubclass(\TYPO3\CMS\Extbase\Domain\Model\FrontendUser $frontendUser)
    {
131
132
133
134
135
136
137
138
        //If user is not an instance of our own frontend user class we have to fetch it again
        if (!($frontendUser instanceof FrontendUser)) {
            $frontendUser = $this->frontendUserRepository->findByUid($frontendUser->getUid());
        }

        return $frontendUser;
    }
}