https://github.com/toplan/filter-manager
:mag:A filter manager help you elegant generate filter url
https://github.com/toplan/filter-manager
filter filter-manager filter-url url-creater
Last synced: 3 months ago
JSON representation
:mag:A filter manager help you elegant generate filter url
- Host: GitHub
- URL: https://github.com/toplan/filter-manager
- Owner: toplan
- License: mit
- Created: 2015-01-23T04:51:40.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-04-11T15:23:00.000Z (over 8 years ago)
- Last Synced: 2025-08-11T08:36:59.426Z (5 months ago)
- Topics: filter, filter-manager, filter-url, url-creater
- Language: PHP
- Homepage:
- Size: 98.6 KB
- Stars: 78
- Watchers: 7
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Intro
A filter manager package for the product list filter, help you elegant generate filter url.
**[中文文档](https://github.com/toplan/FilterManager/blob/master/README_CN.md)**
# Install
```php
composer require 'toplan/filter-manager:~1.0.4'
```
# Usage
### 1. The preparatory work
```php
require 'path/to/vendor/autoload.php';
use Toplan\FilterManager\FilterManager as FilterManager;
// params
$paramsArray = [
'paramName' => 'value',
...
]
// create instance by yourself.
$fm = FilterManager::create($paramsArray)->setBlackList(['page']);
//then, render `$fm` value to your template!
```
**Or used in laravel just like this:**
Find the providers key in config/app.php and register the FilterManger Service Provider.
```php
'providers' => array(
Toplan\FilterManager\FilterManagerServiceProvider::class,
)
```
Find the aliases key in config/app.php.
```php
'aliases' => array(
'FilterManager' => Toplan\FilterManager\Facades\FilterManager::class,
)
```
### 2. Just enjoy it
use value `$fm` in template:
```html
All
Male
Female
```
or use laravel facade value `FilterManager` in template:
```html
All
Male
Female
```
# API
### create(array $filters, $baseUrl, $blackList)
create a instance.
- `$filters`: this is filters data, required, exp:['gender'=>'male', 'city'=>'beijing']
- `$baseUrl`: default value is empty string.
- `$blackList`: this is blacklist for filters, default value is `[]`, exp:['pageindex'].
### setBlackList(array $list)
set black list for filter.
example:
```php
$fm->setBlackList(['page', 'pageindex']);
//or in laravel
FilterManager::setBlackList(['page', 'pageindex']);
```
### has($filterName)
whether has the character filter, if true will return the value, if don`t return false.
example:
```php
$value = $fm->has('gender');
//or in laravel
$value = FilterManager::has('gender');
```
### isActive($filterName, $filterValue, $trueReturn, $falseReturn)
example:
```php
//in laravel
FilterManager::isActive('gender', 'male');//this will return true or false;
FilterManager::isActive('gender', 'male', 'active', '');//this will return 'active' or '';
```
### url($filterName, $filterValue, $multi, $linkageRemoveFilters, $blackList)
One filter has some values, and every value has a url, this method return a full url string.
- `$filterName`: param name, required.
- `$filterValue`: param value, default value is `FM_SELECT_ALL`.
- `$multi`: whether to support multiple values? `false` or `true`, default value is `false`.
- `$linkageRemoveFilters`：linkage remove the other filter, default value is `[]`.
- `$blackList`: temporary blacklist, default value is ``[]``.
example:
```php
//in laravel
FilterManager::url('gender', FM_SELECT_ALL);//without gender param
FilterManager::url('gender', 'male', false);//single value
FilterManager::url('cities', 'shanghai', true);
FilterManager::url('cities', 'beijing', true);//multiple values
// One province has many cities, one city has many counties ...,
// If you select 'all province' or one of provinces,
// you should linkage remove the selected cities and counties ...
//
// like this:
// select all province
FilterManager::url('province', FM_SELECT_ALL, false, ['cities', 'counties', ...]);//linkage remove selected cities
// select one province
FilterManager::url('province', 'sichuan', false, ['cities', 'counties', ...]);//linkage remove selected cities
```