diff --git a/Resources/doc/_static/.gitkeep b/Resources/doc/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Resources/doc/conf.py b/Resources/doc/conf.py new file mode 100644 index 0000000..fcbd938 --- /dev/null +++ b/Resources/doc/conf.py @@ -0,0 +1,226 @@ +# -*- coding: utf-8 -*- +# +# BeSimpleSoapBundle documentation build configuration file, created by +# sphinx-quickstart on Mon Aug 1 22:24:10 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +from sphinx.highlighting import lexers +from pygments.lexers.web import PhpLexer +lexers['php'] = PhpLexer(startinline=True) + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) +sys.path.append(os.path.abspath('_exts')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'BeSimpleSoapBundle' +copyright = u'2011, Christian Kerl, Francis Besset' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '1.0.0' +# The full version, including alpha/beta/rc tags. +release = '1.0.0-DEV' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +#pygments_style = 'sphinx' +pygments_style = 'perldoc' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'BeSimpleSoapBundledoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'BeSimpleSoapBundle.tex', u'BeSimpleSoapBundle Documentation', + u'Christian Kerl, Francis Besset', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'besimplesoapbundle', u'BeSimpleSoapBundle Documentation', + [u'Christian Kerl, Francis Besset'], 1) +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst new file mode 100644 index 0000000..d272f45 --- /dev/null +++ b/Resources/doc/index.rst @@ -0,0 +1,27 @@ +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 +--------------- + +.. toctree:: + :maxdepth: 1 + :numbered: + + reference/installation + reference/configuration + +Tutorial +-------- + +.. toctree:: + :maxdepth: 1 + :numbered: + + tutorial/complex_type + tutorial/array + +.. _`ckWebServicePlugin`: http://www.symfony-project.org/plugins/ckWebServicePlugin \ No newline at end of file diff --git a/Resources/doc/reference/configuration.rst b/Resources/doc/reference/configuration.rst new file mode 100644 index 0000000..4c2d469 --- /dev/null +++ b/Resources/doc/reference/configuration.rst @@ -0,0 +1,51 @@ +Configuration +============= + +Routing +------- + +Include the `BeSimpleSoapBundle`'s routing configuration in your routing file (you can choose the prefix arbitrarily): + +.. code-block:: yaml + + # app/config/routing.yml + _besimple_soap: + resource: "@BeSimpleSoapBundle/Resources/config/routing/webservicecontroller.xml" + prefix: /ws + +Config +------ + +Configure your first web service in your config file: + +.. code-block:: yaml + + # app/config/config.yml + be_simple_soap: + services: + DemoApi: + namespace: http://mysymfonyapp.com/ws/DemoApi/1.0/ + binding: rpc-literal + resource: "@AcmeDemoBundle/Controller/DemoController.php" + resource_type: annotation + +Annotations for Controllers +--------------------------- + +.. code-block:: php + + use BeSimple\SoapBundle\ServiceDefinition\Annotation as Soap; + use BeSimple\SoapBundle\Soap\SoapResponse; + + class DemoController extends Controller + { + /** + * @Soap\Method("Hello") + * @Soap\Param("name", phpType = "string") + * @Soap\Result(phpType = "string") + */ + public function helloAction($name) + { + return new SoapResponse(sprintf('Hello %s!', $name)); + } + } \ No newline at end of file diff --git a/Resources/doc/reference/installation.rst b/Resources/doc/reference/installation.rst new file mode 100644 index 0000000..69b5d70 --- /dev/null +++ b/Resources/doc/reference/installation.rst @@ -0,0 +1,65 @@ +Installation +============ + +Requirements +------------ + +Install and enable PHP's SOAP extension +Download `Zend\Soap`_ or add in `deps` file + +.. code-block:: ini + + ; deps file + [Zend\Soap] + git=http://github.com/BeSimple/zend-soap.git + target=/zend-framework/library/Zend/Soap + +Add Zend\Soap library in autoload.php + +.. code-block:: php + + // app/autoload.php + $loader->registerNamespaces(array( + 'ZendSoap' => __DIR__.'/../vendor/zend-framework/library', + // your other namespaces + )); + +Installation +------------ + +`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 new BeSimple\SoapBundle\BeSimpleSoapBundle(), + // ... + ); + } + + +.. _`Zend\Soap`: http://github.com/BeSimple/zend-soap +.. _`Download`: http://github.com/BeSimple/BeSimpleSoapBundle \ No newline at end of file diff --git a/Resources/doc/tutorial/array.rst b/Resources/doc/tutorial/array.rst new file mode 100644 index 0000000..32b28ff --- /dev/null +++ b/Resources/doc/tutorial/array.rst @@ -0,0 +1,26 @@ +Array +===== + +Controller +---------- + +.. code-block:: php + + namespace My\App\Controller; + + use BeSimple\SoapBundle\ServiceDefinition\Annotation as Soap; + use BeSimple\SoapBundle\Soap\SoapResponse; + use Symfony\Component\DependencyInjection\ContainerAware; + + class DemoController extends ContainerAware + { + /** + * @Soap\Method("isString") + * @Soap\Param("strings", phpType = "string[]") + * @Soap\Result(phpType = "boolean") + */ + public function helloAction(array $strings) + { + return new SoapResponse(true); + } + } \ No newline at end of file diff --git a/Resources/doc/tutorial/complex_type.rst b/Resources/doc/tutorial/complex_type.rst new file mode 100644 index 0000000..de60eb8 --- /dev/null +++ b/Resources/doc/tutorial/complex_type.rst @@ -0,0 +1,120 @@ +Complex Type +============ + +This tutorial explains how to do to return a complex type. + +If your SOAP function takes a complex type as input, this tutorial is +valid. You'll just have to adapt the input parameters of your method. + + +Controller +---------- + +.. code-block:: php + + namespace My\App\Controller; + + use BeSimple\SoapBundle\ServiceDefinition\Annotation as Soap; + use BeSimple\SoapBundle\Soap\SoapResponse; + use Symfony\Component\DependencyInjection\ContainerAware; + + class DemoController extends ContainerAware + { + /** + * @Soap\Method("getUser") + * @Soap\Param("name", phpType = "string") + * + * Specify \My\App\Entity\User phpType + * Warning: Do not forget the first backslash + * @Soap\Result(phpType = "\My\App\Entity\User") + */ + public function getUserAction($name) + { + $user = $this->container->getDoctrine()->getRepository('MyApp:User')->findOneByName($name); + + if (!$user) { + throw new \SoapFault('USER_NOT_FOUND', sprintf('The user with the name "%s" can not be found', $name)); + } + + return new SoapResponse($user); + } + } + +User class +---------- + +You can expose public property and public method (getter and setter). + +.. code-block:: php + + namespace My\App\Entity; + + use BeSimple\SoapBundle\ServiceDefinition\Annotation as Soap; + + class User + { + /** + * @Soap\PropertyComplexType("string") + */ + public $firstname; + + /** + * @Soap\PropertyComplexType("string") + */ + public $lastname; + + private $id; + private $username; + private $email; + + /** + * @Soap\MethodComplexType("int", name="user_id", nillable=true) + */ + public function getId() + { + return $this->id; + } + + /** + * @Soap\MethodComplexType("string", setter="setUsername") + */ + public function getUsername() + { + return $this->username; + } + + /** + * @Soap\MethodComplexType("string", setter="setEmail") + */ + public function getEmail() + { + return $this->email; + } + + public function setUsername($username) + { + $this->username = $username; + } + + public function setEmail($email) + { + $this->email = $email; + } + } + +PropertyComplexType +------------------- + +`PropertyComplexType` accepts the following options: + + * **name**: To override the original name of the property + * **nillable**: To specify that the value can be null + +MethodComplexType +------------------- + +`MethodComplexType` accepts the following options: + + * **name**: To override the original name of the property + * **nillable**: To specify that the value can be null + * **setter**: The set method name value. *Mandatory if the complex type is passed as a parameter to a function.* \ No newline at end of file