| ids | Provides an interface to interact with page ids. |
| page_renderer | Renders the HTML page that is sent to the client. |
| PeppermintParsedown | |
| search | Holds a collection to methods to manipulate various types of search index. |
| Slimdown | Modified by Starbeamrainbowlabs (starbeamrainbowlabs) |
add_parser(string $name, \function $parser_code, \function $hash_generator)
Registers a new parser.
| string | $name | The name of the new parser to register. |
| \function | $parser_code | The function to register as a new parser. |
| \function | $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. |
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.
email_user(string $username, string $subject, string $body) : 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. |
Whether the email was sent successfully or not. Currently, this may fail if the user doesn't have a registered email address.
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) : \image
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. |
The handle to the generated GD image.
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.
glob_recursive(string $pattern, integer $flags) : array
A recursive glob() function.
| string | $pattern | The glob pattern to use to find filenames. |
| integer | $flags | The glob flags to use when finding filenames. |
An array of the filepaths that match the given glob.
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_compute_cost( $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.
| $verbose |
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.
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 updaate the current page content! This function only records a new revision against a page name. Thus it is possible to have a disparaty 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, string $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. |
| string | $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.
register_remote_file(array $remote_file_def)
Registers a request for a remote file to be downloaded before execution. Will block until all files are downloaded.
Example definition: [ "local_filename" => "file.ext", "remote_url": "https://example.com" ]
| array | $remote_file_def | The remote file definition to register. |
Exception Throws an exception if a definition for the requested local file already exists.
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_recent_change_atom(array $recent_changes) : string
Renders a list of recent changes as an Atom 1.0 feed.
Requires the XMLWriter PHP class.
| array | $recent_changes | The array of recent changes to render. |
The recent changes as an Atom 1.0 feed.
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.
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.
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_origin(array $s = false, boolean $use_forwarded_host = false) : string
Get the actual absolute origin of the request sent by the user.
| array | $s | The $_SERVER variable contents. Defaults to $_SERVER. |
| boolean | $use_forwarded_host | Whether to utilise the X-Forwarded-Host header when calculating the actual origin. |
The actual origin of the user's request.