Skip to content

Latest commit

 

History

History
133 lines (76 loc) · 2.76 KB

File metadata and controls

133 lines (76 loc) · 2.76 KB
layout doc
title Memcache - Codeception - Documentation

Memcache

Installation

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

{% endhighlight %}

Description

Connects to memcached using either Memcache or Memcached extension.

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

Status

Configuration

  • host (string, default 'localhost') - The memcached host
  • port (int, default 11211) - The memcached port

Example (unit.suite.yml)

{% highlight yaml %}

modules: - Memcache: host: 'localhost' port: 11211

{% endhighlight %}

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

Public Properties

  • memcache - instance of Memcache or Memcached object

Actions

clearMemcache

  • return void

Flushes all Memcached data.

dontSeeInMemcached

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

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

Examples:

{% highlight php %}

dontSeeInMemcached('users_count'); // Checks a 'users_count' exists does not exist or its value is not the one provided $I->dontSeeInMemcached('users_count', 200); {% endhighlight %} #### grabValueFromMemcached * `param string` $key * `return mixed` Grabs value from memcached by key. Example: {% highlight php %} grabValueFromMemcached('users_count'); {% endhighlight %} #### haveInMemcached * `param string` $key * `param mixed` $value * `param int` $expiration * `return void` Stores an item `$value` with `$key` on the Memcached server. #### seeInMemcached * `param string` $key * `param mixed` $value * `return void` Checks item in Memcached exists and the same as expected. Examples: {% highlight php %} seeInMemcached('users_count'); // Checks a 'users_count' exists and has the value 200 $I->seeInMemcached('users_count', 200); {% endhighlight %}

 

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