]> git.mxchange.org Git - friendica.git/commitdiff
Add doc to Model\Term
authorHypolite Petovan <hypolite@mrpetovan.com>
Sat, 23 Feb 2019 14:25:37 +0000 (09:25 -0500)
committerHypolite Petovan <hypolite@mrpetovan.com>
Sat, 23 Feb 2019 22:32:13 +0000 (17:32 -0500)
src/Model/Term.php

index 36876368dfabb1f468d30b7465fba681dba81ba4..58c322365958f4871d6865889a92171257af2241 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @file src/Model/Term
+ * @file src/Model/Term.php
  */
 namespace Friendica\Model;
 
@@ -8,6 +8,15 @@ use Friendica\Core\System;
 use Friendica\Database\DBA;
 use Friendica\Util\Strings;
 
+/**
+ * Class Term
+ *
+ * This Model class handles term table interactions.
+ * This tables stores relevant terms related to posts, photos and searches, like hashtags, mentions and
+ * user-applied categories.
+ *
+ * @package Friendica\Model
+ */
 class Term
 {
     const UNKNOWN           = 0;
@@ -18,7 +27,13 @@ class Term
     const FILE              = 5;
     const SAVEDSEARCH       = 6;
     const CONVERSATION      = 7;
+       /**
+        * An implicit mention is a mention in a comment body that is redundant with the threading information.
+        */
     const IMPLICIT_MENTION  = 8;
+       /**
+        * An exclusive mention transfers the ownership of the post to the target account, usually a forum.
+        */
     const EXCLUSIVE_MENTION = 9;
 
     const TAG_CHARACTER = [