PHP Class Craft\AmForms_SubmissionsService

Inheritance: extends craft\BaseApplicationComponent
Datei anzeigen Open project: am-impact/amforms

Public Methods

Method Description
deleteSubmission ( craft\AmForms_SubmissionModel $submission ) : boolean Delete a submission.
emailSubmission ( craft\AmForms_SubmissionModel $submission, mixed $overrideRecipients = false ) : boolean Email a submission.
getActiveSubmission ( AmForms_FormModel $form ) : craft\AmForms_SubmissionModel Get an active front-end submission based on a form.
getAllSubmissions ( ) : craft\AmForms_SubmissionModel | array | null Get all submissions.
getConfirmationEmailBody ( craft\AmForms_SubmissionModel $submission ) : string Get confirmation email body.
getCriteria ( array $attributes = [] ) : craft\ElementCriteriaModel Returns a criteria model for AmForms_Submission elements.
getSubmissionById ( integer $id ) : craft\AmForms_SubmissionModel | null Get a submission by its ID.
getSubmissionEmailBody ( craft\AmForms_SubmissionModel $submission ) : string Get submission email body.
onBeforeEmailSubmission ( craft\Event $event ) Fires an 'onBeforeEmailSubmission' event.
onBeforeSaveSubmission ( craft\Event $event ) Fires an 'onBeforeSaveSubmission' event.
onEmailSubmission ( craft\Event $event ) Fires an 'onEmailSubmission' event.
onSaveSubmission ( craft\Event $event ) Fires an 'onSaveSubmission' event.
saveSubmission ( craft\AmForms_SubmissionModel $submission ) : boolean Save a submission.
setActiveSubmission ( craft\AmForms_SubmissionModel $submission ) Set an active front-end submission.

Private Methods

Method Description
_translatedObjectPlusEnvironment ( string $string, mixed $object = null ) : string Parse a string through an object and environment variables.

Method Details

deleteSubmission() public method

Delete a submission.
public deleteSubmission ( craft\AmForms_SubmissionModel $submission ) : boolean
$submission craft\AmForms_SubmissionModel
return boolean

emailSubmission() public method

Email a submission.
public emailSubmission ( craft\AmForms_SubmissionModel $submission, mixed $overrideRecipients = false ) : boolean
$submission craft\AmForms_SubmissionModel
$overrideRecipients mixed [Optional] Override recipients from form settings.
return boolean

getActiveSubmission() public method

Get an active front-end submission based on a form.
public getActiveSubmission ( AmForms_FormModel $form ) : craft\AmForms_SubmissionModel
$form AmForms_FormModel
return craft\AmForms_SubmissionModel

getAllSubmissions() public method

Get all submissions.
public getAllSubmissions ( ) : craft\AmForms_SubmissionModel | array | null
return craft\AmForms_SubmissionModel | array | null

getConfirmationEmailBody() public method

Get confirmation email body.
public getConfirmationEmailBody ( craft\AmForms_SubmissionModel $submission ) : string
$submission craft\AmForms_SubmissionModel
return string

getCriteria() public method

Returns a criteria model for AmForms_Submission elements.
public getCriteria ( array $attributes = [] ) : craft\ElementCriteriaModel
$attributes array
return craft\ElementCriteriaModel

getSubmissionById() public method

Get a submission by its ID.
public getSubmissionById ( integer $id ) : craft\AmForms_SubmissionModel | null
$id integer
return craft\AmForms_SubmissionModel | null

getSubmissionEmailBody() public method

Get submission email body.
public getSubmissionEmailBody ( craft\AmForms_SubmissionModel $submission ) : string
$submission craft\AmForms_SubmissionModel
return string

onBeforeEmailSubmission() public method

Fires an 'onBeforeEmailSubmission' event.
public onBeforeEmailSubmission ( craft\Event $event )
$event craft\Event

onBeforeSaveSubmission() public method

Fires an 'onBeforeSaveSubmission' event.
public onBeforeSaveSubmission ( craft\Event $event )
$event craft\Event

onEmailSubmission() public method

Fires an 'onEmailSubmission' event.
public onEmailSubmission ( craft\Event $event )
$event craft\Event

onSaveSubmission() public method

Fires an 'onSaveSubmission' event.
public onSaveSubmission ( craft\Event $event )
$event craft\Event

saveSubmission() public method

Save a submission.
public saveSubmission ( craft\AmForms_SubmissionModel $submission ) : boolean
$submission craft\AmForms_SubmissionModel
return boolean

setActiveSubmission() public method

Set an active front-end submission.
public setActiveSubmission ( craft\AmForms_SubmissionModel $submission )
$submission craft\AmForms_SubmissionModel