In modern web applications, implementing robust search functionality is crucial. While Laravel provides built-in search capabilities, complex applications often require more sophisticated solutions. This guide will walk you through integrating Apache Solr with Laravel using the Solarium package to create a powerful search system.<\/p>\n
Laravel’s built-in search capabilities work well for basic needs, but Solr offers several advantages:<\/p>\n
<\/p>\n# Download Solr\r\nwget https:\/\/downloads.apache.org\/lucene\/solr\/8.11.2\/solr-8.11.2.tgz\r\ntar xzf solr-8.11.2.tgz\r\ncd solr-8.11.2\r\n\r\n# Start Solr\r\nbin\/solr start\r\n\r\n# Create a new core\r\nbin\/solr create -c articles<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\nStep 2: Creating a New Laravel Project<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\ncomposer create-project laravel\/laravel laravel-solr-demo\r\ncd laravel-solr-demo<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
Step 3: Installing Required Packages<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\ncomposer require solarium\/solarium<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\nImplementation Guide<\/h2>\nStep 1: Setting Up the Service Provider<\/h3>\n
Create a new service provider to manage the Solr client:<\/p>\n
\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\nphp artisan make:provider SolrServiceProvider<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
Add the following configuration:<\/p>\n
\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\nnamespace App\\Providers; \r\nuse Illuminate\\Support\\ServiceProvider; \r\nuse Solarium\\Client; \r\nuse Solarium\\Core\\Client\\Adapter\\Curl; \r\nuse Symfony\\Component\\EventDispatcher\\EventDispatcher; \r\nclass SolrServiceProvider extends ServiceProvider { \r\n public function register() { \r\n $this->app->singleton(Client::class, function($app) { \r\n $adapter = new Curl(); $eventDispatcher = new EventDispatcher(); \r\n return new Client($adapter, $eventDispatcher, \r\n [ \r\n 'endpoint' => [ 'localhost' => \r\n [ \r\n 'host' => env('SOLR_HOST', '127.0.0.1'), \r\n 'port' => env('SOLR_PORT', '8983'), \r\n 'path' => env('SOLR_PATH', '\/solr\/'), \r\n 'core' => env('SOLR_CORE', 'articles') \r\n ] \r\n ]\r\n ]); \r\n }); \r\n } \r\n}<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\nStep 2: Creating the Solr Service<\/h3>\n
This service will handle all Solr operations:<\/p>\n
\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\nnamespace App\\Services;\r\n\r\nuse Solarium\\Client;\r\nuse App\\Models\\Article;\r\n\r\nclass SolrService\r\n{\r\n protected $client;\r\n\r\n public function __construct(Client $client)\r\n {\r\n $this->client = $client;\r\n }\r\n\r\n public function indexArticle(Article $article)\r\n {\r\n $update = $this->client->createUpdate();\r\n $doc = $update->createDocument();\r\n \r\n $doc->id = $article->id;\r\n $doc->title = $article->title;\r\n $doc->content = $article->content;\r\n $doc->author = $article->author;\r\n $doc->category = $article->category;\r\n $doc->tags = $article->tags;\r\n $doc->published_at = $article->published_at->format('Y-m-d\\TH:i:s\\Z');\r\n \r\n $update->addDocument($doc);\r\n $update->addCommit();\r\n \r\n return $this->client->update($update);\r\n }\r\n\r\n public function search(string $query, array $filters = [], int $page = 1, int $perPage = 10)\r\n {\r\n $select = $this->client->createSelect();\r\n \r\n \/\/ Set basic query\r\n if (!empty($query)) {\r\n $select->setQuery($query);\r\n }\r\n\r\n \/\/ Add filters\r\n if (!empty($filters)) {\r\n $filterQuery = $select->createFilterQuery('filters');\r\n $filterQueries = [];\r\n \r\n foreach ($filters as $field => $value) {\r\n if (!empty($value)) {\r\n $filterQueries[] = \"$field:\\\"$value\\\"\";\r\n }\r\n }\r\n \r\n if (!empty($filterQueries)) {\r\n $filterQuery->setQuery(implode(' AND ', $filterQueries));\r\n }\r\n }\r\n\r\n \/\/ Add faceting\r\n $facetSet = $select->getFacetSet();\r\n $facetSet->createFacetField('category')->setField('category');\r\n $facetSet->createFacetField('author')->setField('author');\r\n\r\n \/\/ Set pagination\r\n $select->setStart(($page - 1) * $perPage)->setRows($perPage);\r\n\r\n \/\/ Execute query\r\n $result = $this->client->select($select);\r\n \r\n return [\r\n 'total' => $result->getNumFound(),\r\n 'documents' => array_map(function($doc) {\r\n return [\r\n 'id' => $doc->id,\r\n 'title' => $doc->title,\r\n 'content' => $doc->content,\r\n 'author' => $doc->author,\r\n 'category' => $doc->category,\r\n 'published_at' => $doc->published_at\r\n ];\r\n }, $result->getDocuments()),\r\n 'facets' => [\r\n 'category' => $result->getFacetSet()->getFacet('category')->getValues(),\r\n 'author' => $result->getFacetSet()->getFacet('author')->getValues(),\r\n ]\r\n ];\r\n }\r\n\r\n public function suggest(string $query)\r\n {\r\n $suggester = $this->client->createSuggester();\r\n $suggester->setDictionary('suggest');\r\n $suggester->setQuery($query);\r\n $suggester->setCount(5);\r\n \r\n $result = $this->client->suggester($suggester);\r\n \r\n return $result->getAllSuggestions();\r\n }\r\n\r\n public function deleteFromIndex($id)\r\n {\r\n $update = $this->client->createUpdate();\r\n $update->addDeleteById($id);\r\n $update->addCommit();\r\n \r\n return $this->client->update($update);\r\n }\r\n}<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\nStep 3: Setting Up the Model<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\nnamespace App\\Models;\r\n\r\nuse Illuminate\\Database\\Eloquent\\Model;\r\n\r\nclass Article extends Model\r\n{\r\n protected $fillable = [\r\n 'title',\r\n 'content',\r\n 'author',\r\n 'category',\r\n 'tags',\r\n 'published_at'\r\n ];\r\n\r\n protected $casts = [\r\n 'published_at' => 'datetime',\r\n 'tags' => 'array'\r\n ];\r\n}<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\nStep 4: Creating the Search Controller<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\nnamespace App\\Http\\Controllers;\r\n\r\nuse App\\Services\\SolrService;\r\nuse Illuminate\\Http\\Request;\r\n\r\nclass SearchController extends Controller\r\n{\r\n protected $solrService;\r\n\r\n public function __construct(SolrService $solrService)\r\n {\r\n $this->solrService = $solrService;\r\n }\r\n\r\n public function search(Request $request)\r\n {\r\n $validated = $request->validate([\r\n 'q' => 'nullable|string',\r\n 'category' => 'nullable|string',\r\n 'author' => 'nullable|string',\r\n 'page' => 'nullable|integer|min:1',\r\n ]);\r\n\r\n $results = $this->solrService->search(\r\n $validated['q'] ?? '*:*',\r\n array_filter([\r\n 'category' => $validated['category'] ?? null,\r\n 'author' => $validated['author'] ?? null,\r\n ]),\r\n $validated['page'] ?? 1\r\n );\r\n\r\n return response()->json($results);\r\n }\r\n\r\n public function suggest(Request $request)\r\n {\r\n $validated = $request->validate([\r\n 'q' => 'required|string|min:2'\r\n ]);\r\n\r\n $suggestions = $this->solrService->suggest($validated['q']);\r\n \r\n return response()->json($suggestions);\r\n }\r\n}<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
<\/pre>\nKey Features Implementation<\/h2>\n1. Basic Search<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\npublic function search(string $query)\r\n{\r\n $select = $this->client->createSelect();\r\n $select->setQuery($query);\r\n return $this->client->select($select);\r\n}<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
<\/pre>\n
\n2. Faceted Search<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\n$facetSet = $select->getFacetSet();\r\n$facetSet->createFacetField('category')->setField('category');\r\n$facetSet->createFacetField('author')->setField('author');<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\n3. Filtered Search<\/h3>\n\n\t\t\t\n \n \n <\/div>\n <\/div>\n <\/div>\n <\/div>\n \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n <\/p>\n$filterQuery = $select->createFilterQuery('filters');\r\n$filterQuery->setQuery(\"category:\\\"$category\\\"\");<\/pre>\n<\/code><\/pre>\n\t\t\t<\/div>\n <\/div>\n
\nConfiguration<\/h2>\nEnvironment Setup<\/h3>\n
Add these variables to your .env<\/code> file:<\/p>\n\n\t\t\t\n \n \n <\/div>\n