W3cubDocs

/Codeception

Memcache

Installation

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

composer require --dev codeception/module-memcache

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

codecept init upgrade4

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

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)

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

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

Public Properties

  • memcache - instance of Memcache or Memcached object

Actions

clearMemcache

Flushes all Memcached data.

dontSeeInMemcached

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

Examples:

<?php
// With only one argument, only checks the key does not exist
$I->dontSeeInMemcached('users_count');

// Checks a 'users_count' exists does not exist or its value is not the one provided
$I->dontSeeInMemcached('users_count', 200);
?>
  • param $key
  • param $value

grabValueFromMemcached

Grabs value from memcached by key.

Example:

<?php
$users_count = $I->grabValueFromMemcached('users_count');
?>
  • param $key
  • return array string

haveInMemcached

Stores an item $value with $key on the Memcached server.

  • param string $key
  • param mixed $value
  • param int $expiration

seeInMemcached

Checks item in Memcached exists and the same as expected.

Examples:

<?php
// With only one argument, only checks the key exists
$I->seeInMemcached('users_count');

// Checks a 'users_count' exists and has the value 200
$I->seeInMemcached('users_count', 200);
?>
  • param $key
  • param $value

© 2011 Michael Bodnarchuk and contributors
Licensed under the MIT License.
https://codeception.com/docs/modules/Memcache