Skip to content

Auth::authEngineForIRI

Mo McRoberts edited this page Aug 7, 2011 · 1 revision

Create an instance of an authentication system given an IRI.

Synopsis

uses('auth');

public static function [[Auth]]::authEngineForIRI(string [in,out] $iri, string [out] $scheme, string [in] $defaultScheme = null)

Description

The instance is returned by the call to [[Auth::authEngineForScheme]](). $iri will be modified to strip the scheme (if supplied), which will be stored in $scheme. Thus, upon successful return, a fully-qualified IRI can be constructed from $scheme . ':' . $iri

Parameters

Name Direction Type Description
$iri in,out string The IRI to match against
$scheme out string The authentication IRI scheme that was determined
$defaultScheme in string The default authentication scheme to use if none can be determined from $iri

Clone this wiki locally