default sort on `many_many` relation table isn't clearly documented

未关闭
#312 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
php
领域
documentation

调研方向

Search the developer documentation for the many_many relation and default_sort configuration described in the issue. Document that sorting uses the related TaxonomyTerm by default and explain how to configure sorting on the through relation, using the provided BlogPostTaxonomyTerm example. Done means a newcomer can find and understand the required configuration.

由索引模型根据 Issue 内容生成。

描述

affects/v4 affects/v5 type/docs

Affected Version

5.0.0

Description

I have a BlogPost DataObject that has many_many relation with TaxonomyTerm DataObject through BlogPostTaxonomyTerm as below:

private static array $many_many = [
    'Terms' => [
        'through' => BlogPostTaxonomyTerm::class,
        'from' => 'Parent',
        'to' => 'TaxonomyTerm',
    ],
];

There is a Sort field on the TaxonomyTerm DataObject and a separate Sort field on the many_many through relation DataObject BlogPostTaxonomyTerm.

I want to sort the linked TaxonomyTerms on the BlogPost based on the Sort value on the BlogPostTaxonomyTerm table. However, I am not able to do that. The Sorting result is always determined by the Sort value on the TaxonomyTerm DataObject instead.

Here is an example, I have the following fixture file for unit test:

SilverStripe\Taxonomy\TaxonomyTerm:
  term1:
    Name: term1
    Sort: 1
  term2:
    Name: term2
    Sort: 2
  term3:
    Name: term3
    Sort: 3

App\Pages\BlogPost:
  page1:
    Title: 'Blog Post 1'
    PublishDate: '2023-06-20 15:55:50'

App\Taxonomy\ThroughRelations\BlogPostTaxonomyTerm:
  blogPostTerm1:
    Parent: =>App\Pages\BlogPost.page1
    TaxonomyTerm: =>SilverStripe\Taxonomy\TaxonomyTerm.term3
    Sort: 1
  blogPostTerm2:
    Parent: =>App\Pages\BlogPost.page1
    TaxonomyTerm: =>SilverStripe\Taxonomy\TaxonomyTerm.term2
    Sort: 2
  blogPostTerm3:
    Parent: =>App\Pages\BlogPost.page1
    TaxonomyTerm: =>SilverStripe\Taxonomy\TaxonomyTerm.term1
    Sort: 3

And I want to test the first term of the App\Pages\BlogPost.page1.
The expected result is the first term should be "term3", however the actual first term is "term1".

After I add the following config to the BlogPostTaxonomyTerm many_many relation, the Sorting works as expected.

 private static string $default_sort = '"BlogPostTaxonomyTerm"."Sort"';
主要语言
没有语言数据
星标
7
派生
76
平均合并
1 小时 48 分钟
30 天内合并 PR
1

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

silverstripe/developer-docs 的其他 Issue

查看 silverstripe/developer-docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。