manuxi/sulu-news-bundle

Say hello to Sulu news!

1.6.4 2024-09-20 23:07 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.9

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

• news
• sulu
• sulucms

README

I made this bundle to have the possibility to manage news in my projects without the dependency to elasticsearch.

This bundle contains

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

The news 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-news-bundle

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

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

Please add the following to your routes_admin.yaml:

SuluNewsBundle:
    resource: '@SuluNewsBundle/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_):
news, news_translation, news_seo, news_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 news. After page reload you should see the news item in the navigation. Start to create news. Use smart_content property type to show a list of news, e.g.:

<property name="newslist" type="smart_content">
    <meta>
        <title lang="en">News</title>
        <title lang="de">News</title>
    </meta>
    <params>
        <param name="provider" value="news"/>
        <param name="max_per_page" value="5"/>
        <param name="page_parameter" value="page"/>
    </params>
</property>

Example of the corresponding twig template for the news list:

{% for news in newslist %}
    <div class="col">
        <h2>
            {{ news.title }}
        </h2>
        <h3>
            {{ news.subtitle }}
        </h3>
        <p>
            {{ news.created|format_datetime('full', 'none', locale=app.request.getLocale()) }}
        </p>
        <p>
            {{ news.summary|raw }}
        </p>
        <p>
            <a class="btn btn-primary" href="{{ news.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 news 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 :).