Completed
Push — master ( c6502b...156fba )
by Joschi
03:14
created

AbstractObject::postPersist()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 3
cc 1
eloc 1
nc 1
nop 0
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
3
/**
4
 * apparat-object
5
 *
6
 * @category    Apparat
7
 * @package     Apparat\Object
8
 * @subpackage  Apparat\Object\Domain
9
 * @author      Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Apparat\Object\Domain\Model\Object;
38
39
use Apparat\Kernel\Ports\Kernel;
40
use Apparat\Object\Domain\Model\Object\Traits\DomainPropertiesTrait;
41
use Apparat\Object\Domain\Model\Object\Traits\IterableTrait;
42
use Apparat\Object\Domain\Model\Object\Traits\MetaPropertiesTrait;
43
use Apparat\Object\Domain\Model\Object\Traits\PayloadTrait;
44
use Apparat\Object\Domain\Model\Object\Traits\ProcessingInstructionsTrait;
45
use Apparat\Object\Domain\Model\Object\Traits\RelationsTrait;
46
use Apparat\Object\Domain\Model\Object\Traits\StatesTrait;
47
use Apparat\Object\Domain\Model\Object\Traits\SystemPropertiesTrait;
48
use Apparat\Object\Domain\Model\Path\RepositoryPath;
49
use Apparat\Object\Domain\Model\Path\RepositoryPathInterface;
50
use Apparat\Object\Domain\Model\Properties\AbstractDomainProperties;
51
use Apparat\Object\Domain\Model\Properties\InvalidArgumentException as PropertyInvalidArgumentException;
52
use Apparat\Object\Domain\Model\Properties\MetaProperties;
53
use Apparat\Object\Domain\Model\Properties\ProcessingInstructions;
54
use Apparat\Object\Domain\Model\Properties\Relations;
55
use Apparat\Object\Domain\Model\Properties\SystemProperties;
56
use Apparat\Object\Domain\Repository\SelectorInterface;
57
use Apparat\Object\Domain\Repository\Service;
58
59
/**
60
 * Abstract object
61
 *
62
 * @package Apparat\Object
63
 * @subpackage Apparat\Object\Domain
64
 */
65
abstract class AbstractObject implements ObjectInterface, \Iterator, \Countable
66
{
67
    /**
68
     * Use traits
69
     */
70
    use SystemPropertiesTrait, MetaPropertiesTrait, DomainPropertiesTrait, RelationsTrait,
71
        ProcessingInstructionsTrait, PayloadTrait, IterableTrait, StatesTrait;
72
73
    /**
74
     * Repository path
75
     *
76
     * @var RepositoryPathInterface
77
     */
78
    protected $path;
79
    /**
80
     * Latest revision
81
     *
82
     * @var Revision
83
     */
84
    protected $latestRevision;
85
86
    /**
87
     * Object constructor
88
     *
89
     * @param RepositoryPathInterface $path Object repository path
90
     * @param string $payload Object payload
91
     * @param array $propertyData Property data
92
     */
93 30
    public function __construct(RepositoryPathInterface $path, $payload = '', array $propertyData = [])
94
    {
95
        // If the domain property collection class is invalid
96 30
        if (!$this->domainPropertyCClass
97 30
            || !class_exists($this->domainPropertyCClass)
98 30
            || !(new \ReflectionClass($this->domainPropertyCClass))->isSubclassOf(AbstractDomainProperties::class)
99
        ) {
100 1
            throw new PropertyInvalidArgumentException(
101
                sprintf(
102 1
                    'Invalid domain property collection class "%s"',
103 1
                    $this->domainPropertyCClass
104
                ),
105 1
                PropertyInvalidArgumentException::INVALID_DOMAIN_PROPERTY_COLLECTION_CLASS
106
            );
107
        }
108
109
        // Save the original object path
110 29
        $this->path = $path;
111
112
        // Load the current revision data
113 29
        $this->loadRevisionData($payload, $propertyData);
114
115
        // Determine the latest revision number (considering a possible draft)
116 28
        $this->latestRevision = $this->hasDraft()
117
            ? Kernel::create(Revision::class, [$this->getRevision()->getRevision() + 1, true])
118 28
            : $this->getRevision();
119
120
        // Update the object path
121 28
        $this->updatePath();
122 28
    }
123
124
    /**
125
     * Load object revision data
126
     *
127
     * @param string $payload Object payload
128
     * @param array $propertyData Property data
129
     */
130 29
    protected function loadRevisionData($payload = '', array $propertyData = [])
131
    {
132 29
        $this->payload = $payload;
133
134
        // Instantiate the system properties
135 29
        $systemPropertyData = (empty($propertyData[SystemProperties::COLLECTION]) ||
136 29
            !is_array(
137 29
                $propertyData[SystemProperties::COLLECTION]
138 29
            )) ? [] : $propertyData[SystemProperties::COLLECTION];
139 29
        $this->systemProperties = Kernel::create(SystemProperties::class, [$systemPropertyData, $this]);
140
141
        // Instantiate the meta properties
142 28
        $metaPropertyData = (empty($propertyData[MetaProperties::COLLECTION]) ||
143 24
            !is_array(
144 28
                $propertyData[MetaProperties::COLLECTION]
145 28
            )) ? [] : $propertyData[MetaProperties::COLLECTION];
146
        /** @var MetaProperties $metaProperties */
147 28
        $metaProperties = Kernel::create(MetaProperties::class, [$metaPropertyData, $this]);
148 28
        $this->setMetaProperties($metaProperties, true);
149
150
        // Instantiate the domain properties
151 28
        $domainPropertyData = (empty($propertyData[AbstractDomainProperties::COLLECTION]) ||
152 23
            !is_array(
153 28
                $propertyData[AbstractDomainProperties::COLLECTION]
154 28
            )) ? [] : $propertyData[AbstractDomainProperties::COLLECTION];
155
        /** @var AbstractDomainProperties $domainProperties */
156 28
        $domainProperties = Kernel::create($this->domainPropertyCClass, [$domainPropertyData, $this]);
157 28
        $this->setDomainProperties($domainProperties, true);
158
159
        // Instantiate the processing instructions
160 28
        $procInstData = (empty($propertyData[ProcessingInstructions::COLLECTION]) ||
161 20
            !is_array(
162 28
                $propertyData[ProcessingInstructions::COLLECTION]
163 28
            )) ? [] : $propertyData[ProcessingInstructions::COLLECTION];
164
        /** @var ProcessingInstructions $procInstCollection */
165 28
        $procInstCollection = Kernel::create(ProcessingInstructions::class, [$procInstData, $this]);
166 28
        $this->setProcessingInstructions($procInstCollection, true);
167
168
        // Instantiate the object relations
169 28
        $relationData = (empty($propertyData[Relations::COLLECTION]) ||
170 24
            !is_array(
171 28
                $propertyData[Relations::COLLECTION]
172 28
            )) ? [] : $propertyData[Relations::COLLECTION];
173
        /** @var Relations $relationCollection */
174 28
        $relationCollection = Kernel::create(Relations::class, [$relationData, $this]);
175 28
        $this->setRelations($relationCollection, true);
176
177
        // Reset the object state
178 28
        $this->resetState();
179 28
    }
180
181
    /**
182
     * Return whether this object already has a draft revision
183
     */
184 28
    protected function hasDraft()
185
    {
186
        // Create the object draft resource path
187 28
        $draftPath = $this->path->setRevision(Revision::current(true));
188
189
        // Use the object manager to look for a draft resource
190
        /** @var ManagerInterface $objectManager */
191 28
        $objectManager = Kernel::create(Service::class)->getObjectManager();
192 28
        return $objectManager->objectResourceExists($draftPath);
193
    }
194
195
    /**
196
     * Update the object path
197
     */
198 28
    protected function updatePath()
199
    {
200 28
        $revision = $this->getRevision();
201 28
        $this->path = $this->path->setRevision(
202 28
            !$revision->isDraft() && ($this->getCurrentRevision()->getRevision() == $revision->getRevision())
203 23
                ? Revision::current($revision->isDraft())
204 28
                : $revision
205 28
        )->setHidden($this->isDeleted());
206 28
    }
207
208
    /**
209
     * Return this object's current revision
210
     *
211
     * @return Revision Current revision
212
     */
213 27
    protected function getCurrentRevision()
214
    {
215 27
        if ($this->latestRevision->isDraft() && ($this->latestRevision->getRevision() > 1)) {
216 1
            return Kernel::create(Revision::class, [$this->latestRevision->getRevision() - 1, false]);
217
        }
218 27
        return $this->latestRevision;
219
    }
220
221
    /**
222
     * Use a specific object revision
223
     *
224
     * @param Revision $revision Revision to be used
225
     * @return ObjectInterface Object
226
     * @throws OutOfBoundsException If a revision beyond the latest one is requested
227
     */
228 26
    public function useRevision(Revision $revision)
229
    {
230
        // If a revision beyond the latest one is requested
231 26
        if (!$revision->isCurrent() && ($revision->getRevision() > $this->latestRevision->getRevision())) {
232 1
            throw new OutOfBoundsException(
233 1
                sprintf('Invalid object revision "%s"', $revision->getRevision()),
234 1
                OutOfBoundsException::INVALID_OBJECT_REVISION
235
            );
236
        }
237
238
        // Determine whether the current revision was requested
239 26
        $currentRevision = $this->getCurrentRevision();
240 26
        $isCurrentRevision = $revision->isCurrent() || $currentRevision->equals($revision);
241 26
        if ($isCurrentRevision) {
242 26
            $revision = $currentRevision;
243
        }
244
245
        // If the requested revision is not already used
246 26
        if (!$this->getRevision()->equals($revision)) {
247
248
            /** @var ManagerInterface $objectManager */
249 1
            $objectManager = Kernel::create(Service::class)->getObjectManager();
250
            /** @var Revision $newRevision */
251 1
            $newRevision = $isCurrentRevision ? Revision::current() : $revision;
252
            /** @var RepositoryPath $newRevisionPath */
253 1
            $newRevisionPath = $this->path->setRevision($newRevision);
254
255
            // Instantiate the requested revision resource
256 1
            $revisionResource = $objectManager->loadObjectResource($newRevisionPath, SelectorInterface::ALL);
257
258
            // Load the revision resource data
259 1
            $this->loadRevisionData($revisionResource->getPayload(), $revisionResource->getPropertyData());
260
261
            // Update the object path
262 1
            $this->updatePath();
263
        }
264
265 26
        return $this;
266
    }
267
268
    /**
269
     * Return the object repository path
270
     *
271
     * @return RepositoryPathInterface Object repository path
272
     */
273 28
    public function getRepositoryPath()
274
    {
275 28
        return $this->path;
276
    }
277
278
    /**
279
     * Return the object property data
280
     *
281
     * @return array Object property data
282
     */
283 8
    public function getPropertyData()
284
    {
285 8
        $propertyData = array_filter([
286 8
            SystemProperties::COLLECTION => $this->systemProperties->toArray(),
287 8
            MetaProperties::COLLECTION => $this->metaProperties->toArray(),
288 8
            AbstractDomainProperties::COLLECTION => $this->domainProperties->toArray(),
289 8
            ProcessingInstructions::COLLECTION => $this->processingInstructions->toArray(),
290 8
            Relations::COLLECTION => $this->relations->toArray(),
291 8
        ], function (array $collection) {
292 8
            return (boolean)count($collection);
293 8
        });
294
295 8
        return $propertyData;
296
    }
297
298
    /**
299
     * Return the absolute object URL
300
     *
301
     * @return string
302
     */
303 4
    public function getAbsoluteUrl()
304
    {
305 4
        return getenv('APPARAT_BASE_URL').ltrim($this->path->getRepository()->getUrl(), '/').strval($this->path);
306
    }
307
308
    /**
309
     * Persist the current object revision
310
     *
311
     * @return ObjectInterface Object
312
     */
313 4
    public function persist()
314
    {
315
        // If this is not the latest revision
316 4
        if ($this->getRevision()->getRevision() !== $this->latestRevision->getRevision()) {
317 1
            throw new RuntimeException(
318
                sprintf(
319 1
                    'Cannot persist revision %s/%s',
320 1
                    $this->getRevision()->getRevision(),
321 1
                    $this->latestRevision->getRevision()
322
                ),
323 1
                RuntimeException::CANNOT_PERSIST_EARLIER_REVISION
324
            );
325
        }
326
327
        // Update the object repository
328 4
        $this->path->getRepository()->updateObject($this);
329
330
        // Reset to a clean state
331 2
        $this->resetState();
332 2
        $this->latestRevision = $this->getRevision();
333 2
        $this->updatePath();
334
335
        // Post persistence hook
336 2
        $this->postPersist();
337
338 2
        return $this;
339
    }
340
341
    /**
342
     * Post persistence hook
343
     *
344
     * @return void
345
     */
346 2
    protected function postPersist()
347
    {
348 2
    }
349
350
    /**
351
     * Publish the current object revision
352
     *
353
     * @return ObjectInterface Object
354
     */
355 2
    public function publish()
356
    {
357
        // If this is an unpublished draft
358 2
        if ($this->isDraft() & !$this->hasBeenPublished()) {
359 2
            $this->setPublishedState();
360 2
            $this->latestRevision = $this->latestRevision->setDraft(false);
361 2
            $this->updatePath();
362
        }
363
364 2
        return $this;
365
    }
366
367
    /**
368
     * Delete the object and all its revisions
369
     *
370
     * @return ObjectInterface Object
371
     */
372 3
    public function delete()
373
    {
374
        // If this object is not already deleted
375 3
        if (!$this->isDeleted() && !$this->hasBeenDeleted()) {
376 3
            $this->setDeletedState();
377 3
            $this->updatePath();
378
        }
379
380 3
        return $this;
381
    }
382
383
    /**
384
     * Undelete the object and all its revisions
385
     *
386
     * @return ObjectInterface Object
387
     */
388 2
    public function undelete()
389
    {
390
        // If this object is already deleted
391 2
        if ($this->isDeleted() && !$this->hasBeenUndeleted()) {
392 2
            $this->setUndeletedState();
393 2
            $this->updatePath();
394
        }
395
396 2
        return $this;
397
    }
398
399
    /**
400
     * Convert this object revision into a draft
401
     */
402 5
    protected function convertToDraft()
403
    {
404
        // Assume the latest revision as draft revision
405 5
        $draftRevision = $this->latestRevision;
406
407
        // If it equals the current revision: Spawn a draft
408 5
        if ($draftRevision->equals($this->getCurrentRevision())) {
409 5
            $draftRevision = $this->latestRevision = $draftRevision->increment()->setDraft(true);
410
        }
411
412
        // Set the system properties to draft mode
413 5
        $this->setSystemProperties($this->systemProperties->createDraft($draftRevision), true);
414
415
        // Update the object path
416 5
        $this->updatePath();
417 5
    }
418
}
419