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

Public Member Functions

 getInstalledLocales ()
 
 getLocalizedAbout ()
 
 getLocalizedContactEmail ()
 
 getLocalizedContactName ()
 
 getLocalizedIntro ()
 
 getLocalizedPageHeaderTitle ()
 
 getLocalizedPageHeaderTitleType ()
 
 getLocalizedTitle ()
 
 getMinPasswordLength ()
 
 getOriginalStyleFilename ()
 
 getPrimaryLocale ()
 
 getRedirect ()
 
getSetting ($name, $locale=null)
 
 getSiteStyleFilename ()
 
getSupportedLocaleNames ()
 
 getSupportedLocales ()
 
 setInstalledLocales ($installedLocales)
 
 setMinPasswordLength ($minPasswordLength)
 
 setOriginalStyleFilename ($originalStyleFilename)
 
 setPrimaryLocale ($primaryLocale)
 
 setRedirect ($redirect)
 
 setSupportedLocales ($supportedLocales)
 
 Site ()
 
 updateSetting ($name, $value, $type=null, $isLocalized=false)
 
- 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 system-wide site properties.

See Also
SiteDAO

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

Member Function Documentation

Site::getInstalledLocales ( )

Get installed locales.

Returns
array

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

References DataObject\getData().

Site::getLocalizedAbout ( )

Get localized site about statement.

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

Site::getLocalizedContactEmail ( )

Get localized site contact email.

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

Site::getLocalizedContactName ( )

Get localized site contact name.

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

Site::getLocalizedIntro ( )

Get localized site intro.

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

Site::getLocalizedPageHeaderTitle ( )

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

Returns
string

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

References AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and getSetting().

Site::getLocalizedPageHeaderTitleType ( )

Get localized site logo type.

Returns
boolean

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

References DataObject\getLocalizedData().

Site::getLocalizedTitle ( )

Get localized site title.

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

Site::getMinPasswordLength ( )

Get minimum password length.

Returns
int

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

References DataObject\getData().

Site::getOriginalStyleFilename ( )

Get original site stylesheet filename.

Returns
string

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

References DataObject\getData().

Site::getPrimaryLocale ( )

Get primary locale.

Returns
string

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

References DataObject\getData().

Site::getRedirect ( )

Get redirect

Returns
int

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

References DataObject\getData().

& Site::getSetting (   $name,
  $locale = null 
)

Retrieve a site setting value.

Parameters
$namestring
$localestring
Returns
mixed

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

References DAORegistry\getDAO().

Referenced by getLocalizedPageHeaderTitle().

Site::getSiteStyleFilename ( )

Get the local name under which the site-wide locale file is stored.

Returns
string

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

& 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 35 of file Site.inc.php.

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

Site::getSupportedLocales ( )

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

Returns
array

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

References DataObject\getData().

Referenced by getSupportedLocaleNames().

Site::setInstalledLocales (   $installedLocales)

Set installed locales.

Parameters
$installedLocalesarray

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

References DataObject\setData().

Site::setMinPasswordLength (   $minPasswordLength)

Set minimum password length.

Parameters
$minPasswordLengthint

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

References DataObject\setData().

Site::setOriginalStyleFilename (   $originalStyleFilename)

Set original site stylesheet filename.

Parameters
$originalStyleFilenamestring

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

References DataObject\setData().

Site::setPrimaryLocale (   $primaryLocale)

Set primary locale.

Parameters
$primaryLocalestring

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

References DataObject\setData().

Site::setRedirect (   $redirect)

Set redirect

Parameters
$redirectint

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

References DataObject\setData().

Site::setSupportedLocales (   $supportedLocales)

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

Parameters
$supportedLocalesarray

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

References DataObject\setData().

Site::Site ( )

Constructor.

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

Site::updateSetting (   $name,
  $value,
  $type = null,
  $isLocalized = false 
)

Update a site setting value.

Parameters
$namestring
$valuemixed
$typestring optional
$isLocalizedboolean optional

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

References DAORegistry\getDAO().


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