zicht/page-bundle

Zicht PageBundle

9.0.0 2024-05-02 14:38 UTC

Requires

• php: ^8.0
• sonata-project/admin-bundle: ^4.21.0
• symfony/config: ^6.4
• symfony/console: ^6.4
• symfony/security-core: ^6.4
• twig/twig: ^2.7 || ^3
• zicht/admin-bundle: ^9
• zicht/framework-extra-bundle: ^11
• zicht/menu-bundle: ^7
• zicht/url-bundle: ^8
• zicht/util: ^2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phpunit/phpunit: ^9.6
• symfony/form: ^6.4
• vimeo/psalm: ^5

MIT

README

Provides composable pages through a simple entity model.

Approach

The idea is that any content page of any type is always composed of a few "content items", which are in turn of any type. This is modelled in a one-to-many related of Page -> ContentItem, where both Page and ContentItem follow an Entity inheritance model, so "type" of page and "type" of content item are directly implemented by simply having another derivative class.

A piece of the puzzle

See the documentation for zicht/cms (https://github.com/zicht/cms) for more information on how the zicht/page-bundle relates to the other Zicht Bundles

Voters

To enable the use of voters in your configuration you should properly configure security.yml or in the security part of your config.

At least you should have these lines:

security:
    access_decision_manager:
            strategy: unanimous

PageVoter

The PageVoter requires the page to have Zicht\Bundle\PageBundle\Model\PageInterface implemented. This Voter looks for the isPublic public function to check whether a page can be displayed to the public.

ScheduledContentVoter

The ScheduledContentVoter requires the page to have Zicht\Bundle\PageBundle\Model\ScheduledContentInterface implemented. With this voter a page can be scheduled for publication.

Debug pages

Add a reference to the debug pages route/controller to be able to view the "Debug pages" page. Add it in config/routes/zicht_page.yaml. Use condition: '%kernel.debug%' to only enable the route on environments where debug mode is enabled (typically local dev environment and the testing environment). Visit the /{_locale}/debug/pages path to only show pages and their information per language/locale (/nl/debug/pages for instance). If you want to view all pages and their information (or don't have a multi language site), visit the path /debug/pages.

zicht_page_debug:
    resource: '@ZichtPageBundle/Resources/config/routing_debug.yml'
    prefix: '/'
    condition: '%kernel.debug%'

Maintainers

• Boudewijn Schoon [e-mail]
• Erik Trapman [e-mail]