OctoberCMS - CachableComponent

CachableComponent.php

<?php

use Cache;
use Cms\Classes\ComponentBase;

abstract class CachableComponentBase extends ComponentBase
{
    /**
     * Build cache configuration which is an array: ['cachedKey' => 'The cache key value', 'cachedTimeInMinutes' => 'Cached time in minutes']
     * @return mixed
     */
    public abstract function cacheConfig();

    protected abstract function prepareData();

    public function onRender()
    {
        $cachedConfig = $this->cacheConfig();
        $key = $cachedConfig['key'];
        $minutes = $cachedConfig['cachedTimeInMinutes'];
        $result = Cache::remember($key, $minutes, function()  {
            $this->prepareData();
            $output = $this->renderPartial('@default');
            return $output;
        });

        return $result;
    }

}

ExampleComponent.php

<?php 
use \ExampleComponent;
class ExampleComponent extends CachableComponentBase
{
    public function cacheConfig()
    {
        return ['key' => '_example_component_key',
                'cachedTimeInMinutes' => 10];
    }
    
    protected function prepareData() {
        //prepare your data before rendering the component
    }
}