RT Extended Cache

RT Extended Cache is a plugin that extends the native MyBB cache handler with additional functionalities to simplify the work of both users and developers. The plugin provides new functions, including auto expiration time for the cache, auto increment and decrement methods, and the ability to cache database queries on the fly.

Table of contents

1. ❗ Dependencies
2. 📃 Features
3. ➕ Installation
4. 🔼 Update
5. 📜 Usage
6. 💡 Feature request
7. 🙏 Questions
8. 🐞 Bug reports

❗ Dependencies

• MyBB 1.8.x
• PHP >= 8.0

📃 Features

• Note: RT Caches are stored with custom prefix, so you can't use it to load default caches. For that use MyBB's $cache
• Set auto expiration time to the cache.
• Auto increment (convenient method for incrementing value).
• Auto decrement (convenient method for decrementing value).
• Cache database queries on the fly.
• Cache remote api requets on the fly.

➕ Installation

• Copy the directories from the plugin inside your root MyBB installation.

🔼 Update

• Copy/paste new files into your MyBB root directory.

📜 Usage

Load RT Cache into plugin/file

To load RT Cache into your plugin or file, you should include the following snippet at the top of your plugin or below require ./global.php if including inside custom file.

• Load RT Cache inside plugin

<?php

if (!defined("IN_MYBB"))
{
    die("Direct initialization of this file is not allowed.");
}

// START: Include from here
if (!defined('RT_EXTENDEDCACHE'))
{
    define('RT_EXTENDEDCACHE', MYBB_ROOT.'inc/plugins/rt_extendedcache.php');
}
require_once RT_EXTENDEDCACHE;
// END: Include from here

• Load RT Cache inside custom customfile.php

<?php

define("IN_MYBB", 1);
define('THIS_SCRIPT', 'customfile.php');
require_once "./global.php";

// START: Include from here
if (!defined('RT_EXTENDEDCACHE'))
{
    define('RT_EXTENDEDCACHE', MYBB_ROOT.'inc/plugins/rt_extendedcache.php');
}
require_once RT_EXTENDEDCACHE;
// END: Include from here

Then you should include global $rt_cache inside your functions or hooks. For example:

function misc_hook()
{
    global $rt_cache;

    $rt_cache->get('some_cache');
}

Check version

To get plugin version, use the $rt_cache->version. Here's an example to check in your plugin if theres need for newer version of RT Extended Cache:

if ($rt_cache->version < 2)
{
    // do something
}

Set cache

To set cache data, use the set() method with the cache name, cache data, and optional expiration time in seconds as parameters:

$rt_cache->set('cache_name', $data, 3600);

The code above will store $data in the cache with the key cache_name for one hour (3600 seconds).

Get cache

To get cache data, use the get() method with the cache name:

$rt_cache->get('cache_name');

The code above will retrieve $data in the cache with the key cache_name.

Delete cache

The delete() method allows you to delete cache. Here's an example:

$rt_cache->delete("cache_name");

Auto increment

The increment() method is a convenient way to increase the value of a cache key. Use it with the key name and the amount to increase the value:

// Increment the value by 1
$new_value = $rt_cache->increment('foo_bar');

// Increment the value by 5
$new_value = $rt_cache->increment('foo_bar', 5);

// Delete the cache // Will always return 0
$new_value = $rt_cache->increment('foo_bar', 0);

Auto decrement

The increment() method is a convenient way to decrease the value of a cache key. Use it with the key name and the amount to decrease the value:

// Decrement the value by 1
$new_value = $rt_cache->decrement('foo_baz');

// Decrement the value by 5
$new_value = $rt_cache->decrement('foo_baz', 5);

// Delete the cache
$new_value = $rt_cache->decrement('foo_baz', 0);

Get cached query

The query() method allows you to cache the results of database queries. Here's an example:

$uid = 1;
$user = $rt_cache->query("SELECT * FROM " . TABLE_PREFIX . "users WHERE uid = '{$db->escape_string($uid)}'")
                  ->cache('cached_user_data_' . $uid, 3600)
                  ->execute();

The code above will cache the query and store it with a key cached_user_data_$uid for 3600 seconds, after that it will refresh the query and get new data.

Delete cached query

The delete() method allows you to delete the query cache with key name. Here's an example:

$uid = 1;
$user = $rt_cache->query("SELECT * FROM " . TABLE_PREFIX . "users WHERE uid = '{$db->escape_string($uid)}'")
                  ->delete('cached_user_data_' . $uid);

The code above will delete the cached query with a key cached_user_data_$uid.

Get cached API request

The api() method allows you to cache the results of requested API url. Here's an example:

$user = $rt_cache->api("https://api-link.com/")
                  ->cache('api_data_from', 3600)
                  ->execute();

The code above will cache the api response and store it with a key api_data_from for 3600 seconds, after that it will get new request to api and get new data.

Delete cached query

The delete() method allows you to delete the API cache with key name. Here's an example:

$user = $rt_cache->api("https://api-link.com/")
                  ->delete('api_data_from');

The code above will delete the cached api with a key api_data_from.

💡 Feature request

Open a new idea by clicking here

🙏 Questions

Open a new question by clicking here

🐞 Bug reports

Open a new bug report by clicking here