Memcache - Codeception - Documentation

Installation

composer require --dev codeception/module-memcache

Description

Connects to memcached using either Memcache or Memcached extension.

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

Status

• Maintainer: davert
• Stability: beta
• Contact: [email protected]

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

• 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:

<?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);

grabValueFromMemcached

• param string $key
• return mixed

Grabs value from memcached by key.

Example:

<?php
$users_count = $I->grabValueFromMemcached('users_count');

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:

<?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);