Changeset 9601

Timestamp:

06/16/08 15:55:12 (3 months ago)

Author:

chrisk

Message:

sf1.1 compatible: added support for soap headers; updated documentation;

Files:

• plugins/ckWebServicePlugin/trunk/README (modified) (5 diffs)
• plugins/ckWebServicePlugin/trunk/lib/controller/ckWebServiceController.class.php (modified) (4 diffs)
• plugins/ckWebServicePlugin/trunk/package.xml (modified) (1 diff)

plugins/ckWebServicePlugin/trunk/README

@@ -1 +1 @@
-= ckWebService plugin =
-
-
+ 
-
-The `ckWebServicePlugin` is a symfony plugin that let you expose your modules and actions as a webservice.
@@ -49 +49 @@
-          encoding: utf-8
-          soap_version: %SOAP_1_2%
+        # register your SoapHeaders and their corresponding data container class [optional]
+        soap_headers:
+          FooHeader:                     # name of the soap header
+            class: MyFooHeaderDataClass  # name of the data class
+          BarHeader:
+            class: MyFooHeaderDataClass
-  }}}
-
-=== module.yml ===
-
-
+ 
-  
-  The plugin allows per action configuration of parameters passed by the soap call so you can use them like request parameters.
@@ -120 +126 @@
-  }}}
-    
-enabled
+your
-
-=== Example ===
@@ -174 +180 @@
-  
-  '''Attention:''' This class has no ''getSoapResult'' method, because the result of the action is stored in the ''result'' member, see 'Internals'->'Getting the action result' for more details.
+
+== SoapHeader ==
+
+  The plugin also supports the use of SoapHeaders. You can use them to send additional data, like authentication data, with a method call.
+  
+  The data a soap header carries is always stored in a complex type, that means you have to specify a class in which the SoapServer can put the incoming data. For compatibility reasons to Microsofts .NET Framework webservice implementation the SoapHeader and the data class need to have the same name.
+  But fortunatly PHP's ''SoapServer'' implementation allows a mapping of types, defined in the *.wsdl file, to PHP classes. To define these mappings you have to use the ''soap_headers'' setting in ''app.yml''. The keys in this array are always the names of the SoapHeaders. The values are arrays containing a key ''class'' and as value the name of the data class.
+  This enables you to give SoapHeaders, transporting the same kind of data, different names.
+  
+  The data classes have to be in your application's ''lib/'' folder or a module's ''lib/'' folder.
+  
+  To handle incoming headers you have to listen to the ''webservice.handle_header'' event, it is a ''notifyUntil'' event.
+  The event has two parameters. The first is ''header'' containing the name of the SoapHeader. The second is ''data'' containing an instance of the data class.
+  If you want to modify the headers value, use ''$event->setReturnValue($modifiedData)'' where ''$modifiedData'' is an instance of the data class.
+  
+  The following example shows how to process a SoapHeader:
+  
+  {{{
+  #php
+  <?php
+  
+  /**
+   * WrappedString stores a simple string send with a SoapHeader.
+   */
+  class WrappedString
+  {
+    public $data = "";
+  }
+    
+  /**
+   * SoapHeaderListener listens to the webservice.handle_header event for the MyFooHeader.
+   */
+  class SoapHeaderListener
+  {
+    const HEADER_NAME = 'MyFooHeader';
+    
+    /**
+     * Constructor connects the SoapHeaderListener with the webservice.handle_header event.
+     *
+     * @param sfEventDispatcher $dispatcher The sfEventDispatcher instance.
+     */
+    public function __construct(sfEventDispatcher $dispatcher)
+    {
+      $dispatcher->connect('webservice.handle_header', array($this, 'listenToWebserviceHandleHeaderEvent'));
+    }
+  
+    /**
+     * Handles a webservice.handle_header event, if the header is of type MyFooHeader.
+     *
+     * @param sfEvent $event A sfEvent instance.
+     */
+    public function listenToWebserviceHandleHeaderEvent(sfEvent $event)
+    {
+      if($event['header'] == self::HEADER_NAME)
+      {
+        $return = new WrappedString();        
+        $return->data = sprintf('%s --- has been processed.', $event['data']->data);
+        
+        $event->setReturnValue($return);
+      
+        return true;
+      }
+      else
+      {
+        return false;
+      }
+    }
+  }
+  
+  ?>
+  }}}
+  
+  '''Attention:''' SoapHeaders are not yet supported by the WSDL Generator task, so you have to define them yourself in the *.wsdl file.
-
-== Internals ==
@@ -242 +321 @@
-== TODO ==
-
-
+ to generator
-  * decide how to handle redirects
-  * write tests

plugins/ckWebServicePlugin/trunk/lib/controller/ckWebServiceController.class.php

@@ -23 +23 @@
-  protected $soap_server = null;
-
+  protected $soap_headers = array();
+  
-  /**
-   * Initializes this controller.
@@ -31 +33 @@
-  {
-    parent::initialize($context);
+    
-    $this->dispatcher->connect('controller.change_action', array($this, 'listenToControllerChangeActionEvent'));
-  }
@@ -83 +86 @@
-    $persist = sfConfig::get('app_ck_web_service_plugin_persist', SOAP_PERSISTENCE_SESSION);
-
+    $this->soap_headers = sfConfig::get('app_ck_web_service_plugin_soap_headers', array());
+    
+    if(!isset($options['classmap']) || !is_array($options['classmap']))
+    {
+      $options['classmap'] = array();
+    }
+    
+    foreach($headers as $header_name => $header_options)
+    {
+      if(isset($header_options['class']))
+      {
+        $options['classmap'][$header_name] = $header_options['class'];
+      }
+    }
+    
-    if (sfConfig::get('sf_logging_enabled'))
-    {
@@ -114 +132 @@
-  public function __call($method, $arguments)
-  {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-

plugins/ckWebServicePlugin/trunk/package.xml

@@ -11 +11 @@
-  <active>yes</active>
- </lead>
-5-04
+6-16
- <version>
-1.3
-1.3
+2.0
+2.0
- </version>
- <stability>