From: Raphaël Gertz Date: Tue, 14 Oct 2025 10:44:57 +0000 (+0200) Subject: Update documentation X-Git-Tag: 0.5.6~1 X-Git-Url: https://git.rapsys.eu/packbundle/commitdiff_plain/38b37a1222916033f3af99e3a857d798a57d7837?ds=inline Update documentation --- diff --git a/README.md b/README.md index 81cd07a..bd7ebc5 100644 --- a/README.md +++ b/README.md @@ -101,8 +101,8 @@ class AppKernel extends Kernel ### Step 3: Configure the Bundle -Setup configuration file `config/packages/rapsys_pack.yaml` with the following -content available in `Resources/config/packages/rapsys_pack.yaml`: +Setup configuration file `config/packages/rapsyspack.yaml` with the following +content available in `vendor/rapsys/packbundle/config/packages/rapsyspack.yaml`: ```yaml #Services configuration @@ -110,23 +110,23 @@ services: #Replace assets.packages definition assets.packages: class: 'Symfony\Component\Asset\Packages' - arguments: [ '@rapsys_pack.path_package' ] + arguments: [ '@rapsyspack.path_package' ] #Replace assets.context definition assets.context: class: 'Rapsys\PackBundle\Context\RequestStackContext' arguments: [ '@request_stack', '%asset.request_context.base_path%', '%asset.request_context.secure%' ] #Register assets pack package - rapsys_pack.path_package: + rapsyspack.path_package: class: 'Rapsys\PackBundle\Package\PathPackage' arguments: [ '/', '@assets.empty_version_strategy', '@assets.context' ] public: true #Register twig pack extension - rapsys_pack.pack_extension: + rapsyspack.pack_extension: class: 'Rapsys\PackBundle\Extension\PackExtension' - arguments: [ '@service_container', '@rapsys_pack.intl_util', '@file_locator', '@rapsys_pack.path_package', '@rapsys_pack.slugger_util' ] + arguments: [ '@service_container', '@rapsyspack.intl_util', '@file_locator', '@rapsyspack.path_package', '@rapsyspack.slugger_util' ] tags: [ 'twig.extension' ] #Register intl util service - rapsys_pack.intl_util: + rapsyspack.intl_util: class: 'Rapsys\PackBundle\Util\IntlUtil' public: true #Register facebook event subscriber @@ -135,54 +135,54 @@ services: tags: [ 'kernel.event_subscriber' ] #Register intl util class alias Rapsys\PackBundle\Util\IntlUtil: - alias: 'rapsys_pack.intl_util' + alias: 'rapsyspack.intl_util' #Register facebook util service - rapsys_pack.facebook_util: + rapsyspack.facebook_util: class: 'Rapsys\PackBundle\Util\FacebookUtil' - arguments: [ '@router', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ] + arguments: [ '@router', '%kernel.project_dir%/var/cache', '%rapsyspack.path%' ] public: true #Register facebook util class alias Rapsys\PackBundle\Util\FacebookUtil: - alias: 'rapsys_pack.facebook_util' + alias: 'rapsyspack.facebook_util' #Register image util service - rapsys_pack.image_util: + rapsyspack.image_util: class: 'Rapsys\PackBundle\Util\ImageUtil' - arguments: [ '@router', '@rapsys_pack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ] + arguments: [ '@router', '@rapsyspack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsyspack.path%' ] public: true #Register image util class alias Rapsys\PackBundle\Util\ImageUtil: - alias: 'rapsys_pack.image_util' + alias: 'rapsyspack.image_util' #Register map util service - rapsys_pack.map_util: + rapsyspack.map_util: class: 'Rapsys\PackBundle\Util\MapUtil' - arguments: [ '@router', '@rapsys_pack.slugger_util' ] + arguments: [ '@router', '@rapsyspack.slugger_util' ] public: true #Register map util class alias Rapsys\PackBundle\Util\MapUtil: - alias: 'rapsys_pack.map_util' + alias: 'rapsyspack.map_util' #Register slugger util service - rapsys_pack.slugger_util: + rapsyspack.slugger_util: class: 'Rapsys\PackBundle\Util\SluggerUtil' arguments: [ '%kernel.secret%' ] public: true #Register slugger util class alias Rapsys\PackBundle\Util\SluggerUtil: - alias: 'rapsys_pack.slugger_util' + alias: 'rapsyspack.slugger_util' #Register image controller Rapsys\PackBundle\Controller\ImageController: - arguments: [ '@service_container', '@rapsys_pack.image_util', '@rapsys_pack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ] + arguments: [ '@service_container', '@rapsyspack.image_util', '@rapsyspack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsyspack.path%' ] tags: [ 'controller.service_arguments' ] #Register map controller Rapsys\PackBundle\Controller\MapController: - arguments: [ '@service_container', '@rapsys_pack.map_util', '@rapsys_pack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%' ] + arguments: [ '@service_container', '@rapsyspack.map_util', '@rapsyspack.slugger_util', '%kernel.project_dir%/var/cache', '%rapsyspack.path%' ] tags: [ 'controller.service_arguments' ] Rapsys\PackBundle\Form\CaptchaType: - arguments: [ '@rapsys_pack.image_util', '@rapsys_pack.slugger_util', '@translator' ] + arguments: [ '@rapsyspack.image_util', '@rapsyspack.slugger_util', '@translator' ] tags: [ 'form.type' ] ``` Setup configuration file `config/packages/myproject.yaml` with the following -content available in `Resources/config/packages/rapsys_pack.yaml`: +content available in `vendor/rapsys/packbundle/config/packages/rapsyspack.yaml`: ```yaml #Services configuration @@ -192,9 +192,9 @@ services: arguments: [ '@router', [ 'en', 'en_gb', 'en_us', 'fr', 'fr_fr' ] ] tags: [ 'kernel.event_subscriber' ] #Register facebook util service - rapsys_blog.facebook_util: + myproject.facebook_util: class: 'Rapsys\PackBundle\Util\FacebookUtil' - arguments: [ '@router', '%kernel.project_dir%/var/cache', '%rapsys_pack.path%', 'facebook', '%kernel.project_dir%/public/png/facebook.png' ] + arguments: [ '@router', '%kernel.project_dir%/var/cache', '%rapsyspack.path%', 'facebook', '%kernel.project_dir%/public/png/facebook.png' ] public: true ``` @@ -214,7 +214,7 @@ $ bin/console debug:config RapsysPackBundle ### Step 4: Use the twig extension in your Template -You can use a template like this to generate your first `rapsys_pack` enabled +You can use a template like this to generate your first `rapsyspack` enabled template: ```twig @@ -223,7 +223,7 @@ template: {% block title %}Welcome!{% endblock %} - {% stylesheet '//fonts.googleapis.com/css?family=Irish+Grover|La+Belle+Aurore' '@NamedBundle/Resources/public/css/{reset,screen}.css' '@Short/css/example.css' %} + {% stylesheet '//fonts.googleapis.com/css?family=Irish+Grover|La+Belle+Aurore' '@NamedBundle/public/css/{reset,screen}.css' '@Short/css/example.css' %} {% endstylesheet %} @@ -273,9 +273,9 @@ namespace Rapsys\PackBundle\Filter; use Twig\Error\Error; -//This class will be defined in the parameter rapsys_pack.filters.(css|img|js).[x].class string +//This class will be defined in the parameter rapsyspack.filters.(css|img|js).[x].class string class MyPackFilter implements FilterInterface { - //The constructor arguments ... will be replaced with values defined in the parameter rapsys_pack.filters.(css|img|js).[x].args array + //The constructor arguments ... will be replaced with values defined in the parameter rapsyspack.filters.(css|img|js).[x].args array public function __construct(string $fileName, int $line, string $bin = 'mypack', ...) { //Set fileName $this->fileName = $fileName;