Open Journal Systems  3.3.0
Role Class Reference
Inheritance diagram for Role:
DataObject

Public Member Functions

 __construct ($roleId=null)
 
 getRoleId ()
 
 setRoleId ($roleId)
 
- 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 generic PKP user roles within the system and the associated permissions.

Describes user roles within the system and the associated permissions.

See also
RoleDAO

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

Constructor & Destructor Documentation

◆ __construct()

Role::__construct (   $roleId = null)

Constructor.

Parameters
$roleIdfor this role. Default to null for backwards compatibility

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

References DataObject\setId().

Member Function Documentation

◆ getRoleId()

Role::getRoleId ( )

Get role ID of this role.

Returns
int

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

References DataObject\getId().

◆ setRoleId()

Role::setRoleId (   $roleId)

Set role ID of this role.

Parameters
$roleIdint

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

References DataObject\setId().


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