Documentation

The Forum module tables

Forum Groups

FieldDescription Type Required Default
ID The forum group ID. Unique. Int Yes  
SORT Sort weight. Int Yes 150

Site-dependent parameters of the forum groups

FieldDescription Type Required Default
FORUM_GROUP_ID The forum group ID Int Yes  
LID The site ID Char(2) Yes  
NAME Name of the forum group String(255) Yes  
DESCRIPTION Description of the forum group String(255) No  

Forums

FieldDescription Type Required Default
ID The forum ID. Unique. Int Yes  
NAME The forum name. String(128) Yes  
DESCRIPTION The forum description. String(255) No  
SORT Sort weight Int Yes 150
ACTIVE Specifies the forum is active (Y|N) Char(1) Yes Y
ALLOW_HTML Allow HTML in messages (Y|N) Char(1) Yes N
ALLOW_NL2BR Convert carriage returns to <br> in HTML mode (Y|N) Char(1) Yes N
ALLOW_ANCHOR Allow tags <a> / [a] (Y|N) Char(1) Yes Y
ALLOW_BIU Allow tags <b> / [b], <i> / [i], <u> / [u] (Y|N) Char(1) Yes Y
ALLOW_IMG Allow tag <img> / [img] (Y|N) Char(1) Yes Y
ALLOW_LIST Allow tag <ul> / [list] (Y|N) Char(1) Yes Y
ALLOW_QUOTE Allow tag <quote> / [quote] (Y|N) Char(1) Yes Y
ALLOW_CODE Allow tag <code> / [code] (Y|N) Char(1) Yes Y
ALLOW_FONT Allow tag <font> / [color], [font] (Y|N) Char(1) Yes Y
ALLOW_SMILES Allow smiley images (Y|N) Char(1) Yes Y
ALLOW_UPLOAD Allow uploading files attached to messages. Possible values: N - deny upload, Y - only images, F - files with extensions specified in ALLOW_UPLOAD_EXT, A - all files. Char(1) Yes N
MODERATION Specifies the forum is pre-moderated (Y|N) Char(1) Yes N
ORDER_BY Default sorting of the forum topics. Possible values: T - topic title, N - number of messages, A - author, V - topic views, D - creation date, P - the date of the last message. Char(1) Yes P
ORDER_DIRECTION Default sort order of the forum topics. Possible values: ASC - ascending, DESC - descending. Char(4) Yes DESC
TOPICS Number of topics in the forum. Int Yes 0
POSTS Number of posts in the forum Int Yes 0
LAST_POSTER_ID The ID of the last message author. Int No  
LAST_POSTER_NAME The name of the last message author. String(64) No  
LAST_POST_DATE The date of the last message.. DateTime No  
LAST_MESSAGE_ID The ID of the last message. Int No  
ALLOW_UPLOAD_EXT Comma-separated extensions of files allowed to be uploaded. Applicable if only ALLOW_UPLOAD is "F". String(255) No  
FORUM_GROUP_ID The forum group ID. Int No  
ASK_GUEST_EMAIL Require the e-mail address to be provided by unregistered authors (Y/N) Char(1) No N

Forum and site relation

Field Description Type Required Default
FORUM_ID The forum ID. Int Yes  
SITE_ID The site ID. Char(2) Yes  
PATH2FORUM_MESSAGE Forum message path template. Can contain macros #FORUM_ID#, #TOPIC_ID#, #MESSAGE_ID# which must be replaced with the real forum ID, topic ID and message ID. varchar(250) No  

Forum topics

FieldDescription Type Required Default
ID The forum topic ID. Unique. Int Yes  
TITLE The topic title. String(70) Yes  
DESCRIPTION The topic description. String(70) No  
STATE The topic status: open or closed (Y|N). Char(1) Yes Y
USER_START_ID The topic author ID. Int No  
USER_START_NAME The topic author name. String(64) Yes  
START_DATE The topic creation date.  DateTime Yes  
ICON_ID The topic icon ID.  Int No  
POSTS Number of replies (posts). Int Yes 0
VIEWS Number of views. Int Yes 0
FORUM_ID The parent forum ID. Int Yes  
APPROVED Specifies the topic is published (Y|N). The topic is published if it contains at least one post. Char(1) Yes Y
SORT Sort weight. Int Yes 150
LAST_POSTER_ID The ID of the last message author. Int No  
LAST_POSTER_NAME The name of the last message author. String(64) Yes  
LAST_POST_DATE The date of the last message.. DateTime Yes  
LAST_MESSAGE_ID The ID of the last message. Int Yes  

Posts (forum messages)

FieldDescription Type Required Default
ID The post ID. Unique. Int Yes  
AUTHOR_ID The post author ID. Int No  
AUTHOR_NAME The post author name. String(128) Yes  
AUTHOR_IP The post author ID. String(128) No  
USE_SMILES The user chooses to replace text smileys with icons (Y|N). Char(1) Yes Y
POST_DATE The date the post is created. Datetime Yes  
POST_MESSAGE The post text. Text Yes  
FORUM_ID The ID of the forum in which the post occurred. Int Yes  
TOPIC_ID The ID of the topic in which the post occurred. Int Yes  
APPROVED The post is published (Y|N) Char(1) Yes Y
GUEST_ID The visitor ID. Int No  
AUTHOR_REAL_IP The real IP of the post author. Int No  
ATTACH_IMG Attachment. Int No  

Forum user profile

FieldDescription Type Required Default
ID The profile ID. Unique. Int Yes  
USER_ID The user ID. Unique. Int Yes  
DESCRIPTION The user description. String(64) No  
IP_ADDRESS The IP address from which the last message was sent. String(128) Yes  
AVATAR The avatar. Int No  
NUM_POSTS Total number of posts. Int Yes 0
INTERESTS The user personal information (text). Text No  
LAST_POST The ID of the last message created by the user. Int No  
ALLOW_POST The user is not banned. Char(1) Yes Y
LAST_VISIT The date of the last visit. DateTime Yes  
DATE_REG The date the user was registered. DateTime Yes  
REAL_IP_ADDRESS The real IP address used to create the last message. String(128) No  
SIGNATURE Signature text. String(255) No  
SHOW_NAME Denotes to show name instead of login (Y|N) Char(1) Yes Y
HIDE_FROM_ONLINE Do not show in the "Who is online" list (Y/N) Char(1) No N
POINTS Current points count. Int No 0

User ranks

FieldDescription Type Required Default
ID The user rank ID. Unique. Yes  
MIN_POINTS Number of points required to gain this rank. Int Yes 0
CODE Mnemonic code of the rank. varchar(100) No  
VOTES Number of votes that a user in this rank can give to other users. Int Yes 0

Language parameters of points

FieldDescription Type Required Default
POINTS_ID The rank ID. Int Yes  
LID The language ID. Char(2) Yes  
NAME The rank name. String(250) Yes  

 Point-per-post lookup table

Field Description Type Required Default
ID The primary record ID. Int Yes  
MIN_NUM_POSTS Number of messages required to gain this number of points per message. Int Yes 0
POINTS_PER_POST Number of points per message. Can be fractional. decimal(18, 4) Yes 0

Smileys and icons

FieldDescription Type Required Default
ID The smiley ID. Unique. Yes  
TYPE The smiley type: S - smiley, I - icon. Char(2) Yes S
TYPING Smiley text variants. Separated with spaces. String(100) Yes  
IMAGE The image name. String(128) Yes  
SORT Sort weight. Int Yes 150
IMAGE_WIDTH Image width. Int Yes 0
IMAGE_HEIGHT Image height. Int Yes 0

Language parameters of smileys

FieldDescription Type Required Default
SMILE_ID The smiley ID. Int Yes  
LID The language ID. Char(2) Yes  
NAME The smiley name. String(255) Yes  

Subscription

FieldDescription Type Required Default
ID The subscription ID. Int Yes  
USER_ID The subscriber ID. Int Yes  
FORUM_ID The ID of the forum whose messages a subscriber wants to receive. Int Yes  
TOPIC_ID The ID of the topic whose messages a subscriber wants to receive. Int No  
START_DATE The date of subscription. DateTime Yes  
LAST_SEND The ID of the last message sent. Int No  
NEW_TOPIC_ONLY Subscribed to new topics only (Y/N) Char(1) Yes N
SITE_ID The ID of the site from which the subscription has been made. Char(2) Yes en

Private messages

Field Description Type Required Default
ID The unique message ID. Int Yes  
AUTHOR_ID The message author ID. Int Yes  
USER_ID The message recipient user ID. Int Yes  
FOLDER_ID The user folder ID. Int Yes  
IS_READ Indicates that the message is read. Int Yes  
USE_SMILES Replace text smileys with images (Y|N). Int Yes  
POST_DATE The date the message was created. DateTimeYes  
POST_SUBJ The message subject. String(255)No  
POST_MESSAGE The message body. TextNo  

User folders

Field Description Type Required Default
ID The unique folder ID. Int Yes  
TITLE The message author ID. String(50)Yes  
USER_ID The folder owner ID. Int Yes  

Dictionary of obscene words

Field Description Type Required Default
ID The unique record ID. Int Yes  
TITLE The dictionary name. String(50) Yes  
TYPE The dictionary type. Char Yes  

Dictionary of letters

Field Description Type Required Default
ID The unique record ID. Int Yes  
DICTIONARY_ID The dictionary ID. Int Yes  
LETTER The original letter to be substituted. String(50)Yes  
REPLACEMENT The replacement letter. String(50)Yes  

Dictionary of unquotable words

Field Description Type Required Default
ID The unique record ID. Int Yes  
DICTIONARY_ID The dictionary ID. Int Yes  
WORDS A word. String(255)No  
PATTERN A pattern which would match words under this dictionary record. String(255)No  
REPLACEMENT A word with which the matching words will be replaced. String(255)No  
DESCRIPTION The description. Text No  
REPLACEMENT The replacement word. String(50)Yes  
USE_IT Use this pattern (Y|N). CharYes  
© «Bitrix24», 2001-2024
Up