1 | <?php |
||
50 | class BeforeQueryEvent extends Event |
||
51 | { |
||
52 | const EVENT_NAME = 'beforeQuery'; |
||
53 | |||
54 | /** |
||
55 | * Constructor |
||
56 | * |
||
57 | * @param Connection $connection The DB Connection |
||
58 | * @param Query $query The Query |
||
59 | * @param array $queryParams Query Parameters |
||
60 | * @param array $queryOptions Query Options |
||
61 | * @param mixed $results Query results/pre-results |
||
62 | * |
||
63 | * @return void |
||
|
|||
64 | */ |
||
65 | public function __construct(Connection $connection, Query $query, |
||
80 | |||
81 | /** |
||
82 | * Returns the Database Connection |
||
83 | * |
||
84 | * @return Connection |
||
85 | */ |
||
86 | public function getConnection() |
||
90 | |||
91 | /** |
||
92 | * Returns the Query |
||
93 | * |
||
94 | * @return Query |
||
95 | */ |
||
96 | public function getQuery() |
||
100 | |||
101 | /** |
||
102 | * Returns the Query's parameters (i.e values) |
||
103 | * |
||
104 | * @return array |
||
105 | */ |
||
106 | public function getQueryParameters() |
||
110 | |||
111 | /** |
||
112 | * Returns the Query's driver options |
||
113 | * |
||
114 | * @return array |
||
115 | */ |
||
116 | public function getQueryOptions() |
||
120 | |||
121 | /** |
||
122 | * Returns the Query's results (if any) |
||
123 | * |
||
124 | * @return mixed |
||
125 | */ |
||
126 | public function getResults() |
||
130 | |||
131 | /** |
||
132 | * Defines the Query |
||
133 | * |
||
134 | * @param Query $query The Query |
||
135 | * |
||
136 | * @return void |
||
137 | */ |
||
138 | public function setQuery(Query $query) |
||
142 | |||
143 | /** |
||
144 | * Defines Driver options for this query |
||
145 | * |
||
146 | * @param array $queryOptions Driver options for this query |
||
147 | * |
||
148 | * @return void |
||
149 | */ |
||
150 | public function setQueryOptions(array $queryOptions) |
||
154 | |||
155 | /** |
||
156 | * Defines parameters (i.e values) for the query |
||
157 | * |
||
158 | * @param array $queryParameters Parameters (values) for the Query |
||
159 | * |
||
160 | * @return void |
||
161 | */ |
||
162 | public function setQueryParameters(array $queryParameters) |
||
166 | |||
167 | /** |
||
168 | * Defines Results for this Query |
||
169 | * |
||
170 | * @param mixed $results Query's results |
||
171 | * |
||
172 | * @return void |
||
173 | */ |
||
174 | public function setResults($results) |
||
178 | |||
179 | /** |
||
180 | * Defines the QueryBridge for this query |
||
181 | * |
||
182 | * @param QueryBridge $bridge The QueryBridge used with this Query |
||
183 | * |
||
184 | * @return void |
||
185 | */ |
||
186 | public function setQueryBridge(QueryBridge $bridge) |
||
190 | |||
191 | /** |
||
192 | * Returns the defined QueryBridge for this Query |
||
193 | * |
||
194 | * @return QueryBridge |
||
195 | */ |
||
196 | public function getQueryBridge() |
||
200 | } |
Adding a
@return
annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.