Skip to content

Commit a9b33f5

Browse files
github-actions[bot]github-actions[bot]
github-actions[bot]
authored and
github-actions[bot]
committed
updated
1 parent 3d910f5 commit a9b33f5

38 files changed

+1165
-7446
lines changed

‎_includes/extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ extensions:
6868

6969
[See Source](https://github.com/Codeception/Codeception/blob/5.0/ext/Recorder.php)
7070

71-
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](http://codeception.com/images/recorder.gif))
71+
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](https://codeception.com/images/recorder.gif))
7272
Activated only for suites with WebDriver module enabled.
7373

7474
The screenshots are saved to `tests/_output/record_*` directories, open `index.html` to see them as a slideshow.
@@ -116,7 +116,7 @@ It is also possible to skip recording of steps for specified tests by using the
116116
public function testLogin(AcceptanceTester $I)
117117
{
118118
$I->login();
119-
$I->amOnUrl('http://codeception.com');
119+
$I->amOnUrl('https://codeception.com');
120120
}
121121
```
122122

‎docs/modules/AMQP.md

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,6 @@ $I->bindQueueToExchange(
8585

8686
{% endhighlight %}
8787

88-
* `param string` $queue
89-
* `param string` $exchange
90-
* `param string` $routing_key
91-
* `param bool` $nowait
92-
* `param array` $arguments
93-
* `param int` $ticket
94-
* `return mixed|null`
9588

9689

9790
#### declareExchange
@@ -110,16 +103,6 @@ $I->declareExchange(
110103

111104
{% endhighlight %}
112105

113-
* `param string` $exchange
114-
* `param string` $type
115-
* `param bool` $passive
116-
* `param bool` $durable
117-
* `param bool` $auto_delete
118-
* `param bool` $internal
119-
* `param bool` $nowait
120-
* `param array` $arguments
121-
* `param int` $ticket
122-
* `return mixed|null`
123106

124107

125108
#### declareQueue
@@ -137,15 +120,6 @@ $I->declareQueue(
137120

138121
{% endhighlight %}
139122

140-
* `param string` $queue
141-
* `param bool` $passive
142-
* `param bool` $durable
143-
* `param bool` $exclusive
144-
* `param bool` $auto_delete
145-
* `param bool` $nowait
146-
* `param array` $arguments
147-
* `param int` $ticket
148-
* `return mixed|null`
149123

150124

151125
#### dontSeeQueueIsEmpty
@@ -157,12 +131,9 @@ Checks if queue is not empty.
157131
<?php
158132
$I->pushToQueue('queue.emails', 'Hello, davert');
159133
$I->dontSeeQueueIsEmpty('queue.emails');
160-
?>
161134

162135
{% endhighlight %}
163136

164-
* `param string` $queue
165-
166137

167138
#### grabMessageFromQueue
168139

@@ -172,13 +143,9 @@ Takes last message from queue.
172143

173144
<?php
174145
$message = $I->grabMessageFromQueue('queue.emails');
175-
?>
176146

177147
{% endhighlight %}
178148

179-
* `param string` $queue
180-
* `return \PhpAmqpLib\Message\AMQPMessage`
181-
182149

183150
#### purgeAllQueues
184151

@@ -188,7 +155,6 @@ Purge all queues defined in config.
188155

189156
<?php
190157
$I->purgeAllQueues();
191-
?>
192158

193159
{% endhighlight %}
194160

@@ -201,12 +167,9 @@ Purge a specific queue defined in config.
201167

202168
<?php
203169
$I->purgeQueue('queue.emails');
204-
?>
205170

206171
{% endhighlight %}
207172

208-
* `param string` $queueName
209-
210173

211174
#### pushToExchange
212175

@@ -219,14 +182,9 @@ and (optionally) a routing key
219182
$I->pushToExchange('exchange.emails', 'thanks');
220183
$I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'));
221184
$I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'), 'severity');
222-
?>
223185

224186
{% endhighlight %}
225187

226-
* `param string` $exchange
227-
* `param string|\PhpAmqpLib\Message\AMQPMessage` $message
228-
* `param string` $routing_key
229-
230188

231189
#### pushToQueue
232190

@@ -237,20 +195,14 @@ Sends message to queue
237195
<?php
238196
$I->pushToQueue('queue.jobs', 'create user');
239197
$I->pushToQueue('queue.jobs', new AMQPMessage('create'));
240-
?>
241198

242199
{% endhighlight %}
243200

244-
* `param string` $queue
245-
* `param string|\PhpAmqpLib\Message\AMQPMessage` $message
246-
247201

248202
#### scheduleQueueCleanup
249203

250204
Add a queue to purge list
251205

252-
* `param string` $queue
253-
254206

255207
#### seeMessageInQueueContainsText
256208

@@ -264,13 +216,9 @@ Checks if message containing text received.
264216
<?php
265217
$I->pushToQueue('queue.emails', 'Hello, davert');
266218
$I->seeMessageInQueueContainsText('queue.emails','davert');
267-
?>
268219

269220
{% endhighlight %}
270221

271-
* `param string` $queue
272-
* `param string` $text
273-
274222

275223
#### seeNumberOfMessagesInQueue
276224

@@ -281,13 +229,9 @@ Checks that queue have expected number of message
281229
<?php
282230
$I->pushToQueue('queue.emails', 'Hello, davert');
283231
$I->seeNumberOfMessagesInQueue('queue.emails',1);
284-
?>
285232

286233
{% endhighlight %}
287234

288-
* `param string` $queue
289-
* `param int` $expected
290-
291235

292236
#### seeQueueIsEmpty
293237

@@ -299,11 +243,7 @@ Checks that queue is empty
299243
$I->pushToQueue('queue.emails', 'Hello, davert');
300244
$I->purgeQueue('queue.emails');
301245
$I->seeQueueIsEmpty('queue.emails');
302-
?>
303246

304247
{% endhighlight %}
305248

306-
* `param string` $queue
307-
* `param int` $expected
308-
309249
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-amqp/tree/master/src/Codeception/Module/AMQP.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/Apc.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
This module interacts with the [Alternative PHP Cache (APC)](http://php.net/manual/en/intro.apcu.php)
36-
using either _APCu_ or _APC_ extension.
35+
This module interacts with the [Alternative PHP Cache (APC)](https://php.net/manual/en/intro.apcu.php)
36+
using _APCu_ extension.
3737

3838
Performs a cleanup by flushing all values after each test run.
3939

@@ -59,7 +59,7 @@ Be sure you don't use the production server to connect.
5959

6060
#### dontSeeInApc
6161

62-
Checks item in APC(u) doesn't exist or is the same as expected.
62+
Checks item in APCu doesn't exist or is the same as expected.
6363

6464
Examples:
6565

@@ -71,39 +71,32 @@ $I->dontSeeInApc('users_count');
7171

7272
// Checks a 'users_count' exists does not exist or its value is not the one provided
7373
$I->dontSeeInApc('users_count', 200);
74-
?>
7574

7675
{% endhighlight %}
7776

78-
* `param string|string[]` $key
79-
* `param mixed` $value
80-
8177

8278
#### flushApc
8379

84-
Clears the APC(u) cache
80+
Clears the APCu cache
8581

8682

8783
#### grabValueFromApc
8884

89-
Grabs value from APC(u) by key.
85+
Grabs value from APCu by key.
9086

9187
Example:
9288

9389
{% highlight php %}
9490

9591
<?php
9692
$users_count = $I->grabValueFromApc('users_count');
97-
?>
9893

9994
{% endhighlight %}
10095

101-
* `param string|string[]` $key
102-
10396

10497
#### haveInApc
10598

106-
Stores an item `$value` with `$key` on the APC(u).
99+
Stores an item `$value` with `$key` on the APCu.
107100

108101
Examples:
109102

@@ -123,18 +116,13 @@ $entries['key2'] = 'value2';
123116
$entries['key3'] = ['value3a','value3b'];
124117
$entries['key4'] = 4;
125118
$I->haveInApc($entries, null);
126-
?>
127119

128120
{% endhighlight %}
129121

130-
* `param string|array` $key
131-
* `param mixed` $value
132-
* `param int` $expiration
133-
134122

135123
#### seeInApc
136124

137-
Checks item in APC(u) exists and the same as expected.
125+
Checks item in APCu exists and the same as expected.
138126

139127
Examples:
140128

@@ -146,11 +134,8 @@ $I->seeInApc('users_count');
146134

147135
// Checks a 'users_count' exists and has the value 200
148136
$I->seeInApc('users_count', 200);
149-
?>
150137

151138
{% endhighlight %}
152139

153-
* `param string|string[]` $key
154-
* `param mixed` $value
155140

156141
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-apc/tree/master/src/Codeception/Module/Apc.php">Help us to improve documentation. Edit module reference</a></div>

0 commit comments

Comments
 (0)