Missing Documentation: Model Service - $_type_classes

オープン
#227 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
38/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
php
領域
documentation

調査の方向性

Read the Model Service documentation at services/model/building-your-own.html, especially the Typed Columns and Composite Types sections. Check how $_type_classes and the ChannelPreferences example relate to custom composite types, then document the property and explain its use. Done means the guide clearly describes how custom composite types are configured.

索引モデルが issue の本文から書いたものです。

説明

Suggested Change

Add documentation to describe $_type_classes property for the Model Service. The use case I have found which demonstrates this can be found in the Site Model

Note: While writing this issue, I noticed that this model now does not actually use a custom $_type_classes for any of its properties: ExpressionEngine\Service\Model\Column\CustomType

I am assuming that this change happened between version 5 and 6.

Reasoning

The documentation does describe Typed Columns but it does not describe that Composite Types can be custom.

Example of a custom composite type: ChannelPreferences

Additional context

I assume that the Site Model no longer utilizes these custom $_type_classes because information stored in these variables is only accessible once the model has been loaded, therefore these property values cannot be used when filtering for models. Is this correct?

Also, I have not looked deeper into this, but the Site Model was the only model I was familiar with that used this type of Variable Column. My next question is whether or not the uses of $_type_classes are being phased out in a later version?

主要言語
CSS
スター
22
フォーク
79
平均マージ
2日 1時間
マージ済み PR(30日)
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ExpressionEngine/ExpressionEngine-User-Guide のほかの issue

ExpressionEngine/ExpressionEngine-User-Guide の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。