Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/black-lamp/yii2-search
Component for search in Active Record model
https://github.com/black-lamp/yii2-search
black-lamp php yii-extension yii2
Last synced: about 2 months ago
JSON representation
Component for search in Active Record model
- Host: GitHub
- URL: https://github.com/black-lamp/yii2-search
- Owner: black-lamp
- License: bsd-3-clause
- Created: 2016-09-19T15:25:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-10T08:33:50.000Z (over 7 years ago)
- Last Synced: 2024-04-03T01:15:19.037Z (9 months ago)
- Topics: black-lamp, php, yii-extension, yii2
- Language: PHP
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Component for search in Active Record model
===========================================
[](https://travis-ci.org/black-lamp/yii2-search)
[](https://packagist.org/packages/black-lamp/yii2-search)
[](https://packagist.org/packages/black-lamp/yii2-search)
[](https://packagist.org/packages/black-lamp/yii2-search)
Installation
------------
Run command
```
composer require black-lamp/yii2-search
```
or add
```json
"black-lamp/yii2-search": "^2.0.0"
```
to the require section of your composer.json.
#### Add 'SiteSearch' component to application config
```php
'components' => [
// ...
'search' => [
'class' => bl\search\SearchComponent::class,
// models where you need the search
'models' => [
'article' => [
'class' => frontend\models\Article::class,
'label' => 'Articles'
],
// ...
]
],
]
```
To models array you should to add the active record models where component will be make a search.
`class` it's a model's name.
`label` it's a title for displaying in view.
#### Implement [interface](https://github.com/black-lamp/yii2-search/blob/master/src/interfaces/SearchInterface.php) in the models where you need a search
```php
/**
* @property integer $id
* @property string $title
* @property string $shortText
* @property string $fullText
* @property string $socialNetworksText
*/
class Article extends ActiveRecord implements \bl\search\interfaces\SearchInterface
{
// ...
/**
* @inheritdoc
*/
public function getSearchTitle() {
return $this->title;
}
/**
* @inheritdoc
*/
public function getSearchDescription() {
return $this->shortText;
}
/**
* @inheritdoc
*/
public function getSearchUrl() {
return Url::toRoute["/articles/$this->id"];
}
/**
* @inheritdoc
*/
public function getSearchFields() {
return [
'title',
'shortText',
'fullText'
];
}
}
```
Using
-----
Call method for getting a search results.
This method return a [SearchResult](https://github.com/black-lamp/yii2-search/blob/master/src/data/SearchResult.php) objects in array.
```php
/**
* @var \bl\search\data\SearchResult[] $result
*/
$result = Yii::$app->searcher->search('Black lamp');
foreach($result as $res) {
$res->title;
$res->description;
$res->url;
}
```