Switching to autoloader file and updating README

RobbiRobb · Feb 2, 2023 · 5facab4 · 5facab4
1 parent 90dd863
commit 5facab4
Show file tree

Hide file tree

Showing 38 changed files with 27 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,9 @@
 This project is a MediaWiki-bot intended for querying and manipulating data. It has a wide range of functions that come in handy when using the bot on a day to day basis.
 
 ## Installation
-Download all files and save them in a place where PHP can access them. To then use the bot, create a new file and include the entrance file to all actions in your file.
+Download all files and save them in a place where PHP can access them. To then use the bot, create a new file and include the autoload file.
 
-	require_once("src/bot.php");
+	require_once("src/autoload.php");
 
 You can now create a new instance of the bot to work with.
 
@@ -13,21 +13,33 @@ You can now create a new instance of the bot to work with.
 The correct url to the api can be found on special:version, it should end with `/api.php`
 
 ## Examples
+
 ### Logging in
 This basic example consists of a simple login and logout.
 
-	require_once("src/bot.php");
+	require_once("src/autoload.php");
 
 	$bot = new Bot(<url to the api>);
 	var_dump($bot->login(<username>, <password>));
 	$bot->logout();
 
 This successfully logs the bot in and out of a wiki, provided the url, username and password are correct. For querying data it is usually not necessary to log in, but some actions may require you to log in. It is generally recommended to log in to get access to higher limits to go easy on the servers of the wiki you are working on.
 
+### Logging requests
+If you are experiencing bugs or have trouble with requests failing, it is possible to log requests. To start the logger, just call
+
+	$bot->startLogging();
+
+After this call all requests and responses will be logged in a log file. To stop logging just call
+
+	$bot->stopLogging();
+
+The log entries contain timestamps, HTTP response codes, requested URLs, body sizes and time needed to execute the requests.
+
 ### Generating a list of all articles on a wiki
 This example makes use of one of the provided generator methods to generate a list of all articles in a wiki.
 
-	require_once("src/bot.php");
+	require_once("src/autoload.php");
 
 	$bot = new Bot(<url to the api>);
 	$bot->login(<username>, <password>);
@@ -43,7 +55,7 @@ The method getAllpages returns a generator allowing to iterate over all pages in
 ### Expanding templates
 This is a more advanced example, using the bot to expand the templates on a page, securely remove a parameter and then change the content of the article on the wiki.
 
-	require_once("src/bot.php");
+	require_once("src/autoload.php");
 
 	$bot = new Bot(<url to the api>);
 	$bot->login(<username>, <password>);

diff --git a/src/allpages.php b/src/allpages.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for all pages in a namespace
 *

diff --git a/src/allusers.php b/src/allusers.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for all registered users on a wiki
 *

diff --git a/src/apimultirequest.php b/src/apimultirequest.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for performing multiple API-requests at the same time
 *

diff --git a/src/apirequest.php b/src/apirequest.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests
 *

diff --git a/src/autoload.php b/src/autoload.php
@@ -0,0 +1,9 @@
+<?php
+/**
+* Autoloader for the BottiBott v5 MediaWiki bot
+* Will automatically include all relevant files to guarantee classes are loaded
+*/
+spl_autoload_register(function($class) {
+	require(strtolower($class) . ".php");
+});
+?>
diff --git a/src/backlinks.php b/src/backlinks.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for all pages linking a specific page
 *

diff --git a/src/bot.php b/src/bot.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing the entry point to all operations performed by the bot
 *

diff --git a/src/categories.php b/src/categories.php
@@ -1,8 +1,6 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
-* A class for representing API-requests for all categories of one or multiple oages
+* A class for representing API-requests for all categories of one or multiple pages
 *
 * The class Categories allows the creation of API-requests for all categories of one or multiple given pages
 *

diff --git a/src/categorymembers.php b/src/categorymembers.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for all members of a category
 *

diff --git a/src/content.php b/src/content.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for the content of pages
 *

diff --git a/src/delete.php b/src/delete.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for deleting a page
 *

diff --git a/src/edit.php b/src/edit.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests of edits
 *

diff --git a/src/fileurl.php b/src/fileurl.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests of getting the url of files
 *

diff --git a/src/fileusage.php b/src/fileusage.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for fileusage
 *

diff --git a/src/langlinks.php b/src/langlinks.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for langlinks
 *

diff --git a/src/links.php b/src/links.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for all pages a page links to
 *

diff --git a/src/logevents.php b/src/logevents.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for all events logged
 *

diff --git a/src/logger.php b/src/logger.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for logging requests and responses
 *

diff --git a/src/login.php b/src/login.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for a login
 *

diff --git a/src/logout.php b/src/logout.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for a logout
 *

diff --git a/src/move.php b/src/move.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for moving a page
 *

diff --git a/src/parser.php b/src/parser.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing template Parser
 *

diff --git a/src/parsetree.php b/src/parsetree.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for parsetrees
 *

diff --git a/src/redirect.php b/src/redirect.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for checking if a page is a redirect
 *

diff --git a/src/revisions.php b/src/revisions.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for revisions
 *

diff --git a/src/revisionusers.php b/src/revisionusers.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for users of revisions
 *

diff --git a/src/systemeditcount.php b/src/systemeditcount.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for editcounts
 *

diff --git a/src/templaterebuilder.php b/src/templaterebuilder.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing TemplateRebuilder
 *

diff --git a/src/token.php b/src/token.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class representing API-requests for a token
 *

diff --git a/src/transclusions.php b/src/transclusions.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for all pages transcluding a specific page
 *

diff --git a/src/undo.php b/src/undo.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for reverting edits
 *

diff --git a/src/upload.php b/src/upload.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for uploading
 *

diff --git a/src/uploadbyurl.php b/src/uploadbyurl.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for uploading by url
 *

diff --git a/src/usercontribs.php b/src/usercontribs.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for all contributions a user has done
 *

diff --git a/src/userrights.php b/src/userrights.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for userrights
 *

diff --git a/src/wikitext.php b/src/wikitext.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for expanded wikitext
 *

diff --git a/src/wikitextparser.php b/src/wikitextparser.php
@@ -1,6 +1,4 @@
 <?php
-spl_autoload_register(function($class) {require(strtolower($class).".php");});
-
 /**
 * A class for representing API-requests for parsing wiki text
 *