PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of file.php

This file is part of the phpBB Forum Software package.

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	635 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

file:: (15 methods):
  __construct()
  load()
  unload()
  save()
  tidy()
  get()
  put()
  purge()
  destroy()
  _exists()
  sql_save()
  cleanup_invalid_data_global()
  _read()
  _write()
  clean_varname()

Class: file - X-Ref

ACM File Based Caching

__construct($cache_dir = null) X-Ref

Set cache path

param: string $cache_dir Define the path to the cache directory (default: $phpbb_root_path . 'cache/')

load() X-Ref

{@inheritDoc}

unload() X-Ref

{@inheritDoc}

save() X-Ref

{@inheritDoc}

tidy() X-Ref

{@inheritDoc}

get($var_name) X-Ref

{@inheritDoc}

put($var_name, $var, $ttl = 31536000) X-Ref

{@inheritDoc}

purge() X-Ref

{@inheritDoc}

destroy($var_name, $table = '') X-Ref

{@inheritDoc}

_exists($var_name) X-Ref

{@inheritDoc}

sql_save(\phpbb\db\driver\driver_interface $db, $query, $query_result, $ttl) X-Ref

{@inheritDoc}

cleanup_invalid_data_global(string $file, $handle) X-Ref

Cleanup when loading invalid data global file

param: string $file Filename
param: resource $handle
return: void

_read($filename) X-Ref

Read cached data from a specified file

param: string $filename Filename to write
return: mixed False if an error was encountered, otherwise the data type of the cached data

_write($filename, $data = null, $expires = 0, $query = '') X-Ref

Write cache data to a specified file

'data_global' is a special case and the generated format is different for this file:
<code>
<?php exit; ?>
(expiration)
(length of var and serialised data)
(var)
(serialised data)
... (repeat)
</code>

The other files have a similar format:
<code>
<?php exit; ?>
(expiration)
(query) [SQL files only]
(length of serialised data)
(serialised data)
</code>

param: string $filename Filename to write
param: mixed $data Data to store
param: int $expires Timestamp when the data expires
param: string $query Query when caching SQL queries
return: bool True if the file was successfully created, otherwise false

clean_varname($varname) X-Ref

Replace slashes in the file name

param: string $varname name of a cache variable
return: string $varname name that is safe to use as a filename

PHP Cross Reference of phpBB-3.3.14-deutsch

/phpbb/cache/driver/ -> file.php (summary)

Defines 1 class