Overview

Packages

  • awl
    • AuthPlugin
    • AwlDatabase
    • Browser
    • classEditor
    • DataEntry
    • DataUpdate
    • EMail
    • iCalendar
    • MenuSet
    • PgQuery
    • Session
    • Translation
    • User
    • Utilities
    • Validation
    • vCalendar
    • vComponent
    • XMLDocument
    • XMLElement
  • None

Classes

  • AuthPlugin

Functions

  • auth_external
  • auth_other_awl
  • Overview
  • Package
  • Class

Class AuthPlugin

A class for authenticating and retrieving user information

Package: awl\AuthPlugin
Copyright: Catalyst IT Ltd
License: GNU GPL v2 or later
Author: Andrew McMillan andrew@mcmillan.net.nz
Located at AuthPlugin.php
Methods summary
public
# AuthPlugin( array $authparams )

Create a new AuthPlugin object. This is as lightweight as possible.

Create a new AuthPlugin object. This is as lightweight as possible.

Parameters

$authparams
An array of parameters used for this authentication method.
public object
# Authenticate( string $username, string $password )

Authenticate. Do whatever we need to authenticate a username / password.

Authenticate. Do whatever we need to authenticate a username / password.

Parameters

$username
The username of the person attempting to log in
$password
The password the person is trying to log in with

Returns

object
The "user" object, containing fields matching the 'usr' database table
Properties summary
public $usr
#
public $success
#
API documentation generated by ApiGen