Create a human readable url for your Yii model records
PHP
Latest commit e03934c Feb 19, 2016 @mintao Merge pull request #6 from wilwade/patch-1
Change from FindByAttributes to Exists
Failed to load latest commit information.
tests Added some more tests Aug 22, 2013
.gitignore
Doctrine_Inflector.php Added dependend cols Jun 23, 2011
LICENSE Added composer Aug 5, 2013
README.mkd README.mkd update Aug 25, 2014
SluggableBehavior.php Change from FindByAttributes to Exists Aug 25, 2014
composer.json
composer.lock

README.mkd

What's it all about?

With this behavior, you can generate an URI for a single or combination of columns in your table. Some call it permalink, others call it slug or human readable url.

Check out the latest version at: github.com/mintao/yii-behavior-sluggable

Imagine a blog table

| id | category | title                             |
|----+----------+-----------------------------------|
|  1 | security | NASA Server hacked by hacker kids |
| ...

So you'd like a better URL than that?

http://your-blog.org/index.php?r=blog/show&id=1422

What about

http://your-blog.org/security/nasa-server-hacked-by-hacker-kids

Google will love you ;)

How to get it done

  • Add another column called "slug" to your table
  • Download this extension and drop it into your protected/extensions folder,
  • Add the behavior to your model (shown below)

If you're using git, I'd recommend:

cd <YOUR YII-PROJECT>
mkdir -p protected/extensions/behaviors (optional)
git submodule add git://github.com/mintao/yii-behavior-sluggable.git protected/extensions/behaviors/SluggableBehavior

Demo configuration of this behavior for your model

/**
 * Behaviors for this model
 */
public function behaviors(){
  return array(
    'sluggable' => array(
      'class'=>'ext.behaviors.SluggableBehavior.SluggableBehavior',
      'columns' => array('category', 'title', 'author.name'),
      'unique' => true,
      'update' => true,
    ),
  );
}
  • class Defines the path where to find the SluggableBehavor.php
  • columns Needs to be an array of the fields to use for slug creation
  • unique Set this to true to ensure a unique slug (Numbers will be added to duplicate slugs, if already existing)
  • update Set this to true is every time you change the entry, the slug should be updated too. Set it to false, if the slug should be only created once

Download this extension (and fork it):

github.com/mintao/yii-behavior-sluggable

Changelog

  • 2014-08-25 Slight speed improvement
  • 2011-04-30 Added update functionality
  • 2011-06-23 Added support for dependent models (see demo configuration, author.name)