Initial Revision

Author: vpominchuk

.gitignore

@@ -1,6 +1,2 @@
-composer.phar
-/vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+/vendor
+/.idea

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Vasyl
+Copyright (c) 2021 F9 Web Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,57 @@
-# laravel-mysql-use-index-scope
-A super simple package allowing for use MySQL 'USE INDEX' and 'FORCE INDEX' statements.
+![](https://banners.beyondco.de/Laravel%20MySQL%20USE%20INDEX%20Model%20Scope.png?theme=light&packageManager=composer+require&packageName=vpominchuk%2Flaravel-mysql-use-index-scope&pattern=texture&style=style_1&description=Allowing+for+use+MySQL+USE+INDEX+and+FORCE+INDEX+statements&md=1&showWatermark=0&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg)
+# Laravel MySQL Use Index Scope
+A super simple package allowing for use MySQL `USE INDEX` and `FORCE INDEX` statements.
+
+## Requirements
+- PHP `^7.4 | ^8.0`
+- Laravel 6, 7 and 8
+
+## Installation
+
+`composer require vpominchuk/laravel-mysql-use-index-scope`
+
+## Usage
+Simply reference the required trait in your model:
+
+### Model:
+```php
+    use VPominchuk\ModelUseIndex;
+    
+    class MyModel extends Model
+    {
+        use ModelUseIndex;
+    }
+```
+
+### Anywhere in the code:
+```php
+    $builder = MyModel::where('name', $name)->where('age', $age)->
+        useIndex($indexName)->...
+```
+
+### Database table structure:
+You need to create a named index with required name. For example:
+
+Laravel Migration:
+```php
+    $table->index(['name', 'age'], 'user_age_index');
+```
+## Available methods
+#### `useIndex($indexName)`
+Tells MySQL to use an index if it possible.
+
+#### `forceIndex($indexName)`
+Force MySQL to use an index if it possible.
+
+## Security
+
+If you discover any security related issues, please use the issue tracker.
+
+## Credits
+
+- [Vasyl Pominchuk](https://github.com/vpominchuk)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
+

composer.json

@@ -0,0 +1,34 @@
+{
+  "name": "vpominchuk/laravel-mysql-use-index-scope",
+  "description": "A super simple package allowing for use MySQL `USE INDEX` and `FORCE INDEX` statements",
+  "keywords": [
+    "laravel",
+    "laravel mysql",
+    "laravel mysql use index",
+    "laravel mysql force index",
+  ],
+  "homepage": "https://github.com/vpominchuk/laravel-mysql-use-index-scope",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Vasyl Pominchuk",
+      "email": "vpominchuk@gmail.com",
+      "homepage": "https://pominchuk.com",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "php": "^7.4 | ^8.0",
+    "illuminate/support": "^6.0|^7.0|^8.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "VPominchuk\\": "src"
+    }
+  },
+  "config": {
+    "sort-packages": true
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true
+}

src/ModelUseIndex.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace VPominchuk;
+
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Facades\DB;
+
+/**
+ * @method Builder useIndex(string $index)
+ * @method Builder forceIndex(string $index)
+ *
+ */
+trait ModelUseIndex
+{
+    public function scopeUseIndex($query, string $index): Builder
+    {
+        $table = $this->getTable();
+        return $query->from(DB::raw("`$table` USE INDEX(`$index`)"));
+    }
+
+    public function scopeForceIndex($query, string $index): Builder
+    {
+        $table = $this->getTable();
+        return $query->from(DB::raw("`$table` FORCE INDEX(`$index`)"));
+    }
+}