Event/ReadEventInterface.php at master · CommonApi/Event · GitHub

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
<?php
/**
 * Read Event Interface
 *
 * @package    Event
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014 Amy Stephen. All rights reserved.
 */
namespace CommonApi\Event;

/**
 * Read Event Interface
 *
 * @author     Amy Stephen
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @since      1.0
 */
interface ReadEventInterface
{
    /**
     * Pre-read processing
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRead();

    /**
     * Post-read processing - one row at a time
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterReadRow();

    /**
     * Post-read processing - all rows at one time from query_results
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterRead();
}