feat: add support of settings to ExtractorFactory

Author: Dominik Jansen

README.md

@@ -324,18 +324,22 @@ $client->setSettings([
 $embed = new Embed(new Crawler($client));
 ```
 
-If you need to pass settings to your detectors, you can use the `setSettings` method:
+If you need to pass settings to your detectors, you can add settings to the `ExtractorFactory`:
 
 ```php
-//Create the extractor
-$info = $embed->get($url);
+use Embed\Embed;
+use Embed\ExtractorFactory;
 
-$info->setSettings([
+$embed = new Embed();
+$extractorFactory = new ExtractorFactory([
     'oembed:query_parameters' => [],  //Extra parameters send to oembed
     'twitch:parent' => 'example.com', //Required to embed twitch videos as iframe
     'facebook:token' => '1234|5678',  //Required to embed content from Facebook
     'instagram:token' => '1234|5678', //Required to embed content from Instagram
 ]);
+$embed->setExtractorFactory($extractorFactory);
+
+$info = $embed->get($url);
 ```
 
 Note: The built-in detectors does not require settings. This feature is only for convenience if you create a specific detector that requires settings.

demo/index.php

@@ -6,15 +6,16 @@
 
 function getUrl(): ?string
 {
-    $url = $_GET['url'] ?? null;
+    $skipParams = ['url', 'instagram_token', 'facebook_token'];
+    $url = getParam('url');
 
-    if (empty($url)) {
+    if (!$url) {
         return null;
     }
 
     //fix for unescaped urls
     foreach ($_GET as $name => $value) {
-        if ($name === 'url') {
+        if (in_array($name, $skipParams, true)) {
             continue;
         }
 
@@ -24,6 +25,10 @@ function getUrl(): ?string
     return $url;
 }
 
+function getParam(string $paramName): ?string {
+    return $_GET[$paramName] ?? null;
+}
+
 function getEscapedUrl(): ?string
 {
     $url = getUrl();
@@ -120,7 +125,6 @@ function printCode(?string $code, bool $asHtml = true): void
     'cms' => 'printText',
     'language' => 'printText',
     'languages' => 'printArray',
-    'cms' => 'printText',
 ];
 ?>
 
@@ -173,6 +177,14 @@ function printCode(?string $code, bool $asHtml = true): void
                     <span>Url to test:</span>
                     <input type="url" name="url" autofocus placeholder="http://" value="<?php echo getEscapedUrl(); ?>">
                 </label>
+                <label>
+                    <span>Instagram Token:</span>
+                    <input type="text" name="instagram_token" placeholder="1234|5678" value="<?php echo getParam('instagram_token'); ?>">
+                </label>
+                <label>
+                    <span>Facebook Token:</span>
+                    <input type="text" name="facebook_token" placeholder="1234|5678" value="<?php echo getParam('facebook_token') ?>">
+                </label>
             </fieldset>
 
             <fieldset class="action">
@@ -193,10 +205,16 @@ function printCode(?string $code, bool $asHtml = true): void
                     'Accept-Language' => 'en-US,en;q=0.2',
                     'Cache-Control' => 'max-age=0,no-cache',
                 ]);
+
+                $extractorFactory = new \Embed\ExtractorFactory(
+                    [
+                        'twitch:parent' => $_SERVER['SERVER_NAME'] === 'localhost' ? null : $_SERVER['SERVER_NAME'],
+                        'instagram:token' => getParam('instagram_token'),
+                        'facebook:token' => getParam('facebook_token'),
+                    ]
+                );
+                $embed->setExtractorFactory($extractorFactory);
                 $info = $embed->get(getUrl());
-                $info->setSettings([
-                    'twitch:parent' => $_SERVER['SERVER_NAME'] === 'localhost' ? null : $_SERVER['SERVER_NAME'],
-                ]);
             } catch (Exception $exception) {
                 echo '<pre>';
                 echo $exception;

src/Embed.php

@@ -81,4 +81,9 @@ private function mustRedirect(Extractor $extractor): bool
 
         return $extractor->redirect !== null;
     }
+
+    public function setExtractorFactory(ExtractorFactory $extractorFactory): void
+    {
+        $this->extractorFactory = $extractorFactory;
+    }
 }

src/ExtractorFactory.php

@@ -33,6 +33,12 @@ class ExtractorFactory
         'twitch.tv' => Adapters\Twitch\Extractor::class,
     ];
     private array $customDetectors = [];
+    private array $settings;
+
+    public function __construct(?array $settings = [])
+    {
+        $this->settings = $settings ?? [];
+    }
 
     public function createExtractor(UriInterface $uri, RequestInterface $request, ResponseInterface $response, Crawler $crawler): Extractor
     {
@@ -41,7 +47,9 @@ public function createExtractor(UriInterface $uri, RequestInterface $request, Re
 
         $class = $this->adapters[$host] ?? $this->default;
 
+        /** @var Extractor $extractor */
         $extractor = new $class($uri, $request, $response, $crawler);
+        $extractor->setSettings($this->settings);
 
         foreach ($this->customDetectors as $name => $detector) {
             $extractor->addDetector($name, new $detector($extractor));