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

Public Member Functions

 getPath ()
 
 getRoleName ($plural=false)
 
 Role ($roleId=null)
 
- Public Member Functions inherited from PKPRole
 getPath ()
 
 getRoleId ()
 
 getRoleName ($plural=false)
 
 PKPRole ($roleId=null)
 
 setRoleId ($roleId)
 
- 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 user roles within the system and the associated permissions.

See Also
RoleDAO

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

Member Function Documentation

Role::getPath ( )

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

Returns
string

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

References DataObject\getId().

Role::getRoleName (   $plural = false)

Get the i18n key name associated with the specified role.

Parameters
$pluralboolean get the plural form of the name
Returns
string

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

References DataObject\getId().

Role::Role (   $roleId = null)

Constructor.

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

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


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