diff --git a/reference/memcached/book.xml b/reference/memcached/book.xml new file mode 100644 index 0000000000..8d6ec30479 --- /dev/null +++ b/reference/memcached/book.xml @@ -0,0 +1,54 @@ + + + + + Memcached + Memcached + + + &reftitle.intro; + + memcached is a high-performance, + distributed memory object caching system, generic in nature, but intended + for use in speeding up dynamic web applications by alleviating database + load. + + + This extension uses libmemcached library to provide API for communicating + with memcached servers. It also provides a session handler + (memcached). + + + Information about libmemcached can be found at &url.libmemcached;. + + + + &reference.memcached.setup; + &reference.memcached.constants; + &reference.memcached.examples; + &reference.memcached.memcached; + + + + + diff --git a/reference/memcached/configure.xml b/reference/memcached/configure.xml new file mode 100644 index 0000000000..01deba2d5e --- /dev/null +++ b/reference/memcached/configure.xml @@ -0,0 +1,49 @@ + + + +
+ &reftitle.install; + + &pecl.info; + http://pecl.php.net/package/memcached + + + If libmemcached is installed in a non-standard location, use switch, where DIR is the + libmemcached install prefix. This directory has to contain the + include/libmemcached/memcached.h file. + + + Zlib is required for compression support. To specify non-standard + installation of Zlib, use switch, where DIR is the Zlib + install prefix. + + + Session handler support is enabled by default. To disable it, use switch. + +
+ + + diff --git a/reference/memcached/constants.xml b/reference/memcached/constants.xml new file mode 100644 index 0000000000..c7024aa8bf --- /dev/null +++ b/reference/memcached/constants.xml @@ -0,0 +1,375 @@ + + + + + &reftitle.constants; + &extension.constants; + + + + Memcached::OPT_COMPRESSION + + Description here... + + + + + Memcached::OPT_PREFIX_KEY + + Description here... + + + + + Memcached::OPT_HASH + + Description here... + + + + + Memcached::HASH_DEFAULT + + Description here... + + + + + Memcached::HASH_MD5 + + Description here... + + + + + Memcached::HASH_CRC + + Description here... + + + + + Memcached::HASH_FNV1_64 + + Description here... + + + + + Memcached::HASH_FNV1A_64 + + Description here... + + + + + Memcached::HASH_FNV1_32 + + Description here... + + + + + Memcached::HASH_FNV1A_32 + + Description here... + + + + + Memcached::HASH_HSIEH + + Description here... + + + + + Memcached::HASH_MURMUR + + Description here... + + + + + Memcached::OPT_DISTRIBUTION + + Description here... + + + + + Memcached::DISTRIBUTION_MODULA + + Description here... + + + + + Memcached::DISTRIBUTION_CONSISTENT + + Description here... + + + + + Memcached::OPT_BUFFER_WRITES + + Description here... + + + + + Memcached::OPT_BINARY_PROTOCOL + + Description here... + + + + + Memcached::OPT_NO_BLOCK + + Description here... + + + + + Memcached::OPT_TCP_NODELAY + + Description here... + + + + + Memcached::OPT_SOCKET_SEND_SIZE + + Description here... + + + + + Memcached::OPT_SOCKET_RECV_SIZE + + Description here... + + + + + Memcached::OPT_CONNECT_TIMEOUT + + Description here... + + + + + Memcached::OPT_RETRY_TIMEOUT + + Description here... + + + + + Memcached::OPT_SEND_TIMEOUT + + Description here... + + + + + Memcached::OPT_RECV_TIMEOUT + + Description here... + + + + + Memcached::OPT_POLL_TIMEOUT + + Description here... + + + + + Memcached::OPT_CACHE_LOOKUPS + + Description here... + + + + + Memcached::OPT_SERVER_FAILURE_LIMIT + + Description here... + + + + + Memcached::RES_SUCCESS + + Description here... + + + + + Memcached::RES_FAILURE + + Description here... + + + + + Memcached::RES_HOST_LOOKUP_FAILURE + + Description here... + + + + + Memcached::RES_UNKNOWN_READ_FAILURE + + Description here... + + + + + Memcached::RES_PROTOCOL_ERROR + + Description here... + + + + + Memcached::RES_CLIENT_ERROR + + Description here... + + + + + Memcached::RES_SERVER_ERROR + + Description here... + + + + + Memcached::RES_WRITE_FAILURE + + Description here... + + + + + Memcached::RES_DATA_EXISTS + + Description here... + + + + + Memcached::RES_NOTSTORED + + Description here... + + + + + Memcached::RES_NOTFOUND + + Description here... + + + + + Memcached::RES_PARTIAL_READ + + Description here... + + + + + Memcached::RES_SOME_ERRORS + + Description here... + + + + + Memcached::RES_NO_SERVERS + + Description here... + + + + + Memcached::RES_END + + Description here... + + + + + Memcached::RES_ERRNO + + Description here... + + + + + Memcached::RES_BUFFERED + + Description here... + + + + + Memcached::RES_TIMEOUT + + Description here... + + + + + Memcached::RES_BAD_KEY_PROVIDED + + Description here... + + + + + Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE + + Description here... + + + + + Memcached::RES_PAYLOAD_FAILURE + + Description here... + + + + + + + + diff --git a/reference/memcached/entities.memcached.xml b/reference/memcached/entities.memcached.xml new file mode 100644 index 0000000000..c299230217 --- /dev/null +++ b/reference/memcached/entities.memcached.xml @@ -0,0 +1,35 @@ +&reference.memcached.memcached.add; +&reference.memcached.memcached.addbykey; +&reference.memcached.memcached.addserver; +&reference.memcached.memcached.append; +&reference.memcached.memcached.appendbykey; +&reference.memcached.memcached.cas; +&reference.memcached.memcached.casbykey; +&reference.memcached.memcached.construct; +&reference.memcached.memcached.decrement; +&reference.memcached.memcached.delete; +&reference.memcached.memcached.deletebykey; +&reference.memcached.memcached.fetch; +&reference.memcached.memcached.fetchall; +&reference.memcached.memcached.flush; +&reference.memcached.memcached.get; +&reference.memcached.memcached.getbykey; +&reference.memcached.memcached.getdelayed; +&reference.memcached.memcached.getdelayedbykey; +&reference.memcached.memcached.getmulti; +&reference.memcached.memcached.getmultibykey; +&reference.memcached.memcached.getoption; +&reference.memcached.memcached.getresultcode; +&reference.memcached.memcached.getserverbykey; +&reference.memcached.memcached.getserverlist; +&reference.memcached.memcached.getstats; +&reference.memcached.memcached.increment; +&reference.memcached.memcached.prepend; +&reference.memcached.memcached.prependbykey; +&reference.memcached.memcached.replace; +&reference.memcached.memcached.replacebykey; +&reference.memcached.memcached.set; +&reference.memcached.memcached.setbykey; +&reference.memcached.memcached.setmulti; +&reference.memcached.memcached.setmultibykey; +&reference.memcached.memcached.setoption; diff --git a/reference/memcached/examples.xml b/reference/memcached/examples.xml new file mode 100644 index 0000000000..c310240900 --- /dev/null +++ b/reference/memcached/examples.xml @@ -0,0 +1,49 @@ + + + + + &reftitle.examples; + + Description here... + + + Memcached Example + + +]]> + + &example.outputs.similar; + + + + + + + + diff --git a/reference/memcached/memcached.xml b/reference/memcached/memcached.xml new file mode 100644 index 0000000000..ddf5753c6d --- /dev/null +++ b/reference/memcached/memcached.xml @@ -0,0 +1,362 @@ + + + + + + The Memcached class + Memcached + + + + +
+ &reftitle.intro; + + Description of the class. + +
+ + +
+ &reftitle.classsynopsis; + + + + Memcached + + + + + Memcached + + + + Constants + + const + integer + Memcached::OPT_COMPRESSION + -1001 + + + const + integer + Memcached::OPT_PREFIX_KEY + -1002 + + + const + integer + Memcached::OPT_HASH + 2 + + + const + integer + Memcached::HASH_DEFAULT + 0 + + + const + integer + Memcached::HASH_MD5 + 1 + + + const + integer + Memcached::HASH_CRC + 2 + + + const + integer + Memcached::HASH_FNV1_64 + 3 + + + const + integer + Memcached::HASH_FNV1A_64 + 4 + + + const + integer + Memcached::HASH_FNV1_32 + 5 + + + const + integer + Memcached::HASH_FNV1A_32 + 6 + + + const + integer + Memcached::HASH_HSIEH + 7 + + + const + integer + Memcached::HASH_MURMUR + 8 + + + const + integer + Memcached::OPT_DISTRIBUTION + 9 + + + const + integer + Memcached::DISTRIBUTION_MODULA + 0 + + + const + integer + Memcached::DISTRIBUTION_CONSISTENT + 1 + + + const + integer + Memcached::OPT_BUFFER_WRITES + 10 + + + const + integer + Memcached::OPT_BINARY_PROTOCOL + 18 + + + const + integer + Memcached::OPT_NO_BLOCK + 0 + + + const + integer + Memcached::OPT_TCP_NODELAY + 1 + + + const + integer + Memcached::OPT_SOCKET_SEND_SIZE + 4 + + + const + integer + Memcached::OPT_SOCKET_RECV_SIZE + 5 + + + const + integer + Memcached::OPT_CONNECT_TIMEOUT + 14 + + + const + integer + Memcached::OPT_RETRY_TIMEOUT + 15 + + + const + integer + Memcached::OPT_SEND_TIMEOUT + 19 + + + const + integer + Memcached::OPT_RECV_TIMEOUT + 15 + + + const + integer + Memcached::OPT_POLL_TIMEOUT + 8 + + + const + integer + Memcached::OPT_CACHE_LOOKUPS + 6 + + + const + integer + Memcached::OPT_SERVER_FAILURE_LIMIT + 21 + + + const + integer + Memcached::RES_SUCCESS + 0 + + + const + integer + Memcached::RES_FAILURE + 1 + + + const + integer + Memcached::RES_HOST_LOOKUP_FAILURE + 2 + + + const + integer + Memcached::RES_UNKNOWN_READ_FAILURE + 7 + + + const + integer + Memcached::RES_PROTOCOL_ERROR + 8 + + + const + integer + Memcached::RES_CLIENT_ERROR + 9 + + + const + integer + Memcached::RES_SERVER_ERROR + 10 + + + const + integer + Memcached::RES_WRITE_FAILURE + 5 + + + const + integer + Memcached::RES_DATA_EXISTS + 12 + + + const + integer + Memcached::RES_NOTSTORED + 14 + + + const + integer + Memcached::RES_NOTFOUND + 16 + + + const + integer + Memcached::RES_PARTIAL_READ + 18 + + + const + integer + Memcached::RES_SOME_ERRORS + 19 + + + const + integer + Memcached::RES_NO_SERVERS + 20 + + + const + integer + Memcached::RES_END + 21 + + + const + integer + Memcached::RES_ERRNO + 25 + + + const + integer + Memcached::RES_BUFFERED + 31 + + + const + integer + Memcached::RES_TIMEOUT + 30 + + + const + integer + Memcached::RES_BAD_KEY_PROVIDED + 32 + + + const + integer + Memcached::RES_CONNECTION_SOCKET_CREATE_FAILURE + 11 + + + const + integer + Memcached::RES_PAYLOAD_FAILURE + -1001 + + + Methods + + + + +
+ + + + &reference.memcached.entities.memcached; + + + + diff --git a/reference/memcached/memcached/add.xml b/reference/memcached/memcached/add.xml new file mode 100644 index 0000000000..1c73ca5c8f --- /dev/null +++ b/reference/memcached/memcached/add.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::add + The add purpose + + + + &reftitle.description; + + public voidMemcached::add + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::add</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/addbykey.xml b/reference/memcached/memcached/addbykey.xml new file mode 100644 index 0000000000..daab44877a --- /dev/null +++ b/reference/memcached/memcached/addbykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::addByKey + The addByKey purpose + + + + &reftitle.description; + + public voidMemcached::addByKey + stringserver_key + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::addByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/addserver.xml b/reference/memcached/memcached/addserver.xml new file mode 100644 index 0000000000..c2c7ffb644 --- /dev/null +++ b/reference/memcached/memcached/addserver.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::addServer + The addServer purpose + + + + &reftitle.description; + + public voidMemcached::addServer + stringhost + stringport + stringweight + + + The method description goes here. + + + + + &reftitle.parameters; + + + + host + + + Description... + + + + + port + + + Description... + + + + + weight + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::addServer</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/append.xml b/reference/memcached/memcached/append.xml new file mode 100644 index 0000000000..33269bd988 --- /dev/null +++ b/reference/memcached/memcached/append.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::append + The append purpose + + + + &reftitle.description; + + public voidMemcached::append + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::append</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/appendbykey.xml b/reference/memcached/memcached/appendbykey.xml new file mode 100644 index 0000000000..74a49ee9d9 --- /dev/null +++ b/reference/memcached/memcached/appendbykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::appendByKey + The appendByKey purpose + + + + &reftitle.description; + + public voidMemcached::appendByKey + stringserver_key + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::appendByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/cas.xml b/reference/memcached/memcached/cas.xml new file mode 100644 index 0000000000..7c8e446b49 --- /dev/null +++ b/reference/memcached/memcached/cas.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::cas + The cas purpose + + + + &reftitle.description; + + public voidMemcached::cas + stringcas_token + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + cas_token + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::cas</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/casbykey.xml b/reference/memcached/memcached/casbykey.xml new file mode 100644 index 0000000000..1bfa7392ff --- /dev/null +++ b/reference/memcached/memcached/casbykey.xml @@ -0,0 +1,132 @@ + + + + + + Memcached::casByKey + The casByKey purpose + + + + &reftitle.description; + + public voidMemcached::casByKey + stringcas_token + stringserver_key + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + cas_token + + + Description... + + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::casByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/construct.xml b/reference/memcached/memcached/construct.xml new file mode 100644 index 0000000000..626364db7b --- /dev/null +++ b/reference/memcached/memcached/construct.xml @@ -0,0 +1,96 @@ + + + + + + Memcached::__construct + The __construct purpose + + + + &reftitle.description; + + Memcached::__construct + stringpersistent_id + + + The method description goes here. + + + + + &reftitle.parameters; + + + + persistent_id + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::__construct</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/decrement.xml b/reference/memcached/memcached/decrement.xml new file mode 100644 index 0000000000..b97ab1dc4a --- /dev/null +++ b/reference/memcached/memcached/decrement.xml @@ -0,0 +1,105 @@ + + + + + + Memcached::decrement + The decrement purpose + + + + &reftitle.description; + + public voidMemcached::decrement + stringkey + stringoffset + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + offset + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::decrement</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/delete.xml b/reference/memcached/memcached/delete.xml new file mode 100644 index 0000000000..e582df44a6 --- /dev/null +++ b/reference/memcached/memcached/delete.xml @@ -0,0 +1,105 @@ + + + + + + Memcached::delete + The delete purpose + + + + &reftitle.description; + + public voidMemcached::delete + stringkey + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::delete</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/deletebykey.xml b/reference/memcached/memcached/deletebykey.xml new file mode 100644 index 0000000000..ad1375ca8b --- /dev/null +++ b/reference/memcached/memcached/deletebykey.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::deleteByKey + The deleteByKey purpose + + + + &reftitle.description; + + public voidMemcached::deleteByKey + stringserver_key + stringkey + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::deleteByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/fetch.xml b/reference/memcached/memcached/fetch.xml new file mode 100644 index 0000000000..8cab41411e --- /dev/null +++ b/reference/memcached/memcached/fetch.xml @@ -0,0 +1,85 @@ + + + + + + Memcached::fetch + The fetch purpose + + + + &reftitle.description; + + public voidMemcached::fetch + + + + The method description goes here. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::fetch</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/fetchall.xml b/reference/memcached/memcached/fetchall.xml new file mode 100644 index 0000000000..ab83e50235 --- /dev/null +++ b/reference/memcached/memcached/fetchall.xml @@ -0,0 +1,85 @@ + + + + + + Memcached::fetchAll + The fetchAll purpose + + + + &reftitle.description; + + public voidMemcached::fetchAll + + + + The method description goes here. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::fetchAll</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/flush.xml b/reference/memcached/memcached/flush.xml new file mode 100644 index 0000000000..b8aa30cd33 --- /dev/null +++ b/reference/memcached/memcached/flush.xml @@ -0,0 +1,96 @@ + + + + + + Memcached::flush + The flush purpose + + + + &reftitle.description; + + public voidMemcached::flush + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::flush</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/get.xml b/reference/memcached/memcached/get.xml new file mode 100644 index 0000000000..943023dbfd --- /dev/null +++ b/reference/memcached/memcached/get.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::get + The get purpose + + + + &reftitle.description; + + public voidMemcached::get + stringkey + stringcache_cb + stringcas_token + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + cache_cb + + + Description... + + + + + cas_token + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::get</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getbykey.xml b/reference/memcached/memcached/getbykey.xml new file mode 100644 index 0000000000..91d635cd30 --- /dev/null +++ b/reference/memcached/memcached/getbykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::getByKey + The getByKey purpose + + + + &reftitle.description; + + public voidMemcached::getByKey + stringserver_key + stringkey + stringcache_cb + stringcas_token + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + cache_cb + + + Description... + + + + + cas_token + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getdelayed.xml b/reference/memcached/memcached/getdelayed.xml new file mode 100644 index 0000000000..2fabeb12d6 --- /dev/null +++ b/reference/memcached/memcached/getdelayed.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::getDelayed + The getDelayed purpose + + + + &reftitle.description; + + public voidMemcached::getDelayed + arraykeys + stringwith_cas + stringvalue_cb + + + The method description goes here. + + + + + &reftitle.parameters; + + + + keys + + + Description... + + + + + with_cas + + + Description... + + + + + value_cb + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getDelayed</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getdelayedbykey.xml b/reference/memcached/memcached/getdelayedbykey.xml new file mode 100644 index 0000000000..b9875f8e27 --- /dev/null +++ b/reference/memcached/memcached/getdelayedbykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::getDelayedByKey + The getDelayedByKey purpose + + + + &reftitle.description; + + public voidMemcached::getDelayedByKey + stringserver_key + arraykeys + stringwith_cas + stringvalue_cb + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + keys + + + Description... + + + + + with_cas + + + Description... + + + + + value_cb + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getDelayedByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getmulti.xml b/reference/memcached/memcached/getmulti.xml new file mode 100644 index 0000000000..d75638bfa1 --- /dev/null +++ b/reference/memcached/memcached/getmulti.xml @@ -0,0 +1,105 @@ + + + + + + Memcached::getMulti + The getMulti purpose + + + + &reftitle.description; + + public voidMemcached::getMulti + arraykeys + stringcas_tokens + + + The method description goes here. + + + + + &reftitle.parameters; + + + + keys + + + Description... + + + + + cas_tokens + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getMulti</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getmultibykey.xml b/reference/memcached/memcached/getmultibykey.xml new file mode 100644 index 0000000000..a2a7934ede --- /dev/null +++ b/reference/memcached/memcached/getmultibykey.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::getMultiByKey + The getMultiByKey purpose + + + + &reftitle.description; + + public voidMemcached::getMultiByKey + stringserver_key + arraykeys + stringcas_tokens + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + keys + + + Description... + + + + + cas_tokens + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getMultiByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getoption.xml b/reference/memcached/memcached/getoption.xml new file mode 100644 index 0000000000..3ecc93d73b --- /dev/null +++ b/reference/memcached/memcached/getoption.xml @@ -0,0 +1,96 @@ + + + + + + Memcached::getOption + The getOption purpose + + + + &reftitle.description; + + public voidMemcached::getOption + stringoption + + + The method description goes here. + + + + + &reftitle.parameters; + + + + option + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getOption</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getresultcode.xml b/reference/memcached/memcached/getresultcode.xml new file mode 100644 index 0000000000..651ab2cda8 --- /dev/null +++ b/reference/memcached/memcached/getresultcode.xml @@ -0,0 +1,85 @@ + + + + + + Memcached::getResultCode + The getResultCode purpose + + + + &reftitle.description; + + public voidMemcached::getResultCode + + + + The method description goes here. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getResultCode</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getserverbykey.xml b/reference/memcached/memcached/getserverbykey.xml new file mode 100644 index 0000000000..65fe069555 --- /dev/null +++ b/reference/memcached/memcached/getserverbykey.xml @@ -0,0 +1,96 @@ + + + + + + Memcached::getServerByKey + The getServerByKey purpose + + + + &reftitle.description; + + public voidMemcached::getServerByKey + stringserver_key + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getServerByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getserverlist.xml b/reference/memcached/memcached/getserverlist.xml new file mode 100644 index 0000000000..502d414ce8 --- /dev/null +++ b/reference/memcached/memcached/getserverlist.xml @@ -0,0 +1,85 @@ + + + + + + Memcached::getServerList + The getServerList purpose + + + + &reftitle.description; + + public voidMemcached::getServerList + + + + The method description goes here. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getServerList</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/getstats.xml b/reference/memcached/memcached/getstats.xml new file mode 100644 index 0000000000..76aafecefc --- /dev/null +++ b/reference/memcached/memcached/getstats.xml @@ -0,0 +1,85 @@ + + + + + + Memcached::getStats + The getStats purpose + + + + &reftitle.description; + + public voidMemcached::getStats + + + + The method description goes here. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::getStats</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/increment.xml b/reference/memcached/memcached/increment.xml new file mode 100644 index 0000000000..3691549b6b --- /dev/null +++ b/reference/memcached/memcached/increment.xml @@ -0,0 +1,105 @@ + + + + + + Memcached::increment + The increment purpose + + + + &reftitle.description; + + public voidMemcached::increment + stringkey + stringoffset + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + offset + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::increment</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/prepend.xml b/reference/memcached/memcached/prepend.xml new file mode 100644 index 0000000000..076c2c2c1e --- /dev/null +++ b/reference/memcached/memcached/prepend.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::prepend + The prepend purpose + + + + &reftitle.description; + + public voidMemcached::prepend + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::prepend</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/prependbykey.xml b/reference/memcached/memcached/prependbykey.xml new file mode 100644 index 0000000000..057a55fdcd --- /dev/null +++ b/reference/memcached/memcached/prependbykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::prependByKey + The prependByKey purpose + + + + &reftitle.description; + + public voidMemcached::prependByKey + stringserver_key + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::prependByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/replace.xml b/reference/memcached/memcached/replace.xml new file mode 100644 index 0000000000..bc62f2b6bd --- /dev/null +++ b/reference/memcached/memcached/replace.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::replace + The replace purpose + + + + &reftitle.description; + + public voidMemcached::replace + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::replace</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/replacebykey.xml b/reference/memcached/memcached/replacebykey.xml new file mode 100644 index 0000000000..6c5cf8147f --- /dev/null +++ b/reference/memcached/memcached/replacebykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::replaceByKey + The replaceByKey purpose + + + + &reftitle.description; + + public voidMemcached::replaceByKey + stringserver_key + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::replaceByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/set.xml b/reference/memcached/memcached/set.xml new file mode 100644 index 0000000000..b3e820eb9d --- /dev/null +++ b/reference/memcached/memcached/set.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::set + The set purpose + + + + &reftitle.description; + + public voidMemcached::set + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::set</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/setbykey.xml b/reference/memcached/memcached/setbykey.xml new file mode 100644 index 0000000000..abe09587c0 --- /dev/null +++ b/reference/memcached/memcached/setbykey.xml @@ -0,0 +1,123 @@ + + + + + + Memcached::setByKey + The setByKey purpose + + + + &reftitle.description; + + public voidMemcached::setByKey + stringserver_key + stringkey + stringvalue + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + key + + + Description... + + + + + value + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::setByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/setmulti.xml b/reference/memcached/memcached/setmulti.xml new file mode 100644 index 0000000000..eafbd6c54c --- /dev/null +++ b/reference/memcached/memcached/setmulti.xml @@ -0,0 +1,105 @@ + + + + + + Memcached::setMulti + The setMulti purpose + + + + &reftitle.description; + + public voidMemcached::setMulti + arrayentries + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + entries + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::setMulti</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/setmultibykey.xml b/reference/memcached/memcached/setmultibykey.xml new file mode 100644 index 0000000000..24f5b1c395 --- /dev/null +++ b/reference/memcached/memcached/setmultibykey.xml @@ -0,0 +1,114 @@ + + + + + + Memcached::setMultiByKey + The setMultiByKey purpose + + + + &reftitle.description; + + public voidMemcached::setMultiByKey + stringserver_key + arrayentries + stringexpiration + + + The method description goes here. + + + + + &reftitle.parameters; + + + + server_key + + + Description... + + + + + entries + + + Description... + + + + + expiration + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::setMultiByKey</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcached/setoption.xml b/reference/memcached/memcached/setoption.xml new file mode 100644 index 0000000000..095766b691 --- /dev/null +++ b/reference/memcached/memcached/setoption.xml @@ -0,0 +1,105 @@ + + + + + + Memcached::setOption + The setOption purpose + + + + &reftitle.description; + + public voidMemcached::setOption + stringoption + stringvalue + + + The method description goes here. + + + + + &reftitle.parameters; + + + + option + + + Description... + + + + + value + + + Description... + + + + + + + + + &reftitle.returnvalues; + + Description... + + + + + &reftitle.examples; + + + <function>Memcached::setOption</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Classname::Method + + + + + + + diff --git a/reference/memcached/memcachedexception.xml b/reference/memcached/memcachedexception.xml new file mode 100644 index 0000000000..908a0832d5 --- /dev/null +++ b/reference/memcached/memcachedexception.xml @@ -0,0 +1,112 @@ + + + + + + The MemcachedException class + MemcachedException + + + + +
+ &reftitle.intro; + + Description of the class. + +
+ + +
+ &reftitle.classsynopsis; + + + + MemcachedException + + + + + MemcachedException + + + + extends + RuntimeException + + + + Properties + + + Methods + + + Inherited methods + + + + + +
+ + + +
+ &reftitle.properties; + + + message + + Prop description + + + + code + + Prop description + + + + file + + Prop description + + + + line + + Prop description + + + +
+ + + + + + &reference.memcached.entities.memcachedexception; + + + + diff --git a/reference/memcached/setup.xml b/reference/memcached/setup.xml new file mode 100644 index 0000000000..0529ca7d6b --- /dev/null +++ b/reference/memcached/setup.xml @@ -0,0 +1,54 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + + This extension requires libmemcached client library. + +
+ + + &reference.memcached.configure; + + + +
+ &reftitle.runtime; + &no.config; +
+ + + +
+ &reftitle.resources; + &no.resource; +
+ + + + + diff --git a/reference/memcached/versions.xml b/reference/memcached/versions.xml new file mode 100644 index 0000000000..7f0e49bb6c --- /dev/null +++ b/reference/memcached/versions.xml @@ -0,0 +1,80 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +