| 1 |
<?php |
| 2 |
|
| 3 |
// Start of apc v. |
| 4 |
|
| 5 |
/** |
| 6 |
* Fetch a stored variable from the cache |
| 7 |
* @link http://www.php.net/manual/en/function.apc-fetch.php |
| 8 |
* @param key mixed <p> |
| 9 |
* The key used to store the value (with |
| 10 |
* apc_store). If an array is passed then each |
| 11 |
* element is fetched and returned. |
| 12 |
* </p> |
| 13 |
* @param success bool[optional] <p> |
| 14 |
* Set to true in success and false in failure. |
| 15 |
* </p> |
| 16 |
* @return mixed The stored variable or array of variables on success; false on failure |
| 17 |
*/ |
| 18 |
function apc_fetch ($key, &$success = null) {} |
| 19 |
|
| 20 |
/** |
| 21 |
* Cache a variable in the data store |
| 22 |
* @link http://www.php.net/manual/en/function.apc-store.php |
| 23 |
* @param key string <p> |
| 24 |
* Store the variable using this name. keys are |
| 25 |
* cache-unique, so storing a second value with the same |
| 26 |
* key will overwrite the original value. |
| 27 |
* </p> |
| 28 |
* @param var mixed <p> |
| 29 |
* The variable to store |
| 30 |
* </p> |
| 31 |
* @param ttl int[optional] <p> |
| 32 |
* Time To Live; store var in the cache for |
| 33 |
* ttl seconds. After the |
| 34 |
* ttl has passed, the stored variable will be |
| 35 |
* expunged from the cache (on the next request). If no ttl |
| 36 |
* is supplied (or if the ttl is |
| 37 |
* 0), the value will persist until it is removed from |
| 38 |
* the cache manually, or otherwise fails to exist in the cache (clear, |
| 39 |
* restart, etc.). |
| 40 |
* </p> |
| 41 |
* @return bool Returns true on success, false on failure. |
| 42 |
* Second syntax returns array with error keys. |
| 43 |
*/ |
| 44 |
function apc_store ($key, $var, $ttl = null) {} |
| 45 |
|
| 46 |
/** |
| 47 |
* Cache a new variable in the data store |
| 48 |
* @link http://www.php.net/manual/en/function.apc-add.php |
| 49 |
* @param key string <p> |
| 50 |
* Store the variable using this name. keys are |
| 51 |
* cache-unique, so attempting to use apc_add to |
| 52 |
* store data with a key that already exists will not overwrite the |
| 53 |
* existing data, and will instead return false. (This is the only |
| 54 |
* difference between apc_add and |
| 55 |
* apc_store.) |
| 56 |
* </p> |
| 57 |
* @param var mixed <p> |
| 58 |
* The variable to store |
| 59 |
* </p> |
| 60 |
* @param ttl int[optional] <p> |
| 61 |
* Time To Live; store var in the cache for |
| 62 |
* ttl seconds. After the |
| 63 |
* ttl has passed, the stored variable will be |
| 64 |
* expunged from the cache (on the next request). If no ttl |
| 65 |
* is supplied (or if the ttl is |
| 66 |
* 0), the value will persist until it is removed from |
| 67 |
* the cache manually, or otherwise fails to exist in the cache (clear, |
| 68 |
* restart, etc.). |
| 69 |
* </p> |
| 70 |
* @return bool TRUE if something has effectively been added into the cache, FALSE otherwise. |
| 71 |
* Second syntax returns array with error keys. |
| 72 |
*/ |
| 73 |
function apc_add ($key, $var, $ttl = null) {} |
| 74 |
|
| 75 |
/** |
| 76 |
* Removes a stored variable from the cache |
| 77 |
* @link http://www.php.net/manual/en/function.apc-delete.php |
| 78 |
* @param key string <p> |
| 79 |
* The key used to store the value (with |
| 80 |
* apc_store). |
| 81 |
* </p> |
| 82 |
* @return mixed Returns true on success, false on failure. |
| 83 |
*/ |
| 84 |
function apc_delete ($key) {} |
| 85 |
|
| 86 |
/** |
| 87 |
* Retrieves cached information from APC's data store |
| 88 |
* @link http://www.php.net/manual/en/function.apc-cache-info.php |
| 89 |
* @param cache_type string[optional] <p> |
| 90 |
* If cache_type is "user", |
| 91 |
* information about the user cache will be returned. |
| 92 |
* </p> |
| 93 |
* <p> |
| 94 |
* If cache_type is "filehits", |
| 95 |
* information about which files have been served from the bytecode cache |
| 96 |
* for the current request will be returned. This feature must be enabled at |
| 97 |
* compile time using --enable-filehits. |
| 98 |
* </p> |
| 99 |
* <p> |
| 100 |
* If an invalid or no cache_type is specified, information about |
| 101 |
* the system cache (cached files) will be returned. |
| 102 |
* </p> |
| 103 |
* @param limited bool[optional] <p> |
| 104 |
* If limited is true, the |
| 105 |
* return value will exclude the individual list of cache entries. This |
| 106 |
* is useful when trying to optimize calls for statistics gathering. |
| 107 |
* </p> |
| 108 |
* @return array Array of cached data (and meta-data)&return.falseforfailure; |
| 109 |
*/ |
| 110 |
function apc_cache_info ($cache_type = null, $limited = null) {} |
| 111 |
|
| 112 |
/** |
| 113 |
* Clears the APC cache |
| 114 |
* @link http://www.php.net/manual/en/function.apc-clear-cache.php |
| 115 |
* @param cache_type string[optional] <p> |
| 116 |
* If cache_type is "user", the |
| 117 |
* user cache will be cleared; otherwise, the system cache (cached files) |
| 118 |
* will be cleared. |
| 119 |
* </p> |
| 120 |
* @return bool true always |
| 121 |
*/ |
| 122 |
function apc_clear_cache ($cache_type = null) {} |
| 123 |
|
| 124 |
/** |
| 125 |
* Defines a set of constants for retrieval and mass-definition |
| 126 |
* @link http://www.php.net/manual/en/function.apc-define-constants.php |
| 127 |
* @param key string <p> |
| 128 |
* The key serves as the name of the constant set |
| 129 |
* being stored. This key is used to retrieve the |
| 130 |
* stored constants in apc_load_constants. |
| 131 |
* </p> |
| 132 |
* @param constants array <p> |
| 133 |
* An associative array of constant_name => value |
| 134 |
* pairs. The constant_name must follow the normal |
| 135 |
* constant naming rules. |
| 136 |
* value must evaluate to a scalar value. |
| 137 |
* </p> |
| 138 |
* @param case_sensitive bool[optional] <p> |
| 139 |
* The default behaviour for constants is to be declared case-sensitive; |
| 140 |
* i.e. CONSTANT and Constant |
| 141 |
* represent different values. If this parameter evaluates to false the |
| 142 |
* constants will be declared as case-insensitive symbols. |
| 143 |
* </p> |
| 144 |
* @return bool Returns true on success, false on failure. |
| 145 |
*/ |
| 146 |
function apc_define_constants ($key, array $constants, $case_sensitive = null) {} |
| 147 |
|
| 148 |
/** |
| 149 |
* Loads a set of constants from the cache |
| 150 |
* @link http://www.php.net/manual/en/function.apc-load-constants.php |
| 151 |
* @param key string <p> |
| 152 |
* The name of the constant set (that was stored with |
| 153 |
* apc_define_constants) to be retrieved. |
| 154 |
* </p> |
| 155 |
* @param case_sensitive bool[optional] <p> |
| 156 |
* The default behaviour for constants is to be declared case-sensitive; |
| 157 |
* i.e. CONSTANT and Constant |
| 158 |
* represent different values. If this parameter evaluates to false the |
| 159 |
* constants will be declared as case-insensitive symbols. |
| 160 |
* </p> |
| 161 |
* @return bool Returns true on success, false on failure. |
| 162 |
*/ |
| 163 |
function apc_load_constants ($key, $case_sensitive = null) {} |
| 164 |
|
| 165 |
/** |
| 166 |
* Retrieves APC's Shared Memory Allocation information |
| 167 |
* @link http://www.php.net/manual/en/function.apc-sma-info.php |
| 168 |
* @param limited bool[optional] <p> |
| 169 |
* When set to false (default) apc_sma_info will |
| 170 |
* return a detailed information about each segment. |
| 171 |
* </p> |
| 172 |
* @return array Array of Shared Memory Allocation data; false on failure. |
| 173 |
*/ |
| 174 |
function apc_sma_info ($limited = null) {} |
| 175 |
|
| 176 |
/** |
| 177 |
* Stores a file in the bytecode cache, bypassing all filters. |
| 178 |
* @link http://www.php.net/manual/en/function.apc-compile-file.php |
| 179 |
* @param filename string <p> |
| 180 |
* Full or relative path to a PHP file that will be compiled and stored in |
| 181 |
* the bytecode cache. |
| 182 |
* </p> |
| 183 |
* @param atomic bool[optional] |
| 184 |
* @return mixed Returns true on success, false on failure. |
| 185 |
*/ |
| 186 |
function apc_compile_file ($filename, $atomic = null) {} |
| 187 |
|
| 188 |
/** |
| 189 |
* Get a binary dump of the given files and user variables |
| 190 |
* @link http://www.php.net/manual/en/function.apc-bin-dump.php |
| 191 |
* @param files array[optional] <p> |
| 192 |
* The files. Passing in &null; signals a dump of every entry, while |
| 193 |
* passing in array will dump nothing. |
| 194 |
* </p> |
| 195 |
* @param user_vars array[optional] <p> |
| 196 |
* The user vars. Passing in &null; signals a dump of every entry, while |
| 197 |
* passing in array will dump nothing. |
| 198 |
* </p> |
| 199 |
* @return string a binary dump of the given files and user variables from the APC cache, |
| 200 |
* false if APC is not enabled, or &null; if an unknown error is encountered. |
| 201 |
*/ |
| 202 |
function apc_bin_dump (array $files = null, array $user_vars = null) {} |
| 203 |
|
| 204 |
/** |
| 205 |
* Output a binary dump of cached files and user variables to a file |
| 206 |
* @link http://www.php.net/manual/en/function.apc-bin-dumpfile.php |
| 207 |
* @param files array <p> |
| 208 |
* The file names being dumped. |
| 209 |
* </p> |
| 210 |
* @param user_vars array <p> |
| 211 |
* The user variables being dumped. |
| 212 |
* </p> |
| 213 |
* @param filename string <p> |
| 214 |
* The filename where the dump is being saved. |
| 215 |
* </p> |
| 216 |
* @param flags int[optional] <p> |
| 217 |
* Flags passed to the filename stream. See the |
| 218 |
* file_put_contents documentation for details. |
| 219 |
* </p> |
| 220 |
* @param context resource[optional] <p> |
| 221 |
* The context passed to the filename stream. See the |
| 222 |
* file_put_contents documentation for details. |
| 223 |
* </p> |
| 224 |
* @return int The number of bytes written to the file, otherwise |
| 225 |
* false if APC is not enabled, filename is an invalid file name, |
| 226 |
* filename can't be opened, the file dump can't be completed |
| 227 |
* (e.g., the hard drive is out of disk space), or an unknown error was encountered. |
| 228 |
*/ |
| 229 |
function apc_bin_dumpfile (array $files, array $user_vars, $filename, $flags = null, $context = null) {} |
| 230 |
|
| 231 |
/** |
| 232 |
* Load a binary dump into the APC file/user cache |
| 233 |
* @link http://www.php.net/manual/en/function.apc-bin-load.php |
| 234 |
* @param data string <p> |
| 235 |
* The binary dump being loaded, likely from |
| 236 |
* apc_bin_dump. |
| 237 |
* </p> |
| 238 |
* @param flags int[optional] <p> |
| 239 |
* Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, |
| 240 |
* or both. |
| 241 |
* </p> |
| 242 |
* @return bool true if the binary dump data was loaded |
| 243 |
* with success, otherwise false is returned. false is returned if APC |
| 244 |
* is not enabled, or if the data is not a valid APC |
| 245 |
* binary dump (e.g., unexpected size). |
| 246 |
*/ |
| 247 |
function apc_bin_load ($data, $flags = null) {} |
| 248 |
|
| 249 |
/** |
| 250 |
* Load a binary dump from a file into the APC file/user cache |
| 251 |
* @link http://www.php.net/manual/en/function.apc-bin-loadfile.php |
| 252 |
* @param filename string <p> |
| 253 |
* The file name containing the dump, likely from |
| 254 |
* apc_bin_dumpfile. |
| 255 |
* </p> |
| 256 |
* @param context resource[optional] <p> |
| 257 |
* The files context. |
| 258 |
* </p> |
| 259 |
* @param flags int[optional] <p> |
| 260 |
* Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, |
| 261 |
* or both. |
| 262 |
* </p> |
| 263 |
* @return bool true on success, otherwise false Reasons it may return false include |
| 264 |
* APC is not enabled, filename is an invalid file name or empty, |
| 265 |
* filename can't be opened, the file dump can't be completed, or |
| 266 |
* if the data is not a valid APC binary dump (e.g., unexpected |
| 267 |
* size). |
| 268 |
*/ |
| 269 |
function apc_bin_loadfile ($filename, $context = null, $flags = null) {} |
| 270 |
|
| 271 |
/** |
| 272 |
* Updates an old value with a new value |
| 273 |
* @link http://www.php.net/manual/en/function.apc-cas.php |
| 274 |
* @param key string <p> |
| 275 |
* The key of the value being updated. |
| 276 |
* </p> |
| 277 |
* @param old int <p> |
| 278 |
* The old value (the value currently stored). |
| 279 |
* </p> |
| 280 |
* @param new int <p> |
| 281 |
* The new value to update to. |
| 282 |
* </p> |
| 283 |
* @return bool Returns true on success, false on failure. |
| 284 |
*/ |
| 285 |
function apc_cas ($key, $old, $new) {} |
| 286 |
|
| 287 |
/** |
| 288 |
* Decrease a stored number |
| 289 |
* @link http://www.php.net/manual/en/function.apc-dec.php |
| 290 |
* @param key string <p> |
| 291 |
* The key of the value being decreased. |
| 292 |
* </p> |
| 293 |
* @param step int[optional] <p> |
| 294 |
* The step, or value to decrease. |
| 295 |
* </p> |
| 296 |
* @param success bool[optional] <p> |
| 297 |
* Optionally pass the success or fail boolean value to |
| 298 |
* this referenced variable. |
| 299 |
* </p> |
| 300 |
* @return int the current value of key's value on success, |
| 301 |
* &return.falseforfailure; |
| 302 |
*/ |
| 303 |
function apc_dec ($key, $step = null, &$success = null) {} |
| 304 |
|
| 305 |
/** |
| 306 |
* Deletes files from the opcode cache |
| 307 |
* @link http://www.php.net/manual/en/function.apc-delete-file.php |
| 308 |
* @param keys mixed <p> |
| 309 |
* The files to be deleted. Accepts a string, |
| 310 |
* array of strings, or an APCIterator |
| 311 |
* object. |
| 312 |
* </p> |
| 313 |
* @return mixed Returns true on success, false on failure. |
| 314 |
* Or if keys is an array, then |
| 315 |
* an empty array is returned on success, or an array of failed files |
| 316 |
* is returned. |
| 317 |
*/ |
| 318 |
function apc_delete_file ($keys) {} |
| 319 |
|
| 320 |
/** |
| 321 |
* Checks if APC key exists |
| 322 |
* @link http://www.php.net/manual/en/function.apc-exists.php |
| 323 |
* @param keys mixed <p> |
| 324 |
* A string, or an array of strings, that |
| 325 |
* contain keys. |
| 326 |
* </p> |
| 327 |
* @return mixed true if the key exists, otherwise false Or if an |
| 328 |
* array was passed to keys, then |
| 329 |
* an array is returned that contains all existing keys, or an empty |
| 330 |
* array if none exist. |
| 331 |
*/ |
| 332 |
function apc_exists ($keys) {} |
| 333 |
|
| 334 |
/** |
| 335 |
* Increase a stored number |
| 336 |
* @link http://www.php.net/manual/en/function.apc-inc.php |
| 337 |
* @param key string <p> |
| 338 |
* The key of the value being increased. |
| 339 |
* </p> |
| 340 |
* @param step int[optional] <p> |
| 341 |
* The step, or value to increase. |
| 342 |
* </p> |
| 343 |
* @param success bool[optional] <p> |
| 344 |
* Optionally pass the success or fail boolean value to |
| 345 |
* this referenced variable. |
| 346 |
* </p> |
| 347 |
* @return int the current value of key's value on success, |
| 348 |
* &return.falseforfailure; |
| 349 |
*/ |
| 350 |
function apc_inc ($key, $step = null, &$success = null) {} |
| 351 |
|
| 352 |
// End of apc v. |
| 353 |
?> |