laravel google custom search engine

#Laravel Paket Laravel Google Custom Search Engine untuk mendapatkan hasil Google Custom Search dari Google Custom Search Engine API untuk versi gratis dan berbayar.

Sejarah singkat

Saat Swiftype menutup paket gratisnya, saya mulai mencari alternatif tanpa terlalu banyak pengkodean, tetapi tidak berhasil. Yang terbaik yang saya temukan adalah paket Google Penelusuran Spatie untuk versi berbayar Google CSE, jadi saya melakukan riset dan mengembangkan paket dengan cara yang serupa, tetapi independen terhadap versi Google CSE.

Kopi untuk pengembang

Jika Anda menyukai proyek ini, Anda dapat membelikan saya kopi untuk membantu saya menjadi segar. :) https://ko-fi.com/A067ES5

Instalasi

1/ Instal dengan Komposer

composer require jan-drda/laravel-google-custom-search-engine

2/ Tambahkan penyedia layanan ke config/app.php

 ' providers ' => [
    ' ... ' ,
    ' JanDrdaLaravelGoogleCustomSearchEngineLaravelGoogleCustomSearchEngineProvider '
];

3/ Tambahkan alias untuk Fasad ke config/app.php

 ' aliases ' => [
	...
	' GoogleCseSearch ' => ' JanDrdaLaravelGoogleCustomSearchEngineFacadesLaravelGoogleCustomSearchEngineProvider ' ,
	...
]

4/ Publikasikan file konfigurasi

php artisan vendor:publish --provider= " JanDrdaLaravelGoogleCustomSearchEngineLaravelGoogleCustomSearchEngineProvider " 

Konfigurasi

Membuat mesin pencari khusus Anda

1. Jika Anda membuat mesin di https://cse.google.com/cse/ Anda akan menemukan ID setelah mengeklik Pengaturan
2. Cukup periksa URL yang Anda miliki seperti https://cse.google.com/cse/setup/basic?cx=search_engine_id dan string setelah cx= adalah ID mesin pencari Anda

!! Perhatian !! Jika Anda mengubah gaya mesin pencari Kustom Anda, ID dapat diubah

Dapatkan kunci API Anda

1. buka https://console.developers.google.com, lalu
2. klik menu di sebelah kanan logo GoogleAPI dan klik 'Buat proyek'
3. masukkan nama proyek baru - terserah Anda, Anda dapat menggunakan 'Google CSE'
4. tunggu sampai proyek dibuat - indikatornya adalah lingkaran warna di sudut kanan atas di sekitar ikon lonceng
5. Daftar API ditampilkan - cari 'Google Custom Search API' dan klik di atasnya
6. klik ikon 'Aktifkan' di sisi kanan judul API Penelusuran Khusus
7. klik 'Kredensial' di menu sebelah kiri di bawah bagian 'Perpustakaan'
8. klik 'Buat kredensial' dan pilih 'Kunci API'
9. kunci API Anda ditampilkan, jadi salin dan tempel di sini

Simpan nilai konfigurasi

Simpan ID mesin pencari dan ID api di config/laravelGoogleCustomSearchEngine.php Anda

Penggunaan

Penggunaan sederhana

Buat objek dan panggil fungsi getResults untuk mendapatkan 10 hasil pertama

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 

Jangan lupa untuk memetakan namespace, sehingga pengontrol sampel akan terlihat seperti ini (minimal)

Ini hanya contoh nama pengontrol, Anda dapat menggunakan apa pun yang Anda inginkan, ini adalah pemberitahuan terutama untuk pemula di Laravel

 namespace App  Http  Controllers ;

use App  Http  Controllers  Controller ;
use JanDrda  LaravelGoogleCustomSearchEngine  LaravelGoogleCustomSearchEngine ;

class GoogleSearchController extends Controller
{

  public function index (){
    $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
    $ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 
  }
}

Anda juga bisa mendapatkan informasi tentang pencarian seperti total catatan dan waktu pencarian

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 
$ info = $ fulltext -> getSearchInformation (); // get search information

Penggunaan tingkat lanjut

Anda dapat menggunakan parameter apa pun yang didukung di Google. Daftar parameter ada di sini: https://developers.google.com/custom-search/json-api/v1/reference/cse/list#parameters

Misalnya Anda ingin mendapatkan 10 hasil berikutnya

 $ parameters = array (
    ' start ' => 10 // start from the 10 th results,
    ' num ' => 10 // number of results to get, 10 is maximum and also default value
)

$ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' , $ parameters ); // get second 10 results for query 'some phrase'

Anda juga bisa mendapatkan hasil mentahnya dari Google termasuk informasi lainnya. Daftar lengkap variabel respons tersedia di sini: https://developers.google.com/custom-search/json-api/v1/reference/cse/list#response

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results = $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase'
$ rawResults = $ fulltext -> getRawResults (); // get complete response from Google

Untuk mendapatkan jumlah hasil gunakan saja

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize
$ results =  $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase'
$ noOfResults = $ fulltext -> getTotalNumberOfResults (); // get total number of results (it can be less than 10)

Jika Anda memiliki lebih banyak mesin/kunci api lebih banyak, Anda dapat mengganti variabel konfigurasi dengan fungsi berikut

 $ fulltext = new LaravelGoogleCustomSearchEngine (); // initialize

$ fulltext -> setEngineId ( ' someEngineId ' ); // sets the engine ID
$ fulltext -> setApiKey ( ' someApiId ' ); // sets the API key

$ results =  $ fulltext -> getResults ( ' some phrase ' ); // get first 10 results for query 'some phrase' 

Dokumentasi

Dokumentasi penting akan ada di Github Wiki. Sekarang sedang dalam pengembangan.

Lisensi

Paket ini adalah perangkat lunak sumber terbuka yang dilisensikan di bawah lisensi MIT

Tentang

Saya seorang konsultan perangkat lunak senior independen yang tinggal di Republik Ceko dalam bisnis TI sejak tahun 1997.