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

Public Member Functions

 getInstalledLocales ()
 
 getLocalizedAbout ()
 
 getLocalizedContactEmail ()
 
 getLocalizedContactName ()
 
 getLocalizedPageHeaderTitle ()
 
 getLocalizedTitle ()
 
 getMinPasswordLength ()
 
 getPrimaryLocale ()
 
 getRedirect ()
 
getSupportedLocaleNames ()
 
 getSupportedLocales ()
 
 getTitle ($locale=null)
 
 setInstalledLocales ($installedLocales)
 
 setMinPasswordLength ($minPasswordLength)
 
 setPrimaryLocale ($primaryLocale)
 
 setRedirect ($redirect)
 
 setSupportedLocales ($supportedLocales)
 
- 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 system-wide site properties.

See also
SiteDAO

Definition at line 23 of file Site.inc.php.

Member Function Documentation

◆ getInstalledLocales()

Site::getInstalledLocales ( )

Get installed locales.

Returns
array

Definition at line 160 of file Site.inc.php.

References DataObject\getData().

◆ getLocalizedAbout()

Site::getLocalizedAbout ( )

Get localized site about statement.

Definition at line 106 of file Site.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedContactEmail()

Site::getLocalizedContactEmail ( )

Get localized site contact email.

Definition at line 120 of file Site.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedContactName()

Site::getLocalizedContactName ( )

Get localized site contact name.

Definition at line 113 of file Site.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedPageHeaderTitle()

Site::getLocalizedPageHeaderTitle ( )

Get "localized" site page title (if applicable).

Returns
string

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

References DataObject\getData(), DataObject\getLocalizedData(), and AppLocale\getPrimaryLocale().

◆ getLocalizedTitle()

Site::getLocalizedTitle ( )

Get localized site title.

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

References DataObject\getLocalizedData().

◆ getMinPasswordLength()

Site::getMinPasswordLength ( )

Get minimum password length.

Returns
int

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

References DataObject\getData().

◆ getPrimaryLocale()

Site::getPrimaryLocale ( )

Get primary locale.

Returns
string

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

References DataObject\getData().

◆ getRedirect()

Site::getRedirect ( )

Get redirect

Returns
int

Definition at line 91 of file Site.inc.php.

References DataObject\getData().

◆ getSupportedLocaleNames()

& Site::getSupportedLocaleNames ( )

Return associative array of all locales supported by the site. These locales are used to provide a language toggle on the main site pages.

Returns
array

Definition at line 30 of file Site.inc.php.

References Registry\get(), PKPLocale\getAllLocales(), and getSupportedLocales().

◆ getSupportedLocales()

Site::getSupportedLocales ( )

Get array of all supported locales (for static text).

Returns
array

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

References DataObject\getData().

Referenced by getSupportedLocaleNames().

◆ getTitle()

Site::getTitle (   $locale = null)

Get site title.

Parameters
$localestring Locale code to return, if desired.

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

References DataObject\getData().

◆ setInstalledLocales()

Site::setInstalledLocales (   $installedLocales)

Set installed locales.

Parameters
$installedLocalesarray

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

References DataObject\setData().

◆ setMinPasswordLength()

Site::setMinPasswordLength (   $minPasswordLength)

Set minimum password length.

Parameters
$minPasswordLengthint

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

References DataObject\setData().

◆ setPrimaryLocale()

Site::setPrimaryLocale (   $primaryLocale)

Set primary locale.

Parameters
$primaryLocalestring

Definition at line 152 of file Site.inc.php.

References DataObject\setData().

◆ setRedirect()

Site::setRedirect (   $redirect)

Set redirect

Parameters
$redirectint

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

References DataObject\setData().

◆ setSupportedLocales()

Site::setSupportedLocales (   $supportedLocales)

Set array of all supported locales (for static text).

Parameters
$supportedLocalesarray

Definition at line 186 of file Site.inc.php.

References DataObject\setData().


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