raffaelj/cockpit-uniqueslugs

Unique slugs for collection entries in Cockpit CMS v1

0.5.5 2022-12-16 09:44 UTC

Requires

• composer/installers: ^1.9

MIT

• Raffael Jesche

• cockpit
• slugs

README

This addon is not compatible with Cockpit CMS v2.

See also Cockpit CMS v1 docs, Cockpit CMS v1 repo and Cockpit CMS v2 docs, Cockpit CMS v2 repo.

Unique slugs for collections in Cockpit CMS

Installation

Copy this repository into /addons and name it UniqueSlugs or use the cli.

via git

cd path/to/cockpit
git clone https://github.com/raffaelj/cockpit_UniqueSlugs.git addons/UniqueSlugs

via cp cli

cd path/to/cockpit
./cp install/addon --name UniqueSlugs --url https://github.com/raffaelj/cockpit_UniqueSlugs/archive/master.zip

via composer

Make sure, that the path to cockpit addons is defined in your projects' composer.json file.

{
    "name": "my/cockpit-project",
    "extra": {
        "installer-paths": {
            "addons/{$name}": ["type:cockpit-module"]
        }
    }
}

cd path/to/cockpit-root
composer create-project --ignore-platform-reqs aheinze/cockpit .
composer config extra.installer-paths.addons/{\$name} "type:cockpit-module"

composer require --ignore-platform-reqs raffaelj/cockpit-uniqueslugs

How to use

Add these options to path/to/cockpit/config/config.php to specify the collections and field names for slug generation:

<?php

return [
    'app.name' => 'my app',

    // unique slugs
    'unique_slugs' => [
        'collections'    => [
            'pages'      => 'title',
            'products'   => 'name',
        ],
        'localize' => [
            'pages'     => 'title',
            'products'  => 'name',
        ],
    ],

    // ACL example
    'groups' => [
        'manager' => [
            'cockpit' => [
                'backend' => true,
            ],
            'uniqueslugs' => [
                'manage' => true,
            ],
        ],
    ],
];

all options:

<?php

return [
    'app.name' => 'my app',

    // unique slugs
    'unique_slugs' => [
        'slug_name'      => 'slug', // default: "slug"
        'placeholder'    => 'page', // default: "entry"
        'check_on_update' => true,  // default: false, unique checks on each
                                    // update (if user changes slug by hand)
        'delimiter'      => '|',    // default: "|", is used for nested fields

        'collections'    => [
            'pages'      => 'title',
            'products'   => 'name',
            'something'  => [       // use multiple fields as fallbacks
                'title',
                'name',
                'image|meta|title', // use nested fields for slugs
            ],
        ],
        'localize' => [             // for localized fields, omitted if not set
            'pages'     => 'title', // field name without suffix ("_de")
            'products'  => 'name',
            'something' => [        // use multiple fields as fallbacks
                'title',
                'name',
                'image|meta|title', // use nested fields for slugs
            ],
        ],
    ],

    // ACL example
    'groups' => [
        'manager' => [
            'cockpit' => [
                'backend' => true,
            ],
            'uniqueslugs' => [
                'manage' => true,
            ],
        ],
    ],
];

Or use the GUI. If you are no admin, your user group needs manage rights.

Notes:

Hardcoded settings in the config file will override gui settings.

Don't set slug_name: fieldname_slug if you also set {"slug": true} in the fieldname options for some reason. It should work, but it fails on multilingual setups (explanation).

Your collection can have a visible field named "slug", if you want to edit it by hand.

The builtin option to sluggify text fields via options {"slug": true} in the backend uses Javascript. If you want unique slugs, that option is not necessary anymore.

The code for this addon is inspired by a gist from fabianmu.

Thanks to fabianmu and aheinze