sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-24 17:13:01 +00:00
Code Activity

Bump module versions & go over documentation comments

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-02-10 23:18:34 +00:00
parent 429c3eaf50
commit a3330829cb
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
6 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
modules/action-hash.php
View file

@ -28,19 +28,16 @@ register_module([
add_action("hash", function() { add_action("hash", function() {
global $settings; global $settings;
if(!isset($_GET["string"])) if(!isset($_GET["string"])) {
{
http_response_code(422); http_response_code(422);
exit(page_renderer::render_main("Missing parameter", "<p>The <code>GET</code> parameter <code>string</code> must be specified.</p> exit(page_renderer::render_main("Missing parameter", "<p>The <code>GET</code> parameter <code>string</code> must be specified.</p>
<p>It is strongly recommended that you utilise this page via a private or incognito window in order to prevent your password from appearing in your browser history.</p>")); <p>It is strongly recommended that you utilise this page via a private or incognito window in order to prevent your password from appearing in your browser history.</p>"));
} }
else if(!empty($_GET["raw"])) else if(!empty($_GET["raw"])) {
{
header("content-type: text/plain"); header("content-type: text/plain");
exit(hash_password($_GET["string"])); exit(hash_password($_GET["string"]));
} }
else else {
{
exit(page_renderer::render_main("Hashed string", "<p>Algorithm: <code>$settings->password_algorithm</code></p>\n<p><code>" . $_GET["string"] . "</code> → <code>" . hash_password($_GET["string"]) . "</code></p>")); exit(page_renderer::render_main("Hashed string", "<p>Algorithm: <code>$settings->password_algorithm</code></p>\n<p><code>" . $_GET["string"] . "</code> → <code>" . hash_password($_GET["string"]) . "</code></p>"));
} }
}); });

3
modules/feature-comments.php
View file

@ -1,7 +1,7 @@
<?php <?php
register_module([ register_module([
"name" => "Page Comments", "name" => "Page Comments",
"version" => "0.3.1", "version" => "0.3.2",
"author" => "Starbeamrainbowlabs", "author" => "Starbeamrainbowlabs",
"description" => "Adds threaded comments to the bottom of every page.", "description" => "Adds threaded comments to the bottom of every page.",
"id" => "feature-comments", "id" => "feature-comments",
@ -369,6 +369,7 @@ function find_comment($comment_data, $comment_id)
/** /**
* Deletes the first comment found with the specified id. * Deletes the first comment found with the specified id.
* @package feature-comments
* @param array $comment_data An array of threaded comments to delete the comment from. * @param array $comment_data An array of threaded comments to delete the comment from.
* @param string $target_id The id of the comment to delete. * @param string $target_id The id of the comment to delete.
* @return bool Whether the comment was found and deleted or not. * @return bool Whether the comment was found and deleted or not.

6
modules/feature-interwiki-links.php
View file

@ -1,7 +1,7 @@
<?php <?php
register_module([ register_module([
"name" => "Interwiki links", "name" => "Interwiki links",
"version" => "0.1", "version" => "0.1.1",
"author" => "Starbeamrainbowlabs", "author" => "Starbeamrainbowlabs",
"description" => "Adds interwiki link support. Set the interwiki_index_location setting at an index file to activate support.", "description" => "Adds interwiki link support. Set the interwiki_index_location setting at an index file to activate support.",
"id" => "feature-interwiki-links", "id" => "feature-interwiki-links",
@ -71,6 +71,7 @@ function interwiki_index_update() {
/** /**
* Parses an interwiki pagename into it's component parts. * Parses an interwiki pagename into it's component parts.
* @package interwiki-links
* @param string $interwiki_pagename The interwiki pagename to parse. * @param string $interwiki_pagename The interwiki pagename to parse.
* @return string[] An array containing the parsed components of the interwiki pagename, in the form ["prefix", "page_name"]. * @return string[] An array containing the parsed components of the interwiki pagename, in the form ["prefix", "page_name"].
*/ */
@ -84,6 +85,7 @@ function interwiki_pagename_parse($interwiki_pagename) {
/** /**
* Resolves an interwiki pagename to the associated * Resolves an interwiki pagename to the associated
* interwiki definition object. * interwiki definition object.
* @package interwiki-links
* @param string $interwiki_pagename An interwiki pagename. Should be in the form "prefix:page name". * @param string $interwiki_pagename An interwiki pagename. Should be in the form "prefix:page name".
* @return stdClass The interwiki definition object. * @return stdClass The interwiki definition object.
*/ */
@ -106,6 +108,7 @@ function interwiki_pagename_resolve($interwiki_pagename) {
} }
/** /**
* Converts an interwiki pagename into a url. * Converts an interwiki pagename into a url.
* @package interwiki-links
* @param string $interwiki_pagename The interwiki pagename (in the form "prefix:page name") * @param string $interwiki_pagename The interwiki pagename (in the form "prefix:page name")
* @return string A url that points to the specified interwiki page. * @return string A url that points to the specified interwiki page.
*/ */
@ -125,6 +128,7 @@ function interwiki_get_pagename_url($interwiki_pagename) {
/** /**
* Returns whether a given pagename is an interwiki link or not. * Returns whether a given pagename is an interwiki link or not.
* Note that this doesn't guarantee that it's a _valid_ interwiki link - only that it looks like one :P * Note that this doesn't guarantee that it's a _valid_ interwiki link - only that it looks like one :P
* @package interwiki-links
* @param string $pagename The page name to check. * @param string $pagename The page name to check.
* @return boolean Whether the given page name is an interwiki link or not. * @return boolean Whether the given page name is an interwiki link or not.
*/ */

2
modules/feature-recent-changes.php
View file

@ -1,7 +1,7 @@
<?php <?php
register_module([ register_module([
"name" => "Recent Changes", "name" => "Recent Changes",
"version" => "0.4", "version" => "0.5",
"author" => "Starbeamrainbowlabs", "author" => "Starbeamrainbowlabs",
"description" => "Adds recent changes. Access through the 'recent-changes' action.", "description" => "Adds recent changes. Access through the 'recent-changes' action.",
"id" => "feature-recent-changes", "id" => "feature-recent-changes",

5
modules/feature-redirect.php
View file

@ -18,8 +18,9 @@ register_module([
/** /**
* Updates the metadata associated with redirects in the pageindex entry * Updates the metadata associated with redirects in the pageindex entry
* specified utilising the provided page content. * specified utilising the provided page content.
* @param object $index_entry The page index entry object to update. * @package redirect
* @param string $pagedata The page content to operate on. * @param object $index_entry The page index entry object to update.
* @param string $pagedata The page content to operate on.
*/ */
function update_redirect_metadata(&$index_entry, &$pagedata) { function update_redirect_metadata(&$index_entry, &$pagedata) {
$matches = []; $matches = [];

1
modules/feature-search.php
View file

@ -477,6 +477,7 @@ window.addEventListener("load", function(event) {
/** /**
* Holds a collection to methods to manipulate various types of search index. * Holds a collection to methods to manipulate various types of search index.
* @package search
*/ */
class search class search
{ {