Missing Documentation: Model Service - $_type_classes

Ouverte
  • Quelque chose ne va pas ?
#227 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
38/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
php
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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?

Langage dominant
CSS
Étoiles
22
Forks
79
Merge moyen
2 j 1 h
PR mergées (30 j)
6

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ExpressionEngine/ExpressionEngine-User-Guide

Toutes les issues de ExpressionEngine/ExpressionEngine-User-Guide

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.