PHPackages                             taktwerk/tw-yii2-rest - 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. [HTTP & Networking](/categories/http)
4. /
5. taktwerk/tw-yii2-rest

ActiveYii2-extension[HTTP & Networking](/categories/http)

taktwerk/tw-yii2-rest
=====================

The enhanced restful api for Yii Framework 2.0 based on HarryZheng0907's yii2-rest

v1.0.2(10y ago)03.6kBSDPHP

Since Feb 12Pushed 10y ago1 watchersCompare

[ Source](https://github.com/taktwerk/tw-yii2-rest)[ Packagist](https://packagist.org/packages/taktwerk/tw-yii2-rest)[ RSS](/packages/taktwerk-tw-yii2-rest/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (1)Versions (5)Used By (0)

\#TW-Yii2-Rest

Forked and modified from HarryZheng0907's [yii-rest](https://github.com/HarryZheng0907/yii2-rest).

This package adds some practical search options for your Yii2 ActiveControler's index action.

Functionality
-------------

[](#functionality)

1. Search capability

```
http://url/users?id=1&username=LIKE_dmi&created_at=MAX_1398153715&addresses.city=南京

```

2. Multi-level expanding of relations

```
http://url/users?expand=addresses,friends.addresses&expand-fields=addresses.phone,friends.addresses

```

3. Sorting by child relation

```
http://url/users?sort=addresses.phone DESC,id ASC

```

4. Grouping

```
http://url/rooms?group=building.building_id=4

```

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

[](#installation)

```
php composer.phar require taktwerk/tw-yii2-rest

```

Usage
-----

[](#usage)

### IndexAction

[](#indexaction)

Change the IndexAction of your Active Controlers to point to `taktwerk\rest\IndexAction`

Examples
--------

[](#examples)

```
EQUAL:http://url/users?username=EQUAL_a  // username = 'a'
NOTEQUAL:http://url/users?username=NOTEQUAL_a  // username != 'a'
NULL:http://url/users?username=NULL_  // username IS NULL
LIKE:http://url/users?username=LIKE_a  //username LIKE '%a%'
LLIKE:http://url/users?username=LLIKE_a  //username LIKE '%a'
RLIKE:http://url/users?username=RLIKE_a  //username LIKE 'a%'
IN:http://url/users?username=IN_a,b,c  //username IN ('a','b','c')
NOTIN:http://url/users?username=NOTIN_a,b,c  //username NOT IN ('a','b','c')
MIN:http://url/users?age_min=MIN_10  // age >= 10
MAX:http://url/users?age_max=Max_60  //age