Auth
[ class tree: Auth ] [ index: Auth ] [ all elements ]

Class: Auth_Container_SOAP5

Source Location: /Auth-1.6.4/Auth/Container/SOAP5.php

Class Overview

Auth_Container
   |
   --Auth_Container_SOAP5

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.


Author(s):

Version:

  • Release: @package_version@ File: $Revision: 238999 $

Copyright:

  • 2001-2006 The PHP Group

Variables

Methods


Inherited Variables

Inherited Methods

Class: Auth_Container

Auth_Container::Auth_Container()
Constructor
Auth_Container::addUser()
Add a new user to the storage container
Auth_Container::changePassword()
Change password for user in the storage container
Auth_Container::fetchData()
Fetch data from storage container
Auth_Container::getCryptType()
Returns the crypt current crypt type of the container
Auth_Container::getUser()
Returns a user assoc array
Auth_Container::listUsers()
List all users that are available from the storage container
Auth_Container::log()
Log a message to the Auth log
Auth_Container::removeUser()
Remove user from the storage container
Auth_Container::supportsChallengeResponse()
Returns true if the container supports Challenge Response
Auth_Container::verifyPassword()
Crypt and verfiy the entered password

Class Details

[line 107]
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 the function call or assume that no errors means user authenticated.

See http://www.php.net/manual/en/ref.soap.php for further details on options for the PHP5 SoapClient which are passed through.

Example usage without WSDL:

<?php

$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' ) );

$auth = new Auth('SOAP5', $options); $auth->start();

?>

Example usage with WSDL:

<?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' ) );

$auth = new Auth('SOAP5', $options); $auth->start();

?>



[ Top ]


Class Variables

$soapResponse = array()

[line 145]

The SOAP response
  • Access: public

Type:   array


[ Top ]



Method Detail

Auth_Container_SOAP5 (Constructor)   [line 156]

Auth_Container_SOAP5 Auth_Container_SOAP5( $options, $options)

Constructor of the container class

Parameters:

$options,   $options   —  associative array with endpoint, namespace, method, usernamefield, passwordfield and optional features

[ Top ]

fetchData   [line 183]

mixed fetchData( string $username, string $password)

Fetch data from SOAP service

Requests the SOAP service for the given username/password combination.

  • Return: Returns the SOAP response or false if something went wrong

Overrides Auth_Container::fetchData() (Fetch data from storage container)

Parameters:

string   $username   —  Username
string   $password   —  Password

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:41:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.