<?php
/*
 |  Snicker     The first native FlatFile Comment Plugin 4 Bludit
 |  @file       ./system/abstract.comments-theme.php
 |  @author     SamBrishes <sam@pytes.net>
 |  @version    0.1.2 [0.1.0] - Alpha
 |
 |  @website    https://github.com/pytesNET/snicker
 |  @license    X11 / MIT License
 |  @copyright  Copyright © 2019 SamBrishes, pytesNET <info@pytes.net>
 */
    if(!defined("BLUDIT")){ die("Go directly to Jail. Do not pass Go. Do not collect 200 Cookies!"); }

    abstract class CommentsTheme{
        /*
         |  REQUIRED :: FORM
         |  @note   This method renders the comment form used on the frontend.
         |
         |  @param  multi   The previously passed username (on errors only)
         |                  An `array(username, hash, nickname)` array if the user is logged in.
         |  @param  string  The previously passed email address (on errors only)!
         |  @param  string  The previously passed comment title (on errors only)!
         |  @param  string  The previously passed comment message (on errors only)!
         */
        abstract public function form($username = "", $email = "", $title = "", $message = "");

        /*
         |  REQUIRED :: COMMENT
         |  @note   This method renders the single shown comments on the frontend.
         |
         |  @param  object  The comment instance.
         |  @param  string  The unique comment UID.
         */
        abstract public function comment($comment, $uid, $depth);

        /*
         |  REQUIRED :: PAGINATION
         |  @note   This method renders the pagination for the comment section.
         |
         |  @param  string  The called location: "top" or "bottom".
         |  @param  int     The current comment page.<, startin with 1.
         |  @param  int     The number of comments to be shown per page.
         |  @param  int     The total number of comments for the content page.
         */
        abstract public function pagination($loction, $cpage, $limit, $count);
    }