Download the PHP package ubeeqo/laravel-scout-settings without Composer

On this page you can find all versions of the php package ubeeqo/laravel-scout-settings. 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 laravel-scout-settings

Laravel Scout Settings

Import/Export Algolia settings, synonyms and query rules into your Laravel Scout project.

The easiest way to manage your settings is usually to go to your Algolia dashboard because it has a nice UI and you can test the relevancy directly there.

Once you fine tuned your configuration, you may want to add it to your project.

This package adds two Laravel commands to your project:

This has 3 major advantages:

  1. You can version your configuration with your VCS
  2. You can set up a new environment or restore backups easily
  3. It lets you customize your settings in JSON format before pushing them

Install

Install this package with composer

Laravel 5.5

If you use Laravel 5.5, this package will take advantage of the Package Auto-Discovery feature. Nothing more to do to register the commands.

Laravel 5.4 and prior

If you use an older version of Laravel, you will have to add the Service Provider to the providers array in config/app.php

Usage

You will now get two new commands available in artisan. They both take a model's fully qualified class name, just like Laravel Scout does to import/flush data.

The following example assume you have an App\Contact class, which uses the Searchable trait.

Note: Scout allows you to customize the index name with the searchableAs() method. This package will follow this naming convention.

Backing up settings (Project ⬅️ Algolia)

The following command will export all the settings and synonyms from the App\Contact's index into the following files:

Note that if you want to add the prefix to your file names (which was the default behavior in v1), you can pass the --prefix option.

Pushing settings (Project ➡️ Algolia)

The following command will read all the settings, synonyms and query rules from the files in resources/algolia-settings/ and import them into Algolia's index.

You can also pass the --prefix option, just like the backup command.

Customizing directory

By default, settings, rules and synonyms are saved into the resources/algolia-settings. The directory can be customized by the defining an environment variable named ALGOLIA_SETTINGS_FOLDER. For example, the following command will save all the index resources into resources/indexmeta.

Testing

Need help?

Feel free to open a thread on our Community forum

Contribute

Contributions are welcome!


All versions of laravel-scout-settings with dependencies

PHP Build Version
Package Version
Requires laravel/scout Version ^3.0 || ^4.0
algolia/algoliasearch-client-php Version ^1.25
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 ubeeqo/laravel-scout-settings contains the following files

Loading the files please wait ....