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

Public Member Functions

 getJournalId ()
 
 getRoleId ()
 
 getRoleName ()
 
 getRolePath ()
 
 getUserId ()
 
 Role ()
 
 setJournalId ($journalId)
 
 setRoleId ($roleId)
 
 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

Describes user roles within the system and the associated permissions.

See Also
RoleDAO

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

Member Function Documentation

Role::getJournalId ( )

Get journal ID associated with role.

Returns
int

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

References DataObject\getData().

Role::getRoleId ( )

Get role ID of this role.

Returns
int

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

References DataObject\getData().

Role::getRoleName ( )

Get the i18n key name associated with this role.

Returns
String the key

Definition at line 43 of file Role.inc.php.

References DataObject\getData(), and RoleDAO\getRoleName().

Role::getRolePath ( )

Get the URL path associated with this role's operations.

Returns
String the path

Definition at line 51 of file Role.inc.php.

References DataObject\getData(), and RoleDAO\getRolePath().

Role::getUserId ( )

Get user ID associated with role.

Returns
int

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

References DataObject\getData().

Role::Role ( )

Constructor.

Definition at line 35 of file Role.inc.php.

Role::setJournalId (   $journalId)

Set journal ID associated with role.

Parameters
$journalIdint

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

References DataObject\setData().

Role::setRoleId (   $roleId)

Set role ID of this role.

Parameters
$roleIdint

Definition at line 103 of file Role.inc.php.

References DataObject\setData().

Role::setUserId (   $userId)

Set user ID associated with role.

Parameters
$userIdint

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

References DataObject\setData().


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