GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.

AbstractSnapshotEventStore::doPersist()
last analyzed

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 1
nc 1
1
<?php
2
/*
3
 * Copyright (c) 2012-2014 Janos Szurovecz
4
 *
5
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6
 * this software and associated documentation files (the "Software"), to deal in
7
 * the Software without restriction, including without limitation the rights to
8
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9
 * of the Software, and to permit persons to whom the Software is furnished to do
10
 * so, subject to the following conditions:
11
 *
12
 * The above copyright notice and this permission notice shall be included in all
13
 * copies or substantial portions of the Software.
14
 *
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
 * SOFTWARE.
22
 */
23
24
namespace predaddy\domain\eventsourcing;
25
26
use precore\lang\Object;
27
use precore\lang\ObjectClass;
28
use predaddy\domain\AggregateId;
29
use predaddy\domain\DomainEvent;
30
31
/**
32
 * @author Janos Szurovecz <[email protected]>
33
 */
34
abstract class AbstractSnapshotEventStore extends Object implements SnapshotEventStore
35
{
36
    /**
37
     * @var SnapshotStrategy
38
     */
39
    private $snapshotStrategy;
40
41
    public function __construct(SnapshotStrategy $snapshotStrategy = null)
0 ignored issues
show
Coding Style Naming introduced by
The variable $NEVER is not named in camelCase.

This check marks variable names that have not been written in camelCase.

In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes databaseConnectionString.

Loading history...
42
    {
43
        if ($snapshotStrategy === null) {
44
            $snapshotStrategy = TrivialSnapshotStrategy::$NEVER;
45
        }
46
        $this->snapshotStrategy = $snapshotStrategy;
47
    }
48
49
    /**
50
     * @param EventSourcedAggregateRoot $aggregateRoot
51
     * @return void
52
     */
53
    abstract protected function doCreateSnapshot(EventSourcedAggregateRoot $aggregateRoot);
54
55
    /**
56
     * @param DomainEvent $event
57
     * @return int version number
58
     */
59
    abstract protected function doPersist(DomainEvent $event);
60
61
    /**
62
     * @param DomainEvent $event
63
     * @return void
64
     */
65
    public function persist(DomainEvent $event)
66
    {
67
        $version = $this->doPersist($event);
68
        $aggregateId = $event->aggregateId();
69
        if ($this->eventSourced($aggregateId) && $this->snapshotStrategy->snapshotRequired($event, $version)) {
70
            $this->createSnapshot($aggregateId);
71
        }
72
    }
73
74
    /**
75
     * Events raised in the current transaction are not being stored in this snapshot.
76
     * Only the already persisted events are being utilized.
77
     *
78
     * @param AggregateId $aggregateId
79
     */
80
    public function createSnapshot(AggregateId $aggregateId)
81
    {
82
        if (!$this->eventSourced($aggregateId)) {
83
            return;
84
        }
85
        /* @var $aggregateRoot EventSourcedAggregateRoot */
86
        $aggregateRoot = $this->loadSnapshot($aggregateId);
87
        $stateHash = $aggregateRoot === null ? null : $aggregateRoot->stateHash();
88
        $events = $this->getEventsFor($aggregateId, $stateHash);
89
        if ($events->count() == 0) {
0 ignored issues
show
Bug introduced by
The method count does only exist in Countable, but not in Iterator.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
90
            return;
91
        }
92
        if ($aggregateRoot === null) {
93
            $aggregateRoot = ObjectClass::forName($aggregateId->aggregateClass())->newInstanceWithoutConstructor();
94
        }
95
        $aggregateRoot->loadFromHistory($events);
96
        $this->doCreateSnapshot($aggregateRoot);
97
    }
98
99
    private function eventSourced(AggregateId $aggregateId)
100
    {
101
        $class = ObjectClass::forName($aggregateId->aggregateClass());
102
        return $class->isSubclassOf('predaddy\domain\eventsourcing\EventSourcedAggregateRoot');
103
    }
104
}
105