Class: Auth_Container_SOAP

Source Location: /Auth-1.6.1/Container/SOAP.php

Class Overview

Auth_Container
   |
   --Auth_Container_SOAP

Storage driver for fetching login data from SOAP

Author(s):

Adam Ashley <aashley at php.net>
Bruno Pedro <bpedro at co.sapo.pt>

Version:

Release: 1.6.1 File: $Revision: 1.13 $

Copyright:

2001-2006 The PHP Group

Inherited Variables

Class: Auth_Container

Auth_Container::$activeUser
Auth_Container::$_auth_obj

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 90]
Storage driver for fetching login data from SOAP

This class takes one parameter (options), where you specify the following fields: endpoint, namespace, method, encoding, usernamefield and passwordfield.

You can use specify features of your SOAP service by providing its parameters in an associative manner by using the '_features' array through the options parameter.

The 'matchpassword' option should be set to false if your webservice doesn't return (username,password) pairs, but instead returns error when the login is invalid.

Example usage:

<?php

...

$options = array ( 'endpoint' => 'http://your.soap.service/endpoint', 'namespace' => 'urn:/Your/Namespace', 'method' => 'get', 'encoding' => 'UTF-8', 'usernamefield' => 'login', 'passwordfield' => 'password', 'matchpasswords' => false, '_features' => array ( 'example_feature' => 'example_value', 'another_example' => '' ) ); $auth = new Auth('SOAP', $options, 'loginFunction'); $auth->start();

...

Author: Adam Ashley <aashley@php.net>
Author: Bruno Pedro <bpedro@co.sapo.pt>
Version: Release: 1.6.1 File: $Revision: 1.13 $
Copyright: 2001-2006 The PHP Group
Link: http://pear.php.net/package/Auth
Since: Class available since Release 1.2.0
License: PHP License 3.01

[ Top ]

Class Variables

$soapClient = null

[line 135]

The SOAP client

Access: public

Type:

mixed

[ Top ]

$soapResponse = array()

[line 128]

The SOAP response

Access: public

Type:

array

[ Top ]

Method Detail

Auth_Container_SOAP (Constructor) [line 146]

Auth_Container_SOAP Auth_Container_SOAP(
$options,
$options)

Constructor of the container class

Parameters:

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

[ Top ]

fetchData [line 171]

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 ]