From 0ac7a78870468423f8bf0dd76d11424921c9ef4d Mon Sep 17 00:00:00 2001 From: Francis Besset Date: Sun, 13 Nov 2011 22:40:42 +0100 Subject: [PATCH] [Doc] Global update --- Resources/doc/cache.rst | 26 +++++++++++++ Resources/doc/index.rst | 24 ++++++++---- .../doc/{reference => }/installation.rst | 38 ++++++++++++++++++- .../configuration.rst | 0 .../doc/{ => soapserver}/tutorial/array.rst | 0 .../tutorial/complex_type.rst | 0 .../doc/{ => soapserver}/tutorial/header.rst | 0 Resources/doc/soapserver/tutorials.rst | 9 +++++ .../doc/{reference => soapserver}/types.rst | 0 9 files changed, 87 insertions(+), 10 deletions(-) create mode 100644 Resources/doc/cache.rst rename Resources/doc/{reference => }/installation.rst (52%) rename Resources/doc/{reference => soapserver}/configuration.rst (100%) rename Resources/doc/{ => soapserver}/tutorial/array.rst (100%) rename Resources/doc/{ => soapserver}/tutorial/complex_type.rst (100%) rename Resources/doc/{ => soapserver}/tutorial/header.rst (100%) create mode 100644 Resources/doc/soapserver/tutorials.rst rename Resources/doc/{reference => soapserver}/types.rst (100%) diff --git a/Resources/doc/cache.rst b/Resources/doc/cache.rst new file mode 100644 index 0000000..0090361 --- /dev/null +++ b/Resources/doc/cache.rst @@ -0,0 +1,26 @@ +Cache +===== + +Configuration +------------- + +Configure the cache of PHP Soap WSDL in your config file: + +.. code-block:: yaml + + # app/config/config.yml + be_simple_soap: + cache: + type: disk + lifetime: 86400 + limit: 5 + +The cache type can be: **none**, **disk** (default value), **memory**, **disk_memory**. + +The lifetime in seconds of a WSDL file in the cache (**86400 is the default value by PHP**). + +The limit is the maximum number of in-memory cached WSDL files (**5 is the default value by PHP**). + +If you want more information you can visit the following page `PHP Soap runtime configuration`_. + +.. _`PHP Soap runtime configuration`: http://www.php.net/manual/en/soap.configuration.php \ No newline at end of file diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst index 19be4f2..9182aa0 100644 --- a/Resources/doc/index.rst +++ b/Resources/doc/index.rst @@ -1,9 +1,11 @@ +================== BeSimpleSoapBundle ================== The BeSimpleSoapBundle is a Symfony2 bundle to build WSDL and SOAP based web services. It is based on the `ckWebServicePlugin`_ for symfony. +--------------- Reference Guide --------------- @@ -11,19 +13,25 @@ Reference Guide :maxdepth: 1 :numbered: - reference/installation - reference/configuration - reference/types + installation + cache -Tutorial --------- +---------- +SoapServer +---------- .. toctree:: :maxdepth: 1 :numbered: - tutorial/array - tutorial/complex_type - tutorial/header + soapserver/configuration + soapserver/types + soapserver/tutorials + +---------- +SoapClient +---------- + +Coming soon. .. _`ckWebServicePlugin`: http://www.symfony-project.org/plugins/ckWebServicePlugin \ No newline at end of file diff --git a/Resources/doc/reference/installation.rst b/Resources/doc/installation.rst similarity index 52% rename from Resources/doc/reference/installation.rst rename to Resources/doc/installation.rst index 495bec3..7a6c2e1 100644 --- a/Resources/doc/reference/installation.rst +++ b/Resources/doc/installation.rst @@ -4,8 +4,39 @@ Installation Requirements ------------ -Install and enable PHP's SOAP extension -Download `Zend\\Soap`_ and `Zend\\Mime`_ or add in `deps` file +Install and enable PHP's SOAP extension. + +Download `BeSimple\\SoapCommon`_ and `BeSimple\\SoapServer`_ (only for the server part) and/or `BeSimple\\SoapClient`_ (only for ther client part). + +.. code-block:: ini + + ; deps file + [BeSimple\SoapCommon] + git=http://github.com/BeSimple/SoapCommon + target=/besimple-soapcommon + + [BeSimple\SoapClient] + git=http://github.com/BeSimple/SoapClient + target=/besimple-soapclient + + [BeSimple\SoapServer] + git=http://github.com/BeSimple/SoapServer + target=/besimple-soapserver + + +Add `BeSimple` libraries in autoload.php + +.. code-block:: php + + // app/autoload.php + $loader->registerNamespaces(array( + 'BeSimple\\SoapCommon' => __DIR__.'/../vendor/besimple-soapcommon', + 'BeSimple\\SoapServer' => __DIR__.'/../vendor/besimple-soapserver', + 'BeSimple\\SoapClient' => __DIR__.'/../vendor/besimple-soapclient', + // your other namespaces + )); + +Download `Zend\\Soap`_ and `Zend\\Mime`_ or add in `deps` file. `Zend` library is required only for the server part. .. code-block:: ini @@ -67,4 +98,7 @@ Add `BeSimpleSoapBundle` in your Kernel class .. _`Zend\\Soap`: http://github.com/BeSimple/zend-soap .. _`Zend\\Mime`: http://github.com/BeSimple/zend-mime +.. _`BeSimple\\SoapCommon`: http://github.com/BeSimple/BeSimpleSoapCommon +.. _`BeSimple\\SoapServer`: http://github.com/BeSimple/BeSimpleSoapServer +.. _`BeSimple\\SoapClient`: http://github.com/BeSimple/BeSimpleSoapClient .. _`Download`: http://github.com/BeSimple/BeSimpleSoapBundle diff --git a/Resources/doc/reference/configuration.rst b/Resources/doc/soapserver/configuration.rst similarity index 100% rename from Resources/doc/reference/configuration.rst rename to Resources/doc/soapserver/configuration.rst diff --git a/Resources/doc/tutorial/array.rst b/Resources/doc/soapserver/tutorial/array.rst similarity index 100% rename from Resources/doc/tutorial/array.rst rename to Resources/doc/soapserver/tutorial/array.rst diff --git a/Resources/doc/tutorial/complex_type.rst b/Resources/doc/soapserver/tutorial/complex_type.rst similarity index 100% rename from Resources/doc/tutorial/complex_type.rst rename to Resources/doc/soapserver/tutorial/complex_type.rst diff --git a/Resources/doc/tutorial/header.rst b/Resources/doc/soapserver/tutorial/header.rst similarity index 100% rename from Resources/doc/tutorial/header.rst rename to Resources/doc/soapserver/tutorial/header.rst diff --git a/Resources/doc/soapserver/tutorials.rst b/Resources/doc/soapserver/tutorials.rst new file mode 100644 index 0000000..d1d36a4 --- /dev/null +++ b/Resources/doc/soapserver/tutorials.rst @@ -0,0 +1,9 @@ +Tutorials +========= + +.. toctree:: + :maxdepth: 1 + + tutorial/array + tutorial/complex_type + tutorial/header diff --git a/Resources/doc/reference/types.rst b/Resources/doc/soapserver/types.rst similarity index 100% rename from Resources/doc/reference/types.rst rename to Resources/doc/soapserver/types.rst