Skip to content

Commit 9dbbc5c

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent d2b760f commit 9dbbc5c

File tree

6 files changed

+77
-407
lines changed

6 files changed

+77
-407
lines changed

‎changelog.markdown

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ title: Codeception Changelog
1010
#### 2.2.9
1111

1212
* **[Laravel5]** **Laravel 5.4 support** by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**
13-
* **[WebDriver]** Added `performOn` to wait for element, and run actions inside it. See [complete reference](http://codeception.com/docs/modules/WebDriver#performOn). [#3986](https://github.com/Codeception/Codeception/issues/3986)
13+
* **[WebDriver]** Added [performOn](http://codeception.com/docs/modules/WebDriver#performOn) method to wait for an element and run sequence of actions inside it. [#3986](https://github.com/Codeception/Codeception/issues/3986)
1414
* **[WebDriver]** Improved error messages for `wait*` methods by **[disc](https://github.com/disc)**. See [#3983](https://github.com/Codeception/Codeception/issues/3983)
1515
* **[REST]** Binary responses support by **[spikyjt](https://github.com/spikyjt)** [#3993](https://github.com/Codeception/Codeception/issues/3993) [#3985](https://github.com/Codeception/Codeception/issues/3985)
16-
* `seeBinaryResponseEquals` assert that binary response matches a hash
17-
* `seeBinaryResponseEquals` assert that binary response doesn't match a hash
16+
* [seeBinaryResponseEquals](http://codeception.com/docs/modules/REST#seeBinaryResponseEquals) assert that binary response matches a hash
17+
* [dontSeeBinaryResponseEquals](http://codeception.com/docs/modules/REST#dontSeeBinaryResponseEquals) assert that binary response doesn't match a hash
1818
* hide binary response on debug
1919
* **[Laravel5]** module fix error for applications that do not use a database. See [#3954](https://github.com/Codeception/Codeception/issues/3954) by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**. Fixed [#3942](https://github.com/Codeception/Codeception/issues/3942)
2020
* **[Laravel5]** database seeders to be executed inside a transaction. See [#3954](https://github.com/Codeception/Codeception/issues/3954) by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**. Fixed [#3948](https://github.com/Codeception/Codeception/issues/3948) by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**
@@ -27,13 +27,13 @@ title: Codeception Changelog
2727
#### 2.2.8
2828

2929
* **[WebDriver]** Added tab actions (not supported in PhantomJS):
30-
* `openNewTab` opens a new tab and switches to it
31-
* `closeTab` closes a tab and switches to previous
32-
* `switchToNextTab` switches to next tab
33-
* `switchToPreviousTab` switches to previous tab
30+
* [openNewTab](http://codeception.com/docs/modules/WebDriver#openNewTab) opens a new tab and switches to it
31+
* [closeTab](http://codeception.com/docs/modules/WebDriver#closeTab) closes a tab and switches to previous
32+
* [switchToNextTab](http://codeception.com/docs/modules/WebDriver#switchToNextTab) switches to next tab
33+
* [switchToPreviousTab](http://codeception.com/docs/modules/WebDriver#switchToPreviousTab) switches to previous tab
3434
* **[WebDriver]** Added actions to click element by coordinates. Via **[gimler](https://github.com/gimler)**
35-
* `clickWithLeftButton` clicks element with offset
36-
* `clickWithRightButton` right clicks on element with offset
35+
* [clickWithLeftButton](http://codeception.com/docs/modules/WebDriver#clickWithLeftButton) clicks element with offset
36+
* [clickWithRightButton](http://codeception.com/docs/modules/WebDriver#clickWithRightButton) right clicks on element with offset
3737
* **[WebDriver]** Added `js_error_logging` option to print JS logs in console and in HTML report by **[ngraf](https://github.com/ngraf)**. See [#3821](https://github.com/Codeception/Codeception/issues/3821)
3838
* **[WebDriver]** Improvements to `seeInField` by **[gimler](https://github.com/gimler)**. See [#3905](https://github.com/Codeception/Codeception/issues/3905)
3939
* support option text in seeInField not only value

‎docs/modules/AMQP.md

Lines changed: 45 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -58,60 +58,6 @@ To use this module with Composer you need <em>"videlalvaro/php-amqplib": "*"</em
5858

5959
### Actions
6060

61-
#### bindQueueToExchange
62-
63-
Binds a queue to an exchange
64-
65-
This is an alias of method `queue_bind` of `PhpAmqpLib\Channel\AMQPChannel`.
66-
67-
{% highlight php %}
68-
69-
<?php
70-
$I->bindQueueToExchange(
71-
'nameOfMyQueueToBind', // name of the queue
72-
'transactionTracking.transaction', // exchange name to bind to
73-
'your.routing.key' // Optionally, provide a binding key
74-
//.. see the original method for more options
75-
)
76-
77-
{% endhighlight %}
78-
79-
80-
#### declareExchange
81-
82-
Declares an exchange
83-
84-
This is an alias of method `exchange_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
85-
86-
{% highlight php %}
87-
88-
<?php
89-
$I->declareExchange(
90-
'nameOfMyExchange', // exchange name
91-
'topic' // exchange type
92-
//.. see the original method for more options
93-
)
94-
95-
{% endhighlight %}
96-
97-
98-
#### declareQueue
99-
100-
Declares a queue
101-
102-
This is an alias of method `queue_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
103-
104-
{% highlight php %}
105-
106-
<?php
107-
$I->declareQueue(
108-
'nameOfMyQueue', // exchange name
109-
//.. see the original method for more options
110-
)
111-
112-
{% endhighlight %}
113-
114-
11561
#### grabMessageFromQueue
11662

11763
Takes last message from queue.
@@ -185,6 +131,51 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
185131
* `param` $message string|AMQPMessage
186132

187133

134+
#### declareExchange
135+
136+
Declares an exchange. This is an alias of method `exchange_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
137+
138+
{% highlight php %}
139+
140+
<?php
141+
$I->declareExchange(
142+
'nameOfMyExchange', // exchange name
143+
'topic' // exchange type
144+
//.. see the original method for more options
145+
)
146+
147+
{% endhighlight %}
148+
149+
#### declareQueue
150+
151+
Declares a queue. This is an alias of method `queue_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
152+
153+
{% highlight php %}
154+
155+
<?php
156+
$I->declareQueue(
157+
'nameOfMyQueue', // exchange name
158+
//.. see the original method for more options
159+
)
160+
161+
{% endhighlight %}
162+
163+
#### bindQueueToExchange
164+
165+
Binds a queue to an exchange. This is an alias of method `queue_bind` of `PhpAmqpLib\Channel\AMQPChannel`.
166+
167+
{% highlight php %}
168+
169+
<?php
170+
$I->bindQueueToExchange(
171+
'nameOfMyQueueToBind', // name of the queue
172+
'transactionTracking.transaction', // exchange name to bind to
173+
'your.routing.key' // Optionally, provide a binding key
174+
//.. see the original method for more options
175+
)
176+
177+
{% endhighlight %}
178+
188179
#### seeMessageInQueueContainsText
189180

190181
Checks if message containing text received.

‎docs/modules/AngularJS.md

Lines changed: 8 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -331,20 +331,6 @@ $I->clickWithRightButton(['css' => '.checkout'], 20, 50);
331331
@throws \Codeception\Exception\ElementNotFound
332332

333333

334-
#### closeTab
335-
336-
Closes current browser tab and switches to previous active tab.
337-
338-
{% highlight php %}
339-
340-
<?php
341-
$I->closeTab();
342-
343-
{% endhighlight %}
344-
345-
Can't be used with PhantomJS
346-
347-
348334
#### debugWebDriverLogs
349335

350336
Print out latest Selenium Logs in debug mode
@@ -469,7 +455,6 @@ $I->dontSeeElement('input', ['value' => '123456']);
469455
Opposite of `seeElementInDOM`.
470456

471457
* `param` $selector
472-
* `param array` $attributes
473458

474459

475460
#### dontSeeInCurrentUrl
@@ -702,6 +687,13 @@ $I->fillField(['name' => 'email'], 'jon@mail.com');
702687
* `param` $value
703688

704689

690+
#### getVisibleText
691+
692+
Grabs all visible text from the current page.
693+
694+
* `return` string
695+
696+
705697
#### grabAttributeFrom
706698

707699
Grabs the value of the given attribute value from the given element.
@@ -882,23 +874,6 @@ $I->moveMouseOver(['css' => '.checkout'], 20, 50);
882874
@throws \Codeception\Exception\ElementNotFound
883875

884876

885-
#### openNewTab
886-
887-
Opens a new browser tab (wherever it is possible) and switches to it.
888-
889-
{% highlight php %}
890-
891-
<?php
892-
$I->openNewTab();
893-
894-
{% endhighlight %}
895-
Tab is opened by using `window.open` javascript in a browser.
896-
Please note, that adblock can restrict creating such tabs.
897-
898-
Can't be used with PhantomJS
899-
900-
901-
902877
#### pauseExecution
903878

904879
Pauses test execution in debug mode.
@@ -908,57 +883,6 @@ This method is useful while writing tests,
908883
since it allows you to inspect the current page in the middle of a test case.
909884

910885

911-
#### performOn
912-
913-
Waits for element and runs a sequence of actions inside its context.
914-
Actions can be defined with array, callback, or `Codeception\Util\ActionSequence` instance.
915-
916-
Actions as array are recommended for simple to combine "waitForElement" with assertions;
917-
`waitForElement($el)` and `see('text', $el)` can be simplified to:
918-
919-
{% highlight php %}
920-
921-
<?php
922-
$I->performOn($el, ['see' => 'text']);
923-
924-
{% endhighlight %}
925-
926-
List of actions can be pragmatically build using `Codeception\Util\ActionSequence`:
927-
928-
{% highlight php %}
929-
930-
<?php
931-
$I->performOn('.model', ActionSequence::build()
932-
->see('Warning')
933-
->see('Are you sure you want to delete this?')
934-
->click('Yes')
935-
);
936-
937-
{% endhighlight %}
938-
939-
Actions executed from array or ActionSequence will print debug output for actions, and adds an action name to
940-
exception on failure.
941-
942-
Whenever you need to define more actions a callback can be used. A WebDriver module is passed for argument:
943-
944-
{% highlight php %}
945-
946-
<?php
947-
$I->performOn('.rememberMe', function (WebDriver $I) {
948-
$I->see('Remember me next time');
949-
$I->seeElement('#LoginForm_rememberMe');
950-
$I->dontSee('Login');
951-
});
952-
953-
{% endhighlight %}
954-
955-
In 3rd argument you can set number a seconds to wait for element to appear
956-
957-
* `param` $element
958-
* `param` $actions
959-
* `param int` $timeout
960-
961-
962886
#### pressKey
963887

964888
Presses the given key on the given element.
@@ -1178,7 +1102,6 @@ $I->seeElementInDOM('//form/input[type=hidden]');
11781102
{% endhighlight %}
11791103

11801104
* `param` $selector
1181-
* `param array` $attributes
11821105

11831106

11841107
#### seeInCurrentUrl
@@ -1313,8 +1236,6 @@ as created by `window.alert`|`window.confirm`|`window.prompt`, contains the give
13131236

13141237
* `param` $text
13151238

1316-
@throws \Codeception\Exception\ModuleException
1317-
13181239

13191240
#### seeInSource
13201241

@@ -1667,46 +1588,6 @@ $I->switchToIFrame();
16671588
* `param string|null` $name
16681589
16691590
1670-
#### switchToNextTab
1671-
1672-
Switches to next browser tab.
1673-
An offset can be specified.
1674-
1675-
{% highlight php %}
1676-
1677-
<?php
1678-
// switch to next tab
1679-
$I->switchToNextTab();
1680-
// switch to 2nd next tab
1681-
$I->switchToNextTab(2);
1682-
1683-
{% endhighlight %}
1684-
1685-
Can't be used with PhantomJS
1686-
1687-
* `param int` $offset 1
1688-
1689-
1690-
#### switchToPreviousTab
1691-
1692-
Switches to next browser tab.
1693-
An offset can be specified.
1694-
1695-
{% highlight php %}
1696-
1697-
<?php
1698-
// switch to previous tab
1699-
$I->switchToNextTab();
1700-
// switch to 2nd previous tab
1701-
$I->switchToNextTab(-2);
1702-
1703-
{% endhighlight %}
1704-
1705-
Can't be used with PhantomJS
1706-
1707-
* `param int` $offset 1
1708-
1709-
17101591
#### switchToWindow
17111592
17121593
Switch to another window identified by name.
@@ -1732,9 +1613,7 @@ $I->switchToWindow();
17321613
17331614
{% endhighlight %}
17341615
1735-
If the window has no name, match it by switching to next active tab using `switchToNextTab` method.
1736-
1737-
Or use native Selenium functions to get access to all opened windows:
1616+
If the window has no name, the only way to access it is via the `executeInSelenium()` method, like so:
17381617
17391618
{% highlight php %}
17401619
@@ -1757,8 +1636,6 @@ Enters text into a native JavaScript prompt popup, as created by `window.prompt`
17571636
17581637
* `param` $keys
17591638
1760-
@throws \Codeception\Exception\ModuleException
1761-
17621639
17631640
#### uncheckOption
17641641

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy