Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
AccessKey Class Reference
Inheritance diagram for AccessKey:
DataObject

Public Member Functions

 AccessKey ()
 
 getAccessKeyId ()
 
 getAssocId ()
 
 getContext ()
 
 getExpiryDate ()
 
 getKeyHash ()
 
 getUserId ()
 
 setAccessKeyId ($accessKeyId)
 
 setAssocId ($assocId)
 
 setContext ($context)
 
 setExpiryDate ($expiryDate)
 
 setKeyHash ($keyHash)
 
 setUserId ($userId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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()
 

Detailed Description

AccessKey class.

See Also
AccessKeyDAO

Definition at line 21 of file AccessKey.inc.php.

Member Function Documentation

AccessKey::AccessKey ( )

Constructor

Definition at line 25 of file AccessKey.inc.php.

AccessKey::getAccessKeyId ( )

Get the ID of the key.

Returns
int

Definition at line 37 of file AccessKey.inc.php.

References DataObject\getId(), and Config\getVar().

AccessKey::getAssocId ( )

Get associated ID.

Returns
int

Definition at line 104 of file AccessKey.inc.php.

References DataObject\getData().

AccessKey::getContext ( )

Get context.

Returns
string

Definition at line 55 of file AccessKey.inc.php.

References DataObject\getData().

AccessKey::getExpiryDate ( )

Get expiry date.

Returns
string

Definition at line 121 of file AccessKey.inc.php.

References DataObject\getData().

AccessKey::getKeyHash ( )

Get key hash.

Returns
string

Definition at line 71 of file AccessKey.inc.php.

References DataObject\getData().

AccessKey::getUserId ( )

Get user ID.

Returns
int

Definition at line 87 of file AccessKey.inc.php.

References DataObject\getData().

AccessKey::setAccessKeyId (   $accessKeyId)

Set the ID of the access key.

Parameters
$accessKeyIdint

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

References Config\getVar(), and DataObject\setId().

AccessKey::setAssocId (   $assocId)

Set associated ID.

Parameters
$assocIdint

Definition at line 112 of file AccessKey.inc.php.

References DataObject\setData().

AccessKey::setContext (   $context)

Set context.

Parameters
$contextstring

Definition at line 63 of file AccessKey.inc.php.

References DataObject\setData().

AccessKey::setExpiryDate (   $expiryDate)

Set expiry date.

Parameters
$expiryDatestring

Definition at line 129 of file AccessKey.inc.php.

References DataObject\setData().

AccessKey::setKeyHash (   $keyHash)

Set key hash.

Parameters
$keyHashstring

Definition at line 79 of file AccessKey.inc.php.

References DataObject\setData().

AccessKey::setUserId (   $userId)

Set user ID.

Parameters
$userIdint

Definition at line 95 of file AccessKey.inc.php.

References DataObject\setData().


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