Add doc to Model\Term

This commit is contained in:
Hypolite Petovan 2019-02-23 09:25:37 -05:00
parent 67aa188830
commit f4745c5936

View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* @file src/Model/Term * @file src/Model/Term.php
*/ */
namespace Friendica\Model; namespace Friendica\Model;
@ -8,6 +8,15 @@ use Friendica\Core\System;
use Friendica\Database\DBA; use Friendica\Database\DBA;
use Friendica\Util\Strings; 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 class Term
{ {
const UNKNOWN = 0; const UNKNOWN = 0;
@ -18,7 +27,13 @@ class Term
const FILE = 5; const FILE = 5;
const SAVEDSEARCH = 6; const SAVEDSEARCH = 6;
const CONVERSATION = 7; const CONVERSATION = 7;
/**
* An implicit mention is a mention in a comment body that is redundant with the threading information.
*/
const IMPLICIT_MENTION = 8; 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 EXCLUSIVE_MENTION = 9;
const TAG_CHARACTER = [ const TAG_CHARACTER = [