Download the PHP package lokiwich/scramble-spatie-query-builder without Composer

On this page you can find all versions of the php package lokiwich/scramble-spatie-query-builder. 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?

Example code of lokiwich/scramble-spatie-query-builder

Informations about the package scramble-spatie-query-builder

ScrambleSpatieQueryBuilder

Latest Version on Packagist Total Downloads

Automatically document Spatie Laravel Query Builder filters, sorts, includes, and fields in Dedoc Scramble OpenAPI docs.

No PHPDoc annotations required — the package inspects your controller code and registers Scramble extensions automatically.

Requirements

Installation

The service provider auto-registers four Scramble operation transformers. You do not need to add anything to config/scramble.php.

Usage

Use Spatie Query Builder in your controllers as usual:

Scramble will document query parameters using names from config/query-builder.php (filter, sort, include, fields). When scramble.flatten_deep_query_parameters is true (default), filters and fields use bracket notation (filter[name], fields[users]).

Filter parameters are documented only when you call allowedFilters() explicitly, matching Spatie's filtering rules. Supported definitions include variadic strings, arrays, AllowedFilter::partial / exact / beginsWith / endsWith / operator / scope / belongsTo / callback / custom / trashed, filter aliases, groupOr / groupAnd, and chained ignore(), nullable(), and default().

Customization

Hook into any extension before parameters are added:

Return true from the hook to prevent the parameter from being added.

Testing

Tests use Orchestra Testbench and Scramble's Generator directly — no host application required.

License

MIT © lokiwich

All versions of scramble-spatie-query-builder with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
dedoc/scramble Version ^0.13
illuminate/support Version ^12.0|^13.0
spatie/laravel-query-builder Version ^7.0
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 lokiwich/scramble-spatie-query-builder contains the following files

Loading the files please wait ...