Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
AuthSource Class Reference
Inheritance diagram for AuthSource:
DataObject

Public Member Functions

 AuthSource ()
 
 getAuthId ()
 
 getDefault ()
 
 getPlugin ()
 
getPluginClass ()
 
 getSettings ()
 
 getTitle ()
 
 setAuthId ($authId)
 
 setDefault ($authDefault)
 
 setPlugin ($plugin)
 
 setPluginClass ($authPlugin)
 
 setSettings ($settings)
 
 setTitle ($title)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes 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

AuthSource::AuthSource ( )

Constructor.

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

AuthSource::getAuthId ( )

Get ID of this source.

Returns
int

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

References DataObject\getData().

AuthSource::getDefault ( )

Get flag indicating this is the default authentication source.

Returns
boolean

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

References DataObject\getData().

AuthSource::getPlugin ( )

Get the authentication plugin associated with this source.

Returns
string

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

References DataObject\getData().

& AuthSource::getPluginClass ( )

Get the authentication plugin object associated with this source.

Returns
AuthPlugin

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

References DataObject\getData().

AuthSource::getSettings ( )

Get array of plugin-specific settings for this source.

Returns
array

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

References DataObject\getData().

AuthSource::getTitle ( )

Get user-specified title of this source.

Returns
string

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

References DataObject\getData().

AuthSource::setAuthId (   $authId)

Set ID of this source.

Parameters
$authIdint

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

References DataObject\setData().

AuthSource::setDefault (   $authDefault)

Set flag indicating this is the default authentication source.

Parameters
$authDefaultboolean

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

References DataObject\setData().

AuthSource::setPlugin (   $plugin)

Set the authentication plugin associated with this source.

Parameters
$pluginstring

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

References DataObject\setData().

AuthSource::setPluginClass (   $authPlugin)

Set authentication plugin object associated with this source.

Parameters
$authPluginAuthPlugin

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

References DataObject\setData().

AuthSource::setSettings (   $settings)

Set array of plugin-specific settings for this source.

Parameters
$settingsarray

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

References DataObject\setData().

AuthSource::setTitle (   $title)

Set user-specified title of this source.

Parameters
$titlestring

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

References DataObject\setData().


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