Event/DisplayEventInterface.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
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
75
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<?php
/**
 * Display 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;

/**
 * Display 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 DisplayEventInterface
{
    /**
     * Before any parsing or rendering, after Execute
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRender();

    /**
     * Before parsing of rendered_page to extract tokens for rendering
     *  This is a recursive process - parse - render - parse - render - until no tokens found
     *  token_objects exclude_tokens contains values that are not processed during this parsing
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeParse();

    /**
     * After the Body of the document has been processed for tokens and before the Head is rendered
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeParseHead();

    /**
     * After parsing for tokens (recursive), parameters->tokens contains parsed results
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterParse();

    /**
     * Before Theme is Rendered
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderTheme();

    /**
     * After the Theme has been rendered but before it has been inserted into the rendered_page
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterRenderTheme();

    /**
     * Before Page View is Rendered
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderPage();

    /**
     * After the Page has been rendered but before it has been inserted into the rendered_page
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterRenderPage();

    /**
     * Before Template View is Rendered
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderTemplate();

    /**
     * Prepare Data for Injecting into Template
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onGetTemplateData();

    /**
     * During Template View rendering, before the rendering of the Head
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderTemplateHead();

    /**
     * During Template View rendering for each item
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderTemplateItem();

    /**
     * During Template View rendering, before the rendering of the Footer
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderTemplateFooter();

    /**
     * After the Template/Wrap View has been rendered but before it has been inserted into the rendered_page
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterRenderTemplate();

    /**
     * Before Wrap View is Rendered
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onBeforeRenderWrap();

    /**
     * After the Wrap has been rendered but before it has been inserted into the rendered_page
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterRenderWrap();

    /**
     * On after rendering the entire document
     *
     * @return  $this
     * @since   1.0.0
     */
    public function onAfterRender();
}