Pluf Framework

Pluf Framework Commit Details


Date:2008-11-07 16:45:41 (16 years 1 month ago)
Author:Loic d'Anterroches
Branch:develop, master
Commit:04e2ee104c4477f4834b0da330c0957098fd3002
Parents: 8d29ac0f2a67d7a6fd9e7e2da00dd048aea02c7d
Message:Added the base of a cache framework.

A very minimal cache framework with support of get/set values with
timeout.
Changes:

File differences

src/Pluf/Cache.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?php
/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
# ***** BEGIN LICENSE BLOCK *****
# This file is part of Plume Framework, a simple PHP Application Framework.
# Copyright (C) 2001-2007 Loic d'Anterroches and contributors.
#
# Plume Framework is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
#
# Plume Framework is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# ***** END LICENSE BLOCK ***** */
/**
* Cache class.
*
* You should not use this class directly, but one of the subclasses
* implementing a given engine.
*
* Default timeout in seconds is defined by the 'cache_timeout'
* configuration variable.
*
* <code>
* $cache = new Pluf_Cache_File();
* if (null === ($foo=$cache->get('my-key'))) {
* $foo = run_complex_operation();
* $cache->set('my-key', $foo);
* }
* return $foo;
* </code>
*
* The value to be stored in the cache must be serializable.
*
* @see http://www.php.net/serialize
*/
class Pluf_Cache
{
/**
* Set a value in the cache.
*
* @param string Key to store the information
* @param mixed Value to store
* @param int Timeout in seconds (null)
* @return bool Success
*/
public function set($key, $value, $timeout=null)
{
throw new Pluf_Exception_NotImplemented();
}
/**
* Get value from the cache.
*
* @param string Key to get the information
* @param mixed Default value to return if cache miss (null)
* @param mixed Stored value or default
*/
public function get($key, $default=null)
{
throw new Pluf_Exception_NotImplemented();
}
}
src/Pluf/Cache/File.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?php
/* -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
# ***** BEGIN LICENSE BLOCK *****
# This file is part of Plume Framework, a simple PHP Application Framework.
# Copyright (C) 2001-2007 Loic d'Anterroches and contributors.
#
# Plume Framework is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
#
# Plume Framework is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# ***** END LICENSE BLOCK ***** */
/**
* File based cache.
*
* Info are stored in the 'cache_file_folder' folder. In the folder, 2
* subdirectories are created based on the md5 of the key.
*/
class Pluf_Cache_File extends Pluf_Cache
{
public function __constructor()
{
if (false == Pluf::f('cache_file_folder', false)) {
throw new Pluf_Exception_SettingError('"cache_file_folder" setting not defined.');
}
}
/**
* Set a value in the cache.
*
* @param string Key to store the information
* @param mixed Value to store
* @param int Timeout in seconds (null)
* @return bool Success
*/
public function set($key, $value, $timeout=null)
{
$fname = $this->_keyToFile($key);
$dir = dirname($fname);
if ($timeout == null) $timeout = Pluf::f('cache_timeout', 300);
if (!file_exists($dir)) mkdir($dir, 0777, true);
$expire = time()+$timeout;
file_put_contents($fname, $expire."\n".serialize($value));
}
/**
* Get value from the cache.
*
* @param string Key to get the information
* @param mixed Default value to return if cache miss (null)
* @param mixed Stored value or default
*/
public function get($key, $default=null)
{
$fname = $this->_keyToFile($key);
if (!file_exists($fname)) return $default;
list($timeout, $content) = explode("\n", file_get_contents($fname), 2);
if ($timeout < time()) {
unlink($fname);
return $default;
}
return unserialize($content);
}
/**
* Convert a key into a path to a file.
*
* @param string Key
* @return string Path to file
*/
public function _keyToFile($key)
{
$md5 = md5($key);
return Pluf::f('cache_file_folder').'/'.substr($md5, 0, 2)
.'/'.substr($md5, 2, 2).'/'.substr($md5, 4);
}
}

Archive Download the corresponding diff file

Branches

Tags

Number of commits:
Page rendered in 0.05972s using 13 queries.