Download the PHP package symkit/search-bundle without Composer

On this page you can find all versions of the php package symkit/search-bundle. 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 symkit/search-bundle

Informations about the package search-bundle

Search Bundle

CI Latest Version PHPStan Level 9

A modern, memory-efficient global search bundle for Symfony applications. Supports multiple named search engines, each with its own providers (or shared providers), and includes a ready-to-use UI built with Symfony UX Live Components and Tailwind CSS.

Features

Requirements

Required for the UI component

The UI is optional. The search API works without any of the above.

Installation

Install optional dependencies for the UI:

Configure Assets (ImportMap)

Register the Stimulus controller in your importmap.php:

Tailwind CSS Integration

Add the bundle's templates to your Tailwind scan:

Configuration

Single engine (default)

With no configuration, a single default engine is created with UI enabled:

Multiple engines

Define named engines, each with its own ui toggle:

Usage

1. Create a Search Provider

Implement SearchProviderInterface and use the #[AsSearchProvider] attribute to assign it to an engine.

Shared provider (all engines):

Engine-specific provider:

Via YAML tags (alternative to the attribute):

Without the engine attribute, a provider is registered in all engines.

2. Add the UI Component

Include the GlobalSearch Live Component in your Twig layout:

The component handles:

3. Use the Search API Directly

Inject the default engine or the registry:

4. Listen to Search Events

Hook into the search lifecycle with PreSearchEvent and PostSearchEvent:

PreSearchEvent lets you modify or cancel the query before providers are called. PostSearchEvent lets you filter, reorder, or enrich the results.

Architecture

Advanced Customization

Search Result Model

Parameter Type Description
title string The main text displayed for the result.
subtitle string Secondary information (e.g., path, category).
url string The destination link when clicked.
icon string ux_icon identifier (e.g., heroicons:photo).
badge ?string Optional badge text (e.g., status).

Overriding Templates

Customize the search modal UI by creating:

Dedicated Exceptions

The bundle throws EngineNotFoundException (extends InvalidArgumentException) when requesting an unknown engine, making it easy to catch bundle-specific errors.

Contributing

All versions of search-bundle with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
symfony/config Version ^7.0 || ^8.0
symfony/dependency-injection Version ^7.0 || ^8.0
symfony/framework-bundle Version ^7.0 || ^8.0
symfony/http-kernel Version ^7.0 || ^8.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 symkit/search-bundle contains the following files

Loading the files please wait ...