8000 [Framework] Add tag assets.package to register asset packages by GromNaN · Pull Request #38473 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Framework] Add tag assets.package to register asset packages #38473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Feb 16, 2021
Merged

[Framework] Add tag assets.package to register asset packages #38473

merged 1 commit into from
Feb 16, 2021

Conversation

GromNaN
Copy link
Member
@GromNaN GromNaN commented Oct 7, 2020 •
edited
Loading

Replaces #38366

Q A
Branch? 5.x
Bug fix? no
New feature? yes
Deprecations? no
Tickets -
License MIT
Doc PR symfony/symfony-docs#14962

To configure asset packages in an application, we have to declare it in the framework configuration (doc for assets config). In some case we cannot use this configuration:

  • To use a custom class as package
  • To register an asset package in a shared bundle (my use-case).

This PR adds the assets.package tag. This tag is use to collect and inject package services into the assets.packages service, that is the registry for all packages. Since every package needs a name, the package attribute of the tag is used (same naming convention that the console.command tag).

Main changes:

  • the packages defined in the framework.assets configuration are injected into the assets.packages using the tag instead of being directly injected in service declaration.
  • changed signature of Symfony\Components\Assets\Packages constructor to accept an iterator (backward compatible).
  • a new alias assets._default_package is defined even if assets are not configured.

Example in symfony/demo (commit):

In config/services.yaml:

    avatar.strategy:
        class: Symfony\Component\Asset\VersionStrategy\JsonManifestVersionStrategy
        arg
8000
uments:
            - '%kernel.project_dir%/public/build/manifest.json'

    avatar.package:
        class:  Symfony\Component\Asset\Package
        arguments:
            - '@avatar.strategy'
            - '@assets.context'
        tags:
            - { name: assets.package, package: avatars }

Then we can use the package anywhere

<img src="{{ asset('anna.jpg', 'avatars') }}">

Alternative using autoconfiguration with a custom class:

With a custom class implementing the PackageInterface, the package name can be provided by a the static method getDefaultPackageName. Autowiring and autoconfiguration will import the package.

namespace App\Asset;

use Symfony\Component\Asset\PackageInterface;

class AvatarPackage implements PackageInterface
{
    public static function getDefaultPackageName(): string
    {
        return 'avatars';
    }

    // ... Implements the interface
}

@GromNaN GromNaN mentioned this pull request Oct 7, 2020
Closed
@nicolas-grekas nicolas-grekas added this to the 5.x milestone Oct 12, 2020
@Nyholm
Copy link
Member
Nyholm commented Oct 22, 2020

Thank you for this PR.

I like it, it is a rare feature but I think we should support it.

@nicolas-grekas
Copy link
Member

(rebase needed)

@GromNaN
Copy link
Member Author
GromNaN commented Jan 26, 2021

Thank you for the reminder. The branch has been rebased.

nicolas-grekas
nicolas-grekas approved these changes Feb 11, 2021
View reviewed changes
Copy link
Member
@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

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

LGTM, thanks (with minor comments)

@GromNaN
[Asset] Add tag assets.package to register asset packages
6217ff7 
Autoconfiguration with PackageInterface
@GromNaN GromNaN mentioned this pull request Feb 11, 2021
Merged
@fabpot
Copy link
Member
fabpot commented Feb 16, 2021

Thank you @GromNaN.

@fabpot fabpot merged commit 1262b06 into symfony:5.x Feb 16, 2021
javiereguiluz added a commit to symfony/symfony-docs that referenced this pull request Feb 19, 2021
@javiereguiluz
minor #14962 [Framework] Add tag assets.package (GromNaN)
6b29306 
This PR was squashed before being merged into the 5.3-dev branch.

Discussion
----------

[Framework] Add tag assets.package

Documentation for symfony/symfony#38473

Commits
-------

f4dbec4 [Framework] Add tag assets.package
@fabpot fabpot mentioned this pull request Apr 18, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabpot fabpot fabpot approved these changes

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@xabbuh xabbuh xabbuh approved these changes

Assignees
No one assigned
Labels
Feature Ready Status: Reviewed
Projects
None yet
Milestone
5.4
Development

Successfully merging this pull request may close these issues.
6 participants
@GromNaN @Nyholm @nicolas-grekas @fabpot @xabbuh @carsonbot
0