From a736a52bab9940934d3a95938249e6388a6c9a44 Mon Sep 17 00:00:00 2001 From: Francis Besset Date: Tue, 23 Jul 2013 09:39:18 +0200 Subject: [PATCH] [SoapBundle] [Doc] Removed installation from deps and update installation with composer --- .../SoapBundle/Resources/doc/index.rst | 3 +- .../SoapBundle/Resources/doc/installation.rst | 34 +++++++ .../Resources/doc/installation_composer.rst | 55 ----------- .../Resources/doc/installation_deps.rst | 91 ------------------- 4 files changed, 35 insertions(+), 148 deletions(-) create mode 100644 src/BeSimple/SoapBundle/Resources/doc/installation.rst delete mode 100644 src/BeSimple/SoapBundle/Resources/doc/installation_composer.rst delete mode 100644 src/BeSimple/SoapBundle/Resources/doc/installation_deps.rst diff --git a/src/BeSimple/SoapBundle/Resources/doc/index.rst b/src/BeSimple/SoapBundle/Resources/doc/index.rst index 39200c6..68aae30 100644 --- a/src/BeSimple/SoapBundle/Resources/doc/index.rst +++ b/src/BeSimple/SoapBundle/Resources/doc/index.rst @@ -14,8 +14,7 @@ Reference Guide :numbered: requirements - installation_composer - installation_deps + installation cache ---------- diff --git a/src/BeSimple/SoapBundle/Resources/doc/installation.rst b/src/BeSimple/SoapBundle/Resources/doc/installation.rst new file mode 100644 index 0000000..4586978 --- /dev/null +++ b/src/BeSimple/SoapBundle/Resources/doc/installation.rst @@ -0,0 +1,34 @@ +Installation with Composer +========================== + +Add `besimple/soap-bundle `_ (with vendors) in your composer.json: + +.. code-block:: json + + { + "require": { + "besimple/soap": "0.1.*@dev, + "ass/xmlsecurity": "dev-master" + } + } + +Update vendors: + +.. code-block:: bash + + $ php composer.phar self-update + $ php composer.phar update + +Enable the BeSimpleSoapBundle your application Kernel class: + +.. code-block:: php + + // app/AppKernel.php + public function registerBundles() + { + return array( + // ... + new BeSimple\SoapBundle\BeSimpleSoapBundle(), + // ... + ); + } diff --git a/src/BeSimple/SoapBundle/Resources/doc/installation_composer.rst b/src/BeSimple/SoapBundle/Resources/doc/installation_composer.rst deleted file mode 100644 index e741a36..0000000 --- a/src/BeSimple/SoapBundle/Resources/doc/installation_composer.rst +++ /dev/null @@ -1,55 +0,0 @@ -Installation with Composer -========================== - -Add `besimple/soap-bundle `_ (with vendors) in your composer.json: - -.. code-block:: json - - { - "require": { - "besimple/soap-bundle": "dev-master", - "besimple/soap-common": "dev-master", - "ass/xmlsecurity": "dev-master" - } - } - -To install the server please add `besimple/soap-server `_ in your composer.json: - -.. code-block:: json - - { - "require": { - "besimple/soap-server": "dev-master" - } - } - -To install the client please add `besimple/soap-client `_ in your composer.json: - -.. code-block:: json - - { - "require": { - "besimple/soap-client": "dev-master" - } - } - -Run this command to download the new vendors: - -.. code-block:: bash - - $ php composer.phar self-update - $ php composer.phar update - -Enable the `BeSimpleSoapBundle `_ in your Kernel class - -.. code-block:: php - - // app/AppKernel.php - public function registerBundles() - { - return array( - // ... - new BeSimple\SoapBundle\BeSimpleSoapBundle(), - // ... - ); - } diff --git a/src/BeSimple/SoapBundle/Resources/doc/installation_deps.rst b/src/BeSimple/SoapBundle/Resources/doc/installation_deps.rst deleted file mode 100644 index 529d837..0000000 --- a/src/BeSimple/SoapBundle/Resources/doc/installation_deps.rst +++ /dev/null @@ -1,91 +0,0 @@ -Installation with deps file (deprecated) -======================================== - -**The installation with deps file is deprecated. -Please prefer install the** `BeSimpleSoapBundle `_ **with** `Composer `_. - -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=https://github.com/BeSimple/BeSimpleSoapCommon.git - target=besimple-soapcommon - - [BeSimple\SoapClient] - git=https://github.com/BeSimple/BeSimpleSoapClient.git - target=besimple-soapclient - - [BeSimple\SoapServer] - git=https://github.com/BeSimple/BeSimpleSoapServer.git - target=besimple-soapserver - - -Add `BeSimple` libraries in autoload.php - -.. code-block:: php - - // app/autoload.php - $loader->registerNamespaces(array( - 'BeSimple\\SoapCommon' => __DIR__.'/../vendor/besimple-soapcommon/src', - 'BeSimple\\SoapServer' => __DIR__.'/../vendor/besimple-soapserver/src', - 'BeSimple\\SoapClient' => __DIR__.'/../vendor/besimple-soapclient/src', - // 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 - - ; deps file - [Zend\Soap] - git=http://github.com/BeSimple/zend-soap.git - target=/zend-framework/library/Zend/Soap - - [Zend\Mime] - git=http://github.com/BeSimple/zend-mime.git - target=/zend-framework/library/Zend/Mime - -Add `Zend` library in autoload.php - -.. code-block:: php - - // app/autoload.php - $loader->registerNamespaces(array( - 'Zend' => __DIR__.'/../vendor/zend-framework/library', - // your other namespaces - )); - -`Download `_ the bundle or add in `deps` file - -.. code-block:: ini - - ; deps file - [BeSimpleSoapBundle] - git=http://github.com/BeSimple/BeSimpleSoapBundle.git - target=/bundles/BeSimple/SoapBundle - -Add `BeSimple` in autoload.php - -.. code-block:: php - - // app/autoload.php - $loader->registerNamespaces(array( - 'BeSimple' => __DIR__.'/../vendor/bundles', - // your other namespaces - )); - -Add `BeSimpleSoapBundle` in your Kernel class - -.. code-block:: php - - // app/AppKernel.php - public function registerBundles() - { - return array( - // ... - new BeSimple\SoapBundle\BeSimpleSoapBundle(), - // ... - ); - }