[Doc] Global update

This commit is contained in:
Francis Besset 2011-11-13 22:40:42 +01:00
parent 4abf5a59ed
commit 0ac7a78870
9 changed files with 87 additions and 10 deletions

26
Resources/doc/cache.rst Normal file
View File

@ -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

View File

@ -1,9 +1,11 @@
==================
BeSimpleSoapBundle BeSimpleSoapBundle
================== ==================
The BeSimpleSoapBundle is a Symfony2 bundle to build WSDL and SOAP based web services. The BeSimpleSoapBundle is a Symfony2 bundle to build WSDL and SOAP based web services.
It is based on the `ckWebServicePlugin`_ for symfony. It is based on the `ckWebServicePlugin`_ for symfony.
---------------
Reference Guide Reference Guide
--------------- ---------------
@ -11,19 +13,25 @@ Reference Guide
:maxdepth: 1 :maxdepth: 1
:numbered: :numbered:
reference/installation installation
reference/configuration cache
reference/types
Tutorial ----------
-------- SoapServer
----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:numbered: :numbered:
tutorial/array soapserver/configuration
tutorial/complex_type soapserver/types
tutorial/header soapserver/tutorials
----------
SoapClient
----------
Coming soon.
.. _`ckWebServicePlugin`: http://www.symfony-project.org/plugins/ckWebServicePlugin .. _`ckWebServicePlugin`: http://www.symfony-project.org/plugins/ckWebServicePlugin

View File

@ -4,8 +4,39 @@ Installation
Requirements Requirements
------------ ------------
Install and enable PHP's SOAP extension Install and enable PHP's SOAP extension.
Download `Zend\\Soap`_ and `Zend\\Mime`_ or add in `deps` file
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 .. code-block:: ini
@ -67,4 +98,7 @@ Add `BeSimpleSoapBundle` in your Kernel class
.. _`Zend\\Soap`: http://github.com/BeSimple/zend-soap .. _`Zend\\Soap`: http://github.com/BeSimple/zend-soap
.. _`Zend\\Mime`: http://github.com/BeSimple/zend-mime .. _`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 .. _`Download`: http://github.com/BeSimple/BeSimpleSoapBundle

View File

@ -0,0 +1,9 @@
Tutorials
=========
.. toctree::
:maxdepth: 1
tutorial/array
tutorial/complex_type
tutorial/header