Add example module to set PHP/MySQL configuration

3 files changed, 119 insertions, 1 deletions

diff --git a/modules_v4/example-middleware.disable/module.php b/modules_v4/example-middleware.disable/module.php
index c4c72b8c72..418c82aab5 100644
--- a/modules_v4/example-middleware.disable/module.php
+++ b/modules_v4/example-middleware.disable/module.php
@@ -10,6 +10,9 @@ use Fisharebest\Webtrees\Module\ModuleCustomTrait;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * An example module to demonstrate middleware.
+ */
 return new class extends AbstractModule implements ModuleCustomInterface, MiddlewareInterface {
     use ModuleCustomTrait;
 
diff --git a/modules_v4/example-server-configuration.disable/module.php b/modules_v4/example-server-configuration.disable/module.php
new file mode 100644
index 0000000000..f2fb1c702e
--- /dev/null
+++ b/modules_v4/example-server-configuration.disable/module.php
@@ -0,0 +1,115 @@
+<?php
+
+namespace MyCustomNamespace;
+
+use Fisharebest\Webtrees\Module\AbstractModule;
+use Fisharebest\Webtrees\Module\ModuleCustomInterface;
+use Fisharebest\Webtrees\Module\ModuleCustomTrait;
+use Fisharebest\Webtrees\Services\ServerCheckService;
+use Illuminate\Database\Capsule\Manager as DB;
+
+/**
+ * An example module to modify PHP and database configuration.
+ */
+return new class extends AbstractModule implements ModuleCustomInterface
+{
+    use ModuleCustomTrait;
+
+    /** @var ServerCheckService */
+    private $server_check_service;
+
+    /**
+     * How should this module be identified in the control panel, etc.?
+     *
+     * @return string
+     */
+    public function title(): string
+    {
+        return 'Server configuration';
+    }
+
+    /**
+     * A sentence describing what this module does.
+     *
+     * @return string
+     */
+    public function description(): string
+    {
+        return 'Modify the server configuration';
+    }
+
+    /**
+     * The person or organisation who created this module.
+     *
+     * @return string
+     */
+    public function customModuleAuthorName(): string
+    {
+        return 'Your name';
+    }
+
+    /**
+     * If you do not have access to the PHP.INI or MYSQL.CNF files on your server, then
+     * you may be able to change them.
+     *
+     * @param ServerCheckService $server_check_service
+     */
+    public function boot(ServerCheckService $server_check_service): void
+    {
+        $this->server_check_service = $server_check_service;
+
+        // IMPORTANT - not all servers allow you to change these settings.  Sometimes, even
+        // attempting to change them can result in your script being terminated immediately.
+        // We attempt to detect whether this will happen, but it is not possible to
+        // do so with 100% accuracy.
+
+        if (!$this->server_check_service->isFunctionDisabled('ini_set')) {
+            $this->phpIni();
+        }
+
+        if (!$this->server_check_service->isFunctionDisabled('set_time_limit')) {
+            $this->phpTimeLimit();
+        }
+
+        if (DB::connection()->getDriverName() === 'mysql') {
+            $this->mysql();
+        }
+    }
+
+    /**
+     * Modify the PHP time limit.
+     */
+    private function phpTimeLimit(): void
+    {
+        // Set the time limit for PHP scripts.
+        // Recommended settings are between 15 and 60 seconds.
+        //
+        // Typical webservers will not wait more than 60 seconds for a PHP response,
+        // so it is pointless to allow the server to continue using resources for
+        // a request that will be ignored.
+
+        //set_time_limit(45);
+    }
+
+    /**
+     * Modify the PHP.INI settings.
+     */
+    private function phpIni(): void
+    {
+        // Set the maximum amount of memory that PHP scripts can use.
+        // Recommended settings are between 128M and 1024M
+
+        //ini_set('memory_limit', '256M');
+    }
+
+    /**
+     * Modify the MySQL connection.
+     */
+    private function mysql(): void
+    {
+        // If you get the error "The SELECT would examine more than MAX_JOIN_SIZE rows",
+        // then setting this option may help.
+
+        //DB::statement('SET SESSION sql_big_selects := 1');
+    }
+};
diff --git a/modules_v4/example.disable/module.php b/modules_v4/example.disable/module.php
index e8bbcad8e4..bcffb54dc3 100644
--- a/modules_v4/example.disable/module.php
+++ b/modules_v4/example.disable/module.php
@@ -11,7 +11,7 @@ use Fisharebest\Webtrees\Tree;
 use Fisharebest\Webtrees\View;
 
 /**
- * Class UserInterface
+ * Example module
  */
 return new class extends AbstractModule implements ModuleCustomInterface
 {