mirror/litebans-php
1
0
Fork 0
mirror of https://gitlab.com/ruany/litebans-php.git synced 2025-05-24 00:42:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add documentation for some functions in page.php

Browse Source
This commit is contained in:
Ruan 2015-08-11 09:54:02 +02:00
parent 6db70d78fc
commit a95cac5c5d
1 changed files with 23 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
includes/page.php
View File

@ -44,10 +44,20 @@ class Page {
} }
} }
/**
* Returns an <img> tag representing the Minecraft avatar for a specific name.
* @param string
* @return string
*/
function get_avatar($name) { function get_avatar($name) {
return "<img class='avatar noselect' src='https://cravatar.eu/avatar/$name/25'/>$name"; return "<img class='avatar noselect' src='https://cravatar.eu/avatar/$name/25'/>$name";
} }
/**
* Returns the last name for a UUID, or null if their name is not recorded in the database.
* @param string
* @return null|string
*/
function get_name($uuid) { function get_name($uuid) {
if (array_key_exists($uuid, $this->uuid_name_cache)) return $this->uuid_name_cache[$uuid]; if (array_key_exists($uuid, $this->uuid_name_cache)) return $this->uuid_name_cache[$uuid];
$history = $this->settings->table_history; $history = $this->settings->table_history;
@ -61,6 +71,11 @@ class Page {
return null; return null;
} }
/**
* Returns the banner name for a specific row in the database, converting UUID->name if necessary.
* @param row
* @return string
*/
function get_banner_name($row) { function get_banner_name($row) {
$uuid = $row['banned_by_uuid']; $uuid = $row['banned_by_uuid'];
$name = $this->get_name($uuid); $name = $this->get_name($uuid);
@ -71,6 +86,11 @@ class Page {
return $this->clean($name); return $this->clean($name);
} }
/**
* Converts a timestamp (in milliseconds) to a date using the configured date format.
* @param int
* @return string
*/
function millis_to_date($millis) { function millis_to_date($millis) {
return date($this->settings->date_format, $millis / 1000); return date($this->settings->date_format, $millis / 1000);
} }
@ -78,8 +98,8 @@ class Page {
/** /**
* Prepares text to be displayed on the web interface. * Prepares text to be displayed on the web interface.
* Removes chat colours, replaces newlines with proper HTML, and sanitizes the text. * Removes chat colours, replaces newlines with proper HTML, and sanitizes the text.
* @param $text * @param string
* @return mixed|string * @return string
*/ */
function clean($text) { function clean($text) {
if (strstr($text, "\xa7") || strstr($text, "&")) { if (strstr($text, "\xa7") || strstr($text, "&")) {
@ -94,7 +114,7 @@ class Page {
} }
function print_page_header($title) { function print_page_header($title) {
$type = $title === "Bans" ? "modal" : "navbar"; $type = ($title === "Bans") ? "modal" : "navbar";
echo(" echo("
<div class=\"row\"> <div class=\"row\">
<div class=\"col-lg-12\"> <div class=\"col-lg-12\">