RegistrationDAO Class Reference

Operations for retrieving and modifying Registration objects. More...

List of all members.

Public Member Functions

 _generateUserNameSearchSQL ($search, $searchMatch, $prefix, &$params)
_returnRegistrationFromRow (&$row)
 deleteRegistrationById ($registrationId)
 deleteRegistrationByTypeId ($registrationTypeId)
 deleteRegistrationByUserIdSchedConf ($userId, $schedConfId)
 deleteRegistrationsBySchedConf ($schedConfId)
 deleteRegistrationsByUserId ($userId)
 getInsertRegistrationId ()
getRegisteredUserCount ($schedConfId, $paid=true)
getRegisteredUsers ($schedConfId, $paid=true, $dbResultRange=null)
getRegistration ($registrationId)
 getRegistrationIdByUser ($userId, $schedConfId)
getRegistrationsBySchedConfId ($schedConfId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 getRegistrationsByUser ($userId, $rangeInfo=null)
 getRegistrationSchedConfId ($registrationId)
 getSortMapping ($heading)
 insertRegistration (&$registration)
 isValidRegistration ($domain, $IP, $userId, $schedConfId)
 isValidRegistrationByDomain ($domain, $schedConfId)
 isValidRegistrationByIP ($IP, $schedConfId)
 isValidRegistrationByUser ($userId, $schedConfId)
 registrationExistsByUser ($userId, $schedConfId)
 updateRegistration (&$registration)


Detailed Description

Operations for retrieving and modifying Registration objects.

See also:
Registration

Definition at line 31 of file RegistrationDAO.inc.php.


Member Function Documentation

RegistrationDAO._generateUserNameSearchSQL ( search,
searchMatch,
prefix,
&$  params 
)

Internal function to generate user based search query.

Returns:
string

Definition at line 168 of file RegistrationDAO.inc.php.

Referenced by getRegistrationsBySchedConfId().

& RegistrationDAO._returnRegistrationFromRow ( &$  row  ) 

Internal function to return a Registration object from a row.

Parameters:
$row array
Returns:
Registration

Definition at line 146 of file RegistrationDAO.inc.php.

Referenced by getRegistration(), getRegistrationsBySchedConfId(), and getRegistrationsByUser().

RegistrationDAO.deleteRegistrationById ( registrationId  ) 

Delete a registration by registration ID.

Parameters:
$registrationId int
Returns:
boolean

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

RegistrationDAO.deleteRegistrationByTypeId ( registrationTypeId  ) 

Delete all registration by registration type ID.

Parameters:
$registrationTypeId int
Returns:
boolean

Definition at line 298 of file RegistrationDAO.inc.php.

RegistrationDAO.deleteRegistrationByUserIdSchedConf ( userId,
schedConfId 
)

Delete registration by user ID and scheduled conference ID.

Parameters:
$schedConfId int

Definition at line 280 of file RegistrationDAO.inc.php.

RegistrationDAO.deleteRegistrationsBySchedConf ( schedConfId  ) 

Delete registration by scheduled conference ID.

Parameters:
$schedConfId int

Definition at line 260 of file RegistrationDAO.inc.php.

RegistrationDAO.deleteRegistrationsByUserId ( userId  ) 

Delete registration by user ID.

Parameters:
$userId int

Definition at line 270 of file RegistrationDAO.inc.php.

RegistrationDAO.getInsertRegistrationId (  ) 

Get the ID of the last inserted registration.

Returns:
int

Definition at line 676 of file RegistrationDAO.inc.php.

Referenced by insertRegistration().

& RegistrationDAO.getRegisteredUserCount ( schedConfId,
paid = true 
)

Retrieve a count of all paid registered users.

Parameters:
$schedConfId int
$paid boolean Whether or not included users must be paid
Returns:
int count

Definition at line 428 of file RegistrationDAO.inc.php.

& RegistrationDAO.getRegisteredUsers ( schedConfId,
paid = true,
dbResultRange = null 
)

Retrieve a list of all paid registered users.

Parameters:
$schedConfId int
$paid boolean Whether or not included users must be paid
$dbRangeInfo object DBRangeInfo object describing range of results to return
Returns:
object ItemIterator containing matching Users

Definition at line 405 of file RegistrationDAO.inc.php.

& RegistrationDAO.getRegistration ( registrationId  ) 

Retrieve a registration by registration ID.

Parameters:
$registrationId int
Returns:
Registration

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

References _returnRegistrationFromRow().

RegistrationDAO.getRegistrationIdByUser ( userId,
schedConfId 
)

Retrieve registration ID by user ID.

Parameters:
$userId int
$schedConfId int
Returns:
int

Definition at line 76 of file RegistrationDAO.inc.php.

& RegistrationDAO.getRegistrationsBySchedConfId ( schedConfId,
searchField = null,
searchMatch = null,
search = null,
dateField = null,
dateFrom = null,
dateTo = null,
rangeInfo = null,
sortBy = null,
sortDirection = SORT_DIRECTION_ASC 
)

Retrieve an array of registration matching a particular scheduled conference ID.

Parameters:
$schedConfId int
$searchField int
$searchMatch string "is" or "contains" or "startsWith"
$search String to look in $searchField for
$dateField int
$dateFrom String date to search from
$dateTo String date to search to
Returns:
object DAOResultFactory containing matching Registrations

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

References _generateUserNameSearchSQL(), _returnRegistrationFromRow(), and getSortMapping().

RegistrationDAO.getRegistrationsByUser ( userId,
rangeInfo = null 
)

Retrieve all registrations by user ID.

Parameters:
$userId int
Returns:
object DAOResultFactory containing matching Registrations

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

References _returnRegistrationFromRow().

RegistrationDAO.getRegistrationSchedConfId ( registrationId  ) 

Retrieve registration scheduled conference ID by registration ID.

Parameters:
$registrationId int
Returns:
int

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

RegistrationDAO.getSortMapping ( heading  ) 

Map a column heading value to a database value for sorting

Parameters:
string 
Returns:
string

Definition at line 685 of file RegistrationDAO.inc.php.

Referenced by getRegistrationsBySchedConfId().

RegistrationDAO.insertRegistration ( &$  registration  ) 

Insert a new Registration.

Parameters:
$registration Registration
Returns:
boolean

Definition at line 191 of file RegistrationDAO.inc.php.

References getInsertRegistrationId().

RegistrationDAO.isValidRegistration ( domain,
IP,
userId,
schedConfId 
)

Check whether there is a valid registration for a given scheduled conference.

Parameters:
$domain string
$IP string
$userId int
$schedConfId int
Returns:
boolean

Definition at line 453 of file RegistrationDAO.inc.php.

References isValidRegistrationByDomain(), isValidRegistrationByIP(), and isValidRegistrationByUser().

RegistrationDAO.isValidRegistrationByDomain ( domain,
schedConfId 
)

Check whether there is a valid registration with given domain for a scheduled conference.

Parameters:
$domain string
$schedConfId int
Returns:
boolean

Definition at line 515 of file RegistrationDAO.inc.php.

Referenced by isValidRegistration().

RegistrationDAO.isValidRegistrationByIP ( IP,
schedConfId 
)

Check whether there is a valid registration for the given IP for a sc heduled conference.

Parameters:
$IP string
$schedConfId int
Returns:
boolean

Definition at line 570 of file RegistrationDAO.inc.php.

Referenced by isValidRegistration().

RegistrationDAO.isValidRegistrationByUser ( userId,
schedConfId 
)

Check whether user with ID has a valid registration for a given scheduled conference.

Parameters:
$userId int
$schedConfId int
Returns:
boolean

Definition at line 478 of file RegistrationDAO.inc.php.

Referenced by isValidRegistration().

RegistrationDAO.registrationExistsByUser ( userId,
schedConfId 
)

Check if a registration exists for a given user and scheduled conf.

Parameters:
$userId int
$schedConfId int
Returns:
boolean

Definition at line 122 of file RegistrationDAO.inc.php.

RegistrationDAO.updateRegistration ( &$  registration  ) 

Update an existing registration.

Parameters:
$registration Registration
Returns:
boolean

Definition at line 217 of file RegistrationDAO.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