Référence de la classe ContactController

Graphe d'héritage de ContactController:

Fonctions membres publiques
	getModel ($name='form', $prefix='', $config=array('ignore_request'=> true))
	submit ()
	cancel ($key=null)
Fonctions membres publiques hérités de FormController
	__construct ( $config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null, FormFactoryInterface $formFactory=null)
	add ()
	batch ($model)
	cancel ($key=null)
	edit ($key=null, $urlVar=null)
	getModel ($name='', $prefix='', $config=array('ignore_request'=> true))
	save ($key=null, $urlVar=null)
	editAssociations ()
Fonctions membres publiques hérités de BaseController
	__construct ($config=array(), MVCFactoryInterface $factory=null, ?CMSApplication $app=null, ?Input $input=null)
	addViewPath ($path)
	execute ($task)
	getModel ($name='', $prefix='', $config=array())
	getName ()
	getTask ()
	getTasks ()
	getView ($name='', $type='', $prefix='', $config=array())
	redirect ()
	registerDefaultTask ($method)
	registerTask ($task, $method)
	unregisterTask ($task)
	setMessage ($text, $type='message')
	checkToken ($method='post', $redirect=true)
	setRedirect ($url, $msg=null, $type=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres protégées
	allowAdd ($data=array())
	allowEdit ($data=array(), $key='id')
	getRedirectToItemAppend ($recordId=0, $urlVar='id')
	getReturnPage ()
Fonctions membres protégées hérités de FormController
	allowAdd ($data=[])
	allowEdit ($data=[], $key='id')
	allowSave ($data, $key='id')
	getRedirectToItemAppend ($recordId=null, $urlVar='id')
	getRedirectToListAppend ()
	postSaveHook (BaseDatabaseModel $model, $validData=array())
Fonctions membres protégées hérités de BaseController
	addPath ($type, $path)
	checkEditId ($context, $id)
	createModel ($name, $prefix='', $config=array())
	createView ($name, $prefix='', $type='', $config=array())
	holdEditId ($context, $id)
	releaseEditId ($context, $id)
	setPath ($type, $path)

Attributs protégés
	$view_item = 'form'
	$view_list = 'categories'
Attributs protégés hérités de FormController
	$context
	$option
	$view_item
	$view_list
	$text_prefix
Attributs protégés hérités de BaseController
	$basePath
	$default_view
	$doTask
	$message
	$messageType
	$methods
	$name
	$model_prefix
	$paths
	$redirect
	$task
	$taskMap
	$input
	$factory
	$app

Fonctions membres privées
	_sendEmail ($data, $contact, $emailCopyToSender)

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseController
static	addModelPath ($path, $prefix='')
static	createFileName ($type, $parts=array())
static	getInstance ($prefix, $config=array())
Attributs protégés statiques hérités de BaseController
static	$instance
static	$views

Description détaillée

Controller for single contact view

Depuis

1.5.19

Documentation des fonctions membres

_sendEmail()

_sendEmail (   $data,   $contact,   $emailCopyToSender  )

private

Method to get a model object, loading it if required.

Paramètres

array	$data	The data to send in the email.
\stdClass	$contact	The user information to send the email to
boolean	$emailCopyToSender	True to send a copy of the email to the user.

Renvoie

boolean True on success sending the email, false on failure.

Depuis

1.6.4

Références $app, $data, $fields, $output, Text\_(), Log\add(), MailTemplate\addRecipient(), Uri\base(), PunycodeHelper\emailToPunycode(), FieldsHelper\getFields(), User\getInstance(), FieldsHelper\render(), et Log\WARNING.

allowAdd()

allowAdd (   $data = array() )

protected

Method override to check if you can add a new record.

Paramètres

array

$data

An array of input data.

Renvoie

boolean

Depuis

4.0.0

Références $data, $user, et ArrayHelper\getValue().

allowEdit()

allowEdit (   $data = array(),   $key = 'id'  )

protected

Method override to check if you can edit an existing record.

Paramètres

array	$data	An array of input data.
string	$key	The name of the key for the primary key; default is id.

Renvoie

boolean

Depuis

4.0.0

Références $data, $key, $recordId, $this, $user, et if.

cancel()

cancel

(

$key = null

)

Method to cancel an edit.

Paramètres

string

$key

The name of the primary key of the URL variable.

Renvoie

boolean True if access level checks pass, false otherwise.

Depuis

4.0.0

Références $key, $result, et Route\_().

getModel()

getModel	(		$name = 'form',
			$prefix = '',
			$config = array('ignore_request' => true)
	)

Method to get a model object, loading it if required.

Paramètres

string	$name	The model name. Optional.
string	$prefix	The class prefix. Optional.
array	$config	Configuration array for model. Optional.

Renvoie

The model.

Depuis

1.6.4

Références $name, et $prefix.

getRedirectToItemAppend()

getRedirectToItemAppend (   $recordId = 0,   $urlVar = 'id'  )

protected

Gets the URL arguments to append to an item redirect.

Paramètres

integer	$recordId	The primary key id for the item.
string	$urlVar	The name of the URL variable for the id.

Renvoie

string The arguments to append to the redirect URL.

Depuis

4.0.0

Références $append, $itemId, $recordId, $return, et $tmpl.

getReturnPage()

getReturnPage ( )

protected

Get the return URL.

If a "return" variable has been passed in the request

Renvoie

string The return URL.

Depuis

4.0.0

Références $return, Uri\base(), Uri\isInternal(), et null.

submit()

submit

(

)

Method to submit the contact form and send an email.

Renvoie

boolean True on success sending the email. False on failure.

Depuis

1.5.19

Références $active, $app, $data, $form, $id, $model, $result, $results, Text\_(), Route\_(), Joomla\Application\checkToken(), Factory\getSession(), PluginHelper\importPlugin(), et null.

Documentation des champs

$view_item

$view_item = 'form'

protected

$view_list

$view_list = 'categories'

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• components/com_contact/src/Controller/ContactController.php