README

Installation

Step 1

Method 1: You can install the package via composer:

composer require echoamirali/slugger

Method 2: Add this line to Composer.json file in your project:

"echoamirali/slugger": "*"

Then run following command to download extension using composer

$ composer update

Step 2

Open the config/app.php file and add this line to the end of providers Array:

Echoamirali\Slugger\SluggerServiceProvider::class,

Step 3

Then in the config/app.php and add this line to the end of aliases Array:

'Slugger' => Echoamirali\Slugger\SluggerFacade::class,

Step 4

Run this command in your project dirctory:

php artisan vendor:publish

In the message appear, find the number of Slugger, enter the related number then hit Enter.

Step 5

You can configure package, for this head to config/slugger.php

return [
    /**
     * if do initail option is true, package do some operations on your string like
     * trims spaces, changes characters to lowercase , changes spaces to hyphen, ...
    **/
    'do_initial' => false,
    /**
     * if do translate option is true, package translate your string from 'translate_from'
     * option to 'translate_to' option at the first even before do initial
    **/ 
    'do_translate' => false,
    'translate_from' => 'fa',
    'translate_to' => 'en',
    /**
     * if do pattern option is true, package implement your string into
     * your pattern define in pattern option instead of #string# 
    **/
    'do_pattern' => false,
    'pattern' => '',
    /**
     * first of all you should know remain options only use in laravel models for 
     * avoid repetition and when you put true in 'is_unique' option they work
    **/
    'is_unique' => false,
    // put your database column in this option, that you want be unique
    'field' => 'slug',
    /**
     * this package use some symbols for avoid repetition and you can
     * choose which you want and put it in 'iteration_symbol' option.
     * available options for iteration_symbol are : 
     * decimal, decimal_leading_zero, roman, numbers_in_word, ordinal_number
     **/
    'iteration_symbol' => 'decimal',
    //you can add your custom symbols in this option like alphabet
    'custom_iteration_symbols' => [
        'alphabet' => range('a', 'z')
    ]
];

Usage

You can use the package where ever you want.

First use the class:

use Slugger;

Then use this pattern to slugify your string:

$slug = Slugger::make($string);

Slugger 'make' method has two optional parameters then you can use when you dont want to use config file or merge some options to config file options

/** this parameter has three available options
 * config_file : this is default option and when you choose this option, package use config file options
 * config_options : when you choose this option, you can put your options in config_options parameter
 * config_mixed : when you choose this option, you can put your options in config_options parameter and package merge your options with config file options
**/
$config_status = 'config_options';
// when you choose option except config_file, you should put your options in this parameter
$config_options = ['do_initial' => false, 'do_translate' => false];
$slug = Slugger::make($string, $config_status, $config_options);

Also you can use Slugger in your models.

First use the trait:

use Echoamirali\Slugger\Traits\Slugger;

Then use Slugger trait in your model:

class Post extends Model {

    use Slugger;

}

If you want to use Slugger for some models with different options, you can define specific options for any model.

class Post extends Model {

    use Slugger;

    public $slugger_config = [];
}

Put your model config like slugger config file structure in slugger config property. For Example if you add only is_unique option in slugger config property package use remain option from slugger config file.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email echoamirali@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

echoamirali / slugger

Maintainers

Details