AbstractPersistence.php 5.07 KB
Newer Older
1
<?php
2
3
namespace T3o\TerFe2\Persistence;

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
/*******************************************************************
 *  Copyright notice
 *
 *  (c) 2011 Kai Vogel <kai.vogel@speedprogs.de>, Speedprogs.de
 *
 *  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 2 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!
 ******************************************************************/

/**
 * Abstract persistence handler
 */
31
abstract class AbstractPersistence implements \T3o\TerFe2\Persistence\PersistenceInterface
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
{

    /**
     * @var string
     */
    protected $name = 'Tx_TerFe2';

    /**
     * @var boolean
     */
    protected $isLoaded = FALSE;

    /**
     * @var boolean
     */
    protected $saveImmediately = TRUE;

    /**
     * @var array
     */
    protected $content = array();


    /**
     * Set name
     *
     * @param string $name Name to set
     * @return void
     */
    public function setName($name)
    {
        $this->name = $name;
    }


    /**
     * Get name
     *
     * @return string Name of the persistence
     */
    public function getName()
    {
        if (empty($this->name)) {
75
            // @TODO the property is initialized! Either initialization or this should be removed.
76
77
78
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
            $this->setName(get_class($this));
        }
        return $this->name;
    }


    /**
     * Set isLoaded
     *
     * @param boolean $isLoaded Is loaded state
     * @return void
     */
    public function setIsLoaded($isLoaded)
    {
        $this->isLoaded = (bool)$isLoaded;
    }


    /**
     * Get isLoaded
     *
     * @return boolean Is loaded state
     */
    public function isLoaded()
    {
        return (bool)$this->isLoaded;
    }


    /**
     * Set saveImmediately
     *
     * @param boolean $saveImmediately Save immediately
     * @return void
     */
    public function setSaveImmediately($saveImmediately)
    {
        $this->saveImmediately = (bool)$saveImmediately;
    }


    /**
     * Get saveImmediately
     *
     * @return boolean Save immediately state
     */
    public function saveImmediately()
    {
        return (bool)$this->saveImmediately;
    }


    /**
     * Set value
     *
     * @param string $key Name of the value
     * @param mixed $value Value content
     * @return void
     */
    public function set($key, $value)
    {
        if (empty($key)) {
138
            throw new \Exception('Empty keys are not allowed');
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
        }
        if (!$this->isLoaded()) {
            $this->load();
        }
        $this->content[$key] = $value;
        if ($this->saveImmediately()) {
            $this->save();
        }
    }


    /**
     * Add value
     *
     * @param string $key Name of the value
     * @param mixed $value Value content
     * @return void
     */
    public function add($key, $value)
    {
        $this->set($key, $value);
    }


    /**
     * Add multiple values
     *
     * @param array $value Key <-> value pairs
     * @return void
     */
    public function addMultiple(array $values)
    {
        foreach ($values as $key => $value) {
            $this->add($key, $value);
        }
    }


    /**
     * Check if content contains given key
     *
     * @param string $key Name of the value
     * @return boolean TRUE if exists
     */
    public function has($key)
    {
        if (!$this->isLoaded()) {
            $this->load();
        }
        return isset($this->content[$key]);
    }


    /**
     * Get value
     *
     * @param string $key Name of the value
     * @return mixed Value content
     */
    public function get($key)
    {
        if ($this->has($key)) {
            return $this->content[$key];
        }
        return NULL;
    }


    /**
     * Get all values
     *
     * @return array Key <-> value pairs
     */
    public function getAll()
    {
        if (!$this->isLoaded()) {
            $this->load();
        }
        return $this->content;
    }


    /**
     * Remove a value
     *
     * @param string $key Name of the value
     * @return void
     */
    public function remove($key)
    {
        if ($this->has($key)) {
            unset($this->content[$key]);
        }
        if ($this->saveImmediately()) {
            $this->save();
        }
    }


    /**
     * Remove all values
     *
     * @return void
     */
    public function removeAll()
    {
        if (!$this->isLoaded()) {
            $this->load();
        }
        $this->content = array();
        if ($this->saveImmediately()) {
            $this->save();
        }
    }

}