Sweden Democrats' Meeting Tool
 All Classes Files Functions Variables Pages
Public Member Functions | Private Attributes | List of all members
SD_Meeting_Tool_Registration_Result Class Reference

Information about how the registration went. More...

Public Member Functions

 success ()
 successful ()
 participant_id ()
 set_participant_id ($participant_id)
 has_participant_id ()

Private Attributes

 $success = false
 $participant_id = null

Detailed Description

Information about how the registration went.

Contained in a SD_Meeting_Tool_Registration and filled in by a UI, the class helps the registration plugin decide what action to take, and with which participant.

The participant ID can be successfully processed (ie: was allowed to register) or a failure (ie: was not allowed to register).

Failures without participants should not be processed at all and ignored completely, since there's no useful information in a failed registration without a participant even trying to register.

This class uses methods and private variables more than the other classes because we don't have public filters and actions to adhere to, and can therefore be more strict.

Author
Edward Plainview edwar.nosp@m.d.pl.nosp@m.ainvi.nosp@m.ew@s.nosp@m.verig.nosp@m.edem.nosp@m.okrat.nosp@m.erna.nosp@m..se

Member Function Documentation

SD_Meeting_Tool_Registration_Result::has_participant_id ( )

Does this result have a participant ID set?

Returns
True, if the result has a participant ID set.
SD_Meeting_Tool_Registration_Result::participant_id ( )

Returns the participant ID.

Returns
Participant ID that was processed.
SD_Meeting_Tool_Registration_Result::set_participant_id (   $participant_id)

Sets the participant ID that was processed.

Parameters
$participant_idNew participant ID.
SD_Meeting_Tool_Registration_Result::success ( )

Marks this result as successful.

Result can then be queried via ->successful()

SD_Meeting_Tool_Registration_Result::successful ( )

Queries whether the registration was a success.

Returns
Whether the registration was a success.

Member Data Documentation

SD_Meeting_Tool_Registration_Result::$participant_id = null
private

Participant ID that was processed.

SD_Meeting_Tool_Registration_Result::$success = false
private

Was this registration a complete success?


The documentation for this class was generated from the following file: