zicht/url-bundle

Url utilities for Symfony

8.0.0 2024-05-02 13:45 UTC

Requires

• php: ^8.1
• doctrine/common: ^2.4 || ^3.0
• doctrine/dbal: ^2.13.1 || ^3
• doctrine/orm: ^2.5
• doctrine/persistence: ^2.13 || ^3
• symfony/config: ^6.4
• symfony/console: ^6.4
• symfony/dependency-injection: ^6.4
• symfony/http-foundation: ^6.4
• symfony/security-core: ^6.4
• symfony/translation-contracts: ^1 || ^2 || ^3
• zicht/admin-bundle: ^9
• zicht/framework-extra-bundle: ^11
• zicht/util: ^2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phpunit/phpunit: ^9.6

MIT

• Zicht online

README

This bundle is part of the zicht/cms suite.

The ZichtUrlBundle provides the following features:

• URL "Aliasing" - use seo-friendly url's without routing. The principle is that any url can have an alias which is used to show "readable" url's to the user. The general approach works in a way that is interchangable: each aliased version of any url can be translated to the unaliased version and vice versa. HTML code in the content database should never refer to aliased urls, so this integrates tightly with TinyMCE in the admin.
• By implementing the ProviderInterface, any service can be turned into an object router; i.e.: link to "objects" in stead of paths. This is utilized in the zicht/page-bundle to be able to link to Page object
• Static references: named url's which can be injected anywhere in your project
• Validation constraints

Validator Constraints usage

Zicht\Bundle\RcoSiteBundle\Entity\Page\ContentPage:
    getters:
        body:
            - Zicht\Bundle\UrlBundle\Validator\Constraints\ContainsValidUrls: ~

Tinymce Form type extension

If the TinyMce form type is used from the admin bundle. The type is extended to transform external urls to internal urls. No additional configuration is required

Show public URLS of a page in the admin

To enable this feature, add the following to a page admin, and make sure that form_theme.html.twig from the url-bundle is loaded.

// use Zicht\Bundle\UrlBundle\Admin\AliasOverviewType;

public function configureFormFields(FormMapper $formMapper): void
{
    parent::configureFormFields($formMapper);
    $formMapper
        ->tab('admin.tab.alias_overview')
            ->add('alias_overview', AliasOverviewType::class, ['record' => $this->getSubject()])
        ->end()->end();
}

Importing a csv with aliases

Use the command php bin/console zicht:url:import-aliases url_aliases_file.csv --skip-header --csv-delimiter ';'

This command can parse csv files that follow the following syntax:

PUBLICURL, INTERNALURL, TYPE, CONFLICTINGPUBLICURLSTRATEGY, CONFLICTINGINTERNALURLSTRATEGY
/home, /nl/page/1
/also-home, /nl/page/1

Note that the first line can be ignored using "--skip-header" TYPE, CONFLICTINGPUBLICURLSTRATEGY, and CONFLICTINGINTERNALURLSTRATEGY are optional.'

Events

Sitemap

There is an event that makes it possible to modify the resultset of the sitemap;

• zicht_url.sitemap.filter, which allows you to modify the result from the previous query and filter out items.

Maintainers

• Boudewijn Schoon [e-mail]