PHP Class Contao\Ajax

Provide methods to handle Ajax requests.
Inheritance: extends Backend
Show file Open project: contao/core-bundle Class Usage Examples

Protected Properties

Property Type Description
$strAction string Ajax action
$strAjaxId string Ajax id
$strAjaxKey string Ajax key
$strAjaxName string Ajax name

Public Methods

Method Description
__construct ( string $strAction ) Get the current action
executePostActions ( DataContainer $dc ) Ajax actions that do require a data container object
executePreActions ( ) Ajax actions that do not require a data container object

Protected Methods

Method Description
convertToResponse ( string $str ) : Response Convert a string to a response object
executePostActionsHook ( DataContainer $dc ) Execute the post actions hook

Method Details

__construct() public method

Get the current action
public __construct ( string $strAction )
$strAction string

convertToResponse() protected method

Convert a string to a response object
protected convertToResponse ( string $str ) : Response
$str string
return Symfony\Component\HttpFoundation\Response

executePostActions() public method

Ajax actions that do require a data container object
public executePostActions ( DataContainer $dc )
$dc DataContainer

executePostActionsHook() protected method

Execute the post actions hook
protected executePostActionsHook ( DataContainer $dc )
$dc DataContainer

executePreActions() public method

Ajax actions that do not require a data container object
public executePreActions ( )

Property Details

$strAction protected property

Ajax action
protected string $strAction
return string

$strAjaxId protected property

Ajax id
protected string $strAjaxId
return string

$strAjaxKey protected property

Ajax key
protected string $strAjaxKey
return string

$strAjaxName protected property

Ajax name
protected string $strAjaxName
return string