Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_ExternalAuthDriver class

• Introduction

External auth driver abstract class.

• Class synopsis

AMI_ExternalAuthDriver {
/* Constants */
// Error 1001: wrong user object (invalid object type or null)
const AMI_ExternalAuthDriver::ERR_WRONG_OBJECT =  1001;
// Error 1001: message
const AMI_ExternalAuthDriver::MSG_WRONG_OBJECT =  'Wrong user object';
/* Properties */
// Instance
protected static AMI_ExternalAuthDriver $oInstance = null;
// Settings array
protected array $aSettings = array();
/* Methods */
// Initialize settings.
public init ( [ $aSettings = array() ] ) returns void;
// Object could be created, through getInstance only.
protected __construct ( ) returns AMI_ExternalAuthDriver;
// Object could be cloned.
protected __clone ( ) returns void;
}

• Class Details

See VBulletin_ExternalAuthDriver for usage example.
Tags:
abstract
since 5.12.4

• Class Constants

ERR_WRONG_OBJECT

Error 1001: wrong user object (invalid object type or null)

MSG_WRONG_OBJECT

Error 1001: message

• Class Properies

protected static AMI_ExternalAuthDriver $oInstance

Instance

protected array $aSettings

Settings array

• Class Methods

// Initialize settings.
public init ( [ $aSettings = array() ] ) returns void;
  • array $aSettings
    Settings

Overridden in child classes as: VBulletin_ExternalAuthDriver::init().

// Object could be created, through getInstance only.
protected __construct ( ) returns AMI_ExternalAuthDriver;
// Object could be cloned.
protected __clone ( ) returns void;