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

Public Member Functions

 getAboutDisplayed ()
 
 getAssocId ()
 
 getAssocType ()
 
 getContext ()
 
 getGroupId ()
 
 getLocalizedTitle ()
 
 getPublishEmail ()
 
 getSequence ()
 
 getTitle ($locale)
 
 Group ()
 
 setAboutDisplayed ($aboutDisplayed)
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setContext ($context)
 
 setGroupId ($groupId)
 
 setPublishEmail ($publishEmail)
 
 setSequence ($sequence)
 
 setTitle ($title, $locale)
 
- 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 groups.

See Also
GroupDAO

Definition at line 25 of file Group.inc.php.

Member Function Documentation

Group::getAboutDisplayed ( )

Get flag indicating whether or not the group is displayed in "About"

Returns
boolean

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

References DataObject\getData().

Group::getAssocId ( )

Get assoc ID for this group.

Returns
int

Definition at line 137 of file Group.inc.php.

References DataObject\getData().

Group::getAssocType ( )

Get assoc type for this group.

Returns
int

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

References DataObject\getData().

Group::getContext ( )

Get context of group

Returns
int

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

References DataObject\getData().

Group::getGroupId ( )

Get ID of group. Deprecated in favour of getId.

Returns
int

Definition at line 119 of file Group.inc.php.

References DataObject\getId(), and Config\getVar().

Group::getLocalizedTitle ( )

Get localized title of group.

Definition at line 36 of file Group.inc.php.

References DataObject\getLocalizedData().

Group::getPublishEmail ( )

Get publish email flag

Returns
int

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

References DataObject\getData().

Group::getSequence ( )

Get sequence of group.

Returns
float

Definition at line 169 of file Group.inc.php.

References DataObject\getData().

Group::getTitle (   $locale)

Get title of group (primary locale)

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Group::Group ( )

Constructor

Definition at line 29 of file Group.inc.php.

Group::setAboutDisplayed (   $aboutDisplayed)

Set flag indicating whether or not the group is displayed in "About"

Parameters
$aboutDisplayedboolean

Definition at line 111 of file Group.inc.php.

References DataObject\setData().

Group::setAssocId (   $assocId)

Set assoc ID for this group.

Parameters
$assocIdint

Definition at line 145 of file Group.inc.php.

References DataObject\setData().

Group::setAssocType (   $assocType)

Set assoc type for this group.

Parameters
$assocTypeint

Definition at line 161 of file Group.inc.php.

References DataObject\setData().

Group::setContext (   $context)

Set context of group

Parameters
$contextint

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

References DataObject\setData().

Group::setGroupId (   $groupId)

Set ID of group. DEPRECATED in favour of setId.

Parameters
$groupIdint

Definition at line 128 of file Group.inc.php.

References Config\getVar(), and DataObject\setId().

Group::setPublishEmail (   $publishEmail)

Set publish email flag

Parameters
$contextint

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

References DataObject\setData().

Group::setSequence (   $sequence)

Set sequence of group.

Parameters
$sequencefloat

Definition at line 177 of file Group.inc.php.

References DataObject\setData().

Group::setTitle (   $title,
  $locale 
)

Set title of group

Parameters
$titlestring
$localestring

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

References DataObject\setData().


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