[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/components/com_contact/src/Controller/ -> ContactController.php (summary)

(no description)

Copyright: (C) 2010 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 434 lines (14 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ContactController:: (8 methods):
  getModel()
  submit()
  _sendEmail()
  allowAdd()
  allowEdit()
  cancel()
  getRedirectToItemAppend()
  getReturnPage()


Class: ContactController  - X-Ref

Controller for single contact view

getModel($name = 'form', $prefix = '', $config = array('ignore_request' => true)   X-Ref
Method to get a model object, loading it if required.

param: string  $name    The model name. Optional.
param: string  $prefix  The class prefix. Optional.
param: array   $config  Configuration array for model. Optional.
return: \Joomla\CMS\MVC\Model\BaseDatabaseModel  The model.

submit()   X-Ref
Method to submit the contact form and send an email.

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

_sendEmail($data, $contact, $emailCopyToSender)   X-Ref
Method to get a model object, loading it if required.

param: array      $data               The data to send in the email.
param: \stdClass  $contact            The user information to send the email to
param: boolean    $emailCopyToSender  True to send a copy of the email to the user.
return: boolean  True on success sending the email, false on failure.

allowAdd($data = array()   X-Ref
Method override to check if you can add a new record.

param: array  $data  An array of input data.
return: boolean

allowEdit($data = array()   X-Ref
Method override to check if you can edit an existing record.

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

cancel($key = null)   X-Ref
Method to cancel an edit.

param: string  $key  The name of the primary key of the URL variable.
return: boolean  True if access level checks pass, false otherwise.

getRedirectToItemAppend($recordId = 0, $urlVar = 'id')   X-Ref
Gets the URL arguments to append to an item redirect.

param: integer  $recordId  The primary key id for the item.
param: string   $urlVar    The name of the URL variable for the id.
return: string    The arguments to append to the redirect URL.

getReturnPage()   X-Ref
Get the return URL.

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

return: string    The return URL.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer