WebSVN – Applications.papyrus – Diff – /trunk/api/pear/Auth/Container/SOAP5.php

  * @author     Based upon Auth_Container_SOAP by Bruno Pedro <bpedro@co.sapo.pt>
  * @author     Marcel Oelke <puRe@rednoize.com>
  * @author     Adam Ashley <aashley@php.net>
  * @copyright  2001-2006 The PHP Group
  * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
- * @version    CVS: $Id: SOAP5.php,v 1.1 2006-12-14 15:04:28 jp_milcent Exp $
+ * @version    CVS: $Id: SOAP5.php,v 1.2 2007-11-19 15:11:00 jp_milcent Exp $
  * @since      File available since Release 1.4.0
  */
 /**
  * Storage driver for fetching login data from SOAP using the PHP5 Builtin SOAP
  * functions. This is a modification of the SOAP Storage driver from Bruno Pedro
  * thats using the PEAR SOAP Package.
+ *
  * This class takes one parameter (options), where
  * you specify the following fields:
  *  * location and uri, or wsdl file
  *  * method to call on the SOAP service
  *  * usernamefield, the name of the parameter where the username is supplied
  *  * passwordfield, the name of the parameter where the password is supplied
  *  * matchpassword, whether to look for the password in the response from
+ *
  * $options = array (
  *       'wsdl'           => NULL,
  *       'location'       => 'http://your.soap.service/endpoint',
  *       'uri'            => 'urn:/Your/Namespace',
  *       'method'         => 'checkAuth',
  *       'usernamefield'  => 'username',
  *       'passwordfield'  => 'password',
  *       'matchpasswords' => false,
  *       '_features' => array (
  *           'extra_parameter'    => 'example_value',
  *           'another_parameter'  => 'foobar'
  *       )
  *   );
+ *
  * <?php
+ *
  * $options = array (
  *       'wsdl'           => 'http://your.soap.service/wsdl',
  *       'method'         => 'checkAuth',
  *       'usernamefield'  => 'username',
  *       'passwordfield'  => 'password',
  *       'matchpasswords' => false,
  *       '_features' => array (
  *           'extra_parameter'    => 'example_value',
  *           'another_parameter'  => 'foobar'
  *       )
  *   );
  * @author     Based upon Auth_Container_SOAP by Bruno Pedro <bpedro@co.sapo.pt>
  * @author     Marcel Oelke <puRe@rednoize.com>
  * @author     Adam Ashley <aashley@php.net>
  * @copyright  2001-2006 The PHP Group
  * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
- * @version    Release: 1.4.3  File: $Revision: 1.1 $
+ * @version    Release: 1.5.4  File: $Revision: 1.2 $
  * @since      Class available since Release 1.4.0
  */
 class Auth_Container_SOAP5 extends Auth_Container
+{
      * Required options for the class
      * @var array
      * @access private
      */
     var $_requiredOptions = array(
             'location',
             'uri',
             'method',
             'usernamefield',
             'passwordfield',
             'wsdl',
      * The SOAP response
      * @var array
      * @access public
      */
     var $soapResponse = array();
     // }}}
     // {{{ Auth_Container_SOAP5()
     /**
+        }
         if (!empty($this->_options['_features'])) {
             $this->_features = $this->_options['_features'];
             unset($this->_options['_features']);
+        }
+    }
      * @param  string Username
      * @param  string Password
      * @return mixed Returns the SOAP response or false if something went wrong
      */
     function fetchData($username, $password)
     {
+        $this->log('Auth_Container_SOAP5::fetchData() called.', AUTH_LOG_DEBUG);
         $result = $this->_validateOptions();
         if (PEAR::isError($result))
             return $result;
         // create a SOAP client
         $soapClient = new SoapClient($this->_options["wsdl"], $this->_options);
         $params = array();
         // first, assign the optional features
         foreach ($this->_features as $fieldName => $fieldValue) {
             $params[$fieldName] = $fieldValue;
+        }
         // assign username and password ...
         $params[$this->_options['usernamefield']] = $username;
         $params[$this->_options['passwordfield']] = $password;
         try {
             $this->soapResponse = $soapClient->__soapCall($this->_options['method'], $params);
             if ($this->_options['matchpasswords']) {
                 // check if passwords match
                 if ($password == $this->soapResponse[$this->_options['passwordfield']]) {
                     return true;
                 } else {
                     return false;
                 }
             } else {
                 return true;
+            }
         } catch (SoapFault $e) {
             return PEAR::raiseError("Error retrieving authentication data. Received SOAP Fault: ".$e->faultstring, $e->faultcode);
+        }
+    }
     // }}}
     // {{{ _validateOptions()
     /**
      * Validate that the options passed to the container class are enough for us to proceed
+     *
      * @access private
      * @param  array
      */
-    function _validateOptions($array)
+    function _validateOptions()
     {
-        if (   (   is_null($this->options['wsdl'])
+        if (   (   is_null($this->_options['wsdl'])
-                && is_null($this->options['location'])
+                && is_null($this->_options['location'])
-                && is_null($this->options['uri']))
+                && is_null($this->_options['uri']))
-            || (   is_null($this->options['wsdl'])
+            || (   is_null($this->_options['wsdl'])
-                && (   is_null($this->options['location'])
+                && (   is_null($this->_options['location'])
-                    || is_null($this->options['uri'])))) {
+                    || is_null($this->_options['uri'])))) {
             return PEAR::raiseError('Either a WSDL file or a location/uri pair must be specified.');
+        }
-        if (is_null($this->options['method'])) {
+        if (is_null($this->_options['method'])) {
             return PEAR::raiseError('A method to call on the soap service must be specified.');
+        }
         return true;
+    }
     // }}}
     // {{{ _setDefaults()
      * @access private
      * @return void
      */
     function _setDefaults()
+    {
-        $this->options['wsdl']           = null;
+        $this->_options['wsdl']           = null;
-        $this->options['location']       = null;
+        $this->_options['location']       = null;
-        $this->options['uri']            = null;
+        $this->_options['uri']            = null;
-        $this->options['method']         = null;
+        $this->_options['method']         = null;
-        $this->options['usernamefield']  = 'username';
+        $this->_options['usernamefield']  = 'username';
-        $this->options['passwordfield']  = 'password';
+        $this->_options['passwordfield']  = 'password';
-        $this->options['matchpasswords'] = true;
+        $this->_options['matchpasswords'] = true;
+    }
     // }}}
+}

Subversion Repositories Applications.papyrus

(root)/trunk/api/pear/Auth/Container/SOAP5.php – Rev 1173 → 1713