PHP download

Download the PHP package muffin/slug without Composer

On this page you can find all versions of the php package muffin/slug. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download muffin/slug
More information about muffin/slug
Files in muffin/slug

Vendor muffin
Package slug
Short Description Slugging support for CakePHP ORM
License MIT
Homepage https://github.com/usemuffin/slug

Keywords orm cakephp slug muffin

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of muffin/slug

Informations about the package slug

Slug

Slugging for CakePHP

Installation

Using Composer:

Load the plugin using the CLI command:

Usage

To enable slugging add the behavior to your table classes in the initialize() method.

Please note that Slug expects a database column named slug to function. If you prefer to use another column make sure to specify the field configuration option.

Searching

If you want to find a record using its slug, a custom finder is provided by the plugin.

Configuration

Slug comes with the following configuration options:

field: name of the field (column) to hold the slug. Defaults to slug.
displayField: name of the field(s) to build the slug from. Defaults to the \Cake\ORM\Table::displayField().
separator: defaults to -.
replacements: hash of characters (or strings) to custom replace before generating the slug.
maxLength: maximum length of a slug. Defaults to the field's limit as defined in the schema (when possible). Otherwise, no limit.
slugger: class that implements the Muffin\Slug\SlugInterface. Defaults to Muffin\Slug\Slugger\CakeSlugger.
unique:: tells if slugs should be unique. Set this to a callable if you want to customize how unique slugs are generated. Defaults to true.
scope: extra conditions used when checking a slug for uniqueness.
implementedEvents: events this behavior listens to. Defaults to ['Model.buildValidator' => 'buildValidator', 'Model.beforeSave' => 'beforeSave']. By default the behavior adds validation for the displayField fields to make them required on record creating. If you don't want these auto added validations you can set implementedEvents to just ['Model.beforeSave' => 'beforeSave'].
onUpdate: Boolean indicating whether slug should be updated when updating record, defaults to false.
onDirty: Boolean indicating whether slug should be updated when slug field is dirty (has a preset value custom value), defaults to false.

Sluggers

The plugin contains two sluggers:

CakeSlugger

The CakeSlugger uses \Cake\Utility\Text::slug() to generate slugs. In the behavior config you can set the slugger key as shown below to pass options to the $options arguments of Text::slug().

ConcurSlugger

The ConcurSlugger uses concur/slugify to generate slugs. You can use config array similar to the one shown above to pass options to Cocur\Slugify\Slugify's constructor.

Patches & Features

Fork
Mod, fix
Test - this is important, so it's not unintentionally broken
Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
Pull request - bonus point for topic branches

To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards.

Bugs & Feedback

http://github.com/usemuffin/slug/issues

License

All versions of slug with dependencies

PHP Build Version

Package Version

Version 3.0.0 Release 27. Sep 2023
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of slug from vendor muffin

Requires cakephp/orm Version ^5.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package muffin/slug contains the following files

Loading the files please wait ....