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

Public Member Functions

 getAbbrev ($locale)
 
 getContextId ()
 
 getDefault ()
 
 getLocalizedAbbrev ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getPath ()
 
 getPermitSelfRegistration ()
 
 getRoleId ()
 
 getShowTitle ()
 
 setAbbrev ($abbrev, $locale)
 
 setContextId ($contextId)
 
 setDefault ($isDefault)
 
 setName ($name, $locale)
 
 setPath ($path)
 
 setPermitSelfRegistration ($permitSelfRegistration)
 
 setRoleId ($roleId)
 
 setShowTitle ($showTitle)
 
 UserGroup ()
 
- 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 groups.

See Also
UserGroupDAO

Definition at line 20 of file UserGroup.inc.php.

Member Function Documentation

UserGroup::getAbbrev (   $locale)

Get user group abbrev

Parameters
$localestring
Returns
string

Definition at line 167 of file UserGroup.inc.php.

References DataObject\getData().

UserGroup::getContextId ( )

Get the context ID

Returns
int

Definition at line 64 of file UserGroup.inc.php.

References DataObject\getData().

UserGroup::getDefault ( )

Get the default flag

Returns
boolean

Definition at line 80 of file UserGroup.inc.php.

References DataObject\getData().

UserGroup::getLocalizedAbbrev ( )

Get the localized abbreviation

Returns
string

Definition at line 158 of file UserGroup.inc.php.

References DataObject\getLocalizedData().

UserGroup::getLocalizedName ( )

Get the localized role name

Returns
string

Definition at line 132 of file UserGroup.inc.php.

References DataObject\getLocalizedData().

UserGroup::getName (   $locale)

Get user group name

Parameters
$localestring
Returns
string

Definition at line 141 of file UserGroup.inc.php.

References DataObject\getData().

UserGroup::getPath ( )

Get the role path

Returns
string Role path

Definition at line 48 of file UserGroup.inc.php.

References DataObject\getData().

UserGroup::getPermitSelfRegistration ( )

Get the "permit self-registration" flag (whether or not users may self-register for this role, i.e. in the case of external reviewers, or whether it should be prohibited, in the case of internal reviewers).

Returns
boolean True IFF user self-registration is permitted

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

References DataObject\getData().

UserGroup::getRoleId ( )

Get the role ID

Returns
int ROLE_ID_...

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

References DataObject\getData().

UserGroup::getShowTitle ( )

Get the "show title" flag (whether or not the title of the role should be included in the list of submission contributor names)

Returns
boolean

Definition at line 97 of file UserGroup.inc.php.

References DataObject\getData().

UserGroup::setAbbrev (   $abbrev,
  $locale 
)

Set user group abbrev

Parameters
$abbrevstring
$localestring

Definition at line 176 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setContextId (   $contextId)

Set the context ID

Parameters
$contextIdint

Definition at line 72 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setDefault (   $isDefault)

Set the default flag

Parameters
$isDefaultboolean

Definition at line 88 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setName (   $name,
  $locale 
)

Set user group name

Parameters
$namestring
$localestring

Definition at line 150 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setPath (   $path)

Set the role path $param $path string

Definition at line 56 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setPermitSelfRegistration (   $permitSelfRegistration)

Set the "permit self-registration" flag

Parameters
$isDefaultboolean

Definition at line 124 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setRoleId (   $roleId)

Set the role ID

Parameters
$roleIdint ROLE_ID_...

Definition at line 40 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::setShowTitle (   $showTitle)

Set the "show title" flag

Parameters
$isDefaultboolean

Definition at line 105 of file UserGroup.inc.php.

References DataObject\setData().

UserGroup::UserGroup ( )

Constructor.

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


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