OpenEstate-PHP-Export 2.0-beta2 API
\
Gettext
Extractors
Generators
Languages
Exporter
Utils
OpenEstate
PhpExport
Action
Filter
Html
Order
Provider
Session
Theme
View
PHPMailer
PHPMailer
TrueBV
Exception

\OpenEstate\PhpExport\ActionContact

Send an email from a contact form.

Summary

Methods
Properties
Constants
__construct()
__destruct()
execute()
getName()
getParameters()
getUrl()
getVar()
$captchaVerification
$captchaMaximumAge
$termsVerification
$privacyPolicyVerification
$cancellationPolicyVerification
$contactParameter
$objectIdParameter
$mailLanguage
$delay
NAME
No protected methods found
No protected properties found
N/A
No private methods found
$name
N/A

Constants

NAME

NAME

Action name.

Properties

$captchaVerification

$captchaVerification : boolean

Enable captcha verification.

Type

boolean

$captchaMaximumAge

$captchaMaximumAge : integer

Maximum age, a captcha code is considered valid (in seconds).

Type

integer

$termsVerification

$termsVerification : boolean

Enable terms verification.

Type

boolean

$privacyPolicyVerification

$privacyPolicyVerification : boolean

Enable privacy policy verification.

Type

boolean

$cancellationPolicyVerification

$cancellationPolicyVerification : boolean

Enable cancellation policy verification.

Type

boolean

$contactParameter

$contactParameter : string

Parameter name for contact values.

Type

string

$objectIdParameter

$objectIdParameter : string

Parameter name for the object ID.

Type

string

$mailLanguage

$mailLanguage : string

Language of generated emails.

Type

string

$delay

$delay : integer

Delay before the action is executed (in seconds).

Type

integer

$name

$name : string

Internal name of this action.

Type

string

Methods

__construct()

__construct(string  $name = self::NAME)

Contact constructor.

Parameters

string $name

internal name

__destruct()

__destruct()

AbstractAction destructor.

execute()

execute(\OpenEstate\PhpExport\Environment  $env) : mixed

Execute this action.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

Returns

mixed —

action result

getName()

getName() : string

Get the internal action name.

Returns

string —

action name

getParameters()

getParameters(\OpenEstate\PhpExport\Environment  $env) : array

Get parameter values for this action.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

Returns

array —

associative array with parameter values

getUrl()

getUrl(\OpenEstate\PhpExport\Environment  $env) : string

Get url for this action.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

Returns

string —

url

getVar()

getVar(string  $name) : string

Get the variable name of a contact value.

Parameters

string $name

value name

Returns

string —

variable name