[Asset] added the component #13234

fabpot · 2015-01-04T11:10:11Z

Q	A
Bug fix?	yes
New feature?	yes
BC breaks?	no
Deprecations?	yes
Tests pass?	yes
Fixed tickets	#10973, #11748, #11876, #4883, #12474
License	MIT
Doc PR	not yet

TODO:

submit documentation PR

The current Asset sub-namespace in Templating has several (major) problems:

It does not cover all use cases (see [assets] bundle package #10973 and [Templating] Asset URLs in SSL #4883 for some example)
It has some design issues (relies on the Request instance and so requires the request scope, very coupled with the PHP templating sub-system, see [FrameworkBundle] templating_php.xml is loaded even when php engine is not enabled #11748 and Add (or fix) the missing Dependency in Twig bundle #11876)

To decouple this feature and make it reusable in Silex for instance, and to fix the design issues and make it more extensible, I've decided to extract and rework the features provided into a new Asset component.

Basically, this component allows the developer to easily manage asset URLs: versioning, paths, and hosts.

Both the new and the old asset management features are kept in this PR to avoid breaking BC; the old system is of course deprecated and automatically converted to the new one.

Even if the features are quite similar, and besides the flexilibity of the new system, here are some differences:

PathPackage always prepend the path (even if the given path starts with /).
Usage is stricter (for instance, PathPackage requires a basePath to be passed and UrlPackage requires that at least on URL is passed).
In the configuration, named packages inherits from the version and version format of the default package by default.
It is not possible to override the version when asking for a URL (instead, you can define your own version strategy implementation -- the use cases explained in [Templating] Added ability to set a specific version of the asset #6092 are easily implemented this way).
It's not possible to generate absolute URLs (see URL manipulations as a Twig extension #13264 for a better alternative using composition; so using absolute_url(asset_path('me.png')) should work).
[assets] bundle package #10973 was about adding shortcuts for bundles, which is a good idea; but given that you rarely reference built-in or third-party bundle assets and because we now have a one-bundle default approach named AppBundle, the same can be achieved with just a simple piece of configuration with the new assets feature:

framework:
    assets:
        packages:
            app:
                base_path: /bundles/app/
            img:
                base_path: /bundles/app/images/

Then:

{{ asset('images/me.png', 'app') }}
# /bundles/app/images/me.png

{{ asset('me.png', 'img') }}
# /bundles/app/images/me.png

#12474 discussed the possibility to add a version for absolute URL. It's not possible to do that in a generic way as the version strategy involves both the version and the path, which obviously cannot work when the path is an absolute URL already. Instead, one should use the asset_version Twig function to add the version manually.

acasademont · 2015-01-05T11:13:47Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

+                    ->canBeUnset()
+                    ->fixXmlConfig('base_url')
+                    ->children()
+                        ->scalarNode('version')->defaultValue(null)->end()


wouldn't it be better defaultNull?

acasademont · 2015-01-05T11:25:25Z

I like the overall simplification, no more weird behaviour depending on wether your packages contain ssl/non-ssl urls.

mickaelandrieu · 2015-01-05T12:24:47Z

src/Symfony/Component/Asset/composer.json

+        "php": ">=5.3.3"
+    },
+    "suggest": {
+        "symfony/http-foundation": ""


👍 thanks for this "totaly" standalone component !

albertplaya · 2015-01-05T15:05:57Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -442,6 +444,54 @@ private function addTemplatingSection(ArrayNodeDefinition $rootNode)
        ;
    }

+    private function addAssetsSection(ArrayNodeDefinition $rootNode)
+    {


This code reminds me http://www.history.com/topics/ancient-history/the-egyptian-pyramids, 👯 #troll

xabbuh · 2015-01-19T21:51:26Z

src/Symfony/Bridge/Twig/Extension/AssetExtension.php

+    {
+        // BC layer to be removed in 3.0
+        if (2 < $count = func_num_args()) {
+            trigger_error('Generating absolute URL with the Twig asset() function was deprecated in 2.7 and will be removed in 3.0. Please use absolute_url() instead.', E_USER_DEPRECATED);


"Generating an absolute URL [...]" or "Generating absolute URLs [...]"?

stof · 2015-01-20T08:17:39Z

src/Symfony/Component/Asset/Package.php

+    }
+
+    /**
+     * @return ContextInterface|null


this cannot be null anymore

This PR was merged into the 2.7 branch. Discussion ---------- [Asset] added the component | Q | A | ------------- | --- | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #10973, #11748, #11876, #4883, #12474 | License | MIT | Doc PR | not yet TODO: - [ ] submit documentation PR The current Asset sub-namespace in Templating has several (major) problems: * It does not cover all use cases (see #10973 and #4883 for some example) * It has some design issues (relies on the Request instance and so requires the request scope, very coupled with the PHP templating sub-system, see #11748 and #11876) To decouple this feature and make it reusable in Silex for instance, and to fix the design issues and make it more extensible, I've decided to extract and rework the features provided into a new Asset component. Basically, this component allows the developer to easily manage asset URLs: versioning, paths, and hosts. Both the new and the old asset management features are kept in this PR to avoid breaking BC; the old system is of course deprecated and automatically converted to the new one. Even if the features are quite similar, and besides the flexilibity of the new system, here are some differences: * `PathPackage` always prepend the path (even if the given path starts with `/`). * Usage is stricter (for instance, `PathPackage` requires a basePath to be passed and `UrlPackage` requires that at least on URL is passed). * In the configuration, named packages inherits from the version and version format of the default package by default. * It is not possible to override the version when asking for a URL (instead, you can define your own version strategy implementation -- the use cases explained in #6092 are easily implemented this way). * It's not possible to generate absolute URLs (see #13264 for a better alternative using composition; so using `absolute_url(asset_path('me.png')) should work)`. #10973 was about adding shortcuts for bundles, which is a good idea; but given that you rarely reference built-in or third-party bundle assets and because we now have a one-bundle default approach named AppBundle, the same can be achieved with just a simple piece of configuration with the new assets feature: ```yml framework: assets: packages: app: base_path: /bundles/app/ img: base_path: /bundles/app/images/ ``` Then: ```jinja {{ asset('images/me.png', 'app') }} # /bundles/app/images/me.png {{ asset('me.png', 'img') }} # /bundles/app/images/me.png ``` #12474 discussed the possibility to add a version for absolute URL. It's not possible to do that in a generic way as the version strategy involves both the version and the path, which obviously cannot work when the path is an absolute URL already. Instead, one should use the `asset_version` Twig function to add the version manually. Commits ------- 0750d02 removed usage of the deprecated forms of asset() in the core framework f74a1f2 renamed asset_path() to asset() and added a BC layer 4d0adea [Asset] added a NullContext class d33c41d [Asset] added the component

svassaux · 2015-10-18T16:41:03Z

The following does not work anymore:

img src="{{ asset('images/user.png', 'images') | imagine_filter('default') }}" alt="Image de profil" class="img-circle whitebg"

see http://stackoverflow.com/questions/33200339/symfony-2-7-asset-component-not-working-with-imagine-filter

jakzal · 2015-10-18T18:42:41Z

@svassaux if you think there's a bug, please create a new issue.

12th · 2015-10-25T08:47:53Z

If use absolute_url() for image from the CLI the url is without host, because masterRequest is empty.
Please tell me how get absolute url for image, for example in email?

acasademont · 2015-10-25T08:54:18Z

@12th there's a cookbook on that!

http://symfony.com/doc/current/cookbook/console/sending_emails.html

12th · 2015-10-25T09:30:17Z

@acasademont
Yes, I saw this example, but absolute route work only for twig url() for tag , and when try use absolute for asset(), this not work.

/**
     * Send email to player
     *
     * @param Letter $letter
     * @return int
     */
    public function sendLetter(Letter $letter)
    {
        $context = [];
        $toEmail = '';
        $fromEmail = '';
        $result = null;

        $email = $letter->getEmail();

        switch ($email->getType()) {
            case Email::TYPE_INVITE:
                $mailer = $this->parameters['mailers'][$letter->getEmail()->getGateway()->getSlug()];

                $invite = $this->_inviteHelper->findOneBy(['id' => $letter->getEntityId()]);

                $context['token'] = $letter->getToken();
                $context['entity'] = $this->_emailHelper->getEntity($letter);

                $toEmail = $invite->getEmail();
                $fromEmail = [$mailer['send_from'] => $mailer['sender_name']];

                break;
            default:
                $mailer = $this->parameters['mailers']['default'];
        }

        // For CLI mailing, because request does not has http request
        $requestContext = $this->router->getContext();
        $requestContext
            ->setHost($mailer['site_http_host'])
            ->setScheme($mailer['site_http_schema'])
        ;

        // Change default settings for sending special
        $transport = \Swift_SmtpTransport::newInstance($mailer['host'], $mailer['port'], true)
            ->setUsername($mailer['username'])
            ->setPassword($mailer['password'])
            ->setEncryption($mailer['encryption'])
        ;

        $this->mailer = \Swift_Mailer::newInstance($transport);

        $this->twig->setLoader(new \Twig_Loader_Array(['letter' => $email->getBodyHtml()]));

        $context  = $this->twig->mergeGlobals($context);
        $htmlBody = $this->twig->render('letter', $context);

        // Catch incorrect email
        try {
            $message = \Swift_Message::newInstance()
                ->setSubject($email->getSubject())
                ->setFrom($fromEmail)
                ->setTo($toEmail);

            if ( ! empty($htmlBody)) {
                $message
                    ->setBody($htmlBody, 'text/html')
                    ->addPart($email->getBodyText(), 'text/plain')
                ;
            } else {
                $message->setBody($email->getBodyText());
            }

            $result = $this->mailer->send($message);

        } catch (\Exception $ex) {
            $letter->setStatus(Letter::STATUS_ERROR_SEND);
            $this->_emailHelper->updateLetter($letter);

            VarDumper::dump($ex->getMessage());

            return false;
        }

        $letter->setStatus(Letter::STATUS_SENT);

        if ( ! (bool)$result) {
            $letter->setStatus(Letter::STATUS_ERROR_SEND);
        }

        $this->_emailHelper->updateLetter($letter);

        return $result;
    }

Services

app_main.mailer:
      class: App\MainBundle\Model\Mailer
      arguments:
          - @mailer
          - @router
          - @twig
          - @swiftmailer.transport.real

Config:

swiftmailer:
    transport:  "%mailer_transport%"
    host:       "%mailer_host%"
    username:   "%mailer_user%"
    password:   "%mailer_password%"
    port:       "%mailer_port%"
    encryption: "%mailer_encryption%"
    auth_mode:  login
    spool:     { type: memory }

When try use flush the queue after send, catch error User Error: Call to undefined method getSpool

...
$result = $this->mailer->send($message);

// now manually flush the queue
$spool = $this->mailer->getTransport()->getSpool();
$spool->flushQueue($this->_esmtpTransport);

If dump getMasterRequest() in generateAbsoluteUrl(), the request is null, and I get path without host

/**
     * Returns the absolute URL for the given absolute or relative path.
     *
     * This method returns the path unchanged if no request is available.
     *
     * @param string $path The path
     *
     * @return string The absolute URL
     *
     * @see Request::getUriForPath()
     */
    public function generateAbsoluteUrl($path)
    {
        if (false !== strpos($path, '://') || '//' === substr($path, 0, 2)) {
            return $path;
        }

       VarDumper::dump($this->requestStack->getMasterRequest());die;

        if (!$request = $this->requestStack->getMasterRequest()) {
            return $path;
        }



        if (!$path || '/' !== $path[0]) {
            $prefix = $request->getPathInfo();
            $last = strlen($prefix) - 1;
            if ($last !== $pos = strrpos($prefix, '/')) {
                $prefix = substr($prefix, 0, $pos).'/';
            }

            return $request->getUriForPath($prefix.$path);
        }

        return $request->getSchemeAndHttpHost().$path;
    }

acasademont · 2015-10-25T09:32:31Z

that's why you have the asset_base_url :p

http://symfony.com/doc/current/reference/configuration/framework.html#assets-base-urls

12th · 2015-10-25T09:40:17Z

And whether it is possible to dynamically change depending on the sender's e-mail settings?

acasademont · 2015-10-25T09:45:25Z

mmm you would need to create a "package" for each of them and have different url's in there

http://symfony.com/doc/current/reference/configuration/framework.html#packages

12th · 2015-10-25T10:19:07Z

Alternatively I try, but it's not the best option because the sender to the individual letters is different and is selected from the panel

12th · 2015-10-25T10:54:40Z

If set host in package base_path

framework:
    assets:
        version_format: %%s?%%s
        packages:
            img_email:
                version: 15.09.22
                base_path: http://site.com/email/

template lokk like:

<body style="margin:0; padding: 0; background:#2e2b2a url({{ absolute_url(asset('main/bg.png', 'img_email'))  }}) top center repeat;">

the html look like

<body style=3D"margin:0; padding: 0; background:#2e2b2a url(/http://site.com/email/main/bg.png) top center repeat;">

with slash at the beginning of the address

12th · 2015-10-25T11:05:15Z

as a solution to use

 // fix absolute url to image, because absolute_url() not work from CLI 
 $htmlBody = str_replace('%site_http_host%', 'http://'.$mailer['site_http_host'], $htmlBody);

12th · 2015-10-25T22:12:19Z

Solution there #15448

fabpot force-pushed the asset-component branch 8 times, most recently from e716f76 to c9e9565 Compare January 4, 2015 18:30

This was referenced Jan 4, 2015

[assets] bundle package #10973

Closed

[Templating] Asset URLs in SSL #4883

Closed

fabpot force-pushed the asset-component branch 2 times, most recently from 10c720c to 95f7b7f Compare January 5, 2015 07:18

acasademont reviewed Jan 5, 2015
View reviewed changes

mickaelandrieu reviewed Jan 5, 2015
View reviewed changes

fabpot force-pushed the asset-component branch 8 times, most recently from 6439559 to b0bc46f Compare January 5, 2015 13:14

albertplaya reviewed Jan 5, 2015
View reviewed changes

xabbuh reviewed Jan 19, 2015
View reviewed changes

fabpot force-pushed the asset-component branch from 4283428 to 48d3d15 Compare January 19, 2015 22:10

stof reviewed Jan 20, 2015
View reviewed changes

src/Symfony/Component/Asset/Package.php

}

/**

* @return ContextInterface|null

Copy link

Member

stof Jan 20, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this cannot be null anymore

fabpot force-pushed the asset-component branch from 48d3d15 to c8b799c Compare February 10, 2015 12:37

fabpot added 4 commits February 10, 2015 13:45

[Asset] added the component

d33c41d

[Asset] added a NullContext class

4d0adea

renamed asset_path() to asset() and added a BC layer

f74a1f2

removed usage of the deprecated forms of asset() in the core framework

0750d02

fabpot force-pushed the asset-component branch from c8b799c to 0750d02 Compare February 10, 2015 12:59

fabpot merged commit 0750d02 into symfony:2.7 Feb 10, 2015

javiereguiluz mentioned this pull request Feb 10, 2015

Document the new Asset component + framework changes symfony/symfony-docs#4982

Closed

4 tasks

fabpot deleted the asset-component branch February 12, 2015 09:32

fabpot mentioned this pull request Mar 9, 2015

Assets base_url configuration doesn't apply to both http and https #13832

Closed

Alsatian67 mentioned this pull request Apr 12, 2015

[BC Break] "framework.templating.assets_base_urls" in config #14332

Closed

Guite mentioned this pull request Jun 9, 2015

Updated to Symfony 2.7 LTS zikula/core#2486

Merged

xabbuh mentioned this pull request Dec 29, 2016

[Asset] Provide default context #21027

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Asset] added the component #13234

[Asset] added the component #13234

fabpot commented Jan 4, 2015

acasademont Jan 5, 2015

acasademont commented Jan 5, 2015

mickaelandrieu Jan 5, 2015

albertplaya Jan 5, 2015

xabbuh Jan 19, 2015

fabpot Jan 19, 2015

stof Jan 20, 2015

svassaux commented Oct 18, 2015

jakzal commented Oct 18, 2015

12th commented Oct 25, 2015

acasademont commented Oct 25, 2015

12th commented Oct 25, 2015

acasademont commented Oct 25, 2015

12th commented Oct 25, 2015

acasademont commented Oct 25, 2015

12th commented Oct 25, 2015

12th commented Oct 25, 2015

12th commented Oct 25, 2015

12th commented Oct 25, 2015

[Asset] added the component #13234

[Asset] added the component #13234

Conversation

fabpot commented Jan 4, 2015

acasademont Jan 5, 2015

Choose a reason for hiding this comment

acasademont commented Jan 5, 2015

mickaelandrieu Jan 5, 2015

Choose a reason for hiding this comment

albertplaya Jan 5, 2015

Choose a reason for hiding this comment

xabbuh Jan 19, 2015

Choose a reason for hiding this comment

fabpot Jan 19, 2015

Choose a reason for hiding this comment

stof Jan 20, 2015

Choose a reason for hiding this comment

svassaux commented Oct 18, 2015

jakzal commented Oct 18, 2015

12th commented Oct 25, 2015

acasademont commented Oct 25, 2015

12th commented Oct 25, 2015

acasademont commented Oct 25, 2015

12th commented Oct 25, 2015

acasademont commented Oct 25, 2015

12th commented Oct 25, 2015

12th commented Oct 25, 2015

12th commented Oct 25, 2015

12th commented Oct 25, 2015