fix

Author: 1batu

README.md

@@ -1 +1,88 @@
-# laravel-model-view-counter
+# Model View Counter
+
+Model View Counter, Laravel modellerinizin görüntülenme sayılarını takip etmenizi sağlayan ve cache yapısı kullanarak performansı optimize eden bir pakettir. Bu paket sayesinde, herhangi bir modelin kaç kez görüntülendiğini kolayca takip edebilir ve analiz edebilirsiniz.
+
+## Özellikler
+
+- **Model Bazlı Görüntülenme Sayacı**: Herhangi bir Laravel modelinin görüntülenme sayısını takip edin.
+- **Cache Desteği**: Görüntülenme sayıları cache’de tutularak performans artırılır.
+- **Kolay Entegrasyon**: Modellerinize basit bir trait ekleyerek hızlıca kullanmaya başlayın.
+- **Event ve Listener**: Laravel’in event sistemi kullanılarak esnek bir yapı sunulur.
+- **Cache Temizleme Komutu**: Cache’i temizlemek için Artisan komutu içerir.
+
+## Kurulum
+
+```json
+"repositories": [
+    {
+        "type": "vcs",
+        "url": "https://github.com/DigitalCoreHub/laravel-model-view-counter.git"
+    }
+],
+```
+
+```bash
+composer require digitalcorehub/laravel-model-view-counter
+php artisan vendor:publish
+php artisan migrate
+```
+
+## Yapılandırma
+
+`config/model-view-counter.php` dosyasında paketinizin ayarlarını yapılandırabilirsiniz:
+
+```php
+return [
+    'models' => [
+        /*
+            Örnek:
+            App\Models\User::class,
+            App\Models\Blog::class,
+        */
+    ],
+    'cache_enabled' => true, // Cache özelliğini etkinleştirmek için
+    'cache_threshold' => 10, // Cache'de birikmesi gereken minimum sayı
+    'cache_key' => 'model_view_counts', // Cache anahtarı
+];
+```
+
+Kullanmak istediğiniz modelleri tanımlamayı unutmayın.
+
+## Kullanım
+
+### Modellerinize Trait’i Ekleyin
+
+```php
+namespace App\Models;
+
+use Illuminate\Foundation\Auth\User as Authenticatable;
+use DigitalCoreHub\LaravelModelViewCounter\Traits\CountableView;
+
+class User extends Authenticatable
+{
+    use CountableView;
+}
+```
+
+### Tetikleyin
+
+```php
+// Modeliniz görüntülendiğinde ModelViewed event’ini tetikleyin.
+Route::get('users/{user:id}', function (User $user) {
+    event(new ModelViewed($user));
+});
+```
+
+### Görüntülenme Sayısını Çekin
+
+```html
+<!-- Görüntülenme sayısını çekin -->
+<h1>{{ $user->name }}</h1>
+<p>Görüntülenme Sayısı: {{ $user->viewCount() }}</p>
+```
+
+### Görüntülenme Sayısını Arttırın
+
+```php
+$user->incrementViewCount();
+```

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "digitalcorehub/laravel-model-view-counter",
-    "description": "//",
+    "description": "A Laravel package to count model views with caching support.",
     "type": "library",
     "license": "MIT",
     "autoload": {

config/model-view-counter.php

@@ -3,12 +3,13 @@
 return [
     'models' => [
         /*
-            Example:
-            App\Models\Post::class,
-            App\Models\Blogs::class,
+        *   Example Models
+        *   App\Models\Post::class,
+        *   App\Models\Blogs::class,
+        *   App\Models\User::class,
         */
     ],
-    'cache_enabled' => true, // To enable caching feature
+    'cache_enabled' => false, // To enable caching feature
     'cache_threshold' => 10, // Minimum count to accumulate in cache
     'cache_key' => 'model_view_counts', // Cache key
 ];

src/Traits/CountableView.php

@@ -24,24 +24,39 @@ protected function incrementViewCountWithCache()
 
         $modelKey = $this->getCacheModelKey();
 
-        // Önceki sayımları al
+        /*
+        *  Önceki sayımları al
+        *  Get previous counts
+        */
         $counts = Cache::get($cacheKey, []);
 
-        // Modelin sayımını artır
+        /*
+        *  Modelin sayımını artır
+        *  Increase the number of models
+        */
         if (isset($counts[$modelKey])) {
             $counts[$modelKey]++;
         } else {
             $counts[$modelKey] = 1;
         }
 
-        // Güncellenmiş sayımları önbelleğe kaydet
+        /*
+        *   Güncellenmiş sayımları önbelleğe kaydet
+        *   Cache updated counts
+        */
         Cache::put($cacheKey, $counts);
 
-        // Eğer eşik değeri aşıldıysa veritabanına kaydet
+        /*
+        *   Eğer eşik değeri aşıldıysa veritabanına kaydet
+        *   If threshold value is exceeded, save to database
+        */
         if ($counts[$modelKey] >= $threshold) {
             $this->persistCountsToDatabase($modelKey, $counts[$modelKey]);
 
-            // Sayımı sıfırla
+            /*
+            *   Sayımı sıfırla
+            *   Reset count
+            */
             $counts[$modelKey] = 0;
             Cache::put($cacheKey, $counts);
         }