neoan3-apps/cache

Caching based on output buffer

dev-master 2020-12-14 02:06 UTC

MIT

• neoan

README

This class will utilize the output buffer to establish basic caching. This is especially useful if you render static pages server-side after computational procedures.

Installation

composer require neoan3-apps/cache

Usage

1. Set caching as early as possible during execution. In neoan3, the construct of the used frame is ideal.

   function __construct() {
       Neoan3\Apps\Cache::setCaching('-2 hours');
       parent::__construct();
   }

2. Write the output after rendering your application. In a neoan3 frame:

   // overwrite output method
   function output($params = []) {
       parent::output($params);
       Neoan3\Apps\Cache::write();
   }

Methods

setCaching

Neoan3\Apps\Cache::setCaching( strtotime-expression, ['fileEnding'] )

The first parameter expresses the lifetime of the cached file. Use a negative strtotime-expression. The second parameter overwrites the default value ['Controller.php'], which holds values controlling what strings must be included in file-names for the files to be cached.

write

Neoan3\Apps\Cache::write()

Writes the output buffer to a cached file in the respective component.

invalidate

Neoan3\Apps\Cache::invalidate( string )

Takes the name of a component folder as string to delete all cache-files of a particular component.

invalidateAll

Neoan3\Apps\Cache::invalidateAll()

Clears all cache-files in the project.