cvs: phpdoc /en/reference/memcache book.xml constants.xml examples.xml reference.xml setup.xml

From: Date: Wed, 26 Dec 2007 13:28:58 +0000
Subject: cvs: phpdoc /en/reference/memcache book.xml constants.xml examples.xml reference.xml setup.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-813@lists.php.net to get a copy of this message
bjori Wed Dec 26 13:28:58 2007 UTC Modified files: /phpdoc/en/reference/memcache book.xml examples.xml setup.xml constants.xml reference.xml Log: MFB: Upgrade to the new-reference-structure - (Created missing setup sections in setup.xml, if any) - Moved the intro to book.xml - Changed the intro ID from <extname>.intro to intro.<extname> - Moved the constants entity to book.xml - Changed constants.xml to be an appendix - Moved memcache.examples to its own chapter (examples.xml) NOTE: The orginal memcache.examples ID was changed to memcache.examples-overview The examples chapter itself is now memcache.examples - Moved the requirements and resources sections to setup.xml - Moved the configure and ini entities to setup.xml

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/book.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/memcache/book.xml diff -u /dev/null phpdoc/en/reference/memcache/book.xml:1.2 --- /dev/null Wed Dec 26 13:28:58 2007 +++ phpdoc/en/reference/memcache/book.xml Wed Dec 26 13:28:57 2007 @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> +<!-- Purpose: remote.other --> +<!-- Membership: pecl, external --> + +<book xml:id="book.memcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>Memcache</title> + + <!-- {{{ preface --> + <preface xml:id="intro.memcache"> + &reftitle.intro; + <para> + Memcache module provides handy procedural and object oriented interface + to memcached, highly effective caching daemon, which was especially + designed to decrease database load in dynamic web applications. + </para> + <para> + The Memcache module also provides a <link + linkend="ref.session">session</link> handler (<literal>memcache</literal>). + </para> + <para> + More information about memcached can be found at <link + xlink:href="&url.memcache;">&url.memcache;</link>. + </para> + </preface> + <!-- }}} --> + + &reference.memcache.setup; + &reference.memcache.constants; + &reference.memcache.examples; + &reference.memcache.reference; + +</book> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +indent-tabs-mode:nil +sgml-parent-document:nil +sgml-default-dtd-file:"../../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +--> + http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/examples.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/memcache/examples.xml diff -u /dev/null phpdoc/en/reference/memcache/examples.xml:1.2 --- /dev/null Wed Dec 26 13:28:58 2007 +++ phpdoc/en/reference/memcache/examples.xml Wed Dec 26 13:28:57 2007 @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<chapter xml:id="memcache.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.examples; + <section xml:id="memcache.examples-overview"> + <para> + <example> + <title>memcache extension overview example</title> + <para> + In this example, an object is being saved in the cache and then + retrieved back. Object and other non-scalar types are serialized + before saving, so it's impossible to store resources (i.e. connection + identifiers and others) in the cache. + </para> + <programlisting role="php"> +<![CDATA[ +<?php + +$memcache = new Memcache; +$memcache->connect('localhost', 11211) or die ("Could not connect"); + +$version = $memcache->getVersion(); +echo "Server's version: ".$version."<br/>\n"; + +$tmp_object = new stdClass; +$tmp_object->str_attr = 'test'; +$tmp_object->int_attr = 123; + +$memcache->set('key', $tmp_object, false, 10) or die ("Failed to save data at the server"); +echo "Store data in the cache (data will expire in 10 seconds)<br/>\n"; + +$get_result = $memcache->get('key'); +echo "Data from the cache:<br/>\n"; + +var_dump($get_result); + +?> +]]> + </programlisting> + </example> + </para> + <para> + <example> + <title>Using memcache session handler</title> + <programlisting role="php"> +<![CDATA[ +<?php + +$session_save_path = "tcp://$host:$port?persistent=1&weight=2&timeout=2&retry_interval=10, ,tcp://$host:$port "; +ini_set('session.save_handler', 'memcache'); +ini_set('session.save_path', $session_save_path); + +?> +]]> + </programlisting> + </example> + </para> + </section> +</chapter> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +indent-tabs-mode:nil +sgml-parent-document:nil +sgml-default-dtd-file:"../../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +--> + + http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/setup.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/memcache/setup.xml diff -u /dev/null phpdoc/en/reference/memcache/setup.xml:1.2 --- /dev/null Wed Dec 26 13:28:58 2007 +++ phpdoc/en/reference/memcache/setup.xml Wed Dec 26 13:28:58 2007 @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<chapter xml:id="memcache.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.setup; + + <!-- {{{ Requirements --> + <section xml:id="memcache.requirements"> + &reftitle.required; + <para> + This module uses functions of <link xlink:href="&url.zlib;">zlib</link> + to support on-the-fly data compression. Zlib is required to install + this module. + </para> + <para> + PHP 4.3.3 or newer is required to use the memcache extension. + </para> + </section> + <!-- }}} --> + + <!-- {{{ Installation --> + &reference.memcache.configure; + <!-- }}} --> + + <!-- {{{ Configuration --> + &reference.memcache.ini; + <!-- }}} --> + + <!-- {{{ Resources --> + <section xml:id="memcache.resources"> + &reftitle.resources; + <para> + There is only one resource type used in memcache module - it's + the link identifier for a cache server connection. + </para> + </section> + <!-- }}} --> + +</chapter> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +indent-tabs-mode:nil +sgml-parent-document:nil +sgml-default-dtd-file:"../../../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +--> + http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/constants.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/memcache/constants.xml diff -u phpdoc/en/reference/memcache/constants.xml:1.3 phpdoc/en/reference/memcache/constants.xml:1.4 --- phpdoc/en/reference/memcache/constants.xml:1.3 Sun Jun 24 03:23:30 2007 +++ phpdoc/en/reference/memcache/constants.xml Wed Dec 26 13:28:57 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<section xml:id='memcache.constants' xmlns="http://docbook.org/ns/docbook"> +<!-- $Revision: 1.4 $ --> +<appendix xml:id='memcache.constants' xmlns="http://docbook.org/ns/docbook"> &reftitle.constants; <table> <title>Memcache Constants</title> @@ -36,7 +36,7 @@ </tbody> </tgroup> </table> -</section> +</appendix> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/memcache/reference.xml?r1=1.11&r2=1.12&diff_format=u Index: phpdoc/en/reference/memcache/reference.xml diff -u phpdoc/en/reference/memcache/reference.xml:1.11 phpdoc/en/reference/memcache/reference.xml:1.12 --- phpdoc/en/reference/memcache/reference.xml:1.11 Mon Dec 10 17:06:05 2007 +++ phpdoc/en/reference/memcache/reference.xml Wed Dec 26 13:28:57 2007 @@ -1,116 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.11 $ --> -<!-- Purpose: remote.other --> -<!-- Membership: pecl, external --> +<!-- $Revision: 1.12 $ --> - <reference xml:id="ref.memcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>Memcache Functions</title> - <titleabbrev>Memcache</titleabbrev> +<reference xml:id="ref.memcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>Memcache &Functions;</title> + &reference.memcache.entities.functions; - <partintro> - <section xml:id="memcache.intro"> - &reftitle.intro; - <para> - Memcache module provides handy procedural and object oriented interface - to memcached, highly effective caching daemon, which was especially - designed to decrease database load in dynamic web applications. - </para> - <para> - The Memcache module also provides a <link - linkend="ref.session">session</link> handler (<literal>memcache</literal>). - </para> - <para> - More information about memcached can be found at <link - xlink:href="&url.memcache;">&url.memcache;</link>. - </para> - </section> +</reference> - <section xml:id="memcache.requirements"> - &reftitle.required; - <para> - This module uses functions of <link xlink:href="&url.zlib;">zlib</link> - to support on-the-fly data compression. Zlib is required to install - this module. - </para> - <para> - PHP 4.3.3 or newer is required to use the memcache extension. - </para> - </section> - - &reference.memcache.configure; - &reference.memcache.ini; - - <section xml:id="memcache.resources"> - &reftitle.resources; - <para> - There is only one resource type used in memcache module - it's - the link identifier for a cache server connection. - </para> - </section> - - &reference.memcache.constants; - - <section xml:id="memcache.examples"> - &reftitle.examples; - <para> - <example> - <title>memcache extension overview example</title> - <para> - In this example, an object is being saved in the cache and then - retrieved back. Object and other non-scalar types are serialized - before saving, so it's impossible to store resources (i.e. connection - identifiers and others) in the cache. - </para> - <programlisting role="php"> -<![CDATA[ -<?php - -$memcache = new Memcache; -$memcache->connect('localhost', 11211) or die ("Could not connect"); - -$version = $memcache->getVersion(); -echo "Server's version: ".$version."<br/>\n"; - -$tmp_object = new stdClass; -$tmp_object->str_attr = 'test'; -$tmp_object->int_attr = 123; - -$memcache->set('key', $tmp_object, false, 10) or die ("Failed to save data at the server"); -echo "Store data in the cache (data will expire in 10 seconds)<br/>\n"; - -$get_result = $memcache->get('key'); -echo "Data from the cache:<br/>\n"; - -var_dump($get_result); - -?> -]]> - </programlisting> - </example> - </para> - <para> - <example> - <title>Using memcache session handler</title> - <programlisting role="php"> -<![CDATA[ -<?php - -$session_save_path = "tcp://$host:$port?persistent=1&weight=2&timeout=2&retry_interval=10, ,tcp://$host:$port "; -ini_set('session.save_handler', 'memcache'); -ini_set('session.save_path', $session_save_path); - -?> -]]> - </programlisting> - </example> - </para> - </section> - - </partintro> - - &reference.memcache.entities.functions; - - </reference> <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -131,3 +27,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> +
« previous php.doc.cvs (#813) next »