Download the PHP package sebdesign/blade-sql-formatter without Composer

On this page you can find all versions of the php package sebdesign/blade-sql-formatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package blade-sql-formatter

Display formatted SQL queries in your Laravel views

GitHub license Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

A small Laravel package for formatting SQL statements and files inside your Blade templates.

This package uses doctrine/sql-formatter to indent and add line breaks in addition to syntax highlighting.

Installation

Requires PHP 8.0+ and Laravel 9+

You can install the package via composer:

You can publish the config file with:

This is the contents of the published config file:

Feel free to customize the style of each token. You can use inline styles or CSS classes, even Tailwind CSS. Check out the demo on Tailwind Play.

Usage

Input:

Output:

select
  *
from
  `users`
where
  `id` = 1
limit
  1

View component

HTML Entity Encoding

If you use Blade's {{ }} echo statements inside the <x-sql> component, they will be sent through htmlspecialchars automatically. If your SQL statement contains single ' or double " quotes, they will be double-encoded.

For example:

Will output:

select
  *
from
  `users`
where
  `email` = & #039;[email protected]&#039;

In order to address this, you can use raw echo statements {!! !!} on your own responsibility.

Learn more about displaying unescaped data.

For example:

Will output:

select
  *
from
  `users`
where
  `email` = '[email protected]'

Blade directive

Rendering and including views

You can render and include SQL files like Blade files inside your controllers and your views. The SQL files will be compiled as formatted and highlighted HTML files, and will be cached in the compiled view path, e.g.: storage/framework/views.

If you don't want to store you SQL files in the resources/views directory, you can load them from another location, by adding the path in the paths key of your config/view.php file.

The following example will use the database/queries directory to find SQL files:

If you prefer using a namespace to separate your Blade files from your SQL files, you can add one in the boot method of a service provider.

The following example will use the database/queries directory to find SQL files with the sql:: namespace:

In this case you don't need to add the path to config/view.php.

Render database/queries/users/select-first-user.sql from a controller.

Include database/queries/users/select-first-user.sql within a Blade view.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.


All versions of blade-sql-formatter with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
doctrine/sql-formatter Version ^1.1
illuminate/contracts Version ^9.33 | ^10.0 | ^11.0
illuminate/view Version ^9.33 | ^10.0 | ^11.0
spatie/laravel-package-tools Version ^1.9.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sebdesign/blade-sql-formatter contains the following files

Loading the files please wait ....