Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
f939300f
Commit
f939300f
authored
Apr 11, 2014
by
Carsten Brandt
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add guide about filtering and sorting related columns
fixes #1581 and #3013
parent
3cdf95d5
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
43 additions
and
5 deletions
+43
-5
data-grid.md
docs/guide/data-grid.md
+43
-5
No files found.
docs/guide/data-grid.md
View file @
f939300f
...
...
@@ -274,15 +274,53 @@ echo GridView::widget([
Working with model relations
----------------------------
When displaying
A
ctive records in a GridView you might encounter the case where you display values of related
When displaying
a
ctive records in a GridView you might encounter the case where you display values of related
columns such as the posts authors name instead of just his
`id`
.
You do this by defining the attribute name in columns as
`author.name`
when the
`Post`
model
has a relation named
`author`
and the author model has an attribute
`name`
.
The GridView will then display the name of the author but sorting and filtering are not enabled by default.
You have to adjust the
`PostSearch`
model to add this functionallity.
You have to adjust the
`PostSearch`
model t
hat has been introduced in the last section t
o add this functionallity.
TBD
To enable sorting on a related column you have to join the related table and add the sorting rule
to the Sort component of the dataprovider:
```
php
$query
=
Post
::
find
();
$dataProvider
=
new
ActiveDataProvider
([
'query'
=>
$query
,
]);
-
https://github.com/yiisoft/yii2/issues/1581
-
https://github.com/yiisoft/yii2/issues/3013
// join with relation `author` that is a relation to the table `users`
// and set the table alias to be `author`
$query
->
joinWith
([
'author'
=>
function
(
$query
)
{
$query
->
from
([
'author'
=>
'users'
]);
}]);
// enable sorting for the related column
$dataProvider
->
sort
->
attributes
[
'author.name'
]
=
[
'asc'
=>
[
'author.name'
=>
SORT_ASC
],
'desc'
=>
[
'author.name'
=>
SORT_DESC
],
];
// ...
```
Filtering also needs the joinWith call as above. You also need to define the searchable column in attributes and rules like this:
```
php
public
function
attributes
()
{
// add related fields to searchable attributes when in search scenario
if
(
$this
->
getScenario
()
==
'search'
)
{
return
array_merge
(
parent
::
attributes
(),
[
'site.number'
]);
}
return
parent
::
attributes
();
}
public
function
rules
()
{
return
[
[[
'id'
],
'integer'
],
[[
'title'
,
'creation_date'
,
'author.name'
],
'safe'
],
];
}
```
In
`search()`
you then just add another filter condition with
`$query->andFilterWhere(['LIKE', 'author.name', $this->getAttribute('author.name')]);`
.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment