Missing Documentation: Model Service - $_type_classes

Đang mở
  • Có gì không ổn?
#227 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
38/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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?

Ngôn ngữ chính
CSS
Star
22
Fork
79
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
6

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ExpressionEngine/ExpressionEngine-User-Guide

Tất cả issue của ExpressionEngine/ExpressionEngine-User-Guide

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.