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 | |
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.
| SD_Meeting_Tool_Registration_Result::has_participant_id | ( | ) |
Does this result have a participant ID set?
| SD_Meeting_Tool_Registration_Result::participant_id | ( | ) |
Returns the participant ID.
| SD_Meeting_Tool_Registration_Result::set_participant_id | ( | $participant_id | ) |
Sets the participant ID that was processed.
| $participant_id | New 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.
|
private |
Participant ID that was processed.
|
private |
Was this registration a complete success?
1.8.1.2