Skip to content

Latest commit

 

History

History
67 lines (57 loc) · 1.6 KB

File metadata and controls

67 lines (57 loc) · 1.6 KB
title Auth::authEngineForIRI — Eregansu Framework
package framework
packageTitle Eregansu Framework
layout default
className Auth
type method

Auth::authEngineForIRI

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