PHPackages                             locustv2/yii2-encode-url-rule - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. locustv2/yii2-encode-url-rule

ActiveYii2-extension[Utility & Helpers](/categories/utility)

locustv2/yii2-encode-url-rule
=============================

Makes the encoding of query parameters easier when creating urls.

1.0.0(9y ago)54732[1 issues](https://github.com/Locustv2/yii2-encode-url-rule/issues)BSD-3-ClausePHP

Since Mar 31Pushed 9y agoCompare

[ Source](https://github.com/Locustv2/yii2-encode-url-rule)[ Packagist](https://packagist.org/packages/locustv2/yii2-encode-url-rule)[ Docs](https://github.com/locustv2/)[ RSS](/packages/locustv2-yii2-encode-url-rule/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

Encode Url Rule for Yii2
========================

[](#encode-url-rule-for-yii2)

This extension enables the creation of urls with parameters that can contain array of data. This is achieved by flatenning the array into a json string and then encoded and added as query string.

[![Latest Stable Version](https://camo.githubusercontent.com/8836f229a22e993b72d837eb249d89f9a12d4002282f5b9e31ce7f1c1098b06b/68747470733a2f2f706f7365722e707567782e6f72672f6c6f6375737476322f796969322d656e636f64652d75726c2d72756c652f762f737461626c65)](https://packagist.org/packages/locustv2/yii2-encode-url-rule)[![Total Downloads](https://camo.githubusercontent.com/b03dee12c56de13be2332d4f45efb0c47beb6fcd3113ceeaa9df65e4a522bbf2/68747470733a2f2f706f7365722e707567782e6f72672f6c6f6375737476322f796969322d656e636f64652d75726c2d72756c652f646f776e6c6f616473)](https://packagist.org/packages/locustv2/yii2-encode-url-rule)[![Latest Unstable Version](https://camo.githubusercontent.com/fb3b6e73a0a977ddf7400b0399b0a9a5f85eef72fe4bbf3d4404d14bc3ecd9e5/68747470733a2f2f706f7365722e707567782e6f72672f6c6f6375737476322f796969322d656e636f64652d75726c2d72756c652f762f756e737461626c65)](https://packagist.org/packages/locustv2/yii2-encode-url-rule)[![License](https://camo.githubusercontent.com/f226d532467696696afd4639cdf27f91150482fe9c258a38ce78ab321ed74b6c/68747470733a2f2f706f7365722e707567782e6f72672f6c6f6375737476322f796969322d656e636f64652d75726c2d72756c652f6c6963656e7365)](https://packagist.org/packages/locustv2/yii2-encode-url-rule)

Installation
------------

[](#installation)

The preferred way to install the library is through [composer](https://getcomposer.org/download/).

Either run

```
php composer.phar require --prefer-dist locustv2/yii2-encode-url-rule

```

or add

```
{
    "require": {
        "locustv2/yii2-encode-url-rule": "~1.0.0"
    }
}
```

to your `composer.json` file.

### Configuring EncodeUrlRule

[](#configuring-encodeurlrule)

To use EncodeUrlRule, add this to your config.

```
'UrlManager' => [
    'ruleConfig' => [
        'class' => 'weblement\components\EncodeUrlRule,
        'paramName' => 'enc',
        'autoEncodeParams' => [
            'page',
            'userId'
        ],
    ],
],
```

### Using EncodeUrlRule

[](#using-encodeurlrule)

When you are creating urls in yii, you can pass an array or parameters to the key `EncodeUrlRule::$paramName` that you set. All parameters that are in `EncodeUrlRule::$autoEncodeParams` will also be encoded and assigned to the key in your url. For example:

```
// /site/url-test/?id=123&key1=value1&enc=a2V5Mj0lMjJ2YWx1ZTIlMjImdXNlcklkPTQ1NiZwYWdlPTI%253D
echo Url::to([
    '/site/url-test',
    'id' => 123,
    'key1' => 'value1',
    'userId' => 456,
    'page' => 2,
    'enc' => [
        'key2' => 'value2'
    ],
]);
```

In your controller action you can get the query parameters as follows

```
public function actionUrlTest($id, $userId, $key2)
{
    var_dump($id); // 123
    var_dump($userId); // 456
    var_dump($key2); // value2
    var_dump(Yii::$app->request->get('key1')); // value1
    var_dump(Yii::$app->request->get('page')); // 2
    var_dump(Yii::$app->request->get()); // contains all get query  parameters including `enc`
}
```

### Further Examples

[](#further-examples)

You are able to also pass arrays as follows:

```
Url::to([
    '/site/url-test',
    'enc' => [
        'user' => [
            'id' => $user->id,
            'name' => $user->name,
        ]
    ],
]);

Url::to([
    '/site/url-test',
    'enc' => [
        'user' => User::find()->asArray()->one(),
    ],
]);
```

However these parameters should will not work if you are trying to assign a controller action parameter.

```
// will not work
public function actionUrlTest($user)
{
    var_dump($user);
}

// will work
public function actionUrlTest()
{
    var_dump(Yii::$app->request->get('user'));
}
```

To do
-----

[](#to-do)

- Add unit tests

Contributing
------------

[](#contributing)

Feel free to send pull requests.

License
-------

[](#license)

For license information check the [LICENSE](LICENSE.md)-file.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3329d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/43f3d13b7b517fc44662d62165016bfeacf0a5858a1cdc7f5c3a8423042bc40b?d=identicon)[Locustv2](/maintainers/Locustv2)

---

Top Contributors

[![Locustv2](https://avatars.githubusercontent.com/u/4509909?v=4)](https://github.com/Locustv2 "Locustv2 (4 commits)")

---

Tags

urlarrayencodeyii2rule

### Embed Badge

![Health badge](/badges/locustv2-yii2-encode-url-rule/health.svg)

```
[![Health](https://phpackages.com/badges/locustv2-yii2-encode-url-rule/health.svg)](https://phpackages.com/packages/locustv2-yii2-encode-url-rule)
```

###  Alternatives

[jbroadway/urlify

A fast PHP slug generator and transliteration library that converts non-ascii characters for use in URLs.

6737.4M62](/packages/jbroadway-urlify)[baibaratsky/yii2-serialized-attributes-behavior

Yii2 Serialized Attributes Behavior

1174.1k9](/packages/baibaratsky-yii2-serialized-attributes-behavior)[cornernote/yii2-returnurl

ReturnUrl helper for tab-aware nested redirection in Yii2.

145.7k1](/packages/cornernote-yii2-returnurl)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)