manuxi/sulu-archive-bundle

Say hello to Sulu archive!

1.1.4 2024-09-24 21:12 UTC

Requires

• php: ^8.1
• 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: ^6.2 | ^7.0
• symfony/console: ^6.2 | ^7.0
• symfony/phpunit-bridge: ^6.2 | ^7.0

MIT

• Manuxi

• archive
• sulu
• sulucms

README

I made this bundle to have the possibility to manage archive data in my projects.

This bundle contains

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

The archive elements and their meta information is translatable.

It contains an example twig template.

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-archive-bundle

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

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

Please add the following to your routes_admin.yaml:

SuluArchiveBundle:
    resource: '@SuluArchiveBundle/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_):
archive, archive_translation, archive_seo, archive_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 Archive. After page reload you should see the archive item in the navigation. Start to create archive elements. Use smart_content property type to show a list of archive elements, e.g.:

<property name="archivelist" type="smart_content">
    <meta>
        <title lang="en">Archive</title>
        <title lang="de">Archiv</title>
    </meta>
    <params>
        <param name="provider" value="Archive"/>
        <param name="max_per_page" value="5"/>
        <param name="page_parameter" value="page"/>
    </params>
</property>

Example of the corresponding twig template for the Archive list:

{% for archive in archivelist %}
    <div class="col">
        <h2>
            {{ archive.title }}
        </h2>
        <h3>
            {{ archive.subtitle }}
        </h3>
        <p>
            {{ archive.created|format_datetime('full', 'none', locale=app.request.getLocale()) }}
        </p>
        <p>
            {{ archive.summary|raw }}
        </p>
        <p>
            <a class="btn btn-primary" href="{{ archive.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 archive editor, meta information can be provided like it's done as usual when rendering your pages.

👩‍🍳 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 :).