Completed
Push — master ( 257f00...bb6dc6 )
by Andrii
14:23
created

AcceptanceTesterActions::dontSeeInPopup()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 3
rs 10
cc 1
nc 1
nop 1
1
<?php  //[STAMP] 6b9adb76422da607221bec2f3c1c5b7b
2
3
namespace hipanel\tests\_support\_generated;
4
5
// This class was automatically generated by build task
6
// You should not change it manually as it will be overwritten on next build
7
// @codingStandardsIgnoreFile
8
9
trait AcceptanceTesterActions
10
{
11
    /**
12
     * @return \Codeception\Scenario
13
     */
14
    abstract protected function getScenario();
15
16
    
17
    /**
18
     * [!] Method is generated. Documentation taken from corresponding module.
19
     *
20
     * Print out latest Selenium Logs in debug mode
21
     *
22
     * @param \Codeception\TestInterface $test
23
     * @see \Codeception\Module\WebDriver::debugWebDriverLogs()
24
     */
25
    public function debugWebDriverLogs($test = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $test is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
26
        return $this->getScenario()->runStep(new \Codeception\Step\Action('debugWebDriverLogs', func_get_args()));
27
    }
28
29
 
30
    /**
31
     * [!] Method is generated. Documentation taken from corresponding module.
32
     *
33
     * Changes the subdomain for the 'url' configuration parameter.
34
     * Does not open a page; use `amOnPage` for that.
35
     *
36
     * ``` php
37
     * <?php
38
     * // If config is: 'http://mysite.com'
39
     * // or config is: 'http://www.mysite.com'
40
     * // or config is: 'http://company.mysite.com'
41
     *
42
     * $I->amOnSubdomain('user');
43
     * $I->amOnPage('/');
44
     * // moves to http://user.mysite.com/
45
     * ?>
46
     * ```
47
     *
48
     * @param $subdomain
49
     *
50
     * @return mixed
51
     * @see \Codeception\Module\WebDriver::amOnSubdomain()
52
     */
53
    public function amOnSubdomain($subdomain) {
0 ignored issues
show
Unused Code introduced by
The parameter $subdomain is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
54
        return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnSubdomain', func_get_args()));
55
    }
56
57
 
58
    /**
59
     * [!] Method is generated. Documentation taken from corresponding module.
60
     *
61
     * Takes a screenshot of the current window and saves it to `tests/_output/debug`.
62
     *
63
     * ``` php
64
     * <?php
65
     * $I->amOnPage('/user/edit');
66
     * $I->makeScreenshot('edit_page');
67
     * // saved to: tests/_output/debug/edit_page.png
68
     * $I->makeScreenshot();
69
     * // saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.png
70
     * ```
71
     *
72
     * @param $name
73
     * @see \Codeception\Module\WebDriver::makeScreenshot()
74
     */
75
    public function makeScreenshot($name = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
76
        return $this->getScenario()->runStep(new \Codeception\Step\Action('makeScreenshot', func_get_args()));
77
    }
78
79
 
80
    /**
81
     * [!] Method is generated. Documentation taken from corresponding module.
82
     *
83
     * Resize the current window.
84
     *
85
     * ``` php
86
     * <?php
87
     * $I->resizeWindow(800, 600);
88
     *
89
     * ```
90
     *
91
     * @param int $width
92
     * @param int $height
93
     * @see \Codeception\Module\WebDriver::resizeWindow()
94
     */
95
    public function resizeWindow($width, $height) {
0 ignored issues
show
Unused Code introduced by
The parameter $width is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $height is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
96
        return $this->getScenario()->runStep(new \Codeception\Step\Action('resizeWindow', func_get_args()));
97
    }
98
99
 
100
    /**
101
     * [!] Method is generated. Documentation taken from corresponding module.
102
     *
103
     * Checks that a cookie with the given name is set.
104
     * You can set additional cookie params like `domain`, `path` as array passed in last argument.
105
     *
106
     * ``` php
107
     * <?php
108
     * $I->seeCookie('PHPSESSID');
109
     * ?>
110
     * ```
111
     *
112
     * @param $cookie
113
     * @param array $params
114
     * @return mixed
115
     * Conditional Assertion: Test won't be stopped on fail
116
     * @see \Codeception\Module\WebDriver::seeCookie()
117
     */
118
    public function canSeeCookie($cookie, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
119
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCookie', func_get_args()));
120
    }
121
    /**
122
     * [!] Method is generated. Documentation taken from corresponding module.
123
     *
124
     * Checks that a cookie with the given name is set.
125
     * You can set additional cookie params like `domain`, `path` as array passed in last argument.
126
     *
127
     * ``` php
128
     * <?php
129
     * $I->seeCookie('PHPSESSID');
130
     * ?>
131
     * ```
132
     *
133
     * @param $cookie
134
     * @param array $params
135
     * @return mixed
136
     * @see \Codeception\Module\WebDriver::seeCookie()
137
     */
138
    public function seeCookie($cookie, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
139
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCookie', func_get_args()));
140
    }
141
142
 
143
    /**
144
     * [!] Method is generated. Documentation taken from corresponding module.
145
     *
146
     * Checks that there isn't a cookie with the given name.
147
     * You can set additional cookie params like `domain`, `path` as array passed in last argument.
148
     *
149
     * @param $cookie
150
     *
151
     * @param array $params
152
     * @return mixed
153
     * Conditional Assertion: Test won't be stopped on fail
154
     * @see \Codeception\Module\WebDriver::dontSeeCookie()
155
     */
156
    public function cantSeeCookie($cookie, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
157
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCookie', func_get_args()));
158
    }
159
    /**
160
     * [!] Method is generated. Documentation taken from corresponding module.
161
     *
162
     * Checks that there isn't a cookie with the given name.
163
     * You can set additional cookie params like `domain`, `path` as array passed in last argument.
164
     *
165
     * @param $cookie
166
     *
167
     * @param array $params
168
     * @return mixed
169
     * @see \Codeception\Module\WebDriver::dontSeeCookie()
170
     */
171
    public function dontSeeCookie($cookie, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
172
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCookie', func_get_args()));
173
    }
174
175
 
176
    /**
177
     * [!] Method is generated. Documentation taken from corresponding module.
178
     *
179
     * Sets a cookie with the given name and value.
180
     * You can set additional cookie params like `domain`, `path`, `expires`, `secure` in array passed as last argument.
181
     *
182
     * ``` php
183
     * <?php
184
     * $I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
185
     * ?>
186
     * ```
187
     *
188
     * @param $name
189
     * @param $val
190
     * @param array $params
191
     *
192
     * @return mixed
193
     * @see \Codeception\Module\WebDriver::setCookie()
194
     */
195
    public function setCookie($cookie, $value, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
196
        return $this->getScenario()->runStep(new \Codeception\Step\Action('setCookie', func_get_args()));
197
    }
198
199
 
200
    /**
201
     * [!] Method is generated. Documentation taken from corresponding module.
202
     *
203
     * Unsets cookie with the given name.
204
     * You can set additional cookie params like `domain`, `path` in array passed as last argument.
205
     *
206
     * @param $cookie
207
     *
208
     * @param array $params
209
     * @return mixed
210
     * @see \Codeception\Module\WebDriver::resetCookie()
211
     */
212
    public function resetCookie($cookie, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
213
        return $this->getScenario()->runStep(new \Codeception\Step\Action('resetCookie', func_get_args()));
214
    }
215
216
 
217
    /**
218
     * [!] Method is generated. Documentation taken from corresponding module.
219
     *
220
     * Grabs a cookie value.
221
     * You can set additional cookie params like `domain`, `path` in array passed as last argument.
222
     *
223
     * @param $cookie
224
     *
225
     * @param array $params
226
     * @return mixed
227
     * @see \Codeception\Module\WebDriver::grabCookie()
228
     */
229
    public function grabCookie($cookie, $params = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cookie is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
230
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabCookie', func_get_args()));
231
    }
232
233
 
234
    /**
235
     * [!] Method is generated. Documentation taken from corresponding module.
236
     *
237
     * Grabs current page source code.
238
     *
239
     * @throws ModuleException if no page was opened.
240
     *
241
     * @return string Current page source code.
242
     * @see \Codeception\Module\WebDriver::grabPageSource()
243
     */
244
    public function grabPageSource() {
245
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabPageSource', func_get_args()));
246
    }
247
248
 
249
    /**
250
     * [!] Method is generated. Documentation taken from corresponding module.
251
     *
252
     * Open web page at the given absolute URL and sets its hostname as the base host.
253
     *
254
     * ``` php
255
     * <?php
256
     * $I->amOnUrl('http://codeception.com');
257
     * $I->amOnPage('/quickstart'); // moves to http://codeception.com/quickstart
258
     * ?>
259
     * ```
260
     * @see \Codeception\Module\WebDriver::amOnUrl()
261
     */
262
    public function amOnUrl($url) {
0 ignored issues
show
Unused Code introduced by
The parameter $url is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
263
        return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnUrl', func_get_args()));
264
    }
265
266
 
267
    /**
268
     * [!] Method is generated. Documentation taken from corresponding module.
269
     *
270
     * Opens the page for the given relative URI.
271
     *
272
     * ``` php
273
     * <?php
274
     * // opens front page
275
     * $I->amOnPage('/');
276
     * // opens /register page
277
     * $I->amOnPage('/register');
278
     * ```
279
     *
280
     * @param string $page
281
     * @see \Codeception\Module\WebDriver::amOnPage()
282
     */
283
    public function amOnPage($page) {
0 ignored issues
show
Unused Code introduced by
The parameter $page is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
284
        return $this->getScenario()->runStep(new \Codeception\Step\Condition('amOnPage', func_get_args()));
285
    }
286
287
 
288
    /**
289
     * [!] Method is generated. Documentation taken from corresponding module.
290
     *
291
     * Checks that the current page contains the given string (case insensitive).
292
     *
293
     * You can specify a specific HTML element (via CSS or XPath) as the second
294
     * parameter to only search within that element.
295
     *
296
     * ``` php
297
     * <?php
298
     * $I->see('Logout');                        // I can suppose user is logged in
299
     * $I->see('Sign Up', 'h1');                 // I can suppose it's a signup page
300
     * $I->see('Sign Up', '//body/h1');          // with XPath
301
     * $I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
302
     * ```
303
     *
304
     * Note that the search is done after stripping all HTML tags from the body,
305
     * so `$I->see('strong')` will return true for strings like:
306
     *
307
     *   - `<p>I am Stronger than thou</p>`
308
     *   - `<script>document.createElement('strong');</script>`
309
     *
310
     * But will *not* be true for strings like:
311
     *
312
     *   - `<strong>Home</strong>`
313
     *   - `<div class="strong">Home</strong>`
314
     *   - `<!-- strong -->`
315
     *
316
     * For checking the raw source code, use `seeInSource()`.
317
     *
318
     * @param string $text
319
     * @param string $selector optional
320
     * Conditional Assertion: Test won't be stopped on fail
321
     * @see \Codeception\Module\WebDriver::see()
322
     */
323
    public function canSee($text, $selector = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
324
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('see', func_get_args()));
325
    }
326
    /**
327
     * [!] Method is generated. Documentation taken from corresponding module.
328
     *
329
     * Checks that the current page contains the given string (case insensitive).
330
     *
331
     * You can specify a specific HTML element (via CSS or XPath) as the second
332
     * parameter to only search within that element.
333
     *
334
     * ``` php
335
     * <?php
336
     * $I->see('Logout');                        // I can suppose user is logged in
337
     * $I->see('Sign Up', 'h1');                 // I can suppose it's a signup page
338
     * $I->see('Sign Up', '//body/h1');          // with XPath
339
     * $I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
340
     * ```
341
     *
342
     * Note that the search is done after stripping all HTML tags from the body,
343
     * so `$I->see('strong')` will return true for strings like:
344
     *
345
     *   - `<p>I am Stronger than thou</p>`
346
     *   - `<script>document.createElement('strong');</script>`
347
     *
348
     * But will *not* be true for strings like:
349
     *
350
     *   - `<strong>Home</strong>`
351
     *   - `<div class="strong">Home</strong>`
352
     *   - `<!-- strong -->`
353
     *
354
     * For checking the raw source code, use `seeInSource()`.
355
     *
356
     * @param string $text
357
     * @param string $selector optional
358
     * @see \Codeception\Module\WebDriver::see()
359
     */
360
    public function see($text, $selector = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
361
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('see', func_get_args()));
362
    }
363
364
 
365
    /**
366
     * [!] Method is generated. Documentation taken from corresponding module.
367
     *
368
     * Checks that the current page doesn't contain the text specified (case insensitive).
369
     * Give a locator as the second parameter to match a specific region.
370
     *
371
     * ```php
372
     * <?php
373
     * $I->dontSee('Login');                         // I can suppose user is already logged in
374
     * $I->dontSee('Sign Up','h1');                  // I can suppose it's not a signup page
375
     * $I->dontSee('Sign Up','//body/h1');           // with XPath
376
     * $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
377
     * ```
378
     *
379
     * Note that the search is done after stripping all HTML tags from the body,
380
     * so `$I->dontSee('strong')` will fail on strings like:
381
     *
382
     *   - `<p>I am Stronger than thou</p>`
383
     *   - `<script>document.createElement('strong');</script>`
384
     *
385
     * But will ignore strings like:
386
     *
387
     *   - `<strong>Home</strong>`
388
     *   - `<div class="strong">Home</strong>`
389
     *   - `<!-- strong -->`
390
     *
391
     * For checking the raw source code, use `seeInSource()`.
392
     *
393
     * @param string $text
394
     * @param string $selector optional
395
     * Conditional Assertion: Test won't be stopped on fail
396
     * @see \Codeception\Module\WebDriver::dontSee()
397
     */
398
    public function cantSee($text, $selector = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
399
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSee', func_get_args()));
400
    }
401
    /**
402
     * [!] Method is generated. Documentation taken from corresponding module.
403
     *
404
     * Checks that the current page doesn't contain the text specified (case insensitive).
405
     * Give a locator as the second parameter to match a specific region.
406
     *
407
     * ```php
408
     * <?php
409
     * $I->dontSee('Login');                         // I can suppose user is already logged in
410
     * $I->dontSee('Sign Up','h1');                  // I can suppose it's not a signup page
411
     * $I->dontSee('Sign Up','//body/h1');           // with XPath
412
     * $I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
413
     * ```
414
     *
415
     * Note that the search is done after stripping all HTML tags from the body,
416
     * so `$I->dontSee('strong')` will fail on strings like:
417
     *
418
     *   - `<p>I am Stronger than thou</p>`
419
     *   - `<script>document.createElement('strong');</script>`
420
     *
421
     * But will ignore strings like:
422
     *
423
     *   - `<strong>Home</strong>`
424
     *   - `<div class="strong">Home</strong>`
425
     *   - `<!-- strong -->`
426
     *
427
     * For checking the raw source code, use `seeInSource()`.
428
     *
429
     * @param string $text
430
     * @param string $selector optional
431
     * @see \Codeception\Module\WebDriver::dontSee()
432
     */
433
    public function dontSee($text, $selector = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
434
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSee', func_get_args()));
435
    }
436
437
 
438
    /**
439
     * [!] Method is generated. Documentation taken from corresponding module.
440
     *
441
     * Checks that the current page contains the given string in its
442
     * raw source code.
443
     *
444
     * ``` php
445
     * <?php
446
     * $I->seeInSource('<h1>Green eggs &amp; ham</h1>');
447
     * ```
448
     *
449
     * @param      $raw
450
     * Conditional Assertion: Test won't be stopped on fail
451
     * @see \Codeception\Module\WebDriver::seeInSource()
452
     */
453
    public function canSeeInSource($raw) {
0 ignored issues
show
Unused Code introduced by
The parameter $raw is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
454
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInSource', func_get_args()));
455
    }
456
    /**
457
     * [!] Method is generated. Documentation taken from corresponding module.
458
     *
459
     * Checks that the current page contains the given string in its
460
     * raw source code.
461
     *
462
     * ``` php
463
     * <?php
464
     * $I->seeInSource('<h1>Green eggs &amp; ham</h1>');
465
     * ```
466
     *
467
     * @param      $raw
468
     * @see \Codeception\Module\WebDriver::seeInSource()
469
     */
470
    public function seeInSource($raw) {
0 ignored issues
show
Unused Code introduced by
The parameter $raw is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
471
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInSource', func_get_args()));
472
    }
473
474
 
475
    /**
476
     * [!] Method is generated. Documentation taken from corresponding module.
477
     *
478
     * Checks that the current page contains the given string in its
479
     * raw source code.
480
     *
481
     * ```php
482
     * <?php
483
     * $I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
484
     * ```
485
     *
486
     * @param      $raw
487
     * Conditional Assertion: Test won't be stopped on fail
488
     * @see \Codeception\Module\WebDriver::dontSeeInSource()
489
     */
490
    public function cantSeeInSource($raw) {
0 ignored issues
show
Unused Code introduced by
The parameter $raw is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
491
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInSource', func_get_args()));
492
    }
493
    /**
494
     * [!] Method is generated. Documentation taken from corresponding module.
495
     *
496
     * Checks that the current page contains the given string in its
497
     * raw source code.
498
     *
499
     * ```php
500
     * <?php
501
     * $I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');
502
     * ```
503
     *
504
     * @param      $raw
505
     * @see \Codeception\Module\WebDriver::dontSeeInSource()
506
     */
507
    public function dontSeeInSource($raw) {
0 ignored issues
show
Unused Code introduced by
The parameter $raw is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
508
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInSource', func_get_args()));
509
    }
510
511
 
512
    /**
513
     * [!] Method is generated. Documentation taken from corresponding module.
514
     *
515
     * Checks that the page source contains the given string.
516
     *
517
     * ```php
518
     * <?php
519
     * $I->seeInPageSource('<link rel="apple-touch-icon"');
520
     * ```
521
     *
522
     * @param $text
523
     * Conditional Assertion: Test won't be stopped on fail
524
     * @see \Codeception\Module\WebDriver::seeInPageSource()
525
     */
526
    public function canSeeInPageSource($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
527
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInPageSource', func_get_args()));
528
    }
529
    /**
530
     * [!] Method is generated. Documentation taken from corresponding module.
531
     *
532
     * Checks that the page source contains the given string.
533
     *
534
     * ```php
535
     * <?php
536
     * $I->seeInPageSource('<link rel="apple-touch-icon"');
537
     * ```
538
     *
539
     * @param $text
540
     * @see \Codeception\Module\WebDriver::seeInPageSource()
541
     */
542
    public function seeInPageSource($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
543
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInPageSource', func_get_args()));
544
    }
545
546
 
547
    /**
548
     * [!] Method is generated. Documentation taken from corresponding module.
549
     *
550
     * Checks that the page source doesn't contain the given string.
551
     *
552
     * @param $text
553
     * Conditional Assertion: Test won't be stopped on fail
554
     * @see \Codeception\Module\WebDriver::dontSeeInPageSource()
555
     */
556
    public function cantSeeInPageSource($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
557
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInPageSource', func_get_args()));
558
    }
559
    /**
560
     * [!] Method is generated. Documentation taken from corresponding module.
561
     *
562
     * Checks that the page source doesn't contain the given string.
563
     *
564
     * @param $text
565
     * @see \Codeception\Module\WebDriver::dontSeeInPageSource()
566
     */
567
    public function dontSeeInPageSource($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
568
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInPageSource', func_get_args()));
569
    }
570
571
 
572
    /**
573
     * [!] Method is generated. Documentation taken from corresponding module.
574
     *
575
     * Perform a click on a link or a button, given by a locator.
576
     * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
577
     * For buttons, the "value" attribute, "name" attribute, and inner text are searched.
578
     * For links, the link text is searched.
579
     * For images, the "alt" attribute and inner text of any parent links are searched.
580
     *
581
     * The second parameter is a context (CSS or XPath locator) to narrow the search.
582
     *
583
     * Note that if the locator matches a button of type `submit`, the form will be submitted.
584
     *
585
     * ``` php
586
     * <?php
587
     * // simple link
588
     * $I->click('Logout');
589
     * // button of form
590
     * $I->click('Submit');
591
     * // CSS button
592
     * $I->click('#form input[type=submit]');
593
     * // XPath
594
     * $I->click('//form/*[@type=submit]');
595
     * // link in context
596
     * $I->click('Logout', '#nav');
597
     * // using strict locator
598
     * $I->click(['link' => 'Login']);
599
     * ?>
600
     * ```
601
     *
602
     * @param $link
603
     * @param $context
604
     * @see \Codeception\Module\WebDriver::click()
605
     */
606
    public function click($link, $context = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $link is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $context is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
607
        return $this->getScenario()->runStep(new \Codeception\Step\Action('click', func_get_args()));
608
    }
609
610
 
611
    /**
612
     * [!] Method is generated. Documentation taken from corresponding module.
613
     *
614
     * Checks that there's a link with the specified text.
615
     * Give a full URL as the second parameter to match links with that exact URL.
616
     *
617
     * ``` php
618
     * <?php
619
     * $I->seeLink('Logout'); // matches <a href="#">Logout</a>
620
     * $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
621
     * ?>
622
     * ```
623
     *
624
     * @param string $text
625
     * @param string $url optional
626
     * Conditional Assertion: Test won't be stopped on fail
627
     * @see \Codeception\Module\WebDriver::seeLink()
628
     */
629
    public function canSeeLink($text, $url = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $url is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
630
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeLink', func_get_args()));
631
    }
632
    /**
633
     * [!] Method is generated. Documentation taken from corresponding module.
634
     *
635
     * Checks that there's a link with the specified text.
636
     * Give a full URL as the second parameter to match links with that exact URL.
637
     *
638
     * ``` php
639
     * <?php
640
     * $I->seeLink('Logout'); // matches <a href="#">Logout</a>
641
     * $I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
642
     * ?>
643
     * ```
644
     *
645
     * @param string $text
646
     * @param string $url optional
647
     * @see \Codeception\Module\WebDriver::seeLink()
648
     */
649
    public function seeLink($text, $url = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $url is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
650
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeLink', func_get_args()));
651
    }
652
653
 
654
    /**
655
     * [!] Method is generated. Documentation taken from corresponding module.
656
     *
657
     * Checks that the page doesn't contain a link with the given string.
658
     * If the second parameter is given, only links with a matching "href" attribute will be checked.
659
     *
660
     * ``` php
661
     * <?php
662
     * $I->dontSeeLink('Logout'); // I suppose user is not logged in
663
     * $I->dontSeeLink('Checkout now', '/store/cart.php');
664
     * ?>
665
     * ```
666
     *
667
     * @param string $text
668
     * @param string $url optional
669
     * Conditional Assertion: Test won't be stopped on fail
670
     * @see \Codeception\Module\WebDriver::dontSeeLink()
671
     */
672
    public function cantSeeLink($text, $url = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $url is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
673
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeLink', func_get_args()));
674
    }
675
    /**
676
     * [!] Method is generated. Documentation taken from corresponding module.
677
     *
678
     * Checks that the page doesn't contain a link with the given string.
679
     * If the second parameter is given, only links with a matching "href" attribute will be checked.
680
     *
681
     * ``` php
682
     * <?php
683
     * $I->dontSeeLink('Logout'); // I suppose user is not logged in
684
     * $I->dontSeeLink('Checkout now', '/store/cart.php');
685
     * ?>
686
     * ```
687
     *
688
     * @param string $text
689
     * @param string $url optional
690
     * @see \Codeception\Module\WebDriver::dontSeeLink()
691
     */
692
    public function dontSeeLink($text, $url = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $url is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
693
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeLink', func_get_args()));
694
    }
695
696
 
697
    /**
698
     * [!] Method is generated. Documentation taken from corresponding module.
699
     *
700
     * Checks that current URI contains the given string.
701
     *
702
     * ``` php
703
     * <?php
704
     * // to match: /home/dashboard
705
     * $I->seeInCurrentUrl('home');
706
     * // to match: /users/1
707
     * $I->seeInCurrentUrl('/users/');
708
     * ?>
709
     * ```
710
     *
711
     * @param string $uri
712
     * Conditional Assertion: Test won't be stopped on fail
713
     * @see \Codeception\Module\WebDriver::seeInCurrentUrl()
714
     */
715
    public function canSeeInCurrentUrl($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
716
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInCurrentUrl', func_get_args()));
717
    }
718
    /**
719
     * [!] Method is generated. Documentation taken from corresponding module.
720
     *
721
     * Checks that current URI contains the given string.
722
     *
723
     * ``` php
724
     * <?php
725
     * // to match: /home/dashboard
726
     * $I->seeInCurrentUrl('home');
727
     * // to match: /users/1
728
     * $I->seeInCurrentUrl('/users/');
729
     * ?>
730
     * ```
731
     *
732
     * @param string $uri
733
     * @see \Codeception\Module\WebDriver::seeInCurrentUrl()
734
     */
735
    public function seeInCurrentUrl($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
736
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInCurrentUrl', func_get_args()));
737
    }
738
739
 
740
    /**
741
     * [!] Method is generated. Documentation taken from corresponding module.
742
     *
743
     * Checks that the current URL is equal to the given string.
744
     * Unlike `seeInCurrentUrl`, this only matches the full URL.
745
     *
746
     * ``` php
747
     * <?php
748
     * // to match root url
749
     * $I->seeCurrentUrlEquals('/');
750
     * ?>
751
     * ```
752
     *
753
     * @param string $uri
754
     * Conditional Assertion: Test won't be stopped on fail
755
     * @see \Codeception\Module\WebDriver::seeCurrentUrlEquals()
756
     */
757
    public function canSeeCurrentUrlEquals($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
758
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlEquals', func_get_args()));
759
    }
760
    /**
761
     * [!] Method is generated. Documentation taken from corresponding module.
762
     *
763
     * Checks that the current URL is equal to the given string.
764
     * Unlike `seeInCurrentUrl`, this only matches the full URL.
765
     *
766
     * ``` php
767
     * <?php
768
     * // to match root url
769
     * $I->seeCurrentUrlEquals('/');
770
     * ?>
771
     * ```
772
     *
773
     * @param string $uri
774
     * @see \Codeception\Module\WebDriver::seeCurrentUrlEquals()
775
     */
776
    public function seeCurrentUrlEquals($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
777
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlEquals', func_get_args()));
778
    }
779
780
 
781
    /**
782
     * [!] Method is generated. Documentation taken from corresponding module.
783
     *
784
     * Checks that the current URL matches the given regular expression.
785
     *
786
     * ``` php
787
     * <?php
788
     * // to match root url
789
     * $I->seeCurrentUrlMatches('~^/users/(\d+)~');
790
     * ?>
791
     * ```
792
     *
793
     * @param string $uri
794
     * Conditional Assertion: Test won't be stopped on fail
795
     * @see \Codeception\Module\WebDriver::seeCurrentUrlMatches()
796
     */
797
    public function canSeeCurrentUrlMatches($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
798
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCurrentUrlMatches', func_get_args()));
799
    }
800
    /**
801
     * [!] Method is generated. Documentation taken from corresponding module.
802
     *
803
     * Checks that the current URL matches the given regular expression.
804
     *
805
     * ``` php
806
     * <?php
807
     * // to match root url
808
     * $I->seeCurrentUrlMatches('~^/users/(\d+)~');
809
     * ?>
810
     * ```
811
     *
812
     * @param string $uri
813
     * @see \Codeception\Module\WebDriver::seeCurrentUrlMatches()
814
     */
815
    public function seeCurrentUrlMatches($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
816
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCurrentUrlMatches', func_get_args()));
817
    }
818
819
 
820
    /**
821
     * [!] Method is generated. Documentation taken from corresponding module.
822
     *
823
     * Checks that the current URI doesn't contain the given string.
824
     *
825
     * ``` php
826
     * <?php
827
     * $I->dontSeeInCurrentUrl('/users/');
828
     * ?>
829
     * ```
830
     *
831
     * @param string $uri
832
     * Conditional Assertion: Test won't be stopped on fail
833
     * @see \Codeception\Module\WebDriver::dontSeeInCurrentUrl()
834
     */
835
    public function cantSeeInCurrentUrl($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
836
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInCurrentUrl', func_get_args()));
837
    }
838
    /**
839
     * [!] Method is generated. Documentation taken from corresponding module.
840
     *
841
     * Checks that the current URI doesn't contain the given string.
842
     *
843
     * ``` php
844
     * <?php
845
     * $I->dontSeeInCurrentUrl('/users/');
846
     * ?>
847
     * ```
848
     *
849
     * @param string $uri
850
     * @see \Codeception\Module\WebDriver::dontSeeInCurrentUrl()
851
     */
852
    public function dontSeeInCurrentUrl($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
853
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInCurrentUrl', func_get_args()));
854
    }
855
856
 
857
    /**
858
     * [!] Method is generated. Documentation taken from corresponding module.
859
     *
860
     * Checks that the current URL doesn't equal the given string.
861
     * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
862
     *
863
     * ``` php
864
     * <?php
865
     * // current url is not root
866
     * $I->dontSeeCurrentUrlEquals('/');
867
     * ?>
868
     * ```
869
     *
870
     * @param string $uri
871
     * Conditional Assertion: Test won't be stopped on fail
872
     * @see \Codeception\Module\WebDriver::dontSeeCurrentUrlEquals()
873
     */
874
    public function cantSeeCurrentUrlEquals($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
875
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlEquals', func_get_args()));
876
    }
877
    /**
878
     * [!] Method is generated. Documentation taken from corresponding module.
879
     *
880
     * Checks that the current URL doesn't equal the given string.
881
     * Unlike `dontSeeInCurrentUrl`, this only matches the full URL.
882
     *
883
     * ``` php
884
     * <?php
885
     * // current url is not root
886
     * $I->dontSeeCurrentUrlEquals('/');
887
     * ?>
888
     * ```
889
     *
890
     * @param string $uri
891
     * @see \Codeception\Module\WebDriver::dontSeeCurrentUrlEquals()
892
     */
893
    public function dontSeeCurrentUrlEquals($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
894
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlEquals', func_get_args()));
895
    }
896
897
 
898
    /**
899
     * [!] Method is generated. Documentation taken from corresponding module.
900
     *
901
     * Checks that current url doesn't match the given regular expression.
902
     *
903
     * ``` php
904
     * <?php
905
     * // to match root url
906
     * $I->dontSeeCurrentUrlMatches('~^/users/(\d+)~');
907
     * ?>
908
     * ```
909
     *
910
     * @param string $uri
911
     * Conditional Assertion: Test won't be stopped on fail
912
     * @see \Codeception\Module\WebDriver::dontSeeCurrentUrlMatches()
913
     */
914
    public function cantSeeCurrentUrlMatches($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
915
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCurrentUrlMatches', func_get_args()));
916
    }
917
    /**
918
     * [!] Method is generated. Documentation taken from corresponding module.
919
     *
920
     * Checks that current url doesn't match the given regular expression.
921
     *
922
     * ``` php
923
     * <?php
924
     * // to match root url
925
     * $I->dontSeeCurrentUrlMatches('~^/users/(\d+)~');
926
     * ?>
927
     * ```
928
     *
929
     * @param string $uri
930
     * @see \Codeception\Module\WebDriver::dontSeeCurrentUrlMatches()
931
     */
932
    public function dontSeeCurrentUrlMatches($uri) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
933
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCurrentUrlMatches', func_get_args()));
934
    }
935
936
 
937
    /**
938
     * [!] Method is generated. Documentation taken from corresponding module.
939
     *
940
     * Executes the given regular expression against the current URI and returns the first capturing group.
941
     * If no parameters are provided, the full URI is returned.
942
     *
943
     * ``` php
944
     * <?php
945
     * $user_id = $I->grabFromCurrentUrl('~^/user/(\d+)/~');
946
     * $uri = $I->grabFromCurrentUrl();
947
     * ?>
948
     * ```
949
     *
950
     * @param string $uri optional
951
     *
952
     * @return mixed
953
     * @see \Codeception\Module\WebDriver::grabFromCurrentUrl()
954
     */
955
    public function grabFromCurrentUrl($uri = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $uri is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
956
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabFromCurrentUrl', func_get_args()));
957
    }
958
959
 
960
    /**
961
     * [!] Method is generated. Documentation taken from corresponding module.
962
     *
963
     * Checks that the specified checkbox is checked.
964
     *
965
     * ``` php
966
     * <?php
967
     * $I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
968
     * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
969
     * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
970
     * ?>
971
     * ```
972
     *
973
     * @param $checkbox
974
     * Conditional Assertion: Test won't be stopped on fail
975
     * @see \Codeception\Module\WebDriver::seeCheckboxIsChecked()
976
     */
977
    public function canSeeCheckboxIsChecked($checkbox) {
0 ignored issues
show
Unused Code introduced by
The parameter $checkbox is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
978
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeCheckboxIsChecked', func_get_args()));
979
    }
980
    /**
981
     * [!] Method is generated. Documentation taken from corresponding module.
982
     *
983
     * Checks that the specified checkbox is checked.
984
     *
985
     * ``` php
986
     * <?php
987
     * $I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
988
     * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
989
     * $I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
990
     * ?>
991
     * ```
992
     *
993
     * @param $checkbox
994
     * @see \Codeception\Module\WebDriver::seeCheckboxIsChecked()
995
     */
996
    public function seeCheckboxIsChecked($checkbox) {
0 ignored issues
show
Unused Code introduced by
The parameter $checkbox is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
997
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeCheckboxIsChecked', func_get_args()));
998
    }
999
1000
 
1001
    /**
1002
     * [!] Method is generated. Documentation taken from corresponding module.
1003
     *
1004
     * Check that the specified checkbox is unchecked.
1005
     *
1006
     * ``` php
1007
     * <?php
1008
     * $I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
1009
     * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
1010
     * ?>
1011
     * ```
1012
     *
1013
     * @param $checkbox
1014
     * Conditional Assertion: Test won't be stopped on fail
1015
     * @see \Codeception\Module\WebDriver::dontSeeCheckboxIsChecked()
1016
     */
1017
    public function cantSeeCheckboxIsChecked($checkbox) {
0 ignored issues
show
Unused Code introduced by
The parameter $checkbox is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1018
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeCheckboxIsChecked', func_get_args()));
1019
    }
1020
    /**
1021
     * [!] Method is generated. Documentation taken from corresponding module.
1022
     *
1023
     * Check that the specified checkbox is unchecked.
1024
     *
1025
     * ``` php
1026
     * <?php
1027
     * $I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
1028
     * $I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
1029
     * ?>
1030
     * ```
1031
     *
1032
     * @param $checkbox
1033
     * @see \Codeception\Module\WebDriver::dontSeeCheckboxIsChecked()
1034
     */
1035
    public function dontSeeCheckboxIsChecked($checkbox) {
0 ignored issues
show
Unused Code introduced by
The parameter $checkbox is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1036
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeCheckboxIsChecked', func_get_args()));
1037
    }
1038
1039
 
1040
    /**
1041
     * [!] Method is generated. Documentation taken from corresponding module.
1042
     *
1043
     * Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.
1044
     * Fields are matched by label text, the "name" attribute, CSS, or XPath.
1045
     *
1046
     * ``` php
1047
     * <?php
1048
     * $I->seeInField('Body','Type your comment here');
1049
     * $I->seeInField('form textarea[name=body]','Type your comment here');
1050
     * $I->seeInField('form input[type=hidden]','hidden_value');
1051
     * $I->seeInField('#searchform input','Search');
1052
     * $I->seeInField('//form/*[@name=search]','Search');
1053
     * $I->seeInField(['name' => 'search'], 'Search');
1054
     * ?>
1055
     * ```
1056
     *
1057
     * @param $field
1058
     * @param $value
1059
     * Conditional Assertion: Test won't be stopped on fail
1060
     * @see \Codeception\Module\WebDriver::seeInField()
1061
     */
1062
    public function canSeeInField($field, $value) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1063
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInField', func_get_args()));
1064
    }
1065
    /**
1066
     * [!] Method is generated. Documentation taken from corresponding module.
1067
     *
1068
     * Checks that the given input field or textarea *equals* (i.e. not just contains) the given value.
1069
     * Fields are matched by label text, the "name" attribute, CSS, or XPath.
1070
     *
1071
     * ``` php
1072
     * <?php
1073
     * $I->seeInField('Body','Type your comment here');
1074
     * $I->seeInField('form textarea[name=body]','Type your comment here');
1075
     * $I->seeInField('form input[type=hidden]','hidden_value');
1076
     * $I->seeInField('#searchform input','Search');
1077
     * $I->seeInField('//form/*[@name=search]','Search');
1078
     * $I->seeInField(['name' => 'search'], 'Search');
1079
     * ?>
1080
     * ```
1081
     *
1082
     * @param $field
1083
     * @param $value
1084
     * @see \Codeception\Module\WebDriver::seeInField()
1085
     */
1086
    public function seeInField($field, $value) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1087
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInField', func_get_args()));
1088
    }
1089
1090
 
1091
    /**
1092
     * [!] Method is generated. Documentation taken from corresponding module.
1093
     *
1094
     * Checks that an input field or textarea doesn't contain the given value.
1095
     * For fuzzy locators, the field is matched by label text, CSS and XPath.
1096
     *
1097
     * ``` php
1098
     * <?php
1099
     * $I->dontSeeInField('Body','Type your comment here');
1100
     * $I->dontSeeInField('form textarea[name=body]','Type your comment here');
1101
     * $I->dontSeeInField('form input[type=hidden]','hidden_value');
1102
     * $I->dontSeeInField('#searchform input','Search');
1103
     * $I->dontSeeInField('//form/*[@name=search]','Search');
1104
     * $I->dontSeeInField(['name' => 'search'], 'Search');
1105
     * ?>
1106
     * ```
1107
     *
1108
     * @param $field
1109
     * @param $value
1110
     * Conditional Assertion: Test won't be stopped on fail
1111
     * @see \Codeception\Module\WebDriver::dontSeeInField()
1112
     */
1113
    public function cantSeeInField($field, $value) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1114
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInField', func_get_args()));
1115
    }
1116
    /**
1117
     * [!] Method is generated. Documentation taken from corresponding module.
1118
     *
1119
     * Checks that an input field or textarea doesn't contain the given value.
1120
     * For fuzzy locators, the field is matched by label text, CSS and XPath.
1121
     *
1122
     * ``` php
1123
     * <?php
1124
     * $I->dontSeeInField('Body','Type your comment here');
1125
     * $I->dontSeeInField('form textarea[name=body]','Type your comment here');
1126
     * $I->dontSeeInField('form input[type=hidden]','hidden_value');
1127
     * $I->dontSeeInField('#searchform input','Search');
1128
     * $I->dontSeeInField('//form/*[@name=search]','Search');
1129
     * $I->dontSeeInField(['name' => 'search'], 'Search');
1130
     * ?>
1131
     * ```
1132
     *
1133
     * @param $field
1134
     * @param $value
1135
     * @see \Codeception\Module\WebDriver::dontSeeInField()
1136
     */
1137
    public function dontSeeInField($field, $value) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1138
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInField', func_get_args()));
1139
    }
1140
1141
 
1142
    /**
1143
     * [!] Method is generated. Documentation taken from corresponding module.
1144
     *
1145
     * Checks if the array of form parameters (name => value) are set on the form matched with the
1146
     * passed selector.
1147
     *
1148
     * ``` php
1149
     * <?php
1150
     * $I->seeInFormFields('form[name=myform]', [
1151
     *      'input1' => 'value',
1152
     *      'input2' => 'other value',
1153
     * ]);
1154
     * ?>
1155
     * ```
1156
     *
1157
     * For multi-select elements, or to check values of multiple elements with the same name, an
1158
     * array may be passed:
1159
     *
1160
     * ``` php
1161
     * <?php
1162
     * $I->seeInFormFields('.form-class', [
1163
     *      'multiselect' => [
1164
     *          'value1',
1165
     *          'value2',
1166
     *      ],
1167
     *      'checkbox[]' => [
1168
     *          'a checked value',
1169
     *          'another checked value',
1170
     *      ],
1171
     * ]);
1172
     * ?>
1173
     * ```
1174
     *
1175
     * Additionally, checkbox values can be checked with a boolean.
1176
     *
1177
     * ``` php
1178
     * <?php
1179
     * $I->seeInFormFields('#form-id', [
1180
     *      'checkbox1' => true,        // passes if checked
1181
     *      'checkbox2' => false,       // passes if unchecked
1182
     * ]);
1183
     * ?>
1184
     * ```
1185
     *
1186
     * Pair this with submitForm for quick testing magic.
1187
     *
1188
     * ``` php
1189
     * <?php
1190
     * $form = [
1191
     *      'field1' => 'value',
1192
     *      'field2' => 'another value',
1193
     *      'checkbox1' => true,
1194
     *      // ...
1195
     * ];
1196
     * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1197
     * // $I->amOnPage('/path/to/form-page') may be needed
1198
     * $I->seeInFormFields('//form[@id=my-form]', $form);
1199
     * ?>
1200
     * ```
1201
     *
1202
     * @param $formSelector
1203
     * @param $params
1204
     * Conditional Assertion: Test won't be stopped on fail
1205
     * @see \Codeception\Module\WebDriver::seeInFormFields()
1206
     */
1207
    public function canSeeInFormFields($formSelector, $params) {
0 ignored issues
show
Unused Code introduced by
The parameter $formSelector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1208
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInFormFields', func_get_args()));
1209
    }
1210
    /**
1211
     * [!] Method is generated. Documentation taken from corresponding module.
1212
     *
1213
     * Checks if the array of form parameters (name => value) are set on the form matched with the
1214
     * passed selector.
1215
     *
1216
     * ``` php
1217
     * <?php
1218
     * $I->seeInFormFields('form[name=myform]', [
1219
     *      'input1' => 'value',
1220
     *      'input2' => 'other value',
1221
     * ]);
1222
     * ?>
1223
     * ```
1224
     *
1225
     * For multi-select elements, or to check values of multiple elements with the same name, an
1226
     * array may be passed:
1227
     *
1228
     * ``` php
1229
     * <?php
1230
     * $I->seeInFormFields('.form-class', [
1231
     *      'multiselect' => [
1232
     *          'value1',
1233
     *          'value2',
1234
     *      ],
1235
     *      'checkbox[]' => [
1236
     *          'a checked value',
1237
     *          'another checked value',
1238
     *      ],
1239
     * ]);
1240
     * ?>
1241
     * ```
1242
     *
1243
     * Additionally, checkbox values can be checked with a boolean.
1244
     *
1245
     * ``` php
1246
     * <?php
1247
     * $I->seeInFormFields('#form-id', [
1248
     *      'checkbox1' => true,        // passes if checked
1249
     *      'checkbox2' => false,       // passes if unchecked
1250
     * ]);
1251
     * ?>
1252
     * ```
1253
     *
1254
     * Pair this with submitForm for quick testing magic.
1255
     *
1256
     * ``` php
1257
     * <?php
1258
     * $form = [
1259
     *      'field1' => 'value',
1260
     *      'field2' => 'another value',
1261
     *      'checkbox1' => true,
1262
     *      // ...
1263
     * ];
1264
     * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
1265
     * // $I->amOnPage('/path/to/form-page') may be needed
1266
     * $I->seeInFormFields('//form[@id=my-form]', $form);
1267
     * ?>
1268
     * ```
1269
     *
1270
     * @param $formSelector
1271
     * @param $params
1272
     * @see \Codeception\Module\WebDriver::seeInFormFields()
1273
     */
1274
    public function seeInFormFields($formSelector, $params) {
0 ignored issues
show
Unused Code introduced by
The parameter $formSelector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1275
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInFormFields', func_get_args()));
1276
    }
1277
1278
 
1279
    /**
1280
     * [!] Method is generated. Documentation taken from corresponding module.
1281
     *
1282
     * Checks if the array of form parameters (name => value) are not set on the form matched with
1283
     * the passed selector.
1284
     *
1285
     * ``` php
1286
     * <?php
1287
     * $I->dontSeeInFormFields('form[name=myform]', [
1288
     *      'input1' => 'non-existent value',
1289
     *      'input2' => 'other non-existent value',
1290
     * ]);
1291
     * ?>
1292
     * ```
1293
     *
1294
     * To check that an element hasn't been assigned any one of many values, an array can be passed
1295
     * as the value:
1296
     *
1297
     * ``` php
1298
     * <?php
1299
     * $I->dontSeeInFormFields('.form-class', [
1300
     *      'fieldName' => [
1301
     *          'This value shouldn\'t be set',
1302
     *          'And this value shouldn\'t be set',
1303
     *      ],
1304
     * ]);
1305
     * ?>
1306
     * ```
1307
     *
1308
     * Additionally, checkbox values can be checked with a boolean.
1309
     *
1310
     * ``` php
1311
     * <?php
1312
     * $I->dontSeeInFormFields('#form-id', [
1313
     *      'checkbox1' => true,        // fails if checked
1314
     *      'checkbox2' => false,       // fails if unchecked
1315
     * ]);
1316
     * ?>
1317
     * ```
1318
     *
1319
     * @param $formSelector
1320
     * @param $params
1321
     * Conditional Assertion: Test won't be stopped on fail
1322
     * @see \Codeception\Module\WebDriver::dontSeeInFormFields()
1323
     */
1324
    public function cantSeeInFormFields($formSelector, $params) {
0 ignored issues
show
Unused Code introduced by
The parameter $formSelector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1325
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInFormFields', func_get_args()));
1326
    }
1327
    /**
1328
     * [!] Method is generated. Documentation taken from corresponding module.
1329
     *
1330
     * Checks if the array of form parameters (name => value) are not set on the form matched with
1331
     * the passed selector.
1332
     *
1333
     * ``` php
1334
     * <?php
1335
     * $I->dontSeeInFormFields('form[name=myform]', [
1336
     *      'input1' => 'non-existent value',
1337
     *      'input2' => 'other non-existent value',
1338
     * ]);
1339
     * ?>
1340
     * ```
1341
     *
1342
     * To check that an element hasn't been assigned any one of many values, an array can be passed
1343
     * as the value:
1344
     *
1345
     * ``` php
1346
     * <?php
1347
     * $I->dontSeeInFormFields('.form-class', [
1348
     *      'fieldName' => [
1349
     *          'This value shouldn\'t be set',
1350
     *          'And this value shouldn\'t be set',
1351
     *      ],
1352
     * ]);
1353
     * ?>
1354
     * ```
1355
     *
1356
     * Additionally, checkbox values can be checked with a boolean.
1357
     *
1358
     * ``` php
1359
     * <?php
1360
     * $I->dontSeeInFormFields('#form-id', [
1361
     *      'checkbox1' => true,        // fails if checked
1362
     *      'checkbox2' => false,       // fails if unchecked
1363
     * ]);
1364
     * ?>
1365
     * ```
1366
     *
1367
     * @param $formSelector
1368
     * @param $params
1369
     * @see \Codeception\Module\WebDriver::dontSeeInFormFields()
1370
     */
1371
    public function dontSeeInFormFields($formSelector, $params) {
0 ignored issues
show
Unused Code introduced by
The parameter $formSelector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1372
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInFormFields', func_get_args()));
1373
    }
1374
1375
 
1376
    /**
1377
     * [!] Method is generated. Documentation taken from corresponding module.
1378
     *
1379
     * Selects an option in a select tag or in radio button group.
1380
     *
1381
     * ``` php
1382
     * <?php
1383
     * $I->selectOption('form select[name=account]', 'Premium');
1384
     * $I->selectOption('form input[name=payment]', 'Monthly');
1385
     * $I->selectOption('//form/select[@name=account]', 'Monthly');
1386
     * ?>
1387
     * ```
1388
     *
1389
     * Provide an array for the second argument to select multiple options:
1390
     *
1391
     * ``` php
1392
     * <?php
1393
     * $I->selectOption('Which OS do you use?', array('Windows','Linux'));
1394
     * ?>
1395
     * ```
1396
     *
1397
     * Or provide an associative array for the second argument to specifically define which selection method should be used:
1398
     *
1399
     * ``` php
1400
     * <?php
1401
     * $I->selectOption('Which OS do you use?', array('text' => 'Windows')); // Only search by text 'Windows'
1402
     * $I->selectOption('Which OS do you use?', array('value' => 'windows')); // Only search by value 'windows'
1403
     * ?>
1404
     * ```
1405
     *
1406
     * @param $select
1407
     * @param $option
1408
     * @see \Codeception\Module\WebDriver::selectOption()
1409
     */
1410
    public function selectOption($select, $option) {
0 ignored issues
show
Unused Code introduced by
The parameter $select is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1411
        return $this->getScenario()->runStep(new \Codeception\Step\Action('selectOption', func_get_args()));
1412
    }
1413
1414
 
1415
    /**
1416
     * [!] Method is generated. Documentation taken from corresponding module.
1417
     *
1418
     * Unselect an option in the given select box.
1419
     *
1420
     * @param $select
1421
     * @param $option
1422
     * @see \Codeception\Module\WebDriver::unselectOption()
1423
     */
1424
    public function unselectOption($select, $option) {
0 ignored issues
show
Unused Code introduced by
The parameter $select is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1425
        return $this->getScenario()->runStep(new \Codeception\Step\Action('unselectOption', func_get_args()));
1426
    }
1427
1428
 
1429
    /**
1430
     * [!] Method is generated. Documentation taken from corresponding module.
1431
     *
1432
     * Ticks a checkbox. For radio buttons, use the `selectOption` method instead.
1433
     *
1434
     * ``` php
1435
     * <?php
1436
     * $I->checkOption('#agree');
1437
     * ?>
1438
     * ```
1439
     *
1440
     * @param $option
1441
     * @see \Codeception\Module\WebDriver::checkOption()
1442
     */
1443
    public function checkOption($option) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1444
        return $this->getScenario()->runStep(new \Codeception\Step\Action('checkOption', func_get_args()));
1445
    }
1446
1447
 
1448
    /**
1449
     * [!] Method is generated. Documentation taken from corresponding module.
1450
     *
1451
     * Unticks a checkbox.
1452
     *
1453
     * ``` php
1454
     * <?php
1455
     * $I->uncheckOption('#notify');
1456
     * ?>
1457
     * ```
1458
     *
1459
     * @param $option
1460
     * @see \Codeception\Module\WebDriver::uncheckOption()
1461
     */
1462
    public function uncheckOption($option) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1463
        return $this->getScenario()->runStep(new \Codeception\Step\Action('uncheckOption', func_get_args()));
1464
    }
1465
1466
 
1467
    /**
1468
     * [!] Method is generated. Documentation taken from corresponding module.
1469
     *
1470
     * Fills a text field or textarea with the given string.
1471
     *
1472
     * ``` php
1473
     * <?php
1474
     * $I->fillField("//input[@type='text']", "Hello World!");
1475
     * $I->fillField(['name' => 'email'], '[email protected]');
1476
     * ?>
1477
     * ```
1478
     *
1479
     * @param $field
1480
     * @param $value
1481
     * @see \Codeception\Module\WebDriver::fillField()
1482
     */
1483
    public function fillField($field, $value) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1484
        return $this->getScenario()->runStep(new \Codeception\Step\Action('fillField', func_get_args()));
1485
    }
1486
1487
 
1488
    /**
1489
     * [!] Method is generated. Documentation taken from corresponding module.
1490
     *
1491
     * Clears given field which isn't empty.
1492
     *
1493
     * ``` php
1494
     * <?php
1495
     * $I->clearField('#username');
1496
     * ```
1497
     *
1498
     * @param $field
1499
     * @see \Codeception\Module\WebDriver::clearField()
1500
     */
1501
    public function clearField($field) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1502
        return $this->getScenario()->runStep(new \Codeception\Step\Action('clearField', func_get_args()));
1503
    }
1504
1505
 
1506
    /**
1507
     * [!] Method is generated. Documentation taken from corresponding module.
1508
     *
1509
     * Attaches a file relative to the Codeception `_data` directory to the given file upload field.
1510
     *
1511
     * ``` php
1512
     * <?php
1513
     * // file is stored in 'tests/_data/prices.xls'
1514
     * $I->attachFile('input[@type="file"]', 'prices.xls');
1515
     * ?>
1516
     * ```
1517
     *
1518
     * @param $field
1519
     * @param $filename
1520
     * @see \Codeception\Module\WebDriver::attachFile()
1521
     */
1522
    public function attachFile($field, $filename) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $filename is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1523
        return $this->getScenario()->runStep(new \Codeception\Step\Action('attachFile', func_get_args()));
1524
    }
1525
1526
 
1527
    /**
1528
     * [!] Method is generated. Documentation taken from corresponding module.
1529
     *
1530
     * Finds and returns the text contents of the given element.
1531
     * If a fuzzy locator is used, the element is found using CSS, XPath,
1532
     * and by matching the full page source by regular expression.
1533
     *
1534
     * ``` php
1535
     * <?php
1536
     * $heading = $I->grabTextFrom('h1');
1537
     * $heading = $I->grabTextFrom('descendant-or-self::h1');
1538
     * $value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
1539
     * ?>
1540
     * ```
1541
     *
1542
     * @param $cssOrXPathOrRegex
1543
     *
1544
     * @return mixed
1545
     * @see \Codeception\Module\WebDriver::grabTextFrom()
1546
     */
1547
    public function grabTextFrom($cssOrXPathOrRegex) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXPathOrRegex is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1548
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabTextFrom', func_get_args()));
1549
    }
1550
1551
 
1552
    /**
1553
     * [!] Method is generated. Documentation taken from corresponding module.
1554
     *
1555
     * Grabs the value of the given attribute value from the given element.
1556
     * Fails if element is not found.
1557
     *
1558
     * ``` php
1559
     * <?php
1560
     * $I->grabAttributeFrom('#tooltip', 'title');
1561
     * ?>
1562
     * ```
1563
     *
1564
     *
1565
     * @param $cssOrXpath
1566
     * @param $attribute
1567
     *
1568
     * @return mixed
1569
     * @see \Codeception\Module\WebDriver::grabAttributeFrom()
1570
     */
1571
    public function grabAttributeFrom($cssOrXpath, $attribute) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXpath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attribute is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1572
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabAttributeFrom', func_get_args()));
1573
    }
1574
1575
 
1576
    /**
1577
     * [!] Method is generated. Documentation taken from corresponding module.
1578
     *
1579
     * Finds the value for the given form field.
1580
     * If a fuzzy locator is used, the field is found by field name, CSS, and XPath.
1581
     *
1582
     * ``` php
1583
     * <?php
1584
     * $name = $I->grabValueFrom('Name');
1585
     * $name = $I->grabValueFrom('input[name=username]');
1586
     * $name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']');
1587
     * $name = $I->grabValueFrom(['name' => 'username']);
1588
     * ?>
1589
     * ```
1590
     *
1591
     * @param $field
1592
     *
1593
     * @return mixed
1594
     * @see \Codeception\Module\WebDriver::grabValueFrom()
1595
     */
1596
    public function grabValueFrom($field) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1597
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabValueFrom', func_get_args()));
1598
    }
1599
1600
 
1601
    /**
1602
     * [!] Method is generated. Documentation taken from corresponding module.
1603
     *
1604
     * Grabs either the text content, or attribute values, of nodes
1605
     * matched by $cssOrXpath and returns them as an array.
1606
     *
1607
     * ```html
1608
     * <a href="#first">First</a>
1609
     * <a href="#second">Second</a>
1610
     * <a href="#third">Third</a>
1611
     * ```
1612
     *
1613
     * ```php
1614
     * <?php
1615
     * // would return ['First', 'Second', 'Third']
1616
     * $aLinkText = $I->grabMultiple('a');
1617
     *
1618
     * // would return ['#first', '#second', '#third']
1619
     * $aLinks = $I->grabMultiple('a', 'href');
1620
     * ?>
1621
     * ```
1622
     *
1623
     * @param $cssOrXpath
1624
     * @param $attribute
1625
     * @return string[]
1626
     * @see \Codeception\Module\WebDriver::grabMultiple()
1627
     */
1628
    public function grabMultiple($cssOrXpath, $attribute = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXpath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attribute is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1629
        return $this->getScenario()->runStep(new \Codeception\Step\Action('grabMultiple', func_get_args()));
1630
    }
1631
1632
 
1633
    /**
1634
     * [!] Method is generated. Documentation taken from corresponding module.
1635
     *
1636
     * Checks that the given element exists on the page and is visible.
1637
     * You can also specify expected attributes of this element.
1638
     *
1639
     * ``` php
1640
     * <?php
1641
     * $I->seeElement('.error');
1642
     * $I->seeElement('//form/input[1]');
1643
     * $I->seeElement('input', ['name' => 'login']);
1644
     * $I->seeElement('input', ['value' => '123456']);
1645
     *
1646
     * // strict locator in first arg, attributes in second
1647
     * $I->seeElement(['css' => 'form input'], ['name' => 'login']);
1648
     * ?>
1649
     * ```
1650
     *
1651
     * @param $selector
1652
     * @param array $attributes
1653
     * @return
1654
     * Conditional Assertion: Test won't be stopped on fail
1655
     * @see \Codeception\Module\WebDriver::seeElement()
1656
     */
1657
    public function canSeeElement($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1658
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElement', func_get_args()));
1659
    }
1660
    /**
1661
     * [!] Method is generated. Documentation taken from corresponding module.
1662
     *
1663
     * Checks that the given element exists on the page and is visible.
1664
     * You can also specify expected attributes of this element.
1665
     *
1666
     * ``` php
1667
     * <?php
1668
     * $I->seeElement('.error');
1669
     * $I->seeElement('//form/input[1]');
1670
     * $I->seeElement('input', ['name' => 'login']);
1671
     * $I->seeElement('input', ['value' => '123456']);
1672
     *
1673
     * // strict locator in first arg, attributes in second
1674
     * $I->seeElement(['css' => 'form input'], ['name' => 'login']);
1675
     * ?>
1676
     * ```
1677
     *
1678
     * @param $selector
1679
     * @param array $attributes
1680
     * @return
1681
     * @see \Codeception\Module\WebDriver::seeElement()
1682
     */
1683
    public function seeElement($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1684
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElement', func_get_args()));
1685
    }
1686
1687
 
1688
    /**
1689
     * [!] Method is generated. Documentation taken from corresponding module.
1690
     *
1691
     * Checks that the given element is invisible or not present on the page.
1692
     * You can also specify expected attributes of this element.
1693
     *
1694
     * ``` php
1695
     * <?php
1696
     * $I->dontSeeElement('.error');
1697
     * $I->dontSeeElement('//form/input[1]');
1698
     * $I->dontSeeElement('input', ['name' => 'login']);
1699
     * $I->dontSeeElement('input', ['value' => '123456']);
1700
     * ?>
1701
     * ```
1702
     *
1703
     * @param $selector
1704
     * @param array $attributes
1705
     * Conditional Assertion: Test won't be stopped on fail
1706
     * @see \Codeception\Module\WebDriver::dontSeeElement()
1707
     */
1708
    public function cantSeeElement($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1709
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElement', func_get_args()));
1710
    }
1711
    /**
1712
     * [!] Method is generated. Documentation taken from corresponding module.
1713
     *
1714
     * Checks that the given element is invisible or not present on the page.
1715
     * You can also specify expected attributes of this element.
1716
     *
1717
     * ``` php
1718
     * <?php
1719
     * $I->dontSeeElement('.error');
1720
     * $I->dontSeeElement('//form/input[1]');
1721
     * $I->dontSeeElement('input', ['name' => 'login']);
1722
     * $I->dontSeeElement('input', ['value' => '123456']);
1723
     * ?>
1724
     * ```
1725
     *
1726
     * @param $selector
1727
     * @param array $attributes
1728
     * @see \Codeception\Module\WebDriver::dontSeeElement()
1729
     */
1730
    public function dontSeeElement($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1731
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeElement', func_get_args()));
1732
    }
1733
1734
 
1735
    /**
1736
     * [!] Method is generated. Documentation taken from corresponding module.
1737
     *
1738
     * Checks that the given element exists on the page, even it is invisible.
1739
     *
1740
     * ``` php
1741
     * <?php
1742
     * $I->seeElementInDOM('//form/input[type=hidden]');
1743
     * ?>
1744
     * ```
1745
     *
1746
     * @param $selector
1747
     * @param array $attributes
1748
     * Conditional Assertion: Test won't be stopped on fail
1749
     * @see \Codeception\Module\WebDriver::seeElementInDOM()
1750
     */
1751
    public function canSeeElementInDOM($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1752
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeElementInDOM', func_get_args()));
1753
    }
1754
    /**
1755
     * [!] Method is generated. Documentation taken from corresponding module.
1756
     *
1757
     * Checks that the given element exists on the page, even it is invisible.
1758
     *
1759
     * ``` php
1760
     * <?php
1761
     * $I->seeElementInDOM('//form/input[type=hidden]');
1762
     * ?>
1763
     * ```
1764
     *
1765
     * @param $selector
1766
     * @param array $attributes
1767
     * @see \Codeception\Module\WebDriver::seeElementInDOM()
1768
     */
1769
    public function seeElementInDOM($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1770
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeElementInDOM', func_get_args()));
1771
    }
1772
1773
 
1774
    /**
1775
     * [!] Method is generated. Documentation taken from corresponding module.
1776
     *
1777
     * Opposite of `seeElementInDOM`.
1778
     *
1779
     * @param $selector
1780
     * @param array $attributes
1781
     * Conditional Assertion: Test won't be stopped on fail
1782
     * @see \Codeception\Module\WebDriver::dontSeeElementInDOM()
1783
     */
1784
    public function cantSeeElementInDOM($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1785
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeElementInDOM', func_get_args()));
1786
    }
1787
    /**
1788
     * [!] Method is generated. Documentation taken from corresponding module.
1789
     *
1790
     * Opposite of `seeElementInDOM`.
1791
     *
1792
     * @param $selector
1793
     * @param array $attributes
1794
     * @see \Codeception\Module\WebDriver::dontSeeElementInDOM()
1795
     */
1796
    public function dontSeeElementInDOM($selector, $attributes = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1797
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeElementInDOM', func_get_args()));
1798
    }
1799
1800
 
1801
    /**
1802
     * [!] Method is generated. Documentation taken from corresponding module.
1803
     *
1804
     * Checks that there are a certain number of elements matched by the given locator on the page.
1805
     *
1806
     * ``` php
1807
     * <?php
1808
     * $I->seeNumberOfElements('tr', 10);
1809
     * $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
1810
     * ?>
1811
     * ```
1812
     * @param $selector
1813
     * @param mixed $expected int or int[]
1814
     * Conditional Assertion: Test won't be stopped on fail
1815
     * @see \Codeception\Module\WebDriver::seeNumberOfElements()
1816
     */
1817
    public function canSeeNumberOfElements($selector, $expected) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $expected is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1818
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElements', func_get_args()));
1819
    }
1820
    /**
1821
     * [!] Method is generated. Documentation taken from corresponding module.
1822
     *
1823
     * Checks that there are a certain number of elements matched by the given locator on the page.
1824
     *
1825
     * ``` php
1826
     * <?php
1827
     * $I->seeNumberOfElements('tr', 10);
1828
     * $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
1829
     * ?>
1830
     * ```
1831
     * @param $selector
1832
     * @param mixed $expected int or int[]
1833
     * @see \Codeception\Module\WebDriver::seeNumberOfElements()
1834
     */
1835
    public function seeNumberOfElements($selector, $expected) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $expected is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1836
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElements', func_get_args()));
1837
    }
1838
1839
 
1840
    /**
1841
     * [!] Method is generated. Documentation taken from corresponding module.
1842
     *
1843
     *
1844
     * Conditional Assertion: Test won't be stopped on fail
1845
     * @see \Codeception\Module\WebDriver::seeNumberOfElementsInDOM()
1846
     */
1847
    public function canSeeNumberOfElementsInDOM($selector, $expected) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $expected is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1848
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeNumberOfElementsInDOM', func_get_args()));
1849
    }
1850
    /**
1851
     * [!] Method is generated. Documentation taken from corresponding module.
1852
     *
1853
     *
1854
     * @see \Codeception\Module\WebDriver::seeNumberOfElementsInDOM()
1855
     */
1856
    public function seeNumberOfElementsInDOM($selector, $expected) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $expected is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1857
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeNumberOfElementsInDOM', func_get_args()));
1858
    }
1859
1860
 
1861
    /**
1862
     * [!] Method is generated. Documentation taken from corresponding module.
1863
     *
1864
     * Checks that the given option is selected.
1865
     *
1866
     * ``` php
1867
     * <?php
1868
     * $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
1869
     * ?>
1870
     * ```
1871
     *
1872
     * @param $selector
1873
     * @param $optionText
1874
     *
1875
     * @return mixed
1876
     * Conditional Assertion: Test won't be stopped on fail
1877
     * @see \Codeception\Module\WebDriver::seeOptionIsSelected()
1878
     */
1879
    public function canSeeOptionIsSelected($selector, $optionText) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $optionText is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1880
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeOptionIsSelected', func_get_args()));
1881
    }
1882
    /**
1883
     * [!] Method is generated. Documentation taken from corresponding module.
1884
     *
1885
     * Checks that the given option is selected.
1886
     *
1887
     * ``` php
1888
     * <?php
1889
     * $I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
1890
     * ?>
1891
     * ```
1892
     *
1893
     * @param $selector
1894
     * @param $optionText
1895
     *
1896
     * @return mixed
1897
     * @see \Codeception\Module\WebDriver::seeOptionIsSelected()
1898
     */
1899
    public function seeOptionIsSelected($selector, $optionText) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $optionText is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1900
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeOptionIsSelected', func_get_args()));
1901
    }
1902
1903
 
1904
    /**
1905
     * [!] Method is generated. Documentation taken from corresponding module.
1906
     *
1907
     * Checks that the given option is not selected.
1908
     *
1909
     * ``` php
1910
     * <?php
1911
     * $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
1912
     * ?>
1913
     * ```
1914
     *
1915
     * @param $selector
1916
     * @param $optionText
1917
     *
1918
     * @return mixed
1919
     * Conditional Assertion: Test won't be stopped on fail
1920
     * @see \Codeception\Module\WebDriver::dontSeeOptionIsSelected()
1921
     */
1922
    public function cantSeeOptionIsSelected($selector, $optionText) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $optionText is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1923
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeOptionIsSelected', func_get_args()));
1924
    }
1925
    /**
1926
     * [!] Method is generated. Documentation taken from corresponding module.
1927
     *
1928
     * Checks that the given option is not selected.
1929
     *
1930
     * ``` php
1931
     * <?php
1932
     * $I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
1933
     * ?>
1934
     * ```
1935
     *
1936
     * @param $selector
1937
     * @param $optionText
1938
     *
1939
     * @return mixed
1940
     * @see \Codeception\Module\WebDriver::dontSeeOptionIsSelected()
1941
     */
1942
    public function dontSeeOptionIsSelected($selector, $optionText) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $optionText is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1943
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeOptionIsSelected', func_get_args()));
1944
    }
1945
1946
 
1947
    /**
1948
     * [!] Method is generated. Documentation taken from corresponding module.
1949
     *
1950
     * Checks that the page title contains the given string.
1951
     *
1952
     * ``` php
1953
     * <?php
1954
     * $I->seeInTitle('Blog - Post #1');
1955
     * ?>
1956
     * ```
1957
     *
1958
     * @param $title
1959
     *
1960
     * @return mixed
1961
     * Conditional Assertion: Test won't be stopped on fail
1962
     * @see \Codeception\Module\WebDriver::seeInTitle()
1963
     */
1964
    public function canSeeInTitle($title) {
0 ignored issues
show
Unused Code introduced by
The parameter $title is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1965
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInTitle', func_get_args()));
1966
    }
1967
    /**
1968
     * [!] Method is generated. Documentation taken from corresponding module.
1969
     *
1970
     * Checks that the page title contains the given string.
1971
     *
1972
     * ``` php
1973
     * <?php
1974
     * $I->seeInTitle('Blog - Post #1');
1975
     * ?>
1976
     * ```
1977
     *
1978
     * @param $title
1979
     *
1980
     * @return mixed
1981
     * @see \Codeception\Module\WebDriver::seeInTitle()
1982
     */
1983
    public function seeInTitle($title) {
0 ignored issues
show
Unused Code introduced by
The parameter $title is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1984
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInTitle', func_get_args()));
1985
    }
1986
1987
 
1988
    /**
1989
     * [!] Method is generated. Documentation taken from corresponding module.
1990
     *
1991
     * Checks that the page title does not contain the given string.
1992
     *
1993
     * @param $title
1994
     *
1995
     * @return mixed
1996
     * Conditional Assertion: Test won't be stopped on fail
1997
     * @see \Codeception\Module\WebDriver::dontSeeInTitle()
1998
     */
1999
    public function cantSeeInTitle($title) {
0 ignored issues
show
Unused Code introduced by
The parameter $title is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2000
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInTitle', func_get_args()));
2001
    }
2002
    /**
2003
     * [!] Method is generated. Documentation taken from corresponding module.
2004
     *
2005
     * Checks that the page title does not contain the given string.
2006
     *
2007
     * @param $title
2008
     *
2009
     * @return mixed
2010
     * @see \Codeception\Module\WebDriver::dontSeeInTitle()
2011
     */
2012
    public function dontSeeInTitle($title) {
0 ignored issues
show
Unused Code introduced by
The parameter $title is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2013
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInTitle', func_get_args()));
2014
    }
2015
2016
 
2017
    /**
2018
     * [!] Method is generated. Documentation taken from corresponding module.
2019
     *
2020
     * Accepts the active JavaScript native popup window, as created by `window.alert`|`window.confirm`|`window.prompt`.
2021
     * Don't confuse popups with modal windows,
2022
     * as created by [various libraries](http://jster.net/category/windows-modals-popups).
2023
     * @see \Codeception\Module\WebDriver::acceptPopup()
2024
     */
2025
    public function acceptPopup() {
2026
        return $this->getScenario()->runStep(new \Codeception\Step\Action('acceptPopup', func_get_args()));
2027
    }
2028
2029
 
2030
    /**
2031
     * [!] Method is generated. Documentation taken from corresponding module.
2032
     *
2033
     * Dismisses the active JavaScript popup, as created by `window.alert`, `window.confirm`, or `window.prompt`.
2034
     * @see \Codeception\Module\WebDriver::cancelPopup()
2035
     */
2036
    public function cancelPopup() {
2037
        return $this->getScenario()->runStep(new \Codeception\Step\Action('cancelPopup', func_get_args()));
2038
    }
2039
2040
 
2041
    /**
2042
     * [!] Method is generated. Documentation taken from corresponding module.
2043
     *
2044
     * Checks that the active JavaScript popup,
2045
     * as created by `window.alert`|`window.confirm`|`window.prompt`, contains the given string.
2046
     *
2047
     * @param $text
2048
     *
2049
     * @throws \Codeception\Exception\ModuleException
2050
     * Conditional Assertion: Test won't be stopped on fail
2051
     * @see \Codeception\Module\WebDriver::seeInPopup()
2052
     */
2053
    public function canSeeInPopup($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2054
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('seeInPopup', func_get_args()));
2055
    }
2056
    /**
2057
     * [!] Method is generated. Documentation taken from corresponding module.
2058
     *
2059
     * Checks that the active JavaScript popup,
2060
     * as created by `window.alert`|`window.confirm`|`window.prompt`, contains the given string.
2061
     *
2062
     * @param $text
2063
     *
2064
     * @throws \Codeception\Exception\ModuleException
2065
     * @see \Codeception\Module\WebDriver::seeInPopup()
2066
     */
2067
    public function seeInPopup($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2068
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('seeInPopup', func_get_args()));
2069
    }
2070
2071
 
2072
    /**
2073
     * [!] Method is generated. Documentation taken from corresponding module.
2074
     *
2075
     * Checks that the active JavaScript popup,
2076
     * as created by `window.alert`|`window.confirm`|`window.prompt`, does NOT contain the given string.
2077
     *
2078
     * @param $text
2079
     *
2080
     * @throws \Codeception\Exception\ModuleException
2081
     * Conditional Assertion: Test won't be stopped on fail
2082
     * @see \Codeception\Module\WebDriver::dontSeeInPopup()
2083
     */
2084
    public function cantSeeInPopup($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2085
        return $this->getScenario()->runStep(new \Codeception\Step\ConditionalAssertion('dontSeeInPopup', func_get_args()));
2086
    }
2087
    /**
2088
     * [!] Method is generated. Documentation taken from corresponding module.
2089
     *
2090
     * Checks that the active JavaScript popup,
2091
     * as created by `window.alert`|`window.confirm`|`window.prompt`, does NOT contain the given string.
2092
     *
2093
     * @param $text
2094
     *
2095
     * @throws \Codeception\Exception\ModuleException
2096
     * @see \Codeception\Module\WebDriver::dontSeeInPopup()
2097
     */
2098
    public function dontSeeInPopup($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2099
        return $this->getScenario()->runStep(new \Codeception\Step\Assertion('dontSeeInPopup', func_get_args()));
2100
    }
2101
2102
 
2103
    /**
2104
     * [!] Method is generated. Documentation taken from corresponding module.
2105
     *
2106
     * Enters text into a native JavaScript prompt popup, as created by `window.prompt`.
2107
     *
2108
     * @param $keys
2109
     *
2110
     * @throws \Codeception\Exception\ModuleException
2111
     * @see \Codeception\Module\WebDriver::typeInPopup()
2112
     */
2113
    public function typeInPopup($keys) {
0 ignored issues
show
Unused Code introduced by
The parameter $keys is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2114
        return $this->getScenario()->runStep(new \Codeception\Step\Action('typeInPopup', func_get_args()));
2115
    }
2116
2117
 
2118
    /**
2119
     * [!] Method is generated. Documentation taken from corresponding module.
2120
     *
2121
     * Reloads the current page.
2122
     * @see \Codeception\Module\WebDriver::reloadPage()
2123
     */
2124
    public function reloadPage() {
2125
        return $this->getScenario()->runStep(new \Codeception\Step\Action('reloadPage', func_get_args()));
2126
    }
2127
2128
 
2129
    /**
2130
     * [!] Method is generated. Documentation taken from corresponding module.
2131
     *
2132
     * Moves back in history.
2133
     * @see \Codeception\Module\WebDriver::moveBack()
2134
     */
2135
    public function moveBack() {
2136
        return $this->getScenario()->runStep(new \Codeception\Step\Action('moveBack', func_get_args()));
2137
    }
2138
2139
 
2140
    /**
2141
     * [!] Method is generated. Documentation taken from corresponding module.
2142
     *
2143
     * Moves forward in history.
2144
     * @see \Codeception\Module\WebDriver::moveForward()
2145
     */
2146
    public function moveForward() {
2147
        return $this->getScenario()->runStep(new \Codeception\Step\Action('moveForward', func_get_args()));
2148
    }
2149
2150
 
2151
    /**
2152
     * [!] Method is generated. Documentation taken from corresponding module.
2153
     *
2154
     * Submits the given form on the page, optionally with the given form
2155
     * values.  Give the form fields values as an array. Note that hidden fields
2156
     * can't be accessed.
2157
     *
2158
     * Skipped fields will be filled by their values from the page.
2159
     * You don't need to click the 'Submit' button afterwards.
2160
     * This command itself triggers the request to form's action.
2161
     *
2162
     * You can optionally specify what button's value to include
2163
     * in the request with the last parameter as an alternative to
2164
     * explicitly setting its value in the second parameter, as
2165
     * button values are not otherwise included in the request.
2166
     *
2167
     * Examples:
2168
     *
2169
     * ``` php
2170
     * <?php
2171
     * $I->submitForm('#login', [
2172
     *     'login' => 'davert',
2173
     *     'password' => '123456'
2174
     * ]);
2175
     * // or
2176
     * $I->submitForm('#login', [
2177
     *     'login' => 'davert',
2178
     *     'password' => '123456'
2179
     * ], 'submitButtonName');
2180
     *
2181
     * ```
2182
     *
2183
     * For example, given this sample "Sign Up" form:
2184
     *
2185
     * ``` html
2186
     * <form action="/sign_up">
2187
     *     Login:
2188
     *     <input type="text" name="user[login]" /><br/>
2189
     *     Password:
2190
     *     <input type="password" name="user[password]" /><br/>
2191
     *     Do you agree to our terms?
2192
     *     <input type="checkbox" name="user[agree]" /><br/>
2193
     *     Select pricing plan:
2194
     *     <select name="plan">
2195
     *         <option value="1">Free</option>
2196
     *         <option value="2" selected="selected">Paid</option>
2197
     *     </select>
2198
     *     <input type="submit" name="submitButton" value="Submit" />
2199
     * </form>
2200
     * ```
2201
     *
2202
     * You could write the following to submit it:
2203
     *
2204
     * ``` php
2205
     * <?php
2206
     * $I->submitForm(
2207
     *     '#userForm',
2208
     *     [
2209
     *         'user[login]' => 'Davert',
2210
     *         'user[password]' => '123456',
2211
     *         'user[agree]' => true
2212
     *     ],
2213
     *     'submitButton'
2214
     * );
2215
     * ```
2216
     * Note that "2" will be the submitted value for the "plan" field, as it is
2217
     * the selected option.
2218
     *
2219
     * Also note that this differs from PhpBrowser, in that
2220
     * ```'user' => [ 'login' => 'Davert' ]``` is not supported at the moment.
2221
     * Named array keys *must* be included in the name as above.
2222
     *
2223
     * Pair this with seeInFormFields for quick testing magic.
2224
     *
2225
     * ``` php
2226
     * <?php
2227
     * $form = [
2228
     *      'field1' => 'value',
2229
     *      'field2' => 'another value',
2230
     *      'checkbox1' => true,
2231
     *      // ...
2232
     * ];
2233
     * $I->submitForm('//form[@id=my-form]', $form, 'submitButton');
2234
     * // $I->amOnPage('/path/to/form-page') may be needed
2235
     * $I->seeInFormFields('//form[@id=my-form]', $form);
2236
     * ?>
2237
     * ```
2238
     *
2239
     * Parameter values must be set to arrays for multiple input fields
2240
     * of the same name, or multi-select combo boxes.  For checkboxes,
2241
     * either the string value can be used, or boolean values which will
2242
     * be replaced by the checkbox's value in the DOM.
2243
     *
2244
     * ``` php
2245
     * <?php
2246
     * $I->submitForm('#my-form', [
2247
     *      'field1' => 'value',
2248
     *      'checkbox' => [
2249
     *          'value of first checkbox',
2250
     *          'value of second checkbox,
2251
     *      ],
2252
     *      'otherCheckboxes' => [
2253
     *          true,
2254
     *          false,
2255
     *          false
2256
     *      ],
2257
     *      'multiselect' => [
2258
     *          'first option value',
2259
     *          'second option value'
2260
     *      ]
2261
     * ]);
2262
     * ?>
2263
     * ```
2264
     *
2265
     * Mixing string and boolean values for a checkbox's value is not supported
2266
     * and may produce unexpected results.
2267
     *
2268
     * Field names ending in "[]" must be passed without the trailing square
2269
     * bracket characters, and must contain an array for its value.  This allows
2270
     * submitting multiple values with the same name, consider:
2271
     *
2272
     * ```php
2273
     * $I->submitForm('#my-form', [
2274
     *     'field[]' => 'value',
2275
     *     'field[]' => 'another value', // 'field[]' is already a defined key
2276
     * ]);
2277
     * ```
2278
     *
2279
     * The solution is to pass an array value:
2280
     *
2281
     * ```php
2282
     * // this way both values are submitted
2283
     * $I->submitForm('#my-form', [
2284
     *     'field' => [
2285
     *         'value',
2286
     *         'another value',
2287
     *     ]
2288
     * ]);
2289
     * ```
2290
     *
2291
     * The `$button` parameter can be either a string, an array or an instance
2292
     * of Facebook\WebDriver\WebDriverBy. When it is a string, the
2293
     * button will be found by its "name" attribute. If $button is an
2294
     * array then it will be treated as a strict selector and a WebDriverBy
2295
     * will be used verbatim.
2296
     *
2297
     * For example, given the following HTML:
2298
     *
2299
     * ``` html
2300
     * <input type="submit" name="submitButton" value="Submit" />
2301
     * ```
2302
     *
2303
     * `$button` could be any one of the following:
2304
     *   - 'submitButton'
2305
     *   - ['name' => 'submitButton']
2306
     *   - WebDriverBy::name('submitButton')
2307
     *
2308
     * @param $selector
2309
     * @param $params
2310
     * @param $button
2311
     * @see \Codeception\Module\WebDriver::submitForm()
2312
     */
2313
    public function submitForm($selector, $params, $button = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $params is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $button is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2314
        return $this->getScenario()->runStep(new \Codeception\Step\Action('submitForm', func_get_args()));
2315
    }
2316
2317
 
2318
    /**
2319
     * [!] Method is generated. Documentation taken from corresponding module.
2320
     *
2321
     * Waits up to $timeout seconds for the given element to change.
2322
     * Element "change" is determined by a callback function which is called repeatedly
2323
     * until the return value evaluates to true.
2324
     *
2325
     * ``` php
2326
     * <?php
2327
     * use \Facebook\WebDriver\WebDriverElement
2328
     * $I->waitForElementChange('#menu', function(WebDriverElement $el) {
2329
     *     return $el->isDisplayed();
2330
     * }, 100);
2331
     * ?>
2332
     * ```
2333
     *
2334
     * @param $element
2335
     * @param \Closure $callback
2336
     * @param int $timeout seconds
2337
     * @throws \Codeception\Exception\ElementNotFound
2338
     * @see \Codeception\Module\WebDriver::waitForElementChange()
2339
     */
2340
    public function waitForElementChange($element, $callback, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $callback is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2341
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementChange', func_get_args()));
2342
    }
2343
2344
 
2345
    /**
2346
     * [!] Method is generated. Documentation taken from corresponding module.
2347
     *
2348
     * Waits up to $timeout seconds for an element to appear on the page.
2349
     * If the element doesn't appear, a timeout exception is thrown.
2350
     *
2351
     * ``` php
2352
     * <?php
2353
     * $I->waitForElement('#agree_button', 30); // secs
2354
     * $I->click('#agree_button');
2355
     * ?>
2356
     * ```
2357
     *
2358
     * @param $element
2359
     * @param int $timeout seconds
2360
     * @throws \Exception
2361
     * @see \Codeception\Module\WebDriver::waitForElement()
2362
     */
2363
    public function waitForElement($element, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2364
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElement', func_get_args()));
2365
    }
2366
2367
 
2368
    /**
2369
     * [!] Method is generated. Documentation taken from corresponding module.
2370
     *
2371
     * Waits up to $timeout seconds for the given element to be visible on the page.
2372
     * If element doesn't appear, a timeout exception is thrown.
2373
     *
2374
     * ``` php
2375
     * <?php
2376
     * $I->waitForElementVisible('#agree_button', 30); // secs
2377
     * $I->click('#agree_button');
2378
     * ?>
2379
     * ```
2380
     *
2381
     * @param $element
2382
     * @param int $timeout seconds
2383
     * @throws \Exception
2384
     * @see \Codeception\Module\WebDriver::waitForElementVisible()
2385
     */
2386
    public function waitForElementVisible($element, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2387
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementVisible', func_get_args()));
2388
    }
2389
2390
 
2391
    /**
2392
     * [!] Method is generated. Documentation taken from corresponding module.
2393
     *
2394
     * Waits up to $timeout seconds for the given element to become invisible.
2395
     * If element stays visible, a timeout exception is thrown.
2396
     *
2397
     * ``` php
2398
     * <?php
2399
     * $I->waitForElementNotVisible('#agree_button', 30); // secs
2400
     * ?>
2401
     * ```
2402
     *
2403
     * @param $element
2404
     * @param int $timeout seconds
2405
     * @throws \Exception
2406
     * @see \Codeception\Module\WebDriver::waitForElementNotVisible()
2407
     */
2408
    public function waitForElementNotVisible($element, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2409
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementNotVisible', func_get_args()));
2410
    }
2411
2412
 
2413
    /**
2414
     * [!] Method is generated. Documentation taken from corresponding module.
2415
     *
2416
     * Waits up to $timeout seconds for the given element to be clickable.
2417
     * If element doesn't become clickable, a timeout exception is thrown.
2418
     *
2419
     * ``` php
2420
     * <?php
2421
     * $I->waitForElementClickable('#agree_button', 30); // secs
2422
     * $I->click('#agree_button');
2423
     * ?>
2424
     * ```
2425
     *
2426
     * @param $element
2427
     * @param int $timeout seconds
2428
     * @throws \Exception
2429
     * @see \Codeception\Module\WebDriver::waitForElementClickable()
2430
     */
2431
    public function waitForElementClickable($element, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2432
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForElementClickable', func_get_args()));
2433
    }
2434
2435
 
2436
    /**
2437
     * [!] Method is generated. Documentation taken from corresponding module.
2438
     *
2439
     * Waits up to $timeout seconds for the given string to appear on the page.
2440
     *
2441
     * Can also be passed a selector to search in, be as specific as possible when using selectors.
2442
     * waitForText() will only watch the first instance of the matching selector / text provided.
2443
     * If the given text doesn't appear, a timeout exception is thrown.
2444
     *
2445
     * ``` php
2446
     * <?php
2447
     * $I->waitForText('foo', 30); // secs
2448
     * $I->waitForText('foo', 30, '.title'); // secs
2449
     * ?>
2450
     * ```
2451
     *
2452
     * @param string $text
2453
     * @param int $timeout seconds
2454
     * @param string $selector optional
2455
     * @throws \Exception
2456
     * @see \Codeception\Module\WebDriver::waitForText()
2457
     */
2458
    public function waitForText($text, $timeout = null, $selector = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2459
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForText', func_get_args()));
2460
    }
2461
2462
 
2463
    /**
2464
     * [!] Method is generated. Documentation taken from corresponding module.
2465
     *
2466
     * Wait for $timeout seconds.
2467
     *
2468
     * @param int|float $timeout secs
2469
     * @throws \Codeception\Exception\TestRuntimeException
2470
     * @see \Codeception\Module\WebDriver::wait()
2471
     */
2472
    public function wait($timeout) {
0 ignored issues
show
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2473
        return $this->getScenario()->runStep(new \Codeception\Step\Action('wait', func_get_args()));
2474
    }
2475
2476
 
2477
    /**
2478
     * [!] Method is generated. Documentation taken from corresponding module.
2479
     *
2480
     * Low-level API method.
2481
     * If Codeception commands are not enough, this allows you to use Selenium WebDriver methods directly:
2482
     *
2483
     * ``` php
2484
     * $I->executeInSelenium(function(\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) {
2485
     *   $webdriver->get('http://google.com');
2486
     * });
2487
     * ```
2488
     *
2489
     * This runs in the context of the
2490
     * [RemoteWebDriver class](https://github.com/facebook/php-webdriver/blob/master/lib/remote/RemoteWebDriver.php).
2491
     * Try not to use this command on a regular basis.
2492
     * If Codeception lacks a feature you need, please implement it and submit a patch.
2493
     *
2494
     * @param callable $function
2495
     * @see \Codeception\Module\WebDriver::executeInSelenium()
2496
     */
2497
    public function executeInSelenium($function) {
0 ignored issues
show
Unused Code introduced by
The parameter $function is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2498
        return $this->getScenario()->runStep(new \Codeception\Step\Action('executeInSelenium', func_get_args()));
2499
    }
2500
2501
 
2502
    /**
2503
     * [!] Method is generated. Documentation taken from corresponding module.
2504
     *
2505
     * Switch to another window identified by name.
2506
     *
2507
     * The window can only be identified by name. If the $name parameter is blank, the parent window will be used.
2508
     *
2509
     * Example:
2510
     * ``` html
2511
     * <input type="button" value="Open window" onclick="window.open('http://example.com', 'another_window')">
2512
     * ```
2513
     *
2514
     * ``` php
2515
     * <?php
2516
     * $I->click("Open window");
2517
     * # switch to another window
2518
     * $I->switchToWindow("another_window");
2519
     * # switch to parent window
2520
     * $I->switchToWindow();
2521
     * ?>
2522
     * ```
2523
     *
2524
     * If the window has no name, match it by switching to next active tab using `switchToNextTab` method.
2525
     *
2526
     * Or use native Selenium functions to get access to all opened windows:
2527
     *
2528
     * ``` php
2529
     * <?php
2530
     * $I->executeInSelenium(function (\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) {
2531
     *      $handles=$webdriver->getWindowHandles();
2532
     *      $last_window = end($handles);
2533
     *      $webdriver->switchTo()->window($last_window);
2534
     * });
2535
     * ?>
2536
     * ```
2537
     *
2538
     * @param string|null $name
2539
     * @see \Codeception\Module\WebDriver::switchToWindow()
2540
     */
2541
    public function switchToWindow($name = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2542
        return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToWindow', func_get_args()));
2543
    }
2544
2545
 
2546
    /**
2547
     * [!] Method is generated. Documentation taken from corresponding module.
2548
     *
2549
     * Switch to another frame on the page.
2550
     *
2551
     * Example:
2552
     * ``` html
2553
     * <iframe name="another_frame" src="http://example.com">
2554
     *
2555
     * ```
2556
     *
2557
     * ``` php
2558
     * <?php
2559
     * # switch to iframe
2560
     * $I->switchToIFrame("another_frame");
2561
     * # switch to parent page
2562
     * $I->switchToIFrame();
2563
     *
2564
     * ```
2565
     *
2566
     * @param string|null $name
2567
     * @see \Codeception\Module\WebDriver::switchToIFrame()
2568
     */
2569
    public function switchToIFrame($name = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2570
        return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToIFrame', func_get_args()));
2571
    }
2572
2573
 
2574
    /**
2575
     * [!] Method is generated. Documentation taken from corresponding module.
2576
     *
2577
     * Executes JavaScript and waits up to $timeout seconds for it to return true.
2578
     *
2579
     * In this example we will wait up to 60 seconds for all jQuery AJAX requests to finish.
2580
     *
2581
     * ``` php
2582
     * <?php
2583
     * $I->waitForJS("return $.active == 0;", 60);
2584
     * ?>
2585
     * ```
2586
     *
2587
     * @param string $script
2588
     * @param int $timeout seconds
2589
     * @see \Codeception\Module\WebDriver::waitForJS()
2590
     */
2591
    public function waitForJS($script, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $script is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2592
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForJS', func_get_args()));
2593
    }
2594
2595
 
2596
    /**
2597
     * [!] Method is generated. Documentation taken from corresponding module.
2598
     *
2599
     * Executes custom JavaScript.
2600
     *
2601
     * This example uses jQuery to get a value and assigns that value to a PHP variable:
2602
     *
2603
     * ```php
2604
     * <?php
2605
     * $myVar = $I->executeJS('return $("#myField").val()');
2606
     *
2607
     * // additional arguments can be passed as array
2608
     * // Example shows `Hello World` alert:
2609
     * $I->executeJS("window.alert(arguments[0])", ['Hello world']);
2610
     * ```
2611
     *
2612
     * @param $script
2613
     * @param array $arguments
2614
     * @return mixed
2615
     * @see \Codeception\Module\WebDriver::executeJS()
2616
     */
2617
    public function executeJS($script, $arguments = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $script is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $arguments is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2618
        return $this->getScenario()->runStep(new \Codeception\Step\Action('executeJS', func_get_args()));
2619
    }
2620
2621
 
2622
    /**
2623
     * [!] Method is generated. Documentation taken from corresponding module.
2624
     *
2625
     * Executes asynchronous JavaScript.
2626
     * A callback should be executed by JavaScript to exit from a script.
2627
     * Callback is passed as a last element in `arguments` array.
2628
     * Additional arguments can be passed as array in second parameter.
2629
     *
2630
     * ```js
2631
     * // wait for 1200 milliseconds my running `setTimeout`
2632
     * * $I->executeAsyncJS('setTimeout(arguments[0], 1200)');
2633
     *
2634
     * $seconds = 1200; // or seconds are passed as argument
2635
     * $I->executeAsyncJS('setTimeout(arguments[1], arguments[0])', [$seconds]);
2636
     * ```
2637
     *
2638
     * @param $script
2639
     * @param array $arguments
2640
     * @return mixed
2641
     * @see \Codeception\Module\WebDriver::executeAsyncJS()
2642
     */
2643
    public function executeAsyncJS($script, $arguments = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $script is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $arguments is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2644
        return $this->getScenario()->runStep(new \Codeception\Step\Action('executeAsyncJS', func_get_args()));
2645
    }
2646
2647
 
2648
    /**
2649
     * [!] Method is generated. Documentation taken from corresponding module.
2650
     *
2651
     * Maximizes the current window.
2652
     * @see \Codeception\Module\WebDriver::maximizeWindow()
2653
     */
2654
    public function maximizeWindow() {
2655
        return $this->getScenario()->runStep(new \Codeception\Step\Action('maximizeWindow', func_get_args()));
2656
    }
2657
2658
 
2659
    /**
2660
     * [!] Method is generated. Documentation taken from corresponding module.
2661
     *
2662
     * Performs a simple mouse drag-and-drop operation.
2663
     *
2664
     * ``` php
2665
     * <?php
2666
     * $I->dragAndDrop('#drag', '#drop');
2667
     * ?>
2668
     * ```
2669
     *
2670
     * @param string $source (CSS ID or XPath)
2671
     * @param string $target (CSS ID or XPath)
2672
     * @see \Codeception\Module\WebDriver::dragAndDrop()
2673
     */
2674
    public function dragAndDrop($source, $target) {
0 ignored issues
show
Unused Code introduced by
The parameter $source is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $target is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2675
        return $this->getScenario()->runStep(new \Codeception\Step\Action('dragAndDrop', func_get_args()));
2676
    }
2677
2678
 
2679
    /**
2680
     * [!] Method is generated. Documentation taken from corresponding module.
2681
     *
2682
     * Move mouse over the first element matched by the given locator.
2683
     * If the first parameter null then the page is used.
2684
     * If the second and third parameters are given,
2685
     * then the mouse is moved to an offset of the element's top-left corner.
2686
     * Otherwise, the mouse is moved to the center of the element.
2687
     *
2688
     * ``` php
2689
     * <?php
2690
     * $I->moveMouseOver(['css' => '.checkout']);
2691
     * $I->moveMouseOver(null, 20, 50);
2692
     * $I->moveMouseOver(['css' => '.checkout'], 20, 50);
2693
     * ?>
2694
     * ```
2695
     *
2696
     * @param string $cssOrXPath css or xpath of the web element
2697
     * @param int $offsetX
2698
     * @param int $offsetY
2699
     *
2700
     * @throws \Codeception\Exception\ElementNotFound
2701
     * @see \Codeception\Module\WebDriver::moveMouseOver()
2702
     */
2703
    public function moveMouseOver($cssOrXPath = null, $offsetX = null, $offsetY = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXPath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetX is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetY is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2704
        return $this->getScenario()->runStep(new \Codeception\Step\Action('moveMouseOver', func_get_args()));
2705
    }
2706
2707
 
2708
    /**
2709
     * [!] Method is generated. Documentation taken from corresponding module.
2710
     *
2711
     * Performs click with the left mouse button on an element.
2712
     * If the first parameter `null` then the offset is relative to the actual mouse position.
2713
     * If the second and third parameters are given,
2714
     * then the mouse is moved to an offset of the element's top-left corner.
2715
     * Otherwise, the mouse is moved to the center of the element.
2716
     *
2717
     * ``` php
2718
     * <?php
2719
     * $I->clickWithLeftButton(['css' => '.checkout']);
2720
     * $I->clickWithLeftButton(null, 20, 50);
2721
     * $I->clickWithLeftButton(['css' => '.checkout'], 20, 50);
2722
     * ?>
2723
     * ```
2724
     *
2725
     * @param string $cssOrXPath css or xpath of the web element (body by default).
2726
     * @param int $offsetX
2727
     * @param int $offsetY
2728
     *
2729
     * @throws \Codeception\Exception\ElementNotFound
2730
     * @see \Codeception\Module\WebDriver::clickWithLeftButton()
2731
     */
2732
    public function clickWithLeftButton($cssOrXPath = null, $offsetX = null, $offsetY = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXPath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetX is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetY is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2733
        return $this->getScenario()->runStep(new \Codeception\Step\Action('clickWithLeftButton', func_get_args()));
2734
    }
2735
2736
 
2737
    /**
2738
     * [!] Method is generated. Documentation taken from corresponding module.
2739
     *
2740
     * Performs contextual click with the right mouse button on an element.
2741
     * If the first parameter `null` then the offset is relative to the actual mouse position.
2742
     * If the second and third parameters are given,
2743
     * then the mouse is moved to an offset of the element's top-left corner.
2744
     * Otherwise, the mouse is moved to the center of the element.
2745
     *
2746
     * ``` php
2747
     * <?php
2748
     * $I->clickWithRightButton(['css' => '.checkout']);
2749
     * $I->clickWithRightButton(null, 20, 50);
2750
     * $I->clickWithRightButton(['css' => '.checkout'], 20, 50);
2751
     * ?>
2752
     * ```
2753
     *
2754
     * @param string $cssOrXPath css or xpath of the web element (body by default).
2755
     * @param int $offsetX
2756
     * @param int $offsetY
2757
     *
2758
     * @throws \Codeception\Exception\ElementNotFound
2759
     * @see \Codeception\Module\WebDriver::clickWithRightButton()
2760
     */
2761
    public function clickWithRightButton($cssOrXPath = null, $offsetX = null, $offsetY = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXPath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetX is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetY is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2762
        return $this->getScenario()->runStep(new \Codeception\Step\Action('clickWithRightButton', func_get_args()));
2763
    }
2764
2765
 
2766
    /**
2767
     * [!] Method is generated. Documentation taken from corresponding module.
2768
     *
2769
     * Pauses test execution in debug mode.
2770
     * To proceed test press "ENTER" in console.
2771
     *
2772
     * This method is useful while writing tests,
2773
     * since it allows you to inspect the current page in the middle of a test case.
2774
     * @see \Codeception\Module\WebDriver::pauseExecution()
2775
     */
2776
    public function pauseExecution() {
2777
        return $this->getScenario()->runStep(new \Codeception\Step\Action('pauseExecution', func_get_args()));
2778
    }
2779
2780
 
2781
    /**
2782
     * [!] Method is generated. Documentation taken from corresponding module.
2783
     *
2784
     * Performs a double-click on an element matched by CSS or XPath.
2785
     *
2786
     * @param $cssOrXPath
2787
     * @throws \Codeception\Exception\ElementNotFound
2788
     * @see \Codeception\Module\WebDriver::doubleClick()
2789
     */
2790
    public function doubleClick($cssOrXPath) {
0 ignored issues
show
Unused Code introduced by
The parameter $cssOrXPath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2791
        return $this->getScenario()->runStep(new \Codeception\Step\Action('doubleClick', func_get_args()));
2792
    }
2793
2794
 
2795
    /**
2796
     * [!] Method is generated. Documentation taken from corresponding module.
2797
     *
2798
     * Presses the given key on the given element.
2799
     * To specify a character and modifier (e.g. ctrl, alt, shift, meta), pass an array for $char with
2800
     * the modifier as the first element and the character as the second.
2801
     * For special keys use key constants from WebDriverKeys class.
2802
     *
2803
     * ``` php
2804
     * <?php
2805
     * // <input id="page" value="old" />
2806
     * $I->pressKey('#page','a'); // => olda
2807
     * $I->pressKey('#page',array('ctrl','a'),'new'); //=> new
2808
     * $I->pressKey('#page',array('shift','111'),'1','x'); //=> old!!!1x
2809
     * $I->pressKey('descendant-or-self::*[@id='page']','u'); //=> oldu
2810
     * $I->pressKey('#name', array('ctrl', 'a'), \Facebook\WebDriver\WebDriverKeys::DELETE); //=>''
2811
     * ?>
2812
     * ```
2813
     *
2814
     * @param $element
2815
     * @param $char string|array Can be char or array with modifier. You can provide several chars.
2816
     * @throws \Codeception\Exception\ElementNotFound
2817
     * @see \Codeception\Module\WebDriver::pressKey()
2818
     */
2819
    public function pressKey($element, $char) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $char is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2820
        return $this->getScenario()->runStep(new \Codeception\Step\Action('pressKey', func_get_args()));
2821
    }
2822
2823
 
2824
    /**
2825
     * [!] Method is generated. Documentation taken from corresponding module.
2826
     *
2827
     * Append the given text to the given element.
2828
     * Can also add a selection to a select box.
2829
     *
2830
     * ``` php
2831
     * <?php
2832
     * $I->appendField('#mySelectbox', 'SelectValue');
2833
     * $I->appendField('#myTextField', 'appended');
2834
     * ?>
2835
     * ```
2836
     *
2837
     * @param string $field
2838
     * @param string $value
2839
     * @throws \Codeception\Exception\ElementNotFound
2840
     * @see \Codeception\Module\WebDriver::appendField()
2841
     */
2842
    public function appendField($field, $value) {
0 ignored issues
show
Unused Code introduced by
The parameter $field is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2843
        return $this->getScenario()->runStep(new \Codeception\Step\Action('appendField', func_get_args()));
2844
    }
2845
2846
 
2847
    /**
2848
     * [!] Method is generated. Documentation taken from corresponding module.
2849
     *
2850
     * Saves current cookies into named snapshot in order to restore them in other tests
2851
     * This is useful to save session state between tests.
2852
     * For example, if user needs log in to site for each test this scenario can be executed once
2853
     * while other tests can just restore saved cookies.
2854
     *
2855
     * ``` php
2856
     * <?php
2857
     * // inside AcceptanceTester class:
2858
     *
2859
     * public function login()
2860
     * {
2861
     *      // if snapshot exists - skipping login
2862
     *      if ($I->loadSessionSnapshot('login')) return;
2863
     *
2864
     *      // logging in
2865
     *      $I->amOnPage('/login');
2866
     *      $I->fillField('name', 'jon');
2867
     *      $I->fillField('password', '123345');
2868
     *      $I->click('Login');
2869
     *
2870
     *      // saving snapshot
2871
     *      $I->saveSessionSnapshot('login');
2872
     * }
2873
     * ?>
2874
     * ```
2875
     *
2876
     * @param $name
2877
     * @return mixed
2878
     * @see \Codeception\Module\WebDriver::saveSessionSnapshot()
2879
     */
2880
    public function saveSessionSnapshot($name) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2881
        return $this->getScenario()->runStep(new \Codeception\Step\Action('saveSessionSnapshot', func_get_args()));
2882
    }
2883
2884
 
2885
    /**
2886
     * [!] Method is generated. Documentation taken from corresponding module.
2887
     *
2888
     * Loads cookies from a saved snapshot.
2889
     * Allows to reuse same session across tests without additional login.
2890
     *
2891
     * See [saveSessionSnapshot](#saveSessionSnapshot)
2892
     *
2893
     * @param $name
2894
     * @return mixed
2895
     * @see \Codeception\Module\WebDriver::loadSessionSnapshot()
2896
     */
2897
    public function loadSessionSnapshot($name) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2898
        return $this->getScenario()->runStep(new \Codeception\Step\Action('loadSessionSnapshot', func_get_args()));
2899
    }
2900
2901
 
2902
    /**
2903
     * [!] Method is generated. Documentation taken from corresponding module.
2904
     *
2905
     * Deletes session snapshot.
2906
     *
2907
     * See [saveSessionSnapshot](#saveSessionSnapshot)
2908
     *
2909
     * @param $name
2910
     * @return mixed
2911
     * @see \Codeception\Module\WebDriver::deleteSessionSnapshot()
2912
     */
2913
    public function deleteSessionSnapshot($name) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2914
        return $this->getScenario()->runStep(new \Codeception\Step\Action('deleteSessionSnapshot', func_get_args()));
2915
    }
2916
2917
 
2918
    /**
2919
     * [!] Method is generated. Documentation taken from corresponding module.
2920
     *
2921
     * Move to the middle of the given element matched by the given locator.
2922
     * Extra shift, calculated from the top-left corner of the element,
2923
     * can be set by passing $offsetX and $offsetY parameters.
2924
     *
2925
     * ``` php
2926
     * <?php
2927
     * $I->scrollTo(['css' => '.checkout'], 20, 50);
2928
     * ?>
2929
     * ```
2930
     *
2931
     * @param $selector
2932
     * @param int $offsetX
2933
     * @param int $offsetY
2934
     * @see \Codeception\Module\WebDriver::scrollTo()
2935
     */
2936
    public function scrollTo($selector, $offsetX = null, $offsetY = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $selector is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetX is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $offsetY is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2937
        return $this->getScenario()->runStep(new \Codeception\Step\Action('scrollTo', func_get_args()));
2938
    }
2939
2940
 
2941
    /**
2942
     * [!] Method is generated. Documentation taken from corresponding module.
2943
     *
2944
     * Opens a new browser tab (wherever it is possible) and switches to it.
2945
     *
2946
     * ```php
2947
     * <?php
2948
     * $I->openNewTab();
2949
     * ```
2950
     * Tab is opened by using `window.open` javascript in a browser.
2951
     * Please note, that adblock can restrict creating such tabs.
2952
     *
2953
     * Can't be used with PhantomJS
2954
     *
2955
     * @see \Codeception\Module\WebDriver::openNewTab()
2956
     */
2957
    public function openNewTab() {
2958
        return $this->getScenario()->runStep(new \Codeception\Step\Action('openNewTab', func_get_args()));
2959
    }
2960
2961
 
2962
    /**
2963
     * [!] Method is generated. Documentation taken from corresponding module.
2964
     *
2965
     * Closes current browser tab and switches to previous active tab.
2966
     *
2967
     * ```php
2968
     * <?php
2969
     * $I->closeTab();
2970
     * ```
2971
     *
2972
     * Can't be used with PhantomJS
2973
     * @see \Codeception\Module\WebDriver::closeTab()
2974
     */
2975
    public function closeTab() {
2976
        return $this->getScenario()->runStep(new \Codeception\Step\Action('closeTab', func_get_args()));
2977
    }
2978
2979
 
2980
    /**
2981
     * [!] Method is generated. Documentation taken from corresponding module.
2982
     *
2983
     * Switches to next browser tab.
2984
     * An offset can be specified.
2985
     *
2986
     * ```php
2987
     * <?php
2988
     * // switch to next tab
2989
     * $I->switchToNextTab();
2990
     * // switch to 2nd next tab
2991
     * $I->switchToNextTab(2);
2992
     * ```
2993
     *
2994
     * Can't be used with PhantomJS
2995
     *
2996
     * @param int $offset 1
2997
     * @see \Codeception\Module\WebDriver::switchToNextTab()
2998
     */
2999
    public function switchToNextTab($offset = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $offset is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3000
        return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToNextTab', func_get_args()));
3001
    }
3002
3003
 
3004
    /**
3005
     * [!] Method is generated. Documentation taken from corresponding module.
3006
     *
3007
     * Switches to previous browser tab.
3008
     * An offset can be specified.
3009
     *
3010
     * ```php
3011
     * <?php
3012
     * // switch to previous tab
3013
     * $I->switchToPreviousTab();
3014
     * // switch to 2nd previous tab
3015
     * $I->switchToPreviousTab(2);
3016
     * ```
3017
     *
3018
     * Can't be used with PhantomJS
3019
     *
3020
     * @param int $offset 1
3021
     * @see \Codeception\Module\WebDriver::switchToPreviousTab()
3022
     */
3023
    public function switchToPreviousTab($offset = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $offset is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3024
        return $this->getScenario()->runStep(new \Codeception\Step\Action('switchToPreviousTab', func_get_args()));
3025
    }
3026
3027
 
3028
    /**
3029
     * [!] Method is generated. Documentation taken from corresponding module.
3030
     *
3031
     * Waits for element and runs a sequence of actions inside its context.
3032
     * Actions can be defined with array, callback, or `Codeception\Util\ActionSequence` instance.
3033
     *
3034
     * Actions as array are recommended for simple to combine "waitForElement" with assertions;
3035
     * `waitForElement($el)` and `see('text', $el)` can be simplified to:
3036
     *
3037
     * ```php
3038
     * <?php
3039
     * $I->performOn($el, ['see' => 'text']);
3040
     * ```
3041
     *
3042
     * List of actions can be pragmatically build using `Codeception\Util\ActionSequence`:
3043
     *
3044
     * ```php
3045
     * <?php
3046
     * $I->performOn('.model', ActionSequence::build()
3047
     *     ->see('Warning')
3048
     *     ->see('Are you sure you want to delete this?')
3049
     *     ->click('Yes')
3050
     * );
3051
     * ```
3052
     *
3053
     * Actions executed from array or ActionSequence will print debug output for actions, and adds an action name to
3054
     * exception on failure.
3055
     *
3056
     * Whenever you need to define more actions a callback can be used. A WebDriver module is passed for argument:
3057
     *
3058
     * ```php
3059
     * <?php
3060
     * $I->performOn('.rememberMe', function (WebDriver $I) {
3061
     *      $I->see('Remember me next time');
3062
     *      $I->seeElement('#LoginForm_rememberMe');
3063
     *      $I->dontSee('Login');
3064
     * });
3065
     * ```
3066
     *
3067
     * In 3rd argument you can set number a seconds to wait for element to appear
3068
     *
3069
     * @param $element
3070
     * @param $actions
3071
     * @param int $timeout
3072
     * @see \Codeception\Module\WebDriver::performOn()
3073
     */
3074
    public function performOn($element, $actions, $timeout = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $element is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $actions is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $timeout is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3075
        return $this->getScenario()->runStep(new \Codeception\Step\Action('performOn', func_get_args()));
3076
    }
3077
3078
 
3079
    /**
3080
     * [!] Method is generated. Documentation taken from corresponding module.
3081
     *
3082
     *
3083
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::getClientCredentials()
3084
     */
3085
    public function getClientCredentials() {
3086
        return $this->getScenario()->runStep(new \Codeception\Step\Action('getClientCredentials', func_get_args()));
3087
    }
3088
3089
 
3090
    /**
3091
     * [!] Method is generated. Documentation taken from corresponding module.
3092
     *
3093
     *
3094
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::getSellerCredentials()
3095
     */
3096
    public function getSellerCredentials() {
3097
        return $this->getScenario()->runStep(new \Codeception\Step\Action('getSellerCredentials', func_get_args()));
3098
    }
3099
3100
 
3101
    /**
3102
     * [!] Method is generated. Documentation taken from corresponding module.
3103
     *
3104
     *
3105
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::getManagerCredentials()
3106
     */
3107
    public function getManagerCredentials() {
3108
        return $this->getScenario()->runStep(new \Codeception\Step\Action('getManagerCredentials', func_get_args()));
3109
    }
3110
3111
 
3112
    /**
3113
     * [!] Method is generated. Documentation taken from corresponding module.
3114
     *
3115
     *
3116
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::getAdminCredentials()
3117
     */
3118
    public function getAdminCredentials() {
3119
        return $this->getScenario()->runStep(new \Codeception\Step\Action('getAdminCredentials', func_get_args()));
3120
    }
3121
3122
 
3123
    /**
3124
     * [!] Method is generated. Documentation taken from corresponding module.
3125
     *
3126
     *
3127
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::restartBrowser()
3128
     */
3129
    public function restartBrowser() {
3130
        return $this->getScenario()->runStep(new \Codeception\Step\Action('restartBrowser', func_get_args()));
3131
    }
3132
3133
 
3134
    /**
3135
     * [!] Method is generated. Documentation taken from corresponding module.
3136
     *
3137
     *
3138
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::needPage()
3139
     */
3140
    public function needPage($url) {
0 ignored issues
show
Unused Code introduced by
The parameter $url is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3141
        return $this->getScenario()->runStep(new \Codeception\Step\Action('needPage', func_get_args()));
3142
    }
3143
3144
 
3145
    /**
3146
     * [!] Method is generated. Documentation taken from corresponding module.
3147
     *
3148
     *
3149
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::storeSession()
3150
     */
3151
    public function storeSession($name) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3152
        return $this->getScenario()->runStep(new \Codeception\Step\Action('storeSession', func_get_args()));
3153
    }
3154
3155
 
3156
    /**
3157
     * [!] Method is generated. Documentation taken from corresponding module.
3158
     *
3159
     *
3160
     * @see \hipanel\tests\_support\Helper\CredentialsProvider::retrieveSession()
3161
     */
3162
    public function retrieveSession($name) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3163
        return $this->getScenario()->runStep(new \Codeception\Step\Action('retrieveSession', func_get_args()));
3164
    }
3165
3166
 
3167
    /**
3168
     * [!] Method is generated. Documentation taken from corresponding module.
3169
     *
3170
     *
3171
     * @see \hipanel\tests\_support\Helper\PnotifyHelper::closeNotification()
3172
     */
3173
    public function closeNotification($text) {
0 ignored issues
show
Unused Code introduced by
The parameter $text is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3174
        return $this->getScenario()->runStep(new \Codeception\Step\Action('closeNotification', func_get_args()));
3175
    }
3176
3177
 
3178
    /**
3179
     * [!] Method is generated. Documentation taken from corresponding module.
3180
     *
3181
     * @param $textOnButton
3182
     * @throws \Codeception\Exception\ModuleException
3183
     * @see \hipanel\tests\_support\Helper\PressButtonHelper::pressButton()
3184
     */
3185
    public function pressButton($textOnButton) {
0 ignored issues
show
Unused Code introduced by
The parameter $textOnButton is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3186
        return $this->getScenario()->runStep(new \Codeception\Step\Action('pressButton', func_get_args()));
3187
    }
3188
3189
 
3190
    /**
3191
     * [!] Method is generated. Documentation taken from corresponding module.
3192
     *
3193
     * @param int $timeOut
3194
     * @throws \Codeception\Exception\ModuleException
3195
     * @see \hipanel\tests\_support\Helper\WaitHelper::waitForPageUpdate()
3196
     */
3197
    public function waitForPageUpdate($timeOut = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $timeOut is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3198
        return $this->getScenario()->runStep(new \Codeception\Step\Action('waitForPageUpdate', func_get_args()));
3199
    }
3200
}
3201