SchedConf Class Reference
[SchedConf]

Describes basic scheduled conference properties. More...

List of all members.

Public Member Functions

 getAcronym ($locale)
getConference ()
 getConferenceId ()
 getCurrent ()
 getEndDate ()
 getFullTitle ()
 getLocalizedAcronym ()
getLocalizedSetting ($name)
 getLocalizedTitle ()
 getPath ()
 getPrimaryLocale ()
 getSchedConfAcronym ()
 getSchedConfId ()
 getSchedConfIntroduction ()
 getSchedConfTitle ()
 getSequence ()
getSetting ($name, $locale=null)
 getSettings ()
 getStartDate ()
 getStyleFilename ()
 getTitle ($locale)
 getUrl ()
 setConferenceId ($conferenceId)
 setCurrent ($current)
 setEndDate ($endDate)
 setPath ($path)
 setPrimaryLocale ($primaryLocale)
 setSchedConfId ($schedConfId)
 setSequence ($sequence)
 setStartDate ($startDate)
 updateSetting ($name, $value, $type=null, $isLocalized=false)


Detailed Description

Describes basic scheduled conference properties.

See also:
SchedConfDAO

Definition at line 37 of file SchedConf.inc.php.


Member Function Documentation

SchedConf.getAcronym ( locale  ) 

Get acronym of scheduled conference

Parameters:
$locale string
Returns:
string

Definition at line 121 of file SchedConf.inc.php.

References getSetting().

& SchedConf.getConference (  ) 

Get the conference for this scheduled conference.

Returns:
string

Definition at line 59 of file SchedConf.inc.php.

References getConferenceId().

Referenced by getPrimaryLocale().

SchedConf.getConferenceId (  ) 

Get conference ID of scheduled conference.

Returns:
int

Definition at line 147 of file SchedConf.inc.php.

Referenced by getConference().

SchedConf.getCurrent (  ) 

get current

Returns:
int

Definition at line 69 of file SchedConf.inc.php.

SchedConf.getEndDate (  ) 

Get end date of scheduled conference.

Returns:
date

Definition at line 215 of file SchedConf.inc.php.

SchedConf.getFullTitle (  ) 

Get full title of scheduled conference. (Used to include conference title as well; this behavior was deprecated prior to 2.0 release.)

Returns:
string

Definition at line 245 of file SchedConf.inc.php.

References getSchedConfTitle().

SchedConf.getLocalizedAcronym (  ) 

Get the localized acronym of the scheduled conference

Returns:
string

Definition at line 107 of file SchedConf.inc.php.

References getLocalizedSetting().

Referenced by getSchedConfAcronym().

& SchedConf.getLocalizedSetting ( name  ) 

Get a localized scheduled conference setting.

Parameters:
$name string
Returns:
mixed

Definition at line 269 of file SchedConf.inc.php.

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

Referenced by getLocalizedAcronym(), getLocalizedTitle(), and getSchedConfIntroduction().

SchedConf.getLocalizedTitle (  ) 

Get the localized title of the scheduled conference

Returns:
string

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

References getLocalizedSetting().

Referenced by getSchedConfTitle().

SchedConf.getPath (  ) 

Get path to scheduled conference (in URL).

Returns:
string

Definition at line 163 of file SchedConf.inc.php.

Referenced by getUrl().

SchedConf.getPrimaryLocale (  ) 

Return the primary locale of this scheduled conference.

Returns:
string

Definition at line 306 of file SchedConf.inc.php.

References getConference().

SchedConf.getSchedConfId (  ) 

Get ID of scheduled conference.

Returns:
int

Definition at line 129 of file SchedConf.inc.php.

Referenced by updateSetting().

SchedConf.getSchedConfIntroduction (  ) 

Get the localized introduction of the scheduled conference

Returns:
string

Definition at line 231 of file SchedConf.inc.php.

References getLocalizedSetting().

SchedConf.getSequence (  ) 

Get sequence of scheduled conference in site table of contents.

Returns:
float

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

& SchedConf.getSetting ( name,
locale = null 
)

Retrieve a scheduled conference setting value.

Parameters:
$name 
$locale string
Returns:
mixed

Definition at line 284 of file SchedConf.inc.php.

Referenced by getAcronym(), getLocalizedSetting(), getStyleFilename(), and getTitle().

SchedConf.getSettings (  ) 

Retrieve array of scheduled conference settings.

Returns:
array

Definition at line 259 of file SchedConf.inc.php.

SchedConf.getStartDate (  ) 

Get start date of scheduled conference.

Returns:
date

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

SchedConf.getStyleFilename (  ) 

Get CSS for this scheduled conference

Returns:
string

Definition at line 323 of file SchedConf.inc.php.

References getSetting().

SchedConf.getTitle ( locale  ) 

Get title of scheduled conference

Parameters:
$locale string
Returns:
string

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

References getSetting().

SchedConf.getUrl (  ) 

Get the base URL to the scheduled conference.

Returns:
string

Definition at line 48 of file SchedConf.inc.php.

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

SchedConf.setConferenceId ( conferenceId  ) 

Set conference ID of scheduled conference.

Parameters:
$schedConfId int

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

SchedConf.setCurrent ( current  ) 

set current

Parameters:
$current int

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

SchedConf.setEndDate ( endDate  ) 

Set end date of scheduled conference.

Parameters:
$endDate date

Definition at line 223 of file SchedConf.inc.php.

SchedConf.setPath ( path  ) 

Set path to scheduled conference (in URL).

Parameters:
$path string

Definition at line 171 of file SchedConf.inc.php.

SchedConf.setPrimaryLocale ( primaryLocale  ) 

Set the primary locale of this conference.

Parameters:
$locale string

Definition at line 315 of file SchedConf.inc.php.

SchedConf.setSchedConfId ( schedConfId  ) 

Set ID of scheduled conference.

Parameters:
$schedConfId int

Definition at line 138 of file SchedConf.inc.php.

SchedConf.setSequence ( sequence  ) 

Set sequence of scheduled conference in site table of contents.

Parameters:
$sequence float

Definition at line 187 of file SchedConf.inc.php.

SchedConf.setStartDate ( startDate  ) 

Set start date of scheduled conference.

Parameters:
$startDate date

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

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

Update a scheduled conference setting value.

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

Definition at line 297 of file SchedConf.inc.php.

References getSchedConfId().


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