AuthSource Class Reference

Inheritance diagram for AuthSource:

Public Member Functions
	getAuthId ()
	getDefault ()
	getPlugin ()
&	getPluginClass ()
	getSettings ()
	getTitle ()
	setAuthId ($authId)
	setDefault ($authDefault)
	setPlugin ($plugin)
	setPluginClass ($authPlugin)
	setSettings ($settings)
	setTitle ($title)
Public Member Functions inherited from DataObject
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	getMetadataFieldNames ($translated=true)
	getSetMetadataFieldNames ($translated=true)
	getSupportedExtractionAdapters ()
	getSupportedInjectionAdapters ()
	getSupportedMetadataSchemas ()
	hasData ($key, $locale=null)
	injectMetadata ($metadataDescription)
	removeSupportedMetadataAdapter ($metadataSchemaName)
	setAllData (&$data)
	setData ($key, $value, $locale=null)
	setHasLoadableAdapters ($hasLoadableAdapters)
	setId ($id)
	unsetData ($key, $locale=null)
	upcastTo ($targetObject)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Detailed Description

Describes an authentication source.

See also

AuthSourceDAO

Definition at line 20 of file AuthSource.inc.php.

Member Function Documentation

getAuthId()

AuthSource::getAuthId

(

)

Get ID of this source.

Returns

int

Definition at line 30 of file AuthSource.inc.php.

References DataObject\getData().

getDefault()

AuthSource::getDefault

(

)

Get flag indicating this is the default authentication source.

Returns

boolean

Definition at line 78 of file AuthSource.inc.php.

References DataObject\getData().

getPlugin()

AuthSource::getPlugin

(

)

Get the authentication plugin associated with this source.

Returns

string

Definition at line 62 of file AuthSource.inc.php.

References DataObject\getData().

getPluginClass()

& AuthSource::getPluginClass

(

)

Get the authentication plugin object associated with this source.

Returns

AuthPlugin

Definition at line 110 of file AuthSource.inc.php.

References DataObject\getData().

getSettings()

AuthSource::getSettings

(

)

Get array of plugin-specific settings for this source.

Returns

array

Definition at line 94 of file AuthSource.inc.php.

References DataObject\getData().

getTitle()

AuthSource::getTitle

(

)

Get user-specified title of this source.

Returns

string

Definition at line 46 of file AuthSource.inc.php.

References DataObject\getData().

setAuthId()

AuthSource::setAuthId

(

$authId

)

Set ID of this source.

Parameters

$authId

int

Definition at line 38 of file AuthSource.inc.php.

References DataObject\setData().

setDefault()

AuthSource::setDefault

(

$authDefault

)

Set flag indicating this is the default authentication source.

Parameters

$authDefault

boolean

Definition at line 86 of file AuthSource.inc.php.

References DataObject\setData().

setPlugin()

AuthSource::setPlugin

(

$plugin

)

Set the authentication plugin associated with this source.

Parameters

$plugin

string

Definition at line 70 of file AuthSource.inc.php.

References DataObject\setData().

setPluginClass()

AuthSource::setPluginClass

(

$authPlugin

)

Set authentication plugin object associated with this source.

Parameters

$authPlugin

AuthPlugin

Definition at line 119 of file AuthSource.inc.php.

References DataObject\setData().

setSettings()

AuthSource::setSettings

(

$settings

)

Set array of plugin-specific settings for this source.

Parameters

$settings

array

Definition at line 102 of file AuthSource.inc.php.

References DataObject\setData().

setTitle()

AuthSource::setTitle

(

$title

)

Set user-specified title of this source.

Parameters

$title

string

Definition at line 54 of file AuthSource.inc.php.

References DataObject\setData().

---

The documentation for this class was generated from the following file:

• AuthSource.inc.php