1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Authentication
  7. \
  8. AuthenticationType

AuthenticationType

class AuthenticationType extends ConcreteObject (View source)

Properties

$error from  ConcreteObject
Controller $controller
protected $authTypeID
protected $authTypeName
protected $authTypeHandle
protected $authTypeDisplayOrder
protected $authTypeIsEnabled
protected $pkgID

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
static 
getListSorted()

No description

static AuthenticationType[]
getList(bool $sorted = false, bool $activeOnly = false)

Return a raw list of authentication types.

static bool|AuthenticationType
load(array $arr)

Load an AuthenticationType from an array.

loadController()

Load the AuthenticationTypeController into the AuthenticationType.

getPackageHandle()

AuthenticationType::getPackageHandle Return the package handle.

static AuthenticationType[]
getListByPackage(Package $pkg)

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

static AuthenticationType
add(string $atHandle, string $atName, int $order = 0, bool|Package $pkg = false)

No description

static AuthenticationType
getByHandle(string $atHandle)

Return loaded AuthenticationType with the given handle.

static AuthenticationType
getByID(int $authTypeID)

Return loaded AuthenticationType with the given ID.

getAuthenticationTypeName()

No description

string
getAuthenticationTypeDisplayName(string $format = 'html')

Returns the display name for this instance (localized and escaped accordingly to $format)

getAuthenticationTypeDisplayOrder()

No description

getAuthenticationTypePackageID()

No description

getController()

No description

getAuthenticationTypeIconHTML()

No description

setAuthenticationTypeName(string $authTypeName)

Update the name.

setAuthenticationTypeDisplayOrder(int $order)

AuthenticationType::setAuthenticationTypeDisplayOrder Update the order for display.

getAuthenticationTypeID()

No description

toggle()

AuthenticationType::toggle Toggle the active state of an AuthenticationType.

isEnabled()

No description

getAuthenticationTypeStatus()

No description

disable()

AuthenticationType::disable Disable an authentication type.

enable()

AuthenticationType::enable Enable an authentication type.

delete()

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

bool|string
getAuthenticationTypeFilePath(string $_file)

Return the path to a file.

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.

getAuthenticationTypeHandle()

No description

renderTypeForm()

Render the settings form for this type.

renderForm(string $element = 'form', array $params = [])

Render the login form for this authentication type.

renderHook()

Render the hook form for saving the profile settings.

hasHook()

No description

renderHooked()

Render the a form to be displayed when the authentication type is already hooked.

bool
hasHooked()

Does this authentication type support rendering a form when it has already been hooked?

bool|null
isHooked(User|UserInfo|User|int $user)

Is this authentication type already hooked for a specific user?

Details

in ConcreteObject at line 11
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 16
isError()

No description

in ConcreteObject at line 26
getError()

No description

in ConcreteObject at line 31
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 38
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 43
static uncamelcase($string)

No description

Parameters

$string

at line 24
static getListSorted()

No description

at line 37
static AuthenticationType[] getList(bool $sorted = false, bool $activeOnly = false)

Return a raw list of authentication types.

Parameters

bool $sorted

true: Sort by display order, false: sort by install order
bool $activeOnly

true: include only active types, false: include active and inactive types

Return Value

AuthenticationType[]

at line 68
static bool|AuthenticationType load(array $arr)

Load an AuthenticationType from an array.

Parameters

array $arr

should be an array of the following key/value pairs to create an object from:

array(
    'authTypeID' => int,
    'authTypeHandle' => string,
    'authTypeName' => string,
    'authTypeDisplayOrder' => int,
    'authTypeIsEnabled' => tinyint,
    'pkgID' => int
)

Return Value

bool|AuthenticationType

at line 93
protected loadController()

Load the AuthenticationTypeController into the AuthenticationType.

at line 107
getPackageHandle()

AuthenticationType::getPackageHandle Return the package handle.

at line 119
static AuthenticationType[] getListByPackage(Package $pkg)

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

Parameters

Package $pkg

Return Value

AuthenticationType[]

at line 142
static AuthenticationType add(string $atHandle, string $atName, int $order = 0, bool|Package $pkg = false)

No description

Parameters

string $atHandle

New AuthenticationType handle
string $atName

New AuthenticationType name, expect this to be presented with "%s Authentication Type"
int $order

Order int, used to order the display of AuthenticationTypes
bool|Package $pkg

package object to which this AuthenticationType is associated

Return Value

AuthenticationType

returns a loaded authentication type

Exceptions

Exception

at line 180
static AuthenticationType getByHandle(string $atHandle)

Return loaded AuthenticationType with the given handle.

Parameters

string $atHandle

authenticationType handle

Return Value

AuthenticationType

Exceptions

Exception

at line 201
static AuthenticationType getByID(int $authTypeID)

Return loaded AuthenticationType with the given ID.

Parameters

int $authTypeID

Return Value

AuthenticationType

Exceptions

Exception

at line 214
getAuthenticationTypeName()

No description

at line 226
string getAuthenticationTypeDisplayName(string $format = 'html')

Returns the display name for this instance (localized and escaped accordingly to $format)

Parameters

string $format

= 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped.

Return Value

string

at line 238
getAuthenticationTypeDisplayOrder()

No description

at line 243
getAuthenticationTypePackageID()

No description

at line 248
getController()

No description

at line 253
getAuthenticationTypeIconHTML()

No description

at line 263
setAuthenticationTypeName(string $authTypeName)

Update the name.

Parameters

string $authTypeName

at line 277
setAuthenticationTypeDisplayOrder(int $order)

AuthenticationType::setAuthenticationTypeDisplayOrder Update the order for display.

Parameters

int $order

value from 0-n to signify order

at line 285
getAuthenticationTypeID()

No description

at line 294
toggle()

AuthenticationType::toggle Toggle the active state of an AuthenticationType.

at line 299
isEnabled()

No description

at line 304
getAuthenticationTypeStatus()

No description

at line 313
disable()

AuthenticationType::disable Disable an authentication type.

at line 328
enable()

AuthenticationType::enable Enable an authentication type.

at line 340
delete()

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

at line 357
bool|string getAuthenticationTypeFilePath(string $_file)

Return the path to a file.

Parameters

string $_file

the relative path to the file

Return Value

bool|string

at line 378
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.

Parameters

string $_file

the filename you want

Return Value

string

this will return false if the file is not found

at line 388
getAuthenticationTypeHandle()

No description

at line 399
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.

at line 421
renderForm(string $element = 'form', array $params = [])

Render the login form for this authentication type.

Parameters

string $element
array $params

at line 449
renderHook()

Render the hook form for saving the profile settings.

All settings are expected to be saved by each individual authentication type.

at line 468
hasHook()

No description

at line 479
renderHooked()

Render the a form to be displayed when the authentication type is already hooked.

All settings are expected to be saved by each individual authentication type.

at line 503
bool hasHooked()

Does this authentication type support rendering a form when it has already been hooked?

Return Value

bool

at line 517
bool|null isHooked(User|UserInfo|User|int $user)

Is this authentication type already hooked for a specific user?

Parameters

User|UserInfo|User|int $user

Return Value

bool|null

returns null if the controller does not implement a way to determine if a user is already hooked or not