root/eaccelerator/trunk/doc/php/info.php

Revision 265, 3.1 kB (checked in by hans, 2 years ago)

fixed svn properties on trunk (eol-style and keywords)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 <?php
2 /*
3  * This file is a file with dummy php function to document the functions in
4  * the eAccelerator extension.
5  */
6
7 /**
8  * eAccelerator controlpanel
9  * It's possible to control eAccelerator with some functions eaccelerator provides.
10  * These functions can be disabled with the configuration switch
11  * --without-eaccelerator-info at compile time.
12  *
13  * @package eAccelerator
14  */
15
16 /**
17  * Enable/disable caching
18  * You are only allowed to use this function in scripts that are in the
19  * eaccelerator.admin_allowed_path
20  *
21  * @param boolean true to enable and false to disable eAccelerator caching
22  */
23 function eaccelerator_caching(boolean $flag) {};
24
25 /**
26  * Enable/disable the optimizer
27  * You are only allowed to use this function in scripts that are in the
28  * eaccelerator.admin_allowed_path
29  *
30  * @param boolean true to enable and false to disable eAccelerator the optimizer
31  */
32 function eaccelerator_optimizer(boolean $flag) {};
33
34 /**
35  * Clean the cache
36  * Remove all expired scripts and data from shared memory and disk cache. You
37  * are only allowed to use this function in scripts that are in the
38  * eaccelerator.admin_allowed_path
39  */
40 function eaccelerator_clean() {};
41
42 /**
43  * Clear the cache
44  * Remove all unused scripts and data from shared memory and disk cache, this means
45  * all data that isn't used in the current requests. You are only allowed to use
46  * this function in scripts that are in the eaccelerator.admin_allowed_path
47  */
48 function eaccelerator_clear() {};
49
50 /**
51  * Purge the cache
52  * Removed all scripts that are marked for deletetion. This will happen automaticly
53  * when shared memory is needed. You are only allowed to use this function in
54  * scripts that are in the eaccelerator.admin_allowed_path
55  */
56 function eaccelerator_purge() {};
57
58 /**
59  * Get info
60  * Get info about eAccelerator, this is the info that is showed in the phpinfo()
61  * page. There is also some information about compile time options like the
62  * shared memory and semaphores used.
63  *
64  * @return array An associative array with the info => value pairs
65  */
66 function eaccelerator_info() {};
67
68 /**
69  * Get cached scripts
70  * Get an array with all cached scripts. This is an indexed array with each
71  * element an associative array with information about the cached script.
72  * You are only allowed to use this function in scripts that are in the
73  * eaccelerator.admin_allowed_path
74  *
75  * @return array An indexed array with information about cached scripts
76  */
77 function eaccelerator_cached_scripts() {};
78
79 /**
80  * Get removed cached scripts
81  * Get an array with all cached scripts that are marked as removed. This is an
82  * indexed array with each element an associative array with information about
83  * the cached script. You are only allowed to use this function in scripts that
84  * are in the eaccelerator.admin_allowed_path
85  *
86  * @return array An indexed array with information about the removed scripts
87  */
88 function eaccelerator_removed_scripts() {};
89
90 /**
91  * List cached keys
92  * Returns list of keys in shared memory that matches actual hostname or namespace.
93  *
94  * @return array An indexed array with value an associative array with information
95  *          about that key.
96  */
97 function eaccelerator_list_keys() {};
98
99 ?>
100
Note: See TracBrowser for help on using the browser.