diff --git a/reference/apc/apciterator.xml b/reference/apc/apciterator.xml new file mode 100644 index 0000000000..f3baf489a3 --- /dev/null +++ b/reference/apc/apciterator.xml @@ -0,0 +1,80 @@ + + + + + + The APCIterator class + APCIterator + + + + +
+ &reftitle.intro; + + The APCIterator class makes it easier to iterate + over large APC caches. This is helpful as it allows iterating over large + caches in steps, while grabbing a defined number of entries per lock instance, + so it frees the cache locks for other activities rather than hold up the + entire cache to grab 100 (the default) entries. Also, using regular expression + matching is more efficient as it's been moved to the C level. + +
+ + +
+ &reftitle.classsynopsis; + + + + APCIterator + + + + + APCIterator + + + + Iterator + + + + Traversable + + + + + Methods + + + + +
+ + + + &reference.apc.entities.apciterator; + + + + diff --git a/reference/apc/apciterator/construct.xml b/reference/apc/apciterator/construct.xml new file mode 100644 index 0000000000..3c3aa526e6 --- /dev/null +++ b/reference/apc/apciterator/construct.xml @@ -0,0 +1,115 @@ + + + + + + APCIterator::__construct + Constructs an APCIterator iterator object + + + + &reftitle.description; + + APCIterator::__construct + stringcache + mixedsearchnull + intformat + intchunk_size100 + intlist + + + Constructs an APCIterator object. + + + + + &reftitle.parameters; + + + cache + + + The cache type, which will be user or + file. + + + + + search + + + A PCRE regular expression that + matches against APC key names, either as a string for + a single regular expression, or as an array of regular + expressions. Or, optionally pass in &null; to skip the search. + + + + + format + + + The desired format, as configured with one ore more of the + APC_ITER_* constants. + + + + + chunk_size + + + The chunk size. Must be a value greater than 0. The default + value is 100. + + + + + list + + + The type to list. Either pass in APC_LIST_ACTIVE + or APC_LIST_INACTIVE. + + + + + + + + &reftitle.returnvalues; + + An APCIterator object on success, + or &null; on failure. + + + + + &reftitle.seealso; + + apc_exists + apc_cache_info + + + + + + diff --git a/reference/apc/apciterator/current.xml b/reference/apc/apciterator/current.xml new file mode 100644 index 0000000000..dc8e6035ae --- /dev/null +++ b/reference/apc/apciterator/current.xml @@ -0,0 +1,63 @@ + + + + + + APCIterator::current + Get current item + + + + &reftitle.description; + + public mixedAPCIterator::current + + + + Gets the current item from the APCIterator stack. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the current item on success, or &false; if no + more items or exist, or on failure. + + + + + &reftitle.seealso; + + APCIterator::next + Iterator::current + + + + + + diff --git a/reference/apc/apciterator/gettotalcount.xml b/reference/apc/apciterator/gettotalcount.xml new file mode 100644 index 0000000000..bbf76d87cb --- /dev/null +++ b/reference/apc/apciterator/gettotalcount.xml @@ -0,0 +1,66 @@ + + + + + + APCIterator::getTotalCount + Get total count + + + + &reftitle.description; + + public integerAPCIterator::getTotalCount + + + + Get the total count. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The total count. + + + + + &reftitle.seealso; + + APCIterator::getTotalHits + APCIterator::getTotalSize + apc_cache_info + + + + + + diff --git a/reference/apc/apciterator/gettotalhits.xml b/reference/apc/apciterator/gettotalhits.xml new file mode 100644 index 0000000000..4c66fe08fc --- /dev/null +++ b/reference/apc/apciterator/gettotalhits.xml @@ -0,0 +1,66 @@ + + + + + + APCIterator::getTotalHits + Get total cache hits + + + + &reftitle.description; + + public integerAPCIterator::getTotalHits + + + + Gets the total number of cache hits. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The number of hits on success, or &false; on failure. + + + + + &reftitle.seealso; + + APCIterator::getTotalCount + APCIterator::getTotalSize + apc_cache_info + + + + + + diff --git a/reference/apc/apciterator/gettotalsize.xml b/reference/apc/apciterator/gettotalsize.xml new file mode 100644 index 0000000000..7919955aa0 --- /dev/null +++ b/reference/apc/apciterator/gettotalsize.xml @@ -0,0 +1,66 @@ + + + + + + APCIterator::getTotalSize + Get total cache size + + + + &reftitle.description; + + public intAPCIterator::getTotalSize + + + + Gets the total cache size. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The total cache size. + + + + + &reftitle.seealso; + + APCIterator::getTotalCount + APCIterator::getTotalHits + apc_cache_info + + + + + + diff --git a/reference/apc/apciterator/key.xml b/reference/apc/apciterator/key.xml new file mode 100644 index 0000000000..d56f925d04 --- /dev/null +++ b/reference/apc/apciterator/key.xml @@ -0,0 +1,62 @@ + + + + + + APCIterator::key + Get iterator key + + + + &reftitle.description; + + public stringAPCIterator::key + + + + Gets the current iterator key. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the key on success, or &false; upon failure. + + + + + &reftitle.seealso; + + APCIterator::current + Iterator::key + + + + + + diff --git a/reference/apc/apciterator/next.xml b/reference/apc/apciterator/next.xml new file mode 100644 index 0000000000..d4f23a0074 --- /dev/null +++ b/reference/apc/apciterator/next.xml @@ -0,0 +1,63 @@ + + + + + + APCIterator::next + Move pointer to next item + + + + &reftitle.description; + + public voidAPCIterator::next + + + + Moves the iterator pointer to the next element. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + APCIterator::current + APCIterator::rewind + Iterator::next + + + + + + diff --git a/reference/apc/apciterator/rewind.xml b/reference/apc/apciterator/rewind.xml new file mode 100644 index 0000000000..1a0ccc43d6 --- /dev/null +++ b/reference/apc/apciterator/rewind.xml @@ -0,0 +1,62 @@ + + + + + + APCIterator::rewind + Rewinds iterator + + + + &reftitle.description; + + public voidAPCIterator::rewind + + + + Rewinds back the iterator to the first element. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + APCIterator::next + Iterator::next + + + + + + diff --git a/reference/apc/apciterator/valid.xml b/reference/apc/apciterator/valid.xml new file mode 100644 index 0000000000..25c73afcbd --- /dev/null +++ b/reference/apc/apciterator/valid.xml @@ -0,0 +1,62 @@ + + + + + + APCIterator::valid + Checks if current position is valid + + + + &reftitle.description; + + public voidAPCIterator::valid + + + + Checks if the current iterator position is valid. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; if the current iterator position is valid, otherwise &false;. + + + + + &reftitle.seealso; + + APCIterator::current + Iterator::valid + + + + + + diff --git a/reference/apc/book.xml b/reference/apc/book.xml index 6ee09dbda6..c66b91d78e 100644 --- a/reference/apc/book.xml +++ b/reference/apc/book.xml @@ -19,6 +19,7 @@ &reference.apc.setup; &reference.apc.constants; &reference.apc.reference; + &reference.apc.apciterator; diff --git a/reference/apc/constants.xml b/reference/apc/constants.xml index 57af354de9..6b3768d7d4 100644 --- a/reference/apc/constants.xml +++ b/reference/apc/constants.xml @@ -3,7 +3,243 @@ &reftitle.constants; - &no.constants; + &extension.constants; + + + + + + APC_BIN_VERIFY_CRC32 + (integer) + + + + + + + + + + APC_BIN_VERIFY_MD5 + (integer) + + + + + + + + + + APC_ITER_ALL + (integer) + + + + + + + + + + APC_ITER_ATIME + (integer) + + + + + + + + + + APC_ITER_CTIME + (integer) + + + + + + + + + + APC_ITER_DEVICE + (integer) + + + + + + + + + + APC_ITER_DTIME + (integer) + + + + + + + + + + APC_ITER_FILENAME + (integer) + + + + + + + + + + APC_ITER_INODE + (integer) + + + + + + + + + + APC_ITER_KEY + (integer) + + + + + + + + + + APC_ITER_MD5 + (integer) + + + + + + + + + + APC_ITER_MEM_SIZE + (integer) + + + + + + + + + + APC_ITER_MTIME + (integer) + + + + + + + + + + APC_ITER_NONE + (integer) + + + + + + + + + + APC_ITER_NUM_HITS + (integer) + + + + + + + + + + APC_ITER_REFCOUNT + (integer) + + + + + + + + + + APC_ITER_TTL + (integer) + + + + + + + + + + APC_ITER_TYPE + (integer) + + + + + + + + + + APC_ITER_VALUE + (integer) + + + + + + + + + + APC_LIST_ACTIVE + (integer) + + + + + + + + + + APC_LIST_DELETED + (integer) + + + + + + + + + - diff --git a/reference/apc/functions/apc-bin-dump.xml b/reference/apc/functions/apc-bin-dump.xml new file mode 100644 index 0000000000..427e7fbffd --- /dev/null +++ b/reference/apc/functions/apc-bin-dump.xml @@ -0,0 +1,85 @@ + + + + + + apc_bin_dump + Get a binary dump of the given files and user variables + + + + &reftitle.description; + + stringapc_bin_dump + arrayfiles + arrayuser_vars + + + Returns a binary dump of the given files and user variables from the APC cache. + A &null; for files or user_vars signals a dump of every entry, whereas array() will dump + nothing. + + + + + &reftitle.parameters; + + + files + + + The files. Passing in &null; signals a dump of every entry, while + passing in array will dump nothing. + + + + + user_vars + + + The user vars. Passing in &null; signals a dump of every entry, while + passing in array will dump nothing. + + + + + + + + &reftitle.returnvalues; + + Returns a binary dump of the given files and user variables from the APC cache, + &false; if APC is not enabled, or &null; if an unknown error is encountered. + + + + + &reftitle.seealso; + + apc_bin_dumpfile + apc_bin_load + + + + + + diff --git a/reference/apc/functions/apc-bin-dumpfile.xml b/reference/apc/functions/apc-bin-dumpfile.xml new file mode 100644 index 0000000000..328ed0a3ca --- /dev/null +++ b/reference/apc/functions/apc-bin-dumpfile.xml @@ -0,0 +1,113 @@ + + + + + + apc_bin_dumpfile + Output a binary dump of cached files and user variables to a file + + + + &reftitle.description; + + intapc_bin_dumpfile + arrayfiles + arrayuser_vars + stringfilename + intflags + resourcecontext + + + Outputs a binary dump of the given files and user variables from the APC + cache to the named file. + + + + + &reftitle.parameters; + + + files + + + The file names being dumped. + + + + + user_vars + + + The user variables being dumped. + + + + + filename + + + The filename where the dump is being saved. + + + + + flags + + + Flags passed to the filename stream. See the + file_put_contents documentation for details. + + + + + context + + + The context passed to the filename stream. See the + file_put_contents documentation for details. + + + + + + + + &reftitle.returnvalues; + + The number of bytes written to the file, otherwise + &false; if APC is not enabled, filename is an invalid file name, + filename can't be opened, the file dump can't be completed + (e.g., the hard drive is out of disk space), or an unknown error was encountered. + + + + + &reftitle.seealso; + + apc_bin_dump + apc_bin_load + + + + + + diff --git a/reference/apc/functions/apc-bin-load.xml b/reference/apc/functions/apc-bin-load.xml new file mode 100644 index 0000000000..e849c705b8 --- /dev/null +++ b/reference/apc/functions/apc-bin-load.xml @@ -0,0 +1,100 @@ + + + + + + apc_bin_load + Load a binary dump into the APC file/user cache + + + + &reftitle.description; + + boolapc_bin_load + stringdata + intflags + + + Loads the given binary dump into the APC file/user cache. + + + + + &reftitle.parameters; + + + data + + + The binary dump being loaded, likely from + apc_bin_dump. + + + + + flags + + + Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, + or both. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the binary dump data was loaded + with success, otherwise &false; is returned. &false; is returned if APC + is not enabled, or if the data is not a valid APC + binary dump (e.g., unexpected size). + + + + + &reftitle.examples; + + <function>apc_bin_load</function> example + + +]]> + + + + + + &reftitle.seealso; + + apc_bin_dump + apc_bin_loadfile + + + + + + diff --git a/reference/apc/functions/apc-bin-loadfile.xml b/reference/apc/functions/apc-bin-loadfile.xml new file mode 100644 index 0000000000..ff2b0d749b --- /dev/null +++ b/reference/apc/functions/apc-bin-loadfile.xml @@ -0,0 +1,94 @@ + + + + + + apc_bin_loadfile + Load a binary dump from a file into the APC file/user cache + + + + &reftitle.description; + + boolapc_bin_loadfile + stringfilename + resourcecontext + intflags + + + Loads a binary dump from a file into the APC file/user cache. + + + + + &reftitle.parameters; + + + filename + + + The file name containing the dump, likely from + apc_bin_dumpfile. + + + + + context + + + The files context. + + + + + flags + + + Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, + or both. + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success, otherwise &false; Reasons it may return &false; include + APC is not enabled, filename is an invalid file name or empty, + filename can't be opened, the file dump can't be completed, or + if the data is not a valid APC binary dump (e.g., unexpected + size). + + + + + &reftitle.seealso; + + apc_bin_dumpfile + apc_bin_load + + + + + diff --git a/reference/apc/functions/apc-cache-info.xml b/reference/apc/functions/apc-cache-info.xml index 19ea8e48c7..cccb7d00cd 100644 --- a/reference/apc/functions/apc-cache-info.xml +++ b/reference/apc/functions/apc-cache-info.xml @@ -151,6 +151,9 @@ Array APC configuration directives + APCIterator::getTotalSize + APCIterator::getTotalHits + APCIterator::getTotalCount diff --git a/reference/apc/functions/apc-cas.xml b/reference/apc/functions/apc-cas.xml new file mode 100644 index 0000000000..f4292e95b5 --- /dev/null +++ b/reference/apc/functions/apc-cas.xml @@ -0,0 +1,131 @@ + + + + + + apc_cas + apc_cas + + + + &reftitle.description; + + intapc_cas + stringkey + intold + intnew + + + apc_cas + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + key + + + + + + + + old + + + + + + + + new + + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + <function>apc_cas</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + &reftitle.seealso; + + apc_dec + apc_store + + + + + + diff --git a/reference/apc/functions/apc-compile-file.xml b/reference/apc/functions/apc-compile-file.xml index bb3e51a4c5..7aba805d21 100644 --- a/reference/apc/functions/apc-compile-file.xml +++ b/reference/apc/functions/apc-compile-file.xml @@ -42,6 +42,14 @@ + + &reftitle.seealso; + + apc_bin_dumpfile + apc_bin_loadfile + + + + + + + apc_dec + Decrease a stored number + + + + &reftitle.description; + + intapc_dec + stringkey + intstep1 + boolsuccess + + + Decreases a stored integer value. + + + + + &reftitle.parameters; + + + key + + + The key of the value being decreased. + + + + + step + + + The step, or value to decrease. + + + + + success + + + Optionally pass the success or fail boolean value to + this referenced variable. + + + + + + + + &reftitle.returnvalues; + + Returns the current value of key's value on success, + &return.falseforfailure; + + + + + &reftitle.examples; + + <function>apc_dec</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + apc_inc + + + + + + diff --git a/reference/apc/functions/apc-delete-file.xml b/reference/apc/functions/apc-delete-file.xml new file mode 100644 index 0000000000..a8cc399d11 --- /dev/null +++ b/reference/apc/functions/apc-delete-file.xml @@ -0,0 +1,120 @@ + + + + + + apc_delete_file + Deletes files from the opcode cache + + + + &reftitle.description; + + mixedapc_delete_file + mixedkeys + + + Deletes the given files from the opcode cache. + + + + + &reftitle.parameters; + + + keys + + + The files to be deleted. Accepts a string, + array of strings, or an APCIterator + object. + + + + + + + + &reftitle.returnvalues; + + &return.success; + Or if keys is an array, then + an empty array is returned on success, or an array of failed files + is returned. + + + + + &reftitle.examples; + + <function>apc_delete_file</function> example + + +]]> + + &example.outputs.similar; + + + string(14) "donotexist.php" +} +[Mon May 24 09:30:33 2010] [apc-warning] Could not stat file donotexist.php, unable to delete from cache. in /tmp/test.php on line 18. +bool(false) +]]> + + + + + + &reftitle.seealso; + + apc_clear_cache + apc_delete + apc_exists + + + + + diff --git a/reference/apc/functions/apc-exists.xml b/reference/apc/functions/apc-exists.xml new file mode 100644 index 0000000000..88fdefd02b --- /dev/null +++ b/reference/apc/functions/apc-exists.xml @@ -0,0 +1,125 @@ + + + + + + apc_exists + Checks if APC key exists + + + + &reftitle.description; + + mixedapc_exists + mixedkeys + + + Checks if one ore more APC keys exist. + + + + + &reftitle.parameters; + + + keys + + + A string, or an array of strings, that + contain keys. + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the key exists, otherwise &false; Or if an + array was passed to keys, then + an array is returned that contains all existing keys, or an empty + array if none exist. + + + + + &reftitle.examples; + + <function>apc_exists</function> example + + +]]> + + &example.outputs.similar; + + + bool(true) + ["bar"]=> + bool(true) +} +]]> + + + + + + &reftitle.seealso; + + apc_cache_info + apc_fetch + + + + + diff --git a/reference/apc/functions/apc-fetch.xml b/reference/apc/functions/apc-fetch.xml index 8e5ab69622..0ff37a9434 100644 --- a/reference/apc/functions/apc-fetch.xml +++ b/reference/apc/functions/apc-fetch.xml @@ -74,12 +74,35 @@ string(3) "BAR" + + &reftitle.changelog; + + + + + &Version; + &Description; + + + + + 3.0.17 + + The success parameter was added. + + + + + + + &reftitle.seealso; apc_store apc_delete + APCIterator diff --git a/reference/apc/functions/apc-inc.xml b/reference/apc/functions/apc-inc.xml new file mode 100644 index 0000000000..5a87ea0567 --- /dev/null +++ b/reference/apc/functions/apc-inc.xml @@ -0,0 +1,137 @@ + + + + + + apc_inc + Increase a stored number + + + + &reftitle.description; + + intapc_inc + stringkey + intstep1 + boolsuccess + + + Increases a stored number. + + + + + &reftitle.parameters; + + + key + + + The key of the value being decreased. + + + + + step + + + The step, or value to increase. + + + + + success + + + Optionally pass the success or fail boolean value to + this referenced variable. + + + + + + + + &reftitle.returnvalues; + + Returns the current value of key's value on success, + &return.falseforfailure; + + + + + &reftitle.examples; + + <function>apc_inc</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + &reftitle.seealso; + + apc_dec + + + + + + diff --git a/reference/apc/ini.xml b/reference/apc/ini.xml index a46e0003d4..1c2043a8b5 100644 --- a/reference/apc/ini.xml +++ b/reference/apc/ini.xml @@ -140,6 +140,12 @@ PHP_INI_SYSTEM Available since APC 3.0.7. + + apc.use_request_time + "1" + PHP_INI_ALL + Available since APC 3.1.3. + apc.stat "1" @@ -188,6 +194,12 @@ PHP_INI_SYSTEM + + apc.rfc1867_ttl + "3600" + PHP_INI_SYSTEM + Available since APC 3.1.1. + apc.localcache "0" @@ -212,6 +224,24 @@ PHP_INI_SYSTEM Available since APC 3.0.13. + + apc.preload_path + NULL + PHP_INI_SYSTEM + Available since APC 3.1.1. + + + apc.file_md5 + "0" + PHP_INI_SYSTEM + Available since APC 3.1.1. + + + apc.canonicalize + "1" + PHP_INI_SYSTEM + Available since APC 3.1.1. + @@ -674,6 +704,18 @@ Array + + + apc.rfc1867_ttl + bool + + + + TTL for rfc1867 entries. + + + + apc.localcache @@ -746,6 +788,54 @@ Array + + + + apc.canonicalize + bool + + + + If on, then relative paths are canonicalized in no-stat mode. + + + + + + + apc.preload_path + string + + + + + + + + + + apc.use_request_time + bool + + + + Use the SAPI request start time for + TTL. + + + + + + + apc.file_md5 + bool + + + + Records a md5 hash of files. + + + diff --git a/reference/apc/versions.xml b/reference/apc/versions.xml index aaa134f57d..8f6f7ed011 100644 --- a/reference/apc/versions.xml +++ b/reference/apc/versions.xml @@ -5,12 +5,21 @@ --> + + + + + + + + +