nyrodev/nyrocms-bundle

CMS Bundle for Symfony, provide all admin content handling and public controllers

v6.1 2024-10-03 07:10 UTC

Requires

• becklyn/ordered-form-bundle: ^1.3
• nyrodev/php-template-bundle: ^6
• nyrodev/utility-bundle: ^6
• stof/doctrine-extensions-bundle: ^1.8
• symfony/asset: ^6
• symfony/console: ^6
• symfony/event-dispatcher: ^6
• symfony/form: ^6
• symfony/lock: ^6
• symfony/mailer: ^6
• symfony/monolog-bundle: ^3.8
• symfony/process: ^6
• symfony/security-bundle: ^6
• symfony/serializer-pack: ^1.3
• symfony/templating: ^6
• symfony/translation: ^6
• symfony/twig-bundle: ^6
• symfony/validator: ^6
• symfony/web-link: ^6
• symfony/yaml: ^6

Suggests

• doctrine/doctrine-migrations-bundle: To handle doctrine migration correctly

MIT

• Cédric Nirousset

README

Cms Bundle for Symfony

Needed npm packages

• copy-webpack-plugin
• sortablejs
• jquery
• jquery-ui
• jquery-mobile (for slideshow swipe feature)

npm i copy-webpack-plugin sortablejs jquery jquery-ui jquery-mobile --save-dev

Needed configuration

config/packages/nyrodev.yaml

parameters:
    adminPrefix: /admin
    localeNames:
        fr: Français
        en: English

nyro_dev_utility:
    db_driver: orm
    setLocale: true

nyro_dev_nyro_cms:
    model:
        namespace: App\Entity

config/packages/stof_doctrine_extensions.yaml

stof_doctrine_extensions:
    default_locale: "%locale%"
    translation_fallback: true
    class:
        loggable: NyroDev\UtilityBundle\EventListener\LoggableListener
        translatable: NyroDev\UtilityBundle\EventListener\TranslatableListener
    orm:
        default:
            tree: true
            sortable: true
            loggable: true
            translatable: true
            timestampable: true
            softdeleteable: true

config/packages/doctrine.yaml

doctrine:
    orm:
        filters:
            softdeleteable:
                class: Gedmo\SoftDeleteable\Filter\SoftDeleteableFilter
                enabled: true

config/routes/nyrocms.yaml

nyrocms_admin:
    resource: "@NyroDevNyroCmsBundle/Resources/config/routingAdmin.yaml"
    prefix:   /admin

frontenay:
    resource: 
        handler: frontenay
        controller: App\Controller\FrontController
        homepage: true
    type: nyrocms

Resource configurations could be :

• handler (string) (required): Name of the handle to user
• controller (string) (required): Front Controller to use
• homepage (boolean): in order to add _homepage route alias (only 1 could be set to true)
• forceLang(boolean): to force lang in all URL
• dynamic (array): if you want to load dynamic rootContent using host or paths:
  • rootHandler (string) (required): Name of the parent root handler, used to find defaults and locales
  • host (string): Dynamic host to use in URL, should contains {dynamicHandler}
  • path (string): Dynamic path to use in URL, should contains {dynamicHandler}, starts and ends with a /
  • xmlSitemap (boolean): Enable or disable xmlSitemap (if not provided, same as rootContent used)

config/security.yaml

security:
    password_hashers:
        Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface: 'auto'
        App\Entity\User:
            algorithm: auto
    providers:
        db_provider:
            entity:
                class: App\Entity\User
    role_hierarchy:
        ROLE_SUPERADMIN: [ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]
    firewalls:
        dev:
            pattern: ^/(_(profiler|wdt)|css|images|js)/
            security: false
        admin:
            pattern:    ^%adminPrefix%/.*
            provider: db_provider
            logout:
                path:   nyrocms_admin_security_logout
                target: nyrocms_admin_login
            form_login:
                login_path: nyrocms_admin_login
                check_path: nyrocms_admin_security_check
                default_target_path: nyrocms_admin_homepage
    access_control:
        - { path: ^%adminPrefix%/login, roles: PUBLIC_ACCESS }
        - { path: ^%adminPrefix%/forgot, roles: PUBLIC_ACCESS }
        - { path: ^%adminPrefix%/welcome, roles: PUBLIC_ACCESS }
        - { path: ^%adminPrefix%/contentHandler, roles: ROLE_DEVELOPPER }
        - { path: ^%adminPrefix%/userRole, roles: ROLE_SUPERADMIN }
        - { path: ^%adminPrefix%/user, roles: ROLE_SUPERADMIN }
        - { path: ^%adminPrefix%, roles: ROLE_ADMIN }

Webpack config Entries needed

    .addEntry('js/admin/nyroCms', './vendor/nyrodev/nyrocms-bundle/Resources/public/js/nyroCms.js')
    .addEntry('css/admin/nyroCms', './vendor/nyrodev/nyrocms-bundle/Resources/public/css/nyroCms.scss')

    .addEntry('js/admin/nyroCmsComposer', './vendor/nyrodev/nyrocms-bundle/Resources/public/js/nyroCmsComposer.js')
    .addEntry('css/admin/nyroCmsComposer', './vendor/nyrodev/nyrocms-bundle/Resources/public/css/nyroCmsComposer.scss')

    .addPlugin(new CopyWebpackPlugin({
        patterns: [
            {from: 'vendor/tinymce/tinymce', to: '../tinymce'},
            {from: 'vendor/nyrodev/utility-bundle/Resources/public/js/filemanager', to: '../tinymce/plugins/filemanager'},
            {
                from: 'node_modules/tinymce-i18n/langs7/fr_FR.js',
                to: '../tinymce/langs/fr.js',
                transform: (input, filename) => {
                    return input.toString().replace('tinymce.addI18n("fr_FR", {', 'tinymce.addI18n("fr", {');
                }
            }
        ]
    }))

    .enableSassLoader()
    .autoProvidejQuery()

Command for entities and mapping creation

./bin/console nyrocms:createDbClasses

Others commands

./bin/console nyrocms:addUser
./bin/console nyrocms:addRootContent

Edit config/bootstrap.php

$loader = require dirname(__DIR__).'/vendor/autoload.php';

Overwrite a template

Copy the file from Resources/views into your own folder: src/Resources/NyroDevNyroCmsBundle/views/