← Back to branch summary

~ubuntu-branches/ubuntu/utopic/moodle/utopic

« back to all changes in this revision

Viewing changes to lib/phpunit/classes/event_sink.php

  • Committer: Package Import Robot
  • Author(s): Thijs Kinkhorst
  • Date: 2014-05-12 16:10:38 UTC
  • mfrom: (36.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20140512161038-puyqf65k4e0s8ytz
Tags: 2.6.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/phpunit/classes/event_sink.php
 
1
<?php
 
2
// This file is part of Moodle - http://moodle.org/
 
3
//
 
4
// Moodle is free software: you can redistribute it and/or modify
 
5
// it under the terms of the GNU General Public License as published by
 
6
// the Free Software Foundation, either version 3 of the License, or
 
7
// (at your option) any later version.
 
8
//
 
9
// Moodle is distributed in the hope that it will be useful,
 
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
// GNU General Public License for more details.
 
13
//
 
14
// You should have received a copy of the GNU General Public License
 
15
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
16
 
 
17
/**
 
18
 * Event sink.
 
19
 *
 
20
 * @package    core
 
21
 * @category   phpunit
 
22
 * @copyright  2013 Petr Skoda {@link http://skodak.org}
 
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 
24
 */
 
25
 
 
26
 
 
27
/**
 
28
 * Event redirection sink.
 
29
 *
 
30
 * @package    core
 
31
 * @category   phpunit
 
32
 * @copyright  2013 Petr Skoda {@link http://skodak.org}
 
33
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 
34
 */
 
35
class phpunit_event_sink {
 
36
    /** @var \core\event\base[] array of events */
 
37
    protected $events = array();
 
38
 
 
39
    /**
 
40
     * Stop event redirection.
 
41
     *
 
42
     * Use if you do not want event redirected any more.
 
43
     */
 
44
    public function close() {
 
45
        phpunit_util::stop_event_redirection();
 
46
    }
 
47
 
 
48
    /**
 
49
     * To be called from phpunit_util only!
 
50
     *
 
51
     * @private
 
52
     * @param \core\event\base $event record from event_read table
 
53
     */
 
54
    public function add_event(\core\event\base $event) {
 
55
        /* Number events from 0. */
 
56
        $this->events[] = $event;
 
57
    }
 
58
 
 
59
    /**
 
60
     * Returns all redirected events.
 
61
     *
 
62
     * The instances are records form the event_read table.
 
63
     * The array indexes are numbered from 0 and the order is matching
 
64
     * the creation of events.
 
65
     *
 
66
     * @return \core\event\base[]
 
67
     */
 
68
    public function get_events() {
 
69
        return $this->events;
 
70
    }
 
71
 
 
72
    /**
 
73
     * Return number of events redirected to this sink.
 
74
     *
 
75
     * @return int
 
76
     */
 
77
    public function count() {
 
78
        return count($this->events);
 
79
    }
 
80
 
 
81
    /**
 
82
     * Removes all previously stored events.
 
83
     */
 
84
    public function clear() {
 
85
        $this->events = array();
 
86
    }
 
87
}