sqlGetFromFile

Details

This page shows version 4.x. The current version can be found here.

The sqlGetFromFile hook is triggered when parsing database.sql files. It passes the generated SQL definition and expects the same as return value.

Note

Using the sqlGetFromFile hook has been deprecated and will no longer work in Contao 5.0.

Parameters

  1. array $sql

    The parsed SQL definition.

Return Values

Return $sql after adding your custom definitions.

Example

// src/EventListener/SqlGetFromFileListener.php
namespace App\EventListener;

use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;

#[AsHook('sqlGetFromFile')]
class SqlGetFromFileListener
{
    public function __invoke(array $sql): array
    {
        // Modify the array of SQL statements

        return $sql;
    }
}

References