API Documentation
\

\contacts

Summary

Methods
Properties
Constants
emailContact()
prepareData()
render()
getType()
createContact()
editContact()
deleteContact()
$pageOutput
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$moduleKey
$moduleType
$action
N/A

Properties

$pageOutput

$pageOutput :

Type

$moduleKey

$moduleKey :

Type

$moduleType

$moduleType :

Type

$action

$action :

Type

Methods

emailContact()

emailContact(  $status,   $recordClass,   $recordUid) : integer|string

Send a contact request by email

Parameters

$status
$recordClass
$recordUid

Returns

integer|string —

returns the count of sent mail if successfull, else return the error message

prepareData()

prepareData() : mixed

Launches the data processing step of all modules, executing their own prepareData() function

Returns

mixed

render()

render(  $mainTemplate) : mixed

Launches the rendering step of all modules, executing their own render() function

Parameters

$mainTemplate

Returns

mixed

getType()

getType() : string

must return one or several plugin types separated by comas current possible values are "backend, frontend, authentification"

Returns

string —

coma separated list of current module execution context types

createContact()

createContact()

editContact()

editContact(  $uid)

Parameters

$uid

deleteContact()

deleteContact(  $uid)

Parameters

$uid