Skip to content

Latest commit

 

History

History
195 lines (165 loc) · 6.06 KB

assets.md

File metadata and controls

195 lines (165 loc) · 6.06 KB

Working with assets

You can add assets in several ways, and it's available for most builders.

HTML URL Markdown Libre Office
PDF ✅ ✅ ✅ N/A
Screenshot ✅ ✅ ✅ N/A

Warning

By default the assets are fetch in the assets folder of your application. If your assets files are in another folder, you can override the default value of assets_directory in your configuration file config/sensiolabs_gotenberg.yml.

The asset path resolution depends on certain criteria:

  • If an absolute path is provided in {{ gotenberg_asset() }}, assets() or addAsset, this path will be applied and not the one in the configuration file.

  • If a path is provided in {{ gotenberg_asset() }}, assets() or addAsset, it will be treated as a relative path from the assets_directory configuration.

  • If an absolute path is provided in the configuration file (assets_directory), the path applied in {{ gotenberg_asset() }}, assets() or addAsset will have assets_directory as base path.

  • If a relative path is provided in the configuration file (assets_directory), the path applied will have the root of the project as base path followed by the path from the configuration file.

Examples 
// Without sensiolabs_gotenberg.assets_directory:
$builder->addAsset('/some/absolute/path/img.png'); // (string) '/some/absolute/path/img.png'

// Without sensiolabs_gotenberg.assets_directory:
$builder->addAsset('some/relative/img.png'); // (string) '%kernel.project_dir%/assets/some/relative/img.png'

// With sensiolabs_gotenberg.assets_directory: '/some/absolute/path'
$builder->addAsset('./some/relative/img.png'); // (string) '/some/absolute/path/some/relative/img.png'

// With sensiolabs_gotenberg.assets_directory: 'some/relative/path'
$builder->addAsset('./also/relative/img.png'); // (string) '%kernel.project_dir%/assets/some/relative/path/also/relative/img.png'

Twig file

{{ gotenberg_asset() }} Twig function will help you to generate an asset path.
This function work as asset() Twig function.

You can provide an absolute path.

    <!DOCTYPE html>
    <html lang="en">
        <head>
            <meta charset="utf-8" />
            <title>PDF body</title>
        </head>
        <body>
            <img src="{{ gotenberg_asset('img/ceo.jpeg') }}" alt="CEO"/>
            <img src="{{ gotenberg_asset('img/admin.jpeg') }}" alt="Admin"/>
        </body>
    </html>

The path provided can be relative as well.

    <!DOCTYPE html>
    <html lang="en">
        <head>
            <meta charset="utf-8" />
            <title>PDF body</title>
        </head>
        <body>
            <img src="{{ gotenberg_asset('../public/img/ceo.jpeg') }}" alt="CEO"/>
            <img src="{{ gotenberg_asset('../public/img/admin.jpeg') }}" alt="Admin"/>
        </body>
    </html>

And in your controller nothing needs to be changed.

    namespace App\Controller;

    use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;

    class YourController
    {
        public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
        {
            return $gotenberg->html()
                ->content('twig_simple_pdf.html.twig')
                ->generate()
             ;
        }
    }

HTML file

If your file is an HTML file and not a Twig template, you can also add some assets as below.

The only requirement is that their paths in the HTML file are on the root level.

    <!DOCTYPE html>
    <html lang="en">
        <head>
            <meta charset="utf-8" />
            <title>PDF body</title>
        </head>
        <body>
            <img src="ceo.jpeg" />
            <img src="admin.jpeg" />
        </body>
    </html>

All you need to do is to add the path of the asset file to either assets(...string) or addAsset(string) function.

    namespace App\Controller;

    use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;

    class YourController
    {
        public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
        {
            return $gotenberg->html()
                ->contentFile('content.html')
                ->assets(
                    'img/ceo.jpeg',
                    'img/admin.jpeg'
                )
                ->generate()
            ;
        }
    }

Relative path work as well.

    namespace App\Controller;

    use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;

    class YourController
    {
        public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
        {
            return $gotenberg->html()
                ->contentFile('../public/content.html')
                ->assets(
                    '../img/ceo.jpeg',
                    '../img/admin.jpeg'
                )
                ->generate()
            ;
        }
    }

In some cases you want to add an asset in your HTML in a specific condition. You can do it with addAsset() function to add an asset to the current asset list.

    namespace App\Controller;

    use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;

    class YourController
    {
        public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
        {
            return $gotenberg->html()
                ->contentFile('../public/content.html')
                ->assets(
                    '../img/ceo.jpeg',
                    '../img/admin.jpeg'
                )
                ->addAsset('../img/developer.jpeg') 
                ->generate()
            ;
        }
    }

In the example above ceo.jpeg, admin.jpeg and developer.jpeg will be loaded into