PHP code example of spatie / laravel-sql-commenter
1. Go to this page and download the library: Download spatie/laravel-sql-commenter library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
spatie / laravel-sql-commenter example snippets
return [
/*
* When set to true, comments will be added to all your queries
*/
'enabled' => true,
/*
* These classes add comments to an executed query.
*/
'commenters' => [
Spatie\SqlCommenter\Commenters\ControllerCommenter::class => ['thSegments' => [],
'useRelativePath' => false,
],
Spatie\SqlCommenter\Commenters\CurrentUserCommenter::class,
// Spatie\SqlCommenter\Commenters\FrameworkVersionCommenter::class,
// Spatie\SqlCommenter\Commenters\DbDriverCommenter::class,
],
/*
* If you need fine-grained control over the logging, you can extend
* the SqlCommenter class and specify your custom class here
*/
'commenter_class' => Spatie\SqlCommenter\SqlCommenter::class,
];
use Spatie\SqlCommenter\SqlCommenter;
app(SqlCommenter::class)->addComment('foo', 'bar');
// select * from "users"/*foo='bar'*/;
use \Spatie\SqlCommenter\SqlCommenter;
// queries performed here won't have comments
SqlCommenter::enable();
// queries performed here will have comments
SqlCommenter::disable();
// queries performed here won't have comments
namespace App\Support\SqlCommenters;
use Illuminate\Database\Connection;
use Spatie\SqlCommenter\Comment;
class MyCustomCommenter implements Commenter
{
/** @return Comment|array<Comment>|null */
public function comments(string $query, Connection $connection): Comment|array|null
{
return new Comment('my-custom-key', 'my-custom-value');
}
}