Class AuthenticationType

Concrete\Core\Foundation\Object
Extended by Concrete\Core\Authentication\AuthenticationType

Methods summary

public static
public static Concrete\Core\Authentication\AuthenticationType[]
# getList( boolean $sorted = false, boolean $activeOnly = false )

Return a raw list of authentication types

public static boolean|Concrete\Core\Authentication\AuthenticationType
# load( array $arr )

Load an AuthenticationType from an array.

protected
# loadController( )

Load the AuthenticationTypeController into the AuthenticationType

public
# getPackageHandle( )

AuthenticationType::getPackageHandle Return the package handle.

public static Concrete\Core\Authentication\AuthenticationType[]
# getListByPackage( Package $pkg )

Return an array of AuthenticationTypes that are associated with a specific package.

public static Concrete\Core\Authentication\AuthenticationType
# add( string $atHandle, string $atName, integer $order = 0, boolean|Package $pkg = false )
public static Concrete\Core\Authentication\AuthenticationType
# getByHandle( string $atHandle )

Return loaded AuthenticationType with the given handle.

public static Concrete\Core\Authentication\AuthenticationType
# getByID( integer $authTypeID )

Return loaded AuthenticationType with the given ID.

public
public
public
public
public
public
# setAuthenticationTypeName( string $authTypeName )

Update the name

public
# setAuthenticationTypeDisplayOrder( integer $order )

AuthenticationType::setAuthenticationTypeDisplayOrder Update the order for display.

public
public
# toggle( )

AuthenticationType::toggle Toggle the active state of an AuthenticationType

public
public
public
# disable( )

AuthenticationType::disable Disable an authentication type.

public
# enable( )

AuthenticationType::enable Enable an authentication type.

public
# delete( )

AuthenticationType::delete Remove an AuthenticationType, this should be used sparingly.

public boolean|string
# getAuthenticationTypeFilePath( string $_file )

Return the path to a file

protected string
# mapAuthenticationTypeFilePath( string $_file )

Return the first existing file path in this order: - /models/authentication/types/HANDLE - /packages/PKGHANDLE/authentication/types/HANDLE - /concrete/models/authentication/types/HANDLE - /concrete/core/models/authentication/types/HANDLE

public
public
# renderTypeForm( )

Render the settings form for this type. Settings forms are expected to handle their own submissions and redirect to the appropriate page. Otherwise, if the method exists, all $_REQUEST variables with the arrangement: HANDLE[] in an array to the AuthenticationTypeController::saveTypeForm

public
# renderForm( string $element = 'form', array $params = array() )

Render the login form for this authentication type.

public
# renderHook( )

Render the hook form for saving the profile settings. All settings are expected to be saved by each individual authentication type

public
# hasHook( )

Properties summary

public Concrete\Authentication\Concrete\Controller $controller
#
protected $authTypeID
#
protected $authTypeName
#
protected $authTypeHandle
#
protected $authTypeDisplayOrder
#
protected $authTypeIsEnabled
#
protected $pkgID
#

Properties inherited from Concrete\Core\Foundation\Object

$error