\Smarty_CacheResource_Mysql

MySQL CacheResource CacheResource Implementation based on the Custom API to use MySQL as the storage resource for Smarty's output caching.

Table definition:

CREATE TABLE IF NOT EXISTS `output_cache` (
  `id` CHAR(40) NOT NULL COMMENT 'sha1 hash',
  `name` VARCHAR(250) NOT NULL,
  `cache_id` VARCHAR(250) NULL DEFAULT NULL,
  `compile_id` VARCHAR(250) NULL DEFAULT NULL,
  `modified` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
  `content` LONGTEXT NOT NULL,
  PRIMARY KEY (`id`),
  INDEX(`name`),
  INDEX(`cache_id`),
  INDEX(`compile_id`),
  INDEX(`modified`)
) ENGINE = InnoDB;

Summary

Methods

Properties

Constants

populate()
populateTimestamp()
process()
writeCachedContent()
readCachedContent()
clearAll()
clear()
hasLock()
acquireLock()
releaseLock()
getCachedContent()
locked()
load()
__construct()

No public properties found

No constants found

fetch()
fetchTimestamp()
save()
delete()

$sysplugins
$db
$fetch
$fetchTimestamp
$save

N/A

No private methods found

No private properties found

N/A

File: vendor/smarty/smarty/demo/plugins/cacheresource.mysql.php
Package: CacheResource-examples
Class hierarchy: \Smarty_CacheResource

\Smarty_CacheResource_Custom

\Smarty_CacheResource_Mysql

Properties

$sysplugins

$sysplugins : array

resource types provided by the core

Type

array

$db

$db :

Type

$fetch

$fetch :

Type

$fetchTimestamp

$fetchTimestamp :

Type

$save

$save :

Type

Methods

populate()

populate(\Smarty_Template_Cached  $cached, \Smarty_Internal_Template  $_template) : void

populate Cached Object with meta data from Resource

Parameters

\Smarty_Template_Cached	$cached	cached object
\Smarty_Internal_Template	$_template	template object

populateTimestamp()

populateTimestamp(\Smarty_Template_Cached  $cached) : void

populate Cached Object with timestamp and exists from Resource

Parameters

\Smarty_Template_Cached

$cached

process()

process(\Smarty_Internal_Template  $_template, \Smarty_Template_Cached  $cached = null, boolean  $update = false) : boolean

Read the cached template and process header

Parameters

\Smarty_Internal_Template	$_template	template object
\Smarty_Template_Cached	$cached	cached object
boolean	$update	flag if called because cache update

Returns

boolean —

true or false if the cached content does not exist

writeCachedContent()

writeCachedContent(\Smarty_Internal_Template  $_template, string  $content) : boolean

Write the rendered template output to cache

Parameters

\Smarty_Internal_Template	$_template	template object
string	$content	content to cache

Returns

boolean —

success

readCachedContent()

readCachedContent(\Smarty_Internal_Template  $_template) : string

Read cached template from cache

Parameters

\Smarty_Internal_Template

$_template

template object

Returns

string —

content

clearAll()

clearAll(\Smarty  $smarty, integer  $exp_time = null) : integer

Empty cache

Parameters

\Smarty	$smarty	Smarty object
integer	$exp_time	expiration time (number of seconds, not timestamp)

Returns

integer —

number of cache files deleted

clear()

clear(\Smarty  $smarty, string  $resource_name, string  $cache_id, string  $compile_id, integer  $exp_time) : integer

Empty cache for a specific template

Parameters

\Smarty	$smarty	Smarty object
string	$resource_name	template name
string	$cache_id	cache id
string	$compile_id	compile id
integer	$exp_time	expiration time (number of seconds, not timestamp)

Returns

integer —

number of cache files deleted

hasLock()

hasLock(\Smarty  $smarty, \Smarty_Template_Cached  $cached) : boolean

Check is cache is locked for this template

Parameters

\Smarty	$smarty
\Smarty_Template_Cached	$cached

Returns

boolean

acquireLock()

acquireLock(\Smarty  $smarty, \Smarty_Template_Cached  $cached) : boolean

Lock cache for this template

Parameters

\Smarty	$smarty
\Smarty_Template_Cached	$cached

Returns

boolean

releaseLock()

releaseLock(\Smarty  $smarty, \Smarty_Template_Cached  $cached) : boolean

Unlock cache for this template

Parameters

\Smarty	$smarty
\Smarty_Template_Cached	$cached

Returns

boolean

getCachedContent()

getCachedContent(\Smarty_Internal_Template  $_template) : null|string

Return cached content

Parameters

\Smarty_Internal_Template

$_template

template object

Returns

null|string

locked()

locked(\Smarty  $smarty, \Smarty_Template_Cached  $cached) : boolean|null

Parameters

\Smarty	$smarty
\Smarty_Template_Cached	$cached

Returns

boolean|null

load()

load(\Smarty  $smarty, string  $type = null) : \Smarty_CacheResource

Load Cache Resource Handler

Parameters

\Smarty	$smarty	Smarty object
string	$type	name of the cache resource

Throws

\SmartyException

Returns

\Smarty_CacheResource —

Cache Resource Handler

__construct()

__construct()

fetch()

fetch(string  $id, string  $name, string  $cache_id, string  $compile_id, string  $content, integer  $mtime) : void

fetch cached content and its modification time from data source

Parameters

string	$id	unique cache content identifier
string	$name	template name
string	$cache_id	cache id
string	$compile_id	compile id
string	$content	cached content
integer	$mtime	cache modification timestamp (epoch)

fetchTimestamp()

fetchTimestamp(string  $id, string  $name, string  $cache_id, string  $compile_id) : integer|boolean

Fetch cached content's modification timestamp from data source

Only implement it if modification times can be accessed faster than loading the complete cached content.}}

Parameters

string	$id	unique cache content identifier
string	$name	template name
string	$cache_id	cache id
string	$compile_id	compile id

Returns

integer|boolean —

timestamp (epoch) the template was modified, or false if not found

Inherited from: \Smarty_CacheResource_Mysql