Procedural File: caching.inc.php

Source Location: /libs/caching.inc.php

Classes:

Page Details:

BIGACE - a PHP and MySQL based Web CMS.

BIGACE is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

BIGACE 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

For further information visit www.kevinpapst.de.

Tags:

author:	Kevin Papst <bigace@kevinpapst.de>
version:	$Id: caching.inc.php,v 1.5 2005/09/30 14:32:35 Kevin Exp $

createCacheFile [line 103]

void createCacheFile(
mixed $name, mixed $content, [mixed $options = ''])

Works as createItemCacheFile('0', $name, $options, $content)

Tags:

see:

createItemCacheFile()

[ Top ]

createItemCacheFile [line 50]

boolean createItemCacheFile(
mixed $itemtype, mixed $itemid, mixed $content, [mixed $options = ''])

Creates a Cache File.

Tags:

return:

if Cache File could be created or not

[ Top ]

deleteCacheFile [line 114]

void deleteCacheFile(
mixed $name, [mixed $options = ''])

Works as deleteItemCacheFile('0', $name, $options)

Tags:

see:

deleteItemCacheFile()

[ Top ]

deleteItemCacheFile [line 69]

void deleteItemCacheFile(
mixed $itemtype, mixed $itemid, [mixed $options = ''])

Removes physically the Cache File from the filesystem

[ Top ]

doFullGarbageCollection [line 195]

void doFullGarbageCollection(
)

This causes BIGACE to delete all available cache information!

[ Top ]

existsCacheFile [line 79]

void existsCacheFile(
mixed $itemtype, mixed $itemid, [mixed $options = ''])

Works as existsItemCacheFile('0', $name, $options)

Tags:

see:

existsItemCacheFile()

[ Top ]

existsItemCacheFile [line 40]

void existsItemCacheFile(
mixed $itemtype, mixed $itemid, [mixed $options = ''])

Checks if a Cache File exists for the given parameter combination.

[ Top ]

expireAllCacheFiles [line 84]

void expireAllCacheFiles(
mixed $itemtype, mixed $itemid)

[ Top ]

getCacheContent [line 125]

void getCacheContent(
mixed $name, [mixed $options = ''])

Works as getItemCacheContent('0', $name, $options)

Tags:

see:

getItemCacheContent()

[ Top ]

getItemCacheContent [line 60]

mixed getItemCacheContent(
mixed $itemtype, mixed $itemid, [mixed $options = ''])

Reads the content from Cache File.

Tags:

return:

content if file exists, else false!

[ Top ]

_createItemCacheName [line 134]

the _createItemCacheName(
mixed $itemtype, mixed $itemid, [mixed $options = ''])

Tags:

return:

unique cache name for the given parameter combination

[ Top ]

_createItemCachePreFileName [line 142]

the _createItemCachePreFileName(
mixed $itemtype, mixed $itemid)

Tags:

return:

unique cache name for the given parameter combination

[ Top ]

_readCacheFile [line 147]

void _readCacheFile(
mixed $name)

[ Top ]

_unlinkCacheFile [line 180]

void _unlinkCacheFile(
mixed $file)

Trys to unlink the given cache file.

[ Top ]

_writeCacheFile [line 163]

void _writeCacheFile(
mixed $name, mixed $content)

Writes content into a named cache File.

Make sure the name is the unique cache name!

[ Top ]

Documentation generated on Tue, 11 Oct 2005 23:01:56 +0200 by phpDocumentor 1.3.0RC2