README.md

Get searchresults from a Google Custom Search Engine

This package can fetch results for the paid version of a Google Custom Search Engine. It returns an array with searchresults. You'll need to know how to set up a Google Custom Search Engine.

Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Laravel compatibility

Laravel	googlesearch
4.2.x	1.x
5.x	2.x

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

The best postcards will get published on the open source page on our website.

Installation

This package can be installed through Composer.

composer require spatie/googlesearch

When using Laravel there is a service provider that you can make use of.

// Laravel 5: config/app.php

'providers' => [
    '...',
    'Spatie\GoogleSearch\GoogleSearchServiceProvider'
];

GoogleSearch also comes with a facade, which provides an easy way to call the the class.

// Laravel 5: config/app.php

'aliases' => [
	...
	'GoogleSearch' => 'Spatie\GoogleSearch\Facades\GoogleSearch',
	...
]

You can publish the config file of the package using artisan

php artisan vendor:publish --provider="Spatie\GoogleSearch\GoogleSearchServiceProvider"

This command creates a file within your config directory in which you can specify the id of the Custom Search Engine you want to use.

Usage

Here is a sample call to get search results:

/* 
  This function returns an array with keys
  
  "name"     // the name of the found page
  "url"      // the url of the found page
  "snippet"  // a little piece of text found on the page
*/

$searchResults = GoogleSearch::getResults('The meaning of life'); // is 42

When no results are found an empty array is returned.

##About Spatie Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.