Skip to content

Latest commit

 

History

History
158 lines (93 loc) · 3.27 KB

File metadata and controls

158 lines (93 loc) · 3.27 KB
layout title
doc
Apc - Codeception - Documentation

Apc

Installation

If you use Codeception installed using composer, install this module with the following command:

{% highlight yaml %} composer require --dev codeception/module-apc

{% endhighlight %}

Alternatively, you can enable Apc module in suite configuration file and run

{% highlight yaml %} codecept init upgrade4

{% endhighlight %}

This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
Some modules are bundled with PHAR files.
Warning. Using PHAR file and composer in the same project can cause unexpected errors.

Description

This module interacts with the Alternative PHP Cache (APC) using APCu extension.

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

Status

Example (unit.suite.yml)

{% highlight yaml %}

modules: - Apc

{% endhighlight %}

Be sure you don't use the production server to connect.

Actions

dontSeeInApc

  • param string $key
  • param mixed $value
  • return void

Checks item in APCu doesn't exist or is the same as expected.

Examples:

{% highlight php %}

dontSeeInApc('users_count'); // Checks a 'users_count' exists does not exist or its value is not the one provided $I->dontSeeInApc('users_count', 200); {% endhighlight %} #### flushApc * `return void` Clears the APCu cache #### grabValueFromApc * `param string` $key * `return mixed` Grabs value from APCu by key. Example: {% highlight php %} grabValueFromApc('users_count'); {% endhighlight %} #### haveInApc * `param string` $key * `param mixed` $value * `param int` $expiration * `return string` Stores an item `$value` with `$key` on the APCu. Examples: {% highlight php %} haveInApc('users', ['name' => 'miles', 'email' => 'miles@davis.com']); // Object $I->haveInApc('user', UserRepository::findFirst()); // Key as array of 'key => value' $entries = []; $entries['key1'] = 'value1'; $entries['key2'] = 'value2'; $entries['key3'] = ['value3a','value3b']; $entries['key4'] = 4; $I->haveInApc($entries, null); {% endhighlight %} #### seeInApc * `param string` $key * `param mixed` $value * `return void` Checks item in APCu exists and the same as expected. Examples: {% highlight php %} seeInApc('users_count'); // Checks a 'users_count' exists and has the value 200 $I->seeInApc('users_count', 200); {% endhighlight %}

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference