| BkTree | A serialisable BK-Tree Implementation. |
| ids | Provides an interface to interact with page ids. |
| JsonStorageBox | Represents a key-value data store. |
| Nilsimsa | The MIT License (MIT) |
| page_renderer | Renders the HTML page that is sent to the client. |
| Slimdown | Modified by Starbeamrainbowlabs (starbeamrainbowlabs) |
| StorageBox | Represents a key-value data store. |
add_parser(string $name,callable $parser_code,callable $hash_generator)
Registers a new parser.
| string | $name | The name of the new parser to register. |
| callable | $parser_code | The function to register as a new parser. |
| callable | $hash_generator | A function that should take a single argument of the input source text, and return a unique hash for that content. The return value is used as the filename for cache entries, so should be safe to use as such. |
check_subpage_parents(string $pagename,boolean $create_dir = true)
Makes sure that a subpage's parents exist.
Note this doesn't check the pagename itself.
| string | $pagename | The pagename to check. |
| boolean | $create_dir | Whether to create an associated directory for subpages or not. |
cli_exec(string|array $string): integer
Executes a given Pepperminty Wiki shell command.
This function kill the process if the current execution environment is not the CLI. The returned exit code functions as a normal shell process exit code does.
| string|array | $string | The shell command to execute. |
The exit code of the command executed.
cli_register(string $name,string $description,callable $function): void
Registers a new CLI command.
Throws an error if a CLI command with the specified name already exists.
| string | $name | The name of command. |
| string | $description | The description of the command. |
| callable | $function | The function to execute when this command is executed. An array is passed as the first and only argument containing the arguments passed when the command was invoked. |
delete_comment(array $comment_data,string $target_id): boolean
Deletes the first comment found with the specified id.
| array | $comment_data | An array of threaded comments to delete the comment from. |
| string | $target_id | The id of the comment to delete. |
Whether the comment was found and deleted or not.
delete_recursive(string $path,boolean $delete_self = true)
Recursively deletes a directory and it's contents.
Adapted by Starbeamrainbowlabs
| string | $path | The path to the directory to delete. |
| boolean | $delete_self | Whether to delete the top-level directory. Set this to false to delete only a directory's contents |
email_user(string $username,string $subject,string $body,boolean $ignore_verification = false): boolean
Sends a plain text email to a user, replacing {username} with the specified username.
| string | $username | The username to send the email to. |
| string | $subject | The subject of the email. |
| string | $body | The body of the email. |
| boolean | $ignore_verification | Whether to ignore user email verification status and send the email anyway. Defaults to false. |
Whether the email was sent successfully or not. Currently, this may fail if the user doesn't have a registered email address.
email_user_verify(string $username): boolean
Sends a verification email to the specified user, assuming they need to verify their email address.
If a user does not need to verify their email address, no verification email is sent and true is returned.
| string | $username | The name of the user to send the verification code to. |
Whether the verification code was sent successfully. If a user does not need to verify their email address, this returns true.
email_users(array<mixed,string> $usernames,string $subject,string $body): integer
Sends a plain text email to a list of users, replacing {username} with each user's name.
| array<mixed,string> | $usernames | A list of usernames to email. |
| string | $subject | The subject of the email. |
| string | $body | The body of the email. |
The number of emails sent successfully.
errorimage(string $text,integer $target_size = null): resource
Creates an images containing the specified text.
Useful for sending errors back to the client.
| string | $text | The text to include in the image. |
| integer | $target_size | The target width to aim for when creating the image. Not not specified, a value is determined automatically. |
The handle to the generated GD image.
estimate_reading_time(string $text,string $lang = "en"): array
Estimates the reading time for a given lump of text.
Ref https://github.com/sbrl/Pepperminty-Wiki/issues/172 (has snippet of original code from Firefox & link to study from which the numbers are taken).
| string | $text | The text to estimate for. |
| string | $lang | The language code of the text - defaults to "en" |
An array in the form [ low_time, high_time ] in minutes
fetch_comment_thread(array $comment_data,string $comment_id): array<mixed,object>
Fetches all the parent comments of the specified comment id, including the comment itself at the end.
Useful for figuring out who needs notifying when a new comment is posted.
| array | $comment_data | The comment data to search. |
| string | $comment_id | The comment id to fetch the thread for. |
A list of the comments in the thread, with the deepest one at the end.
find_comment(array $comment_data,string $comment_id): object
Finds the comment with specified id by way of an almost-breadth-first search.
| array | $comment_data | The comment data to search. |
| string | $comment_id | The id of the comment to find. |
The comment data with the specified id, or false if it wasn't found.
find_revisionid_timestamp(string $pagename, $timestamp): integer
Given a page name and timestamp, returns the associated page revision number.
| string | $pagename | The page name to obtain the revision number for. |
| $timestamp |
The revision number of the given page at the given time.
full_url(array $s = false,boolean $use_forwarded_host = false): string
Get the full url, as requested by the client.
| array | $s | The $_SERVER variable. Defaults to $_SERVER. |
| boolean | $use_forwarded_host | Whether to take the X-Forwarded-Host header into account. |
The full url, as requested by the client.
generate_password(string $length): string
Generates a new (cryptographically secure) random password that's also readable (i.e. consonant-vowel-consonant).
This implementation may be changed in the future to use random dictionary words instead - ref https://xkcd.com/936/
| string | $length | The length of password to generate. |
The generated random password.
get_subpages(object $pageindex,string $pagename): object
Gets a list of all the sub pages of the current page.
| object | $pageindex | The pageindex to use to search. |
| string | $pagename | The name of the page to list the sub pages of. |
An object containing all the subpages and their respective distances from the given page name in the pageindex tree.
get_user_pagename(string $username): string
Figures out the path to the user page for a given username.
Does not check to make sure the user acutally exists.
| string | $username | The username to get the path to their user page for. |
The path to the given user's page.
has_action(string $action_name): boolean
Figures out whether a given action is currently registered.
Only guaranteed to be accurate in inside an existing action function
| string | $action_name | The name of the action to search for |
Whether an action with the specified name exists.
hash_password(string $pass): string
Hashes the given password according to the current settings defined in $settings.
| string | $pass | The password to hash. |
The hashed password. Uses password_hash() under-the-hood, but with some additional extras to avoid known issues.
hash_password_compute_cost(boolean $verbose = false): integer
Computes the appropriate cost value for password_hash based on the settings automatically.
Starts at 10 and works upwards in increments of 1. Goes on until a value is found that's greater than the target - or 10x the target time elapses.
| boolean | $verbose | Whether to output verbose progress information to the client or not. |
The automatically calculated password hashing cost.
hash_password_update(string $pass,string $hash): string|null
Determines if the provided password needs re-hashing or not.
| string | $pass | The password to check. |
| string | $hash | The hash of the provided password to check. |
Returns null if an updaste is not required - otherwise returns the new updated hash.
hide_email(\string $email,string $display_text = null): string
Hides an email address from bots. Returns a fragment of HTML that contains the mangled email address.
| \string | ||
| string | $display_text | The display text for the resulting HTML - if null then the original email address is used. |
The mangled email address.
history_add_revision(object $pageinfo,string $newsource,string $oldsource,boolean $save_pageindex = true,string $change_type = "edit")
Adds a history revision against a page.
Note: Does not update the current page content! This function only records a new revision against a page name. Thus it is possible to have a disparity between the history revisions and the actual content displayed in the current revision if you're not careful!
| object | $pageinfo | The pageindex object of the page to operate on. |
| string | $newsource | The page content to save as the new revision. |
| string | $oldsource | The old page content that is the current revision (before the update). |
| boolean | $save_pageindex | Whether the page index should be saved to disk. |
| string | $change_type | The type of change to record this as in the history revision log |
makepathsafe(string $string): string
Makes a path (or page name) safe.
A safe path / page name may not contain: Forward-slashes at the beginning Multiple dots in a row Odd characters (e.g. ?%*:|"<>() etc.) A safe path may, however, contain unicode characters such as éôà etc.
| string | $string | The string to make safe. |
A safe version of the given string.
mb_stripos_all(string $haystack,string $needle): array|false
Case-insensitively finds all occurrences of $needle in $haystack. Handles UTF-8 characters correctly.
| string | $haystack | The string to search. |
| string | $needle | The string to find. |
An array of match indices, or false if nothing was found.
parse_page_source(string $source,boolean $untrusted = false,boolean $use_cache = true): string
Parses the specified page source using the parser specified in the settings into HTML.
The specified parser may (though it's unlikely) render it to other things.
| string | $source | The source to render. |
| boolean | $untrusted | Whether the source string is 'untrusted' - i.e. a user comment. Untrusted source disallows HTML and protects against XSS attacks. |
| boolean | $use_cache | Whether to use the on-disk cache. Has no effect if parser caching is disabled in peppermint.json, or the source string is too small. |
The source rendered to HTML.
render_comments(array<mixed,object> $comments_data,integer $depth): string
Renders a given comments tree to html.
| array<mixed,object> | $comments_data | The comments tree to render. |
| integer | $depth | For internal use only. Specifies the depth at which the comments are being rendered. |
The given comments tree as html.
render_sidebar(array $pageindex,string $root_pagename = ""): string
Renders the sidebar for a given pageindex.
| array | $pageindex | The pageindex to render the sidebar for |
| string | $root_pagename | The pagename that should be considered the root of the rendering. You don't usually need to use this, it is used by the algorithm itself since it is recursive. |
A HTML rendering of the sidebar for the given pageindex.
render_timestamp(integer $timestamp,boolean $absolute = false,boolean $html = true): string
Renders a timestamp in HTML.
| integer | $timestamp | The timestamp to render. |
| boolean | $absolute | Whether the time should be displayed absolutely, or relative to the current time. |
| boolean | $html | Whether the result should formatted as HTML (true) or plain text (false). |
HTML representing the given timestamp.
send_cookie(string $key,string $value,integer $expires): void
Sets a cookie on the client via the set-cookie header.
Uses setcookie() under-the-hood.
| string | $key | The cookie name to set. |
| string | $value | The cookie value to set. |
| integer | $expires | The expiry time to set on the cookie. |
similar_suggest(string $pagename,string $content,\bool $limit_output = true): array
Given a page name, returns a list fo similar pages.
| string | $pagename | The name of the page to return suggestions for. |
| string | $content | The content of the given page. |
| \bool | $limit_output |
A list of suggested page names in the format pagename => rank.
stack_trace(boolean $log_trace = true,boolean $full = false): string
Generates a stack trace.
| boolean | $log_trace | Whether to send the stack trace to the error log. |
| boolean | $full | Whether to output a full description of all the variables involved. |
A string prepresentation of a stack trace.
starts_with(string $haystack,string $needle): boolean
Checks to see if $haystack starts with $needle.
| string | $haystack | The string to search. |
| string | $needle | The string to search for at the beginning of $haystack. |
Whether $needle can be found at the beginning of $haystack.
str_replace_once(string $find,string $replace,string $subject): string
Replaces the first occurrence of $find with $replace.
| string | $find | The string to search for. |
| string | $replace | The string to replace the search string with. |
| string | $subject | The string ot perform the search and replace on. |
The source string after the find and replace has been performed.
theme_update(boolean $force_update = false): boolean
Updates the currently selected theme by fetching it from a remote url.
| boolean | $force_update | Whether to force an update - even if we've already updated recently. |
Whether the update was sucessful. It might fail because of network issues, or the theme update requires a newer version of Pepperminty Wiki than is currently installed.
tree_save(\BkTree $tree)
| \BkTree | $tree |
update_redirect_metadata(object $index_entry,string $pagedata)
Updates the metadata associated with redirects in the pageindex entry specified utilising the provided page content.
| object | $index_entry | The page index entry object to update. |
| string | $pagedata | The page content to operate on. |
update_statistics(boolean $update_all = false,boolean $force = false)
Updates the wiki's statistics.
| boolean | $update_all | Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings. |
| boolean | $force | Whether we should recalculate statistics that don't currently require recalculating anyway. |
upload_check_svg(string $temp_filename): array<mixed,integer>
Checks an uploaded SVG file to make sure it's (at least somewhat) safe.
Sends an error to the client if a problem is found.
| string | $temp_filename | The filename of the SVG file to check. |
The size of the SVG image.
url_stem(array $s = false,boolean $use_forwarded_host = false): string
Get the stem URL at which this Pepperminty Wiki instance is located You can just append ?get_params_here to this and it will be a valid URL.
Uses full_url() under the hood. Note that this is based on the URL of the current request.
| array | $s | The $_SERVER variable (defaults to $_SERVER) |
| boolean | $use_forwarded_host | Whether to use the x-forwarded-host header or ignore it. |
The stem url, as described above