<?php
namespace Laravel\Scout\Console;
use Exception;
use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Str;
use Laravel\Scout\EngineManager;
use Symfony\Component\Console\Attribute\AsCommand;
#[AsCommand(name: 'scout:sync-index-settings')]
class SyncIndexSettingsCommand extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'scout:sync-index-settings';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Sync your configured index settings with your search engine (Meilisearch)';
/**
* Execute the console command.
*
* @param \Laravel\Scout\EngineManager $manager
* @return void
*/
public function handle(EngineManager $manager)
{
$engine = $manager->engine();
$driver = config('scout.driver');
if (! method_exists($engine, 'updateIndexSettings')) {
return $this->error('The "'.$driver.'" engine does not support updating index settings.');
}
try {
$indexes = (array) config('scout.'.$driver.'.index-settings', []);
if (count($indexes)) {
foreach ($indexes as $name => $settings) {
if (! is_array($settings)) {
$name = $settings;
$settings = [];
}
if (class_exists($name)) {
$model = new $name;
}
if (isset($model) &&
config('scout.soft_delete', false) &&
in_array(SoftDeletes::class, class_uses_recursive($model))) {
$settings['filterableAttributes'][] = '__soft_deleted';
}
$engine->updateIndexSettings($indexName = $this->indexName($name), $settings);
$this->info('Settings for the ['.$indexName.'] index synced successfully.');
}
} else {
$this->info('No index settings found for the "'.$driver.'" engine.');
}
} catch (Exception $exception) {
$this->error($exception->getMessage());
}
}
/**
* Get the fully-qualified index name for the given index.
*
* @param string $name
* @return string
*/
protected function indexName($name)
{
if (class_exists($name)) {
return (new $name)->searchableAs();
}
$prefix = config('scout.prefix');
return ! Str::startsWith($name, $prefix) ? $prefix.$name : $name;
}
}