Troubleshooting

Due to the nature of web-based software and variations between server environments and dependencies, sometimes things don't work as expected.

If you encounter any issues installing or running classroombookings, there are a few things you can do to help identify where the problem is and take steps to put it right.

Logging

Classroombookings includes the ability to write information to log files at various thresholds; ranging from 0 (turned off completely) through to 4 (log everything possible).

During installation, this threshold is set to 4 to ensure that any issues during installation are logged for troubleshooting purposes. After installation, this value is changed to 1 (errors only), so that log files don't fill up unnecessarily and introduce a performance penalty.

If there are any problems, the generated log files are the first place to check. These are located in the local/logs folder, and a new file is saved for each day, where the date is part of the filename. Inspect the log file with a text editor.

If this doesn't include any useful or obvious detail, increase the log threshold to 4. To do this, open the local/config.php file in a text editor, adjust the value for log_threshold and save it. Try again to complete the action that produced the error or unexpected behaviour, and re-open and inspect the current log file again for more clues.

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

return array(

    'config' => array(
        'base_url' => 'http://classroombookings.local/',
        'log_threshold' => 4, // <-- change this value to 4 for highest log level
        'index_page' => 'index.php',
        'uri_protocol' => 'REQUEST_URI',
    ),

);

Displaying errors

By default, detailed technical errors aren't displayed when they occur, but this can be turned on.

To do this, create a plain text file called .env in the main classroombookings folder (same directory as index.php). The contents of this file should just be the word development.

This tells classroombookings to run in development mode, which will display errors when they are encountered so you can see exactly what caused the problem.

Once you have encountered an error and fixed the cause, turn off development mode by deleting the .env file, or changing the contents of it to say production.

Server logs

If classroombookings does not even load at all, this might indicate missing or non-installed extensions that are required, or your server configuration is not detected or supported by classroombookings. Check your web server error logs for more information.