1
0
mirror of https://github.com/flarum/core.git synced 2025-07-22 17:21:27 +02:00

Add todos to document magic properties on models

This commit is contained in:
Toby Zerner
2015-07-07 19:20:18 +09:30
parent e62093f4dd
commit f17c3a2778
10 changed files with 27 additions and 0 deletions

View File

@@ -2,6 +2,9 @@
use Flarum\Core\Model; use Flarum\Core\Model;
/**
* @todo document database columns with @property
*/
class AccessToken extends Model class AccessToken extends Model
{ {
/** /**

View File

@@ -14,6 +14,8 @@ use Flarum\Core\Model;
* in the activity feed, and what *subject* is associated with it. For example, * in the activity feed, and what *subject* is associated with it. For example,
* the 'posted' activity type represents that a user made a post. Its subject is * the 'posted' activity type represents that a user made a post. Its subject is
* a post, of which the ID is stored in the `subject_id` column. * a post, of which the ID is stored in the `subject_id` column.
*
* @todo document database columns with @property
*/ */
class Activity extends Model class Activity extends Model
{ {

View File

@@ -14,6 +14,9 @@ use Flarum\Core\Support\Locked;
use Flarum\Core\Support\VisibleScope; use Flarum\Core\Support\VisibleScope;
use Flarum\Core\Support\ValidatesBeforeSave; use Flarum\Core\Support\ValidatesBeforeSave;
/**
* @todo document database columns with @property
*/
class Discussion extends Model class Discussion extends Model
{ {
use EventGenerator; use EventGenerator;

View File

@@ -11,6 +11,8 @@ use Illuminate\Database\Eloquent\Builder;
* Stores information about how much of a discussion a user has read. Can also * Stores information about how much of a discussion a user has read. Can also
* be used to store other information, if the appropriate columns are added to * be used to store other information, if the appropriate columns are added to
* the database, like a user's subscription status for a discussion. * the database, like a user's subscription status for a discussion.
*
* @todo document database columns with @property
*/ */
class DiscussionState extends Model class DiscussionState extends Model
{ {

View File

@@ -2,6 +2,9 @@
use Flarum\Core\Model; use Flarum\Core\Model;
/**
* @todo document database columns with @property
*/
class Group extends Model class Group extends Model
{ {
/** /**

View File

@@ -15,6 +15,8 @@ use Flarum\Core\Model;
* For example, the 'discussionRenamed' notification type represents that * For example, the 'discussionRenamed' notification type represents that
* someone renamed a user's discussion. Its subject is a discussion, of which * someone renamed a user's discussion. Its subject is a discussion, of which
* the ID is stored in the `subject_id` column. * the ID is stored in the `subject_id` column.
*
* @todo document database columns with @property
*/ */
class Notification extends Model class Notification extends Model
{ {

View File

@@ -8,6 +8,9 @@ use Flarum\Core\Support\EventGenerator;
use Flarum\Core\Support\ValidatesBeforeSave; use Flarum\Core\Support\ValidatesBeforeSave;
use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Builder;
/**
* @todo document database columns with @property
*/
class Post extends Model class Post extends Model
{ {
use EventGenerator; use EventGenerator;

View File

@@ -2,6 +2,9 @@
use Flarum\Core\Model; use Flarum\Core\Model;
/**
* @todo document database columns with @property
*/
class EmailToken extends Model class EmailToken extends Model
{ {
/** /**

View File

@@ -2,6 +2,9 @@
use Flarum\Core\Model; use Flarum\Core\Model;
/**
* @todo document database columns with @property
*/
class PasswordToken extends Model class PasswordToken extends Model
{ {
/** /**

View File

@@ -19,6 +19,9 @@ use Flarum\Core\Support\VisibleScope;
use Flarum\Core\Support\EventGenerator; use Flarum\Core\Support\EventGenerator;
use Flarum\Core\Support\ValidatesBeforeSave; use Flarum\Core\Support\ValidatesBeforeSave;
/**
* @todo document database columns with @property
*/
class User extends Model class User extends Model
{ {
use EventGenerator; use EventGenerator;