Home >Backend Development >PHP Tutorial >Should bundle name always include vendor name?
In Symfony3
When executing php bin/console generate:bundle
to create a bundle, the console will ask whether the bundle to be created will be shared in the future.
If you choose no
, the directory after bundle creation will be like src/UserBundle
. If you choose yes
, you need to add vendor name. After creation, the directory will be like src/XX/UserBundle
However, there may be no sharing plan during creation. If you plan to share in the future, you need to reorganize the file namespace
and the corresponding configuration file.
So should vendor name always be included when bundle is created?
For example src/XX/UserBundle
or src/XX/Bundle/UserBundle
The side effect of this is that when you are not going to share the current bundle, you have an extra namespace
in the application source code. Or there is an extra prefix when defining service
and route
, such as xx_user.user_manager
This eliminates the need to worry about changing the directory structure, namespace, route and service namespace issues when sharing the current bundle in the future.
What do you think?
In Symfony3
When executing php bin/console generate:bundle
to create a bundle, the console will ask whether the bundle to be created will be shared in the future.
If you choose no
, the directory after bundle creation will be like src/UserBundle
. If you choose yes
, you need to add vendor name. After creation, the directory will be like src/XX/UserBundle
However, there may be no sharing plan during creation. If you plan to share in the future, you need to reorganize the file namespace
and the corresponding configuration file.
So should vendor name always be included when bundle is created?
For example src/XX/UserBundle
or src/XX/Bundle/UserBundle
The side effect of this is that when you are not going to share the current bundle, you have an extra namespace
in the application source code. Or there is an extra prefix when defining service
and route
, such as xx_user.user_manager
This eliminates the need to worry about changing the directory structure, namespace, route and service namespace issues when sharing the current bundle in the future.
What do you think?
Why vendorName?
VendorName is to avoid conflicts with the same bundleName of different Vendors. Simply put, it is to avoid naming conflicts. For example, if two Vendors, Foo and Bar, have to create a UserBundle, then a conflict will occur if vendorName is not added. This is not difficult. Do you understand?
Under what circumstances should vendorName be included?
If your bundle is only used in the current project, rather than as a shared third-party bundle (usually needs to be published as a composer package), then vendorName is not required, otherwise vendorName is required.