RegistrationType Class Reference

Basic class describing a registration type. More...

List of all members.

Public Member Functions

 getAccess ()
 getAccessString ()
 getClosingDate ()
 getCode ()
 getCost ()
 getCurrencyCodeAlpha ()
 getCurrencyString ()
 getCurrencyStringShort ()
 getDescription ($locale)
 getDurationYearsMonths ()
 getExpiryDate ()
 getInstitutional ()
 getMembership ()
 getName ($locale)
 getOpeningDate ()
 getPublic ()
 getRegistrationTypeDescription ()
 getRegistrationTypeName ()
 getSchedConfId ()
 getSequence ()
 getSummaryString ()
 getTypeId ()
 RegistrationType ()
 setAccess ($access)
 setClosingDate ($closingDate)
 setCode ($code)
 setCost ($cost)
 setCurrencyCodeAlpha ($currencyCodeAlpha)
 setDescription ($description, $locale)
 setExpiryDate ($expiryDate)
 setInstitutional ($institutional)
 setMembership ($membership)
 setName ($name, $locale)
 setOpeningDate ($openingDate)
 setPublic ($public)
 setSchedConfId ($schedConfId)
 setSequence ($sequence)
 setTypeId ($typeId)


Detailed Description

Basic class describing a registration type.

See also:
RegistrationTypeDAO

Definition at line 27 of file RegistrationType.inc.php.


Member Function Documentation

RegistrationType.getAccess (  ) 

Get registration access type.

Returns:
int

Definition at line 277 of file RegistrationType.inc.php.

RegistrationType.getAccessString (  ) 

Get registration access type locale key.

Returns:
int

Definition at line 293 of file RegistrationType.inc.php.

RegistrationType.getClosingDate (  ) 

Get registration type closing date.

Returns:
date

Definition at line 219 of file RegistrationType.inc.php.

RegistrationType.getCode (  ) 

Get registration type code.

Returns:
string

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

RegistrationType.getCost (  ) 

Get registration type cost.

Returns:
float

Definition at line 141 of file RegistrationType.inc.php.

Referenced by getSummaryString().

RegistrationType.getCurrencyCodeAlpha (  ) 

Get registration type currency code.

Returns:
string

Definition at line 157 of file RegistrationType.inc.php.

RegistrationType.getCurrencyString (  ) 

Get registration type currency string.

Returns:
int

Definition at line 173 of file RegistrationType.inc.php.

RegistrationType.getCurrencyStringShort (  ) 

Get registration type currency abbreviated string.

Returns:
int

Definition at line 188 of file RegistrationType.inc.php.

Referenced by getSummaryString().

RegistrationType.getDescription ( locale  ) 

Get registration type description.

Parameters:
$locale string
Returns:
string

Definition at line 124 of file RegistrationType.inc.php.

RegistrationType.getDurationYearsMonths (  ) 

Get registration type duration in years and months.

Returns:
string

Definition at line 251 of file RegistrationType.inc.php.

Referenced by getSummaryString().

RegistrationType.getExpiryDate (  ) 

Get registration type expiry date.

Returns:
date

Definition at line 235 of file RegistrationType.inc.php.

RegistrationType.getInstitutional (  ) 

Check if this registration type is for an institution.

Returns:
boolean

Definition at line 310 of file RegistrationType.inc.php.

RegistrationType.getMembership (  ) 

Check if this registration type requires a membership.

Returns:
boolean

Definition at line 326 of file RegistrationType.inc.php.

RegistrationType.getName ( locale  ) 

Get registration type name.

Parameters:
$locale string
Returns:
string

Definition at line 82 of file RegistrationType.inc.php.

RegistrationType.getOpeningDate (  ) 

Get registration type opening date.

Returns:
date

Definition at line 203 of file RegistrationType.inc.php.

RegistrationType.getPublic (  ) 

Check if this registration type should be publicly visible.

Returns:
boolean

Definition at line 342 of file RegistrationType.inc.php.

RegistrationType.getRegistrationTypeDescription (  ) 

Get the localized registration type description

Returns:
string

Definition at line 115 of file RegistrationType.inc.php.

RegistrationType.getRegistrationTypeName (  ) 

Get the localized registration type name

Returns:
string

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

Referenced by getSummaryString().

RegistrationType.getSchedConfId (  ) 

Get the scheduled conference ID of the registration type.

Returns:
int

Definition at line 57 of file RegistrationType.inc.php.

RegistrationType.getSequence (  ) 

Get registration type display sequence.

Returns:
float

Definition at line 358 of file RegistrationType.inc.php.

RegistrationType.getSummaryString (  ) 

Get registration type summary in the form: TypeName - Duration - Cost (CurrencyShort).

Returns:
string

Definition at line 374 of file RegistrationType.inc.php.

References getCost(), getCurrencyStringShort(), getDurationYearsMonths(), and getRegistrationTypeName().

RegistrationType.getTypeId (  ) 

Get the ID of the registration type.

Returns:
int

Definition at line 41 of file RegistrationType.inc.php.

RegistrationType.setAccess ( access  ) 

Set registration access type.

Parameters:
$access int

Definition at line 285 of file RegistrationType.inc.php.

RegistrationType.setClosingDate ( closingDate  ) 

Set registration type closing date.

Parameters:
$duration date

Definition at line 227 of file RegistrationType.inc.php.

RegistrationType.setCode ( code  ) 

Set registration type code.

Parameters:
$typeCode string

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

RegistrationType.setCost ( cost  ) 

Set registration type cost.

Parameters:
$cost float

Definition at line 149 of file RegistrationType.inc.php.

RegistrationType.setCurrencyCodeAlpha ( currencyCodeAlpha  ) 

Set registration type currency code.

Parameters:
$currencyCodeAlpha string

Definition at line 165 of file RegistrationType.inc.php.

RegistrationType.setDescription ( description,
locale 
)

Set registration type description.

Parameters:
$description string
$locale string

Definition at line 133 of file RegistrationType.inc.php.

RegistrationType.setExpiryDate ( expiryDate  ) 

Set registration type expiry date.

Parameters:
$duration date

Definition at line 243 of file RegistrationType.inc.php.

RegistrationType.setInstitutional ( institutional  ) 

Set whether or not this registration type is for an institution.

Parameters:
$institutional boolean

Definition at line 318 of file RegistrationType.inc.php.

RegistrationType.setMembership ( membership  ) 

Set whether or not this registration type requires a membership.

Parameters:
$membership boolean

Definition at line 334 of file RegistrationType.inc.php.

RegistrationType.setName ( name,
locale 
)

Set registration type name.

Parameters:
$name string
$locale string

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

RegistrationType.setOpeningDate ( openingDate  ) 

Set registration type opening date.

Parameters:
$duration date

Definition at line 211 of file RegistrationType.inc.php.

RegistrationType.setPublic ( public  ) 

Set whether or not this registration should be publicly visible.

Parameters:
$public boolean

Definition at line 350 of file RegistrationType.inc.php.

RegistrationType.setSchedConfId ( schedConfId  ) 

Set the scheduled conference ID of the registration type.

Parameters:
$schedConfId int

Definition at line 65 of file RegistrationType.inc.php.

RegistrationType.setSequence ( sequence  ) 

Set registration type display sequence.

Parameters:
$sequence float

Definition at line 366 of file RegistrationType.inc.php.

RegistrationType.setTypeId ( typeId  ) 

Set the ID of the registration type.

Parameters:
$typeId int

Definition at line 49 of file RegistrationType.inc.php.


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