4
4
5
5
## What it does
6
6
7
- This library allows you
7
+ This library allows you
8
8
9
- 1 . To get url seeds from search engine api (Google)
10
- 2 . Get code snippets from any web page by crawling url seeds.
9
+ 1 . To get code snippets using search engine api (Google)
10
+ 2 . To get code snippets from any web page by crawling url seeds.
11
11
12
12
## How to use it
13
13
@@ -101,7 +101,7 @@ $urlSeeds = GoogleProvider::create($config)->fetch($query, $meta);
101
101
2 . Create your new class in the ` Snippetify\SnippetSniffer\Providers ` folder
102
102
3 . Each provider implements ` Snippetify\SnippetSniffer\Providers\ProviderInterface `
103
103
4 . Take a look at ` Snippetify\SnippetSniffer\Providers\GoogleProvider ` to get you helped
104
- 5 . Your fetch method must return an array of ` GuzzleHttp\Psr7\Uri `
104
+ 5 . Your fetch method must return an array of ` Psr\Http\Message\UriInterface `
105
105
6 . Add it in the providers stacks in the ` Snippetify\SnippetSniffer\Core.php `
106
106
7 . Write tests. Take a look at ` Snippetify\SnippetSniffer\Tests\Providers\GoogleProviderTest ` to get you helped
107
107
8 . Send a pull request to us
@@ -110,7 +110,7 @@ $urlSeeds = GoogleProvider::create($config)->fetch($query, $meta);
110
110
111
111
1 . Your provider must implement ` Snippetify\SnippetSniffer\Providers\ProviderInterface `
112
112
2 . Take a look at ` Snippetify\SnippetSniffer\Providers\GoogleProvider ` to get you helped
113
- 3 . Your fetch method must return an array of ` GuzzleHttp\Psr7\Uri `
113
+ 3 . Your fetch method must return an array of ` Psr\Http\Message\UriInterface `
114
114
4 . Pass your new provider in the configuration parameter or use the ` addProvider ` method
115
115
116
116
``` php
@@ -119,15 +119,15 @@ use Snippetify\SnippetSniffer\SnippetSniffer;
119
119
// Use Configurations
120
120
$config = [
121
121
"providers" => [
122
- "provider_name" => " ProviderClass::class" ,
123
- "provider_2_name" => " Provider2Class::class" // You can add as many as you want
122
+ "provider_name" => ProviderClass::class,
123
+ "provider_2_name" => Provider2Class::class // You can add as many as you want
124
124
]
125
125
];
126
126
127
127
// Or use addProvider method as follow
128
128
SnippetSniffer::create(...)
129
- ->addProvider('provider_name', ' ProviderClass::class' )
130
- ->addProvider('provider_2_name', ' Provider2Class::class' ) // You can add as many as you want
129
+ ->addProvider('provider_name', ProviderClass::class)
130
+ ->addProvider('provider_2_name', Provider2Class::class) // You can add as many as you want
131
131
...
132
132
```
133
133
@@ -189,21 +189,21 @@ use Snippetify\SnippetSniffer\SnippetSniffer;
189
189
// Configurations
190
190
$config = [
191
191
"scrapers" => [
192
- "scraper_name" => " ScraperClass::class" ,
193
- "scraper_2_name" => " Scraper2Class::class" // You can add as many as you want
192
+ "scraper_name" => ScraperClass::class,
193
+ "scraper_2_name" => Scraper2Class::class // You can add as many as you want
194
194
]
195
195
];
196
196
197
197
// Or use addProvider method as follow
198
198
SnippetSniffer::create(...)
199
- ->addScraper('scraper_name', ' ScraperClass::class' )
200
- ->addScraper('scraper_2_name', ' Scraper2Class::class' ) // You can add as many as you want
199
+ ->addScraper('scraper_name', ScraperClass::class)
200
+ ->addScraper('scraper_2_name', Scraper2Class::class) // You can add as many as you want
201
201
...
202
202
```
203
203
204
- ### Sniptbot
204
+ ### Snippet crawler
205
205
206
- Sniptbot allows you to extract all snippets from a website by crawling it.
206
+ Snippet crawler allows you to extract all snippets from a website by crawling it.
207
207
208
208
``` php
209
209
use Snippetify\SnippetSniffer\WebCrawler;
@@ -215,14 +215,13 @@ $config = [...];
215
215
$snippets = WebCrawler::create($config)->fetch(['your uri']);
216
216
```
217
217
218
-
219
-
220
218
#### Configuration reference
221
219
222
220
``` php
223
221
$config = [
224
222
// Required
225
223
// Search engine api configuration keys
224
+ // https://developers.google.com/custom-search/v1/introduction
226
225
'provider' => [
227
226
"cx" => "your google Search engine ID",
228
227
"key" => "your google API key"
0 commit comments