Class Participants

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Brief:

This class gets information about participants and leaders of dates.

This function is developed, to read the participants and leaders of dates from database. Participants and leaders can be counted or be written in an array with surname, firstname and leader-status. Also the limit of participation can to be calculated. This class is flexible in usage. It is possible to pass the paramter of the rolId when creating an instance of this object. The Id will be checked and stored in the object. So no parameters are required when calling a function. Second possibility is to pass the Id to a function of this object. The stored value in current object will be overwritten. This is recommended looping an array, for example, with various Id´s.

Class: Participants
Located at participants.php

Methods summary

`public`	# `__construct( Database & $database, integer $rolId = 0 )` Constructor that will initialize variables and check if $rolId is numeric Constructor that will initialize variables and check if $rolId is numeric Parameters `$database` Object of the class Database. This should be the default global object @b $gDb. `$rolId` The role ID of a date
`public`	# `__destruct( )`
`private boolean`	# `checkId( integer $roleId )` This function checks the passed Id if it is numeric and compares it to the current object variable If the values are different the current object variable will be updated with the new value This function checks the passed Id if it is numeric and compares it to the current object variable If the values are different the current object variable will be updated with the new value Parameters `$roleId` Returns boolean
`public`	# `clear( )` Initialize all parameters of the object Initialize all parameters of the object
`public integer`	# `getCount( integer $rolId = 0 )` Count participants of the date. Count participants of the date. Parameters `$rolId` Returns integer Returns the result of counted participants as numeric value in current object. Leaders are not counted!
`public integer`	# `getLimit( integer $rolId = 0 )` Get the limit of participants. Get the limit of participants. Parameters `$rolId` Returns integer Returns the limit of participants as numeric value of the current object. Leaders are not counted!
`public integer`	# `getNumLeaders( integer $rolId = 0 )` Get the number of leaders. Get the number of leaders. Parameters `$rolId` Returns integer Returns the number of leaders as numeric value of the current object.
`public array\|false`	# `getParticipantsArray( integer $roleId = 0, string $order = 'ASC' )` Return all participants with surname,firstname and leader status as array Return all participants with surname,firstname and leader status as array Parameters `$roleId` `$order` Values ASC/DESC Default: 'ASC' Returns array\|false Returns all participants in an array with fieldnames ['surname'], ['firstname'], ['leader'].

Properties summary

`private`	`$rolId`	#
`private`	`$leader`	#
`private`	`$count`	#
`private`	`$order`	#
`public`	`$memberDate`	#
`public`	`$mDb`	#

Packages

Classes

Exceptions

Functions

Class Participants

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties summary