Apc - Codeception - Documentation

Search

Releasessource

Apc

Installation

composer require --dev codeception/module-apc

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)

   modules:
       - Apc

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:

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

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

flushApc

  • return void

Clears the APCu cache

grabValueFromApc

  • param string $key
  • return mixed

Grabs value from APCu by key.

Example:

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

haveInApc

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

Stores an item $value with $key on the APCu.

Examples:

<?php
// Array
$I->haveInApc('users', ['name' => 'miles', 'email' => '[email protected]']);

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

seeInApc

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

Checks item in APCu exists and the same as expected.

Examples:

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

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

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference
Don't know how to write tests on your own? We will build or improve them for you. Request a quote for official enterprise support or trainings
❀ Support us on OpenCollective!