MINMW
MINMW
Minimum MediaWiki version that is required for Peachy
| Tests |
| AbuseFilter | This file is part of Peachy MediaWiki Bot API |
| AssertFailure | Assertation error bot |
| AutoLoader | Class AutoLoader |
| AutoUpdate | Checks for a new version of Peachy and installs it if there is one. |
| BadEntryError | Error for wrong parameters in a function |
| BadTitle | Invalid Title Error |
| CheckUser | This file is part of Peachy MediaWiki Bot API |
| CodeReview | This file is part of Peachy MediaWiki Bot API |
| CURLError | Generic cURL Error |
| DBError | Generic Database Error |
| DeleteError | Generic Delete Error |
| DependancyError | Misspelling of "dependency", used for backwards compatibility |
| DependencyError | Missing DependencyError Error |
| EditError | Generic Edit Error |
| This file is part of Peachy MediaWiki Bot API | |
| EmailError | Generic Email Error |
| FlaggedRevs | This file is part of Peachy MediaWiki Bot API |
| GlobalBlocking | This file is part of Peachy MediaWiki Bot API |
| GlobalUserInfo | This file is part of Peachy MediaWiki Bot API |
| HookError | Peachy Hook Error |
| Hooks | Hooks class Stores and runs {@link http://wiki.peachy.compwhizii.net/wiki/Manual/Hooks hooks} |
| HTTP | HTTP Class, stores cURL functions |
| Image | |
| ImageError | Generic Image Error |
| IRC | This file is part of Peachy MediaWiki Bot API |
| lime_colorizer | lime_colorizer class. |
| lime_coverage | lime_coverage class. |
| lime_harness | lime_harness class. |
| lime_output | lime_output class. |
| lime_registration | lime_registration class. |
| lime_test | Unit test library. |
| LoggedOut | Logged Out Error |
| LoginError | Login Error |
| MoveError | Generic Move Error |
| MWAPIError | Generic API Error |
| NoTitle | No Title Error |
| NoUser | No User Error |
| Page | Page class, defines methods that all get/modify page info |
| Peachy | Base Peachy class, used to generate all other classes |
| PeachyAWBFunctions | PeachyAWBFunctions class. |
| PeachyError | Generic Peachy Error |
| PermissionsError | Error with user permissions |
| ProtectError | Generic Protect Error |
| RFA | An RFA object contains the parsed information for an RFA |
| RPED | This file is part of Peachy MediaWiki Bot API |
| SimpleIRC | |
| SiteMatrix | This file is part of Peachy MediaWiki Bot API |
| SSH | SSH Class, Establishes and maintains a remote SSH connection |
| UndeleteError | Generic Undelete Error |
| User | User class, stores methods that relate to a specific user |
| UserBlocked | Blocked User Error |
| Wiki | Wiki class Stores and runs methods that don't fit in User, Page, or Image, etc. |
| Xml | Module of static functions for generating XML |
| XMLError | Generic XML Error |
| XMLParse | This file is part of Peachy MediaWiki Bot API |
| XmlSelect |
cecho(string $text, boolean $return = false) : string
Echo function with color capabilities.
Syntax:
[Text to colorize|NAME] where NAME is the name of a defined style. For example:
This text is standard terminal color. [This text will be yellow.|COMMENT] [This text will be white on red.|ERROR]
Defined styles:
You can define your own styles by using this syntax:
lime_colorizer::style('STYLE_NAME', array('bg' => 'red', 'fg' => 'white'));
(Available colors: black, red, green, yellow, blue, magenta, cyan, white)
You can also set options for how the text is formatted (not available on all systems):
lime_colorizer::style('STYLE_NAME', array('bg' => 'red', 'fg' => 'white', 'bold' => true )); (sets bold text)
Available options: bold, underscore, blink, reverse, conceal
| string | $text | |
| boolean | $return |
checkExclusion(\Wiki $wiki, string $text = '', string $pgUsername = null, string|null $optout = null, string|null $taskname = null) : boolean
Detects the presence of a nobots template or one that denies editing by ours
| \Wiki | $wiki | Wiki class |
| string | $text | Text of the page to check (default: '') |
| string | $pgUsername | Username to search for in the template (default: null) |
| string|null | $optout | Text to search for in the optout= parameter. (default: null) |
| string|null | $taskname | (default: null) |
True on match of an appropriate nobots template
getSiteObject() : \Wiki|boolean
Gets the first defined Wiki object
in_array_recursive(string $needle, array $haystack, boolean $insensitive = false) : boolean
Recursive in_array function
| string | $needle | What to search for |
| array | $haystack | What to search in |
| boolean | $insensitive | Whether or not to do a case-insensitive search |
True if $needle is found in $haystack
in_string(string $needle, string $haystack, boolean $insensitive = false) : boolean
Returns whether or not a string is found in another Shortcut for strpos()
| string | $needle | What to search for |
| string | $haystack | What to search in |
| boolean | $insensitive | Whether or not to do a case-insensitive search |
True if $needle is found in $haystack
initImage(string $filename = null) : \Image
Returns an instance of the Image class as specified by $filename or $pageid
| string | $filename | Filename |
initPage(mixed $title = null, mixed $pageid = null, boolean $followRedir = true, boolean $normalize = true) : \Page
Returns an instance of the Page class as specified by $title or $pageid
| mixed | $title | Title of the page (default: null) |
| mixed | $pageid | ID of the page (default: null) |
| boolean | $followRedir | Should it follow a redirect when retrieving the page (default: true) |
| boolean | $normalize | Should the class automatically normalize the title (default: true) |
initUser(mixed $pgUsername) : \User|false
Returns an instance of the User class as specified by $pgUsername
| mixed | $pgUsername | Username |