SuggestWizardController

Receives ajax request from FormEngine suggest wizard and creates suggest answer as json result

Internal

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Methods

searchAction()  : ResponseInterface
Ajax handler for the "suggest" feature in FormEngine.
currentBackendUserMayAccessTable()  : bool
Checks if the current backend user is allowed to access the given table, based on the ctrl-section of the table's configuration array (TCA) entry.
getBackendUser()  : BackendUserAuthentication
getConfigurationForTable()  : array<string|int, mixed>
Returns the configuration for the suggest wizard for the given table. This does multiple overlays from the TSconfig.
getTablesToQueryFromFieldConfiguration()  : array<string|int, mixed>
Checks the given field configuration for the tables that should be used for querying and returns them as an array.
getWhereClause()  : string
Returns the SQL WHERE clause to use for querying records. This is currently only relevant if a foreign_table is configured and should be used; it could e.g. be used to limit to a certain subset of records from the foreign table
isTableHidden()  : bool
Returns TRUE if a table has been marked as hidden in the configuration

Methods

searchAction()

Ajax handler for the "suggest" feature in FormEngine.

public searchAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Tags
throws
RuntimeException

for incomplete or invalid arguments

Return values
ResponseInterface

currentBackendUserMayAccessTable()

Checks if the current backend user is allowed to access the given table, based on the ctrl-section of the table's configuration array (TCA) entry.

protected currentBackendUserMayAccessTable(array<string|int, mixed> $tableConfig) : bool
Parameters
$tableConfig : array<string|int, mixed>
Return values
bool

getConfigurationForTable()

Returns the configuration for the suggest wizard for the given table. This does multiple overlays from the TSconfig.

protected getConfigurationForTable(string $queryTable, array<string|int, mixed> $wizardConfig, array<string|int, mixed> $TSconfig, string $table, string $field) : array<string|int, mixed>
Parameters
$queryTable : string

The table to query

$wizardConfig : array<string|int, mixed>

The configuration for the wizard as configured in the data structure

$TSconfig : array<string|int, mixed>

The TSconfig array of the current page

$table : string

The table where the wizard is used

$field : string

The field where the wizard is used

Return values
array<string|int, mixed>

getTablesToQueryFromFieldConfiguration()

Checks the given field configuration for the tables that should be used for querying and returns them as an array.

protected getTablesToQueryFromFieldConfiguration(array<string|int, mixed> $fieldConfig) : array<string|int, mixed>
Parameters
$fieldConfig : array<string|int, mixed>
Return values
array<string|int, mixed>

getWhereClause()

Returns the SQL WHERE clause to use for querying records. This is currently only relevant if a foreign_table is configured and should be used; it could e.g. be used to limit to a certain subset of records from the foreign table

protected getWhereClause(array<string|int, mixed> $fieldConfig) : string
Parameters
$fieldConfig : array<string|int, mixed>
Return values
string

isTableHidden()

Returns TRUE if a table has been marked as hidden in the configuration

protected isTableHidden(array<string|int, mixed> $tableConfig) : bool
Parameters
$tableConfig : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results