SOAP5.php

Go to the documentation of this file.

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */
 
require_once "Auth/Container.php";
require_once "PEAR.php";
 
class Auth_Container_SOAP5 extends Auth_Container
{
 
    // {{{ properties
 
    var $_requiredOptions = array(
            'location',
            'uri',
            'method',
            'usernamefield',
            'passwordfield',
            'wsdl',
            );
 
    var $_options = array();
 
    var $_features = array();
 
    var $soapResponse = array();
 
    // }}}
    // {{{ Auth_Container_SOAP5()
 
    function Auth_Container_SOAP5($options)
    {
        $this->_setDefaults();
 
        foreach ($options as $name => $value) {
            $this->_options[$name] = $value;
        }
 
        if (!empty($this->_options['_features'])) {
            $this->_features = $this->_options['_features'];
            unset($this->_options['_features']);
        }
    }
 
    // }}}
    // {{{ fetchData()
 
    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()
 
    function _validateOptions()
    {
        if (   (   is_null($this->_options['wsdl'])
                && is_null($this->_options['location'])
                && is_null($this->_options['uri']))
            || (   is_null($this->_options['wsdl'])
                && (   is_null($this->_options['location'])
                    || 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'])) {
            return PEAR::raiseError('A method to call on the soap service must be specified.');
        }
        return true;
    }
 
    // }}}
    // {{{ _setDefaults()
 
    function _setDefaults()
    {
        $this->_options['wsdl']           = null;
        $this->_options['location']       = null;
        $this->_options['uri']            = null;
        $this->_options['method']         = null;
        $this->_options['usernamefield']  = 'username';
        $this->_options['passwordfield']  = 'password';
        $this->_options['matchpasswords'] = true;
    }
 
    // }}}
 
}
?>