eloquent viewable

Dapat Dilihat dengan Fasih

Paket Laravel >= 6.0 ini memungkinkan Anda mengaitkan tampilan dengan model Eloquent.

Setelah terinstal, Anda dapat melakukan hal-hal seperti ini:

 // Return total views count
views ( $ post )-> count ();

// Return total views count that have been made since 20 February 2017
views ( $ post )-> period (Period:: since ( ' 2017-02-20 ' ))-> count ();

// Return total views count that have been made between 2014 and 2016
views ( $ post )-> period (Period:: create ( ' 2014 ' , ' 2016 ' ))-> count ();

// Return total unique views count ( based on visitor cookie )
views ( $ post )-> unique ()-> count ();

// Record a view
views ( $ post )-> record ();

// Record a view with a cooldown
views ( $ post )-> cooldown ( now ()-> addHours ( 2 ))-> record ();

Ringkasan

Terkadang Anda tidak ingin menggunakan layanan pihak ketiga seperti Google Analytics untuk melacak tampilan halaman aplikasi Anda. Maka paket ini akan berguna. Eloquent Viewable memungkinkan Anda dengan mudah mengaitkan tampilan dengan model Eloquent. Ini dirancang dengan mempertimbangkan kesederhanaan.

Paket ini menyimpan setiap rekaman tampilan satu per satu di database. Keuntungannya adalah memungkinkan kita menghitung secara spesifik. Misalnya, jika kita ingin mengetahui berapa banyak orang yang telah melihat postingan tertentu antara 10 Januari dan 17 Februari 2018, kita dapat melakukan hal berikut: views($post)->period(Period::create('10-01-2018', '17-02-2018'))->count(); . Kerugiannya adalah ukuran database Anda dapat berkembang pesat tergantung pada jumlah pengunjung yang dimiliki aplikasi Anda.

Fitur

Berikut beberapa fitur utamanya:

• Kaitkan pandangan dengan model Eloquent
• Dapatkan jumlah penayangan total
• Dapatkan jumlah penayangan dalam periode tertentu
• Dapatkan jumlah penayangan unik
• Dapatkan jumlah penayangan dari tipe yang dapat dilihat (kelas model Eloquent)
• Urutkan yang dapat dilihat berdasarkan tampilan
• Tetapkan cooldown antar tampilan
• Pembungkus cache yang elegan sudah ada di dalamnya
• Abaikan tampilan dari crawler, abaikan alamat IP, atau permintaan dengan header DNT

Dokumentasi

Dalam dokumentasi ini, Anda akan menemukan beberapa informasi bermanfaat tentang penggunaan paket Laravel ini.

Daftar isi

1. Memulai
   • Persyaratan
   • Instalasi
2. Penggunaan
   • Mempersiapkan model Anda
   • Merekam tampilan
   • Mengatur cooldown
   • Mengambil penayangan itu penting
     • Dapatkan jumlah penayangan total
     • Dapatkan jumlah penayangan dalam periode tertentu
     • Dapatkan jumlah penayangan unik total
   • Urutkan model berdasarkan jumlah penayangan
     • Urutkan berdasarkan jumlah penayangan
     • Urutkan berdasarkan jumlah penayangan unik
     • Urutan berdasarkan jumlah penayangan dalam periode yang ditentukan
     • Urutkan berdasarkan jumlah penayangan dalam koleksi yang ditentukan
   • Dapatkan jumlah penayangan dari jenis yang dapat dilihat
   • Lihat koleksi
   • Hapus tampilan saat dihapus
   • Jumlah tampilan cache
3. Mengoptimalkan
   • Indeks basis data
   • cache
4. Memperluas
   • Informasi khusus tentang pengunjung
   • Menggunakan model Views Eloquent Anda sendiri
   • Menggunakan model View Eloquent Anda sendiri
   • Menggunakan detektor perayap khusus
   • Menambahkan makro ke kelas Views

Memulai

Persyaratan

Paket ini membutuhkan PHP 7.4+ dan Laravel 6+ .

Dukungan untuk Lumen tidak dipertahankan.

Informasi versi

Versi	Menerangi	Status	Versi PHP
^7.0	6.xx - 11.xx	Dukungan aktif melalui kontribusi	>= 7.4.0

Instalasi

Pertama, Anda perlu menginstal paket melalui Composer:

composer require cyrildewit/eloquent-viewable

Kedua, Anda dapat mempublikasikan migrasi dengan:

php artisan vendor:publish --provider= " CyrildeWitEloquentViewableEloquentViewableServiceProvider " --tag= " migrations "

Terakhir, Anda perlu menjalankan perintah migrate :

php artisan migrate

Anda secara opsional dapat mempublikasikan file konfigurasi dengan:

php artisan vendor:publish --provider= " CyrildeWitEloquentViewableEloquentViewableServiceProvider " --tag= " config " 

Daftarkan penyedia layanan secara manual

Jika Anda lebih memilih untuk mendaftarkan paket secara manual, Anda dapat menambahkan penyedia berikut ke daftar penyedia aplikasi Anda.

 // config/app.php

' providers ' => [
    // ...
    CyrildeWit  EloquentViewable EloquentViewableServiceProvider::class,
];

Penggunaan

Mempersiapkan model Anda

Untuk mengaitkan tampilan dengan model, model harus mengimplementasikan antarmuka dan sifat berikut:

• Antarmuka: CyrildeWitEloquentViewableContractsViewable
• Sifat: CyrildeWitEloquentViewableInteractsWithViews

Contoh:

 use Illuminate  Database  Eloquent  Model ;
use CyrildeWit  EloquentViewable  InteractsWithViews ;
use CyrildeWit  EloquentViewable  Contracts  Viewable ;

class Post extends Model implements Viewable
{
    use InteractsWithViews;

    // ...
}

Merekam tampilan

Untuk membuat rekaman tampilan, Anda dapat memanggil metode record pada instance Fluent Views .

 views ( $ post )-> record ();

Tempat terbaik di mana Anda harus merekam pandangan pengunjung adalah di dalam pengontrol Anda. Misalnya:

 // PostController . php
public function show ( Post $ post )
{
    views ( $ post )-> record ();

    return view ( ' post.show ' , compact ( ' post ' ));
}

Catatan: Paket ini memfilter crawler secara default. Waspadai hal ini saat melakukan pengujian, karena Tukang Pos misalnya juga merupakan crawler.

Mengatur cooldown

Anda dapat menggunakan metode cooldown pada instance Views untuk menambahkan cooldown di antara rekaman tampilan. Saat Anda menyetel cooldown, Anda perlu menentukan jumlah menitnya.

 views ( $ post )
    -> cooldown ( $ minutes )
    -> record ();

Daripada meneruskan jumlah menit sebagai bilangan bulat, Anda juga dapat meneruskan instance DateTimeInterface .

 $ expiresAt = now ()-> addHours ( 3 );

views ( $ post )
    -> cooldown ( $ expiresAt )
    -> record ();

Bagaimana cara kerjanya

Saat merekam tampilan dengan penundaan sesi, paket ini juga akan menyimpan cuplikan tampilan di sesi pengunjung dengan tanggal kedaluwarsa. Setiap kali pengunjung melihat item itu lagi, paket ini akan memeriksa sesinya dan memutuskan apakah tampilan tersebut harus disimpan dalam database atau tidak.

Mengambil penayangan itu penting

Dapatkan jumlah penayangan total

 views ( $ post )-> count ();

Dapatkan jumlah penayangan dalam periode tertentu

 use CyrildeWit  EloquentViewable  Support  Period ;

// Example : get views count from 2017 upto 2018
views ( $ post )
    -> period (Period:: create ( ' 2017 ' , ' 2018 ' ))
    -> count ();

Kelas Period yang disertakan dengan paket ini menyediakan banyak fitur berguna. API kelas Period terlihat sebagai berikut:

Antara dua waktu tanggal

 $ startDateTime = Carbon:: createFromDate ( 2017 , 4 , 12 );
$ endDateTime = ' 2017-06-12 ' ;

Period:: create ( $ startDateTime , $ endDateTime );

Sejak kencan

Period:: since (Carbon:: create ( 2017 ));

Hingga suatu waktu

Period:: upto (Carbon:: createFromDate ( 2018 , 6 , 1 ));

Sejak masa lalu

Menggunakan Carbon::today() sebagai tanggal waktu mulai dikurangi unit tertentu.

Period:: pastDays (int $ days );
Period:: pastWeeks (int $ weeks );
Period:: pastMonths (int $ months );
Period:: pastYears (int $ years );

Sejak sub

Menggunakan Carbon::now() sebagai tanggal waktu mulai dikurangi unit tertentu.

Period:: subSeconds (int $ seconds );
Period:: subMinutes (int $ minutes );
Period:: subHours (int $ hours );
Period:: subDays (int $ days );
Period:: subWeeks (int $ weeks );
Period:: subMonths (int $ months );
Period:: subYears (int $ years );

Dapatkan jumlah penayangan unik total

Jika Anda hanya ingin mengambil jumlah penayangan unik, Anda cukup menambahkan metode unique ke rantai.

 views ( $ post )
    -> unique ()
    -> count ();

Urutkan model berdasarkan jumlah penayangan

Sifat Viewable menambahkan dua cakupan ke model Anda: orderByViews dan orderByUniqueViews .

Urutkan berdasarkan jumlah penayangan

Post:: orderByViews ()-> get (); // descending
Post:: orderByViews ( ' asc ' )-> get (); // ascending 

Urutkan berdasarkan jumlah penayangan unik

Post:: orderByUniqueViews ()-> get (); // descending
Post:: orderByUniqueViews ( ' asc ' )-> get (); // ascending 

Urutan berdasarkan jumlah penayangan dalam periode yang ditentukan

Post:: orderByViews ( ' asc ' , Period:: pastDays ( 3 ))-> get ();  // descending
Post:: orderByViews ( ' desc ' , Period:: pastDays ( 3 ))-> get (); // ascending

Dan tentu saja, hal ini juga dimungkinkan dengan varian tampilan unik:

Post:: orderByUniqueViews ( ' asc ' , Period:: pastDays ( 3 ))-> get ();  // descending
Post:: orderByUniqueViews ( ' desc ' , Period:: pastDays ( 3 ))-> get (); // ascending 

Urutkan berdasarkan jumlah penayangan dalam koleksi yang ditentukan

Post:: orderByViews ( ' asc ' , null , ' custom-collection ' )-> get ();  // descending
Post:: orderByViews ( ' desc ' , null , ' custom-collection ' )-> get (); // ascending

Post:: orderByUniqueViews ( ' asc ' , null , ' custom-collection ' )-> get ();  // descending
Post:: orderByUniqueViews ( ' desc ' , null , ' custom-collection ' )-> get (); // ascending

Dapatkan jumlah penayangan dari jenis yang dapat dilihat

Jika Anda ingin mengetahui berapa banyak tampilan yang dimiliki tipe tampilan tertentu, Anda perlu meneruskan model Eloquent kosong ke helper views() seperti:

 views ( new Post ())-> count ();

Anda juga dapat memberikan nama kelas yang sepenuhnya memenuhi syarat. Paket tersebut kemudian akan menyelesaikan sebuah instance dari kontainer aplikasi.

 views (Post::class)-> count ();
views ( ' AppPost ' )-> count ();

Lihat koleksi

Jika Anda memiliki tipe tampilan berbeda untuk tipe tampilan yang sama, Anda mungkin ingin menyimpannya dalam koleksinya sendiri.

 views ( $ post )
    -> collection ( ' customCollection ' )
    -> record ();

Untuk mengambil jumlah penayangan dalam koleksi tertentu, Anda dapat menggunakan kembali metode collection() yang sama.

 views ( $ post )
    -> collection ( ' customCollection ' )
    -> count ();

Hapus tampilan saat dihapus

Untuk secara otomatis menghapus semua tampilan model Eloquent yang terlihat saat dihapus, Anda dapat mengaktifkannya dengan mengatur properti removeViewsOnDelete ke true dalam definisi model Anda.

 protected $ removeViewsOnDelete = true ;

Jumlah tampilan cache

Menyimpan jumlah penayangan dalam cache dapat menjadi tantangan dalam beberapa skenario. Misalnya, periodenya bisa dinamis yang membuat caching tidak mungkin dilakukan. Itu sebabnya Anda dapat menggunakan fungsi caching bawaan.

Untuk menyimpan jumlah penayangan dalam cache, cukup tambahkan metode remember() ke rantai. Masa pakai default adalah selamanya.

Contoh:

 views ( $ post )-> remember ()-> count ();
views ( $ post )-> period (Period:: create ( ' 2018-01-24 ' , ' 2018-05-22 ' ))-> remember ()-> count ();
views ( $ post )-> period (Period:: upto ( ' 2018-11-10 ' ))-> unique ()-> remember ()-> count ();
views ( $ post )-> period (Period:: pastMonths ( 2 ))-> remember ()-> count ();
views ( $ post )-> period (Period:: subHours ( 6 ))-> remember ()-> count ();

 // Cache for 3600 seconds
views ( $ post )-> remember ( 3600 )-> count ();

// Cache until the defined DateTime
views ( $ post )-> remember ( now ()-> addWeeks ( 2 ))-> count ();

// Cache forever
views ( $ post )-> remember ()-> count ();

Mengoptimalkan

Indeks basis data

File migrasi tabel views default sudah memiliki dua indeks untuk viewable_id dan viewable_type .

Jika Anda memiliki cukup penyimpanan, Anda dapat menambahkan indeks lain untuk kolom visitor . Bergantung pada jumlah penayangan, hal ini mungkin mempercepat kueri Anda dalam beberapa kasus.

cache

Jumlah penayangan dalam cache dapat berdampak besar pada kinerja aplikasi Anda. Anda dapat membaca dokumentasi tentang caching jumlah penayangan di sini

Menggunakan metode remember() hanya akan menyimpan jumlah tampilan yang dibuat oleh metode count() dalam cache. Cakupan kueri orderByViews dan orderByUnique tidak menggunakan nilai ini karena hanya menambahkan sesuatu ke pembuat kueri. Untuk mengoptimalkan kueri ini, Anda bisa menambahkan kolom tambahan atau beberapa kolom ke tabel database yang dapat dilihat dengan jumlah ini.

Contoh: kita ingin mengurutkan postingan blog kita berdasarkan jumlah penayangan unik . Hal pertama yang mungkin terlintas dalam pikiran Anda adalah menggunakan cakupan kueri orderByUniqueViews .

 $ posts = Post:: latest ()-> orderByUniqueViews ()-> paginate ( 20 );

Kueri ini cukup lambat ketika Anda menyimpan banyak tampilan. Untuk mempercepat, Anda dapat menambahkan misalnya kolom unique_views_count ke tabel posts Anda. Kami harus memperbarui kolom ini secara berkala dengan jumlah penayangan unik. Ini dapat dengan mudah dicapai dengan menggunakan perintah Laravel terjadwal.

Mungkin ada cara yang lebih cepat untuk melakukan ini, tetapi perintahnya bisa seperti:

 $ posts = Post:: all ();

foreach ( $ posts as $ post ) {
    $ post -> unique_views_count = views ( $ post )-> unique ()-> count ();
}

Memperluas

Jika Anda ingin memperluas atau mengganti salah satu kelas inti dengan implementasi Anda sendiri, Anda dapat menggantinya:

• CyrildeWitEloquentViewableViews
• CyrildeWitEloquentViewableView
• CyrildeWitEloquentViewableVisitor
• CyrildeWitEloquentViewableCrawlerDetectAdapter

Catatan: Jangan lupa bahwa semua kelas khusus harus mengimplementasikan antarmuka aslinya

Informasi khusus tentang pengunjung

Kelas Visitor bertanggung jawab untuk menyediakan informasi pembuat Views tentang pengunjung saat ini. Informasi berikut disediakan:

• pengidentifikasi unik (disimpan dalam cookie)
• alamat IP
• periksa header Do No Track
• periksa perayap

Kelas Visitor default mendapatkan informasinya dari permintaan. Oleh karena itu, Anda mungkin mengalami beberapa masalah saat menggunakan pembuat Views melalui RESTful API. Untuk mengatasi ini, Anda perlu memberikan data Anda sendiri tentang pengunjung.

Anda dapat mengganti kelas Visitor secara global atau lokal.

Buat kelas Visitor Anda sendiri

Buat kelas Visitor Anda sendiri di aplikasi Laravel Anda dan implementasikan antarmuka CyrildeWitEloquentViewableContractsVisitor . Buat metode yang diperlukan oleh antarmuka.

Alternatifnya, Anda dapat memperluas kelas Visitor default yang disertakan dengan paket ini.

Secara global

Cukup ikat penerapan Visitor kustom Anda ke kontrak CyrildeWitEloquentViewableContractsVisitor .

 $ this -> app -> bind (
     CyrildeWit  EloquentViewable  Contracts Visitor::class,
     App  Services  Views Visitor::class
);

Secara lokal

Anda juga dapat menyetel instance pengunjung menggunakan metode penyetel useVisitor di pembuat Views .

 use App  Services  Views  Visitor ;

views ( $ post )
    -> useVisitor ( new Visitor ()) // or app ( Visitor::class )
    -> record ();

Menggunakan model Views Eloquent Anda sendiri

Ikat implementasi Views kustom Anda ke CyrildeWitEloquentViewableContractsViews .

Ubah cuplikan kode berikut dan letakkan di metode register di penyedia layanan (misalnya AppServiceProvider ).

 $ this -> app -> bind (
     CyrildeWit  EloquentViewable  Contracts Views::class,
     App  Services  Views Views::class
);

Menggunakan model View Eloquent Anda sendiri

Ikat implementasi View kustom Anda ke CyrildeWitEloquentViewableContractsView .

Ubah cuplikan kode berikut dan letakkan di metode register di penyedia layanan (misalnya AppServiceProvider ).

 $ this -> app -> bind (
     CyrildeWit  EloquentViewable  Contracts View::class,
     App  Models View::class
);

Menggunakan detektor perayap khusus

Ikat penerapan CrawlerDetector khusus Anda ke CyrildeWitEloquentViewableContractsCrawlerDetector .

Ubah cuplikan kode berikut dan letakkan di metode register di penyedia layanan (misalnya AppServiceProvider ).

 $ this -> app -> singleton (
     CyrildeWit  EloquentViewable  Contracts CrawlerDetector::class,
     App  Services  Views CustomCrawlerDetectorAdapter::class
);

Menambahkan makro ke kelas Views

 use CyrildeWit  EloquentViewable  Views ;

Views:: macro ( ' countAndRemember ' , function () {
    return $ this -> remember ()-> count ();
});

Sekarang Anda dapat menggunakan singkatan ini seperti ini:

 views ( $ post )-> countAndRemember ();

Views:: forViewable ( $ post )-> countAndRemember ();

Perbaikan

Silakan lihat PENINGKATAN untuk panduan peningkatan terperinci.

log perubahan

Silakan lihat CHANGELOG untuk informasi lebih lanjut tentang apa yang berubah baru-baru ini.

Berkontribusi

Silakan lihat KONTRIBUSI untuk rinciannya.

Kredit

• Cyril de Wit - Karya awal - cyrildewit

Lihat juga daftar kontributor yang berpartisipasi dalam proyek ini.

Sumber Daya Bermanfaat:

• Mengimplementasikan Penghitung Tampilan Halaman Di Laravel - Stidges

Alternatif

• antonioribeiro/pelacak
• foothing/laravel-simple-pageviews
• kunjungan awssat/laravel
• Kryptonit3/Penghitung
• fraank/ViewCounter

Jangan ragu untuk menambahkan lebih banyak alternatif!

Lisensi

Proyek ini dilisensikan di bawah Lisensi MIT - lihat file LISENSI untuk detailnya.