Inheritance diagram for UserGroup:

Public Member Functions
	getAbbrev ($locale)

	getContextId ()

	getDefault ()

	getLocalizedAbbrev ()

	getLocalizedName ()

	getName ($locale)

	getPath ()

	getPermitMetadataEdit ()

	getPermitSelfRegistration ()

	getRecommendOnly ()

	getRoleId ()

	getShowTitle ()

	setAbbrev ($abbrev, $locale)

	setContextId ($contextId)

	setDefault ($isDefault)

	setName ($name, $locale)

	setPath ($path)

	setPermitMetadataEdit ($permitMetadataEdit)

	setPermitSelfRegistration ($permitSelfRegistration)

	setRecommendOnly ($recommendOnly)

	setRoleId ($roleId)

	setShowTitle ($showTitle)

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 user groups.

See also: UserGroupDAO

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

Member Function Documentation

◆ getAbbrev()

UserGroup::getAbbrev ( $locale )

Get localized user group abbreviation, or array of localized abbreviations if $locale is null

Parameters

$locale string|null

Returns: string|array|null localized abbreviation or array of localized abbreviations or null

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

References DataObject\getData().

◆ getContextId()

UserGroup::getContextId ( )

Get the context ID

Returns: int

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

References DataObject\getData().

◆ getDefault()

UserGroup::getDefault ( )

Get the default flag

Returns: boolean

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

References DataObject\getData().

◆ getLocalizedAbbrev()

UserGroup::getLocalizedAbbrev ( )

Get the localized abbreviation

Returns: string

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

References DataObject\getLocalizedData().

◆ getLocalizedName()

UserGroup::getLocalizedName ( )

Get the localized role name

Returns: string

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

References DataObject\getLocalizedData().

◆ getName()

UserGroup::getName ( $locale )

Get localized user group name, or array of localized names if $locale is null

Parameters

$locale string|null

Returns: string|array|null localized name or array of localized names or null

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

References DataObject\getData().

◆ getPath()

UserGroup::getPath ( )

Get the role path

Returns: string Role path

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

References DataObject\getData().

◆ getPermitMetadataEdit()

UserGroup::getPermitMetadataEdit ( )

Getter for permitMetadataEdit attribute.

Returns: boolean

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

References DataObject\getData().

◆ getPermitSelfRegistration()

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 110 of file UserGroup.inc.php.

References DataObject\getData().

◆ getRecommendOnly()

UserGroup::getRecommendOnly ( )

Get the recommendOnly option (whether or not the manager or the sub-editor role can only recommend or also make decisions in the submission review)

Returns: boolean

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

References DataObject\getData().

◆ getRoleId()

UserGroup::getRoleId ( )

Get the role ID

Returns: int ROLE_ID_...

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

References DataObject\getData().

◆ getShowTitle()

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 91 of file UserGroup.inc.php.

References DataObject\getData().

◆ setAbbrev()

UserGroup::setAbbrev	(	$abbrev,
		$locale
	)

Set user group abbreviation

Parameters

$abbrev	string
$locale	string

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

References DataObject\setData().

◆ setContextId()

UserGroup::setContextId ( $contextId )

Set the context ID

Parameters

$contextId int

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

References DataObject\setData().

◆ setDefault()

UserGroup::setDefault ( $isDefault )

Set the default flag

Parameters

$isDefault boolean

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

References DataObject\setData().

◆ setName()

UserGroup::setName	(	$name,
		$locale
	)

Set user group name

Parameters

$name	string
$locale	string

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

References DataObject\setData().

◆ setPath()

UserGroup::setPath ( $path )

Set the role path $param $path string

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

References DataObject\setData().

◆ setPermitMetadataEdit()

UserGroup::setPermitMetadataEdit ( $permitMetadataEdit )

Setter for permitMetadataEdit attribute.

Parameters

$permitMetadataEdit boolean

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

References DataObject\setData().

◆ setPermitSelfRegistration()

UserGroup::setPermitSelfRegistration ( $permitSelfRegistration )

Set the "permit self-registration" flag

Parameters

$permitSelfRegistration boolean

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

References DataObject\setData().

◆ setRecommendOnly()

UserGroup::setRecommendOnly ( $recommendOnly )

Set the recommendOnly option (whether or not the manager or the sub-editor role can only recommend or also make decisions in the submission review)

Parameters

$recommendOnly boolean

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

References DataObject\setData().

◆ setRoleId()

UserGroup::setRoleId ( $roleId )

Set the role ID

Parameters

$roleId int ROLE_ID_...

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

References DataObject\setData().

◆ setShowTitle()

UserGroup::setShowTitle ( $showTitle )

Set the "show title" flag

Parameters

$showTitle boolean

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

References DataObject\setData().

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

UserGroup.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAbbrev()

◆ getContextId()

◆ getDefault()

◆ getLocalizedAbbrev()

◆ getLocalizedName()

◆ getName()

◆ getPath()

◆ getPermitMetadataEdit()

◆ getPermitSelfRegistration()

◆ getRecommendOnly()

◆ getRoleId()

◆ getShowTitle()

◆ setAbbrev()

◆ setContextId()

◆ setDefault()

◆ setName()

◆ setPath()

◆ setPermitMetadataEdit()

◆ setPermitSelfRegistration()

◆ setRecommendOnly()

◆ setRoleId()

◆ setShowTitle()