minor #10347 Added docs for different protocols as asset base_url (alexander-schranz)

javiereguiluz · javiereguiluz · commit 2a323511aedf · 2018-10-25T16:05:53.000+02:00
This PR was merged into the master branch. Discussion ---------- Added docs for different protocols as asset base_url Documentation for: symfony/symfony#28476 Commits ------- 324ad72 Added docs for different protocols as asset base_url
diff --git a/components/asset.rst b/components/asset.rst
@@ -372,6 +372,35 @@ document inside a template::
     echo $packages->getUrl('resume.pdf', 'doc');
     // result: /somewhere/deep/for/documents/resume.pdf?v1
 
+Local files and other protocols
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In cases of e.g. generating a pdf from html you want directly link to the local file for performance reason you can use the asset component the following way: 
+
+    use Symfony\Component\Asset\UrlPackage;
+    // ...
+
+    $localPackage = new UrlPackage(
+        'file:///path/to/images/',
+        new EmptyVersionStrategy()
+    );
+
+    echo $localPackage->getUrl('/logo.png');
+    // result: file:///path/to/images/logo.png
+
+Or link to a file on a ftp server:
+
+    use Symfony\Component\Asset\UrlPackage;
+    // ...
+
+    $ftpPackage = new UrlPackage(
+        'ftp://example.com/images/',
+        new EmptyVersionStrategy()
+    );
+
+    echo $ftpPackage->getUrl('/logo.png');
+    // result: ftp://example.com/images/logo.png
+
 Learn more
 ----------
 
