Conference Class Reference
[Conference]

Describes basic conference properties. More...

List of all members.

Public Member Functions

 Conference ()
 getConferenceDescription ()
 getConferenceId ()
 getConferenceTitle ()
 getDescription ($locale)
 getEnabled ()
 getLocalizedFavicon ()
getLocalizedSetting ($name)
 getPageHeaderLogo ($home=false)
 getPageHeaderTitle ($home=false)
 getPath ()
 getPrimaryLocale ()
 getSequence ()
getSetting ($name, $locale=null)
getSettings ()
getSupportedFormLocaleNames ()
getSupportedLocaleNames ()
 getTitle ($locale)
 getUrl ()
 setConferenceId ($conferenceId)
 setEnabled ($enabled)
 setPath ($path)
 setPrimaryLocale ($primaryLocale)
 setSequence ($sequence)
 updateSetting ($name, $value, $type=null, $isLocalized=false)


Detailed Description

Describes basic conference properties.

See also:
ConferenceDAO

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


Member Function Documentation

Conference.Conference (  ) 

Constructor.

Definition at line 35 of file Conference.inc.php.

Conference.getConferenceDescription (  ) 

Get the localized description of the conference.

Returns:
string

Definition at line 68 of file Conference.inc.php.

References getLocalizedSetting().

Conference.getConferenceId (  ) 

Get ID of conference.

Returns:
int

Definition at line 101 of file Conference.inc.php.

Referenced by updateSetting().

Conference.getConferenceTitle (  ) 

Get the localized title of the conference.

Returns:
string

Definition at line 51 of file Conference.inc.php.

References getLocalizedSetting().

Conference.getDescription ( locale  ) 

Get description of conference

Parameters:
$locale string
Returns:
string

Definition at line 77 of file Conference.inc.php.

References getSetting().

Conference.getEnabled (  ) 

Get enabled flag of conference

Returns:
int

Definition at line 85 of file Conference.inc.php.

Conference.getLocalizedFavicon (  ) 

Get localized favicon

Returns:
string

Definition at line 302 of file Conference.inc.php.

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

Conference.getPageHeaderLogo ( home = false  ) 

Get "localized" conference page logo (if applicable). param $home boolean get homepage logo

Returns:
string

Definition at line 289 of file Conference.inc.php.

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

Conference.getPageHeaderTitle ( home = false  ) 

Get "localized" conference page title (if applicable). param $home boolean get homepage title

Returns:
string

Definition at line 266 of file Conference.inc.php.

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

Conference.getPath (  ) 

Get path to conference (in URL).

Returns:
string

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

Referenced by getUrl().

Conference.getPrimaryLocale (  ) 

Return the primary locale of this conference.

Returns:
string

Definition at line 199 of file Conference.inc.php.

Conference.getSequence (  ) 

Get sequence of conference in site table of contents.

Returns:
float

Definition at line 135 of file Conference.inc.php.

& Conference.getSetting ( name,
locale = null 
)

Retrieve a conference setting value.

Parameters:
$name 
$locale string
Returns:
mixed

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

Referenced by getDescription(), getLocalizedFavicon(), getLocalizedSetting(), getPageHeaderLogo(), getPageHeaderTitle(), getSupportedFormLocaleNames(), getSupportedLocaleNames(), and getTitle().

& Conference.getSettings (  ) 

Retrieve array of conference settings.

Returns:
array

Definition at line 156 of file Conference.inc.php.

& Conference.getSupportedFormLocaleNames (  ) 

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

Returns:
array

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

References getSetting().

& Conference.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 216 of file Conference.inc.php.

References getSetting().

Conference.getTitle ( locale  ) 

Get title of conference

Parameters:
$locale string
Returns:
string

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

References getSetting().

Conference.getUrl (  ) 

Get the base URL to the conference.

Returns:
string

Definition at line 43 of file Conference.inc.php.

References getPath(), and Request.url().

Conference.setConferenceId ( conferenceId  ) 

Set ID of conference.

Parameters:
$conferenceId int

Definition at line 110 of file Conference.inc.php.

Conference.setEnabled ( enabled  ) 

Set enabled flag of conference

Parameters:
$enabled int

Definition at line 93 of file Conference.inc.php.

Conference.setPath ( path  ) 

Set path to conference (in URL).

Parameters:
$path string

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

Conference.setPrimaryLocale ( primaryLocale  ) 

Set the primary locale of this conference.

Parameters:
$primaryLocale string

Definition at line 207 of file Conference.inc.php.

Conference.setSequence ( sequence  ) 

Set sequence of conference in site table of contents.

Parameters:
$sequence float

Definition at line 143 of file Conference.inc.php.

Conference.updateSetting ( name,
value,
type = null,
isLocalized = false 
)

Update a conference setting value.

Parameters:
$name string
$value mixed
$type string optional
$isLocalized boolean optional

Definition at line 190 of file Conference.inc.php.

References getConferenceId().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7