manuxi/sulu-event-bundle

Say hello to Sulu events!

1.6.1 2024-09-20 23:25 UTC

Requires

• php: ^8.1
• doctrine/doctrine-bundle: ^2.13
• phpcr/phpcr-migrations-bundle: ^1.6
• sulu/automation-bundle: ^2.1
• sulu/sulu: ^2.5
• symfony/config: ^6.2 | ^7.0
• symfony/dependency-injection: ^6.2 | ^7.0
• symfony/framework-bundle: ^6.2 | ^7.0
• symfony/http-foundation: ^6.2 | ^7.0
• symfony/http-kernel: ^6.2 | ^7.0
• symfony/intl: ^6.2 | ^7.0
• symfony/security-core: ^6.2 | ^7.0
• symfony/translation: ^6.2 | ^7.0
• twig/extra-bundle: ^3.12
• twig/intl-extra: ^3.12

Requires (Dev)

• jackalope/jackalope-doctrine-dbal: ^1.3.4
• phpspec/prophecy: ^1.17
• phpunit/phpunit: ^8.0
• symfony/browser-kit: ^4.4 | ^5.0 | ^6.2 | ^7.0
• symfony/console: ^4.4 | ^5.0 | ^6.2 | ^7.0
• symfony/phpunit-bridge: ^4.4 | ^5.0 | ^6.2 | ^7.0

MIT

• Manuel Bertrams

• event
• events
• sulu
• sulucms

README

This bundle was made based on Sulu workshop. I made it to have the possibility to manage events in my projects.

This bundle contains

• Several filters for Event Content Type
• Link Provider
• Sitemap Provider
• Handler for Trash Items
• Handler for Automation
• Possibility to assign a contact as author
• Twig Extension for resolving events / get a list of events
• Events for displaying Activities and more...

The news and their meta information is translatable.

It contains an example twig template.

The events and their meta information is translatable.

Please feel comfortable submitting feature requests. This bundle is still in development. Use at own risk 🤞🏻

👩🏻‍🏭 Installation

Install the package with:

composer require manuxi/sulu-event-bundle

If you're not using Symfony Flex, you'll also need to add the bundle in your config/bundles.php file:

return [
    //...
    Manuxi\SuluEventBundle\SuluEventBundle::class => ['all' => true],
];

Please add the following to your routes_admin.yaml:

SuluEventBundle:
    resource: '@SuluEventBundle/Resources/config/routes_admin.yml'

Last but not least the schema of the database needs to be updated.

Some tables will be created (prefixed with app_):
location, event, event_translation, event_seo, event_excerpt (plus some ManyToMany relation tables).

See the needed queries with php bin/console doctrine:schema:update --dump-sql.
Update the schema by executing php bin/console doctrine:schema:update --force.

Make sure you only process the bundles schema updates!

🎣 Usage

First: Grant permissions for events. After page reload you should see the event item in the navigation. Start to create locations, then events. Use smart_content property type to show a list of events, e.g.:

<property name="events" type="smart_content">
    <meta>
        <title lang="en">Events</title>
        <title lang="de">Veranstaltungen</title>
    </meta>
    <params>
        <param name="provider" value="events"/>
        <param name="max_per_page" value="5"/>
        <param name="page_parameter" value="page"/>
    </params>
</property>

Example of the corresponding twig template for the event list:

{% for event in events %}
    <div class="col">
        <h2>
            {{ event.title }}
        </h2>
        <p>
            {{ event.startDate|format_datetime('full', 'none', locale=app.request.getLocale()) }}
            {% if endDate and startDate != endDate %}
                 - {{ event.endDate|format_datetime('full', 'none', locale=app.request.getLocale()) }}
            {% endif %}
        </p>
        <p>
            {{ event.summary|raw }}
        </p>
        <p>
            {{ event.text|raw }}
        </p>
        <p>
            {{ event.footer|raw }}
        </p>
        <p>
            <a class="btn btn-primary" href="{{ event.routePath }}" role="button">
                {{ "Read more..."|trans }} <i class="fa fa-angle-double-right"></i>
            </a>
        </p>
    </div>
{% endfor %}

Since the seo and excerpt tabs are available in the event editor, meta information can be provided like it's done as usual when rendering your pages.

🧶 Configuration

There exists no configuration yet. I'm on it :)

👩‍🍳 Contributing

For the sake of simplicity this extension was kept small. Please feel comfortable submitting issues or pull requests. As always I'd be glad to get your feedback to improve the extension :).