Download the PHP package tobento/app-slugging without Composer

App Slugging

Slugging support for the app using the Slugifier Service.

Table of Contents

• Getting Started
  • Requirements
• Documentation
  • App
  • Slugging Boot
    • Slugging Config
  • Generating Slugs
  • Adding Slugs
    • Repository Resource
  • Slug Repository
  • Routing
    • Slug Matches
  • Slug Route Matcher
  • Unique Slug Validation Rule
• Credits

  ---

Getting Started

Add the latest version of the app slugging project running this command.

Requirements

• PHP 8.0 or greater

Documentation

App

Check out the App Skeleton if you are using the skeleton.

You may also check out the App to learn more about the app in general.

Slugging Boot

The slugging boot does the following:

• installs and loads slugging config file
• implements slugifier interfaces

Slugging Config

The configuration for the slugging is located in the file at the default App Skeleton config location where you can specify the slugifiers for your application and more.

Generating Slugs

To generate slugs use the slugifier interfaces:

You may check out the Slugifier Service to learn more about it.

Adding Slugs

You may add slugs to prevent dublicate slugs or for routing purposes such as using the Slug Matches on routes.

From Config

You may add slugs using resources directly in the Slugging Config.

Using The App

Sometimes, it may be useful to add slugs using resources within the app:

Repository Resource

With the class you can add any repository implementing the as a resource.

Slug Repository

By default, the slug repository is Slugging Config whereby preventing dublicated slugs.

The advantage using the slug repository is that there will be just one query while added slug resource.

Saving Slugs

Use the method to save a slug:

Deleting Slugs

Use the method to delete a slug:

Routing

First, you will need to install the App Http.

Slug Matches

You may use the class to have mutliple routes with a slug only uri matching different controllers based on the parameter.

Using Locale

You may use the parameter to define the name of the uri locale parameter. Once defined, slugs will be matched locale dependent.

Using The Resource Id

You may use the parameter to define the name of the parameter passed to the handler whereby the resource id from the slug entity will be passed.

Custom Slug Uri

You may use the parameter to change the uri name of the slug.

Unique Slug Validation Rule

Requirements

It requires the App Validation:

Do not forget to boot the validator:

Unique Slug Rule

Skip validation

You may use the parameter in order to skip validation under certain conditions:

Credits

• Tobias Strub
• All Contributors