Documentation

FormTrait

Trait for writing tests interacting with QuickForm.

Table of Contents

Properties

$form  : FormWrapper

Methods

getTestForm()  : FormWrapper
assertMailSentContainingHeaderString()  : void
Assert that the sent mail included the supplied string.
assertMailSentContainingHeaderStrings()  : void
Assert that the sent mail included the supplied strings.
assertMailSentContainingString()  : void
Assert that the sent mail included the supplied string.
assertMailSentContainingStrings()  : void
Assert that the sent mail included the supplied strings.
assertMailSentCount()  : void
Assert the right number of mails were sent.
assertMailSentNotContainingString()  : void
Assert that the sent mail included the supplied string.
assertMailSentNotContainingStrings()  : void
Assert that the sent mail included the supplied strings.
assertMailSentTo()  : void
Assert that the sent mail included the supplied strings.
assertPrematureExit()  : void
assertTemplateVariable()  : void
assertValidationError()  : void
Assert that the sent mail included the supplied string.
getDeprecatedProperty()  : mixed
Retrieve a deprecated property, ensuring a deprecation notice is thrown.

Properties

Methods

getTestForm()

public getTestForm(mixed $formName, mixed $submittedValues[, array<string|int, mixed> $urlParameters = [] ]) : FormWrapper
Parameters
$formName : mixed
$submittedValues : mixed
$urlParameters : array<string|int, mixed> = []
Return values
FormWrapper

assertMailSentContainingHeaderString()

Assert that the sent mail included the supplied string.

protected assertMailSentContainingHeaderString(string $string[, int $mailIndex = 0 ]) : void
Parameters
$string : string
$mailIndex : int = 0

assertMailSentContainingHeaderStrings()

Assert that the sent mail included the supplied strings.

protected assertMailSentContainingHeaderStrings(array<string|int, mixed> $strings[, int $mailIndex = 0 ]) : void
Parameters
$strings : array<string|int, mixed>
$mailIndex : int = 0

assertMailSentContainingString()

Assert that the sent mail included the supplied string.

protected assertMailSentContainingString(string $string[, int $mailIndex = 0 ]) : void
Parameters
$string : string
$mailIndex : int = 0

assertMailSentContainingStrings()

Assert that the sent mail included the supplied strings.

protected assertMailSentContainingStrings(array<string|int, mixed> $strings[, int $mailIndex = 0 ]) : void
Parameters
$strings : array<string|int, mixed>
$mailIndex : int = 0

assertMailSentCount()

Assert the right number of mails were sent.

protected assertMailSentCount(int $count) : void
Parameters
$count : int

assertMailSentNotContainingString()

Assert that the sent mail included the supplied string.

protected assertMailSentNotContainingString(string $string[, int $mailIndex = 0 ]) : void
Parameters
$string : string
$mailIndex : int = 0

assertMailSentNotContainingStrings()

Assert that the sent mail included the supplied strings.

protected assertMailSentNotContainingStrings(array<string|int, mixed> $strings[, int $mailIndex = 0 ]) : void
Parameters
$strings : array<string|int, mixed>
$mailIndex : int = 0

assertMailSentTo()

Assert that the sent mail included the supplied strings.

protected assertMailSentTo(array<string|int, mixed> $recipients[, int $mailIndex = 0 ]) : void
Parameters
$recipients : array<string|int, mixed>
$mailIndex : int = 0

assertPrematureExit()

protected assertPrematureExit() : void

assertTemplateVariable()

protected assertTemplateVariable(mixed $name, mixed $expected) : void
Parameters
$name : mixed
$expected : mixed

assertValidationError()

Assert that the sent mail included the supplied string.

protected assertValidationError(array<string|int, mixed> $errors) : void
Parameters
$errors : array<string|int, mixed>

getDeprecatedProperty()

Retrieve a deprecated property, ensuring a deprecation notice is thrown.

protected getDeprecatedProperty(string $property) : mixed
Parameters
$property : string
Tags
throws
CRM_Core_Exception

        
On this page

Search results