Plug:mjahn:Error4phpCMS

From phpCMS

Contents 1 Overview 2 Licence 3 Download 4 Function 5 Setup 5.1 Installation 5.2 Incorporation 5.3 Configuration

[edit] Overview

title          : Error4phpCMS
version        : 0.2
author         : (c) by Martin Jahn (mjahn)
licence        : GPL
description    : A script for phpCMS for a better and more comfortable error-handling
phpCMS version : 1.2.x

Please post any errors, discussions etc. about this plugin to the phpCMS forum at http://www.phpcms.de/forum/ or send an email to mail (at) martin-jahn.info

[edit] Licence

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

[edit] Download

The plugin can be downloaded from the plug-in's homepage on http://martin-jahn.info/phpcms/error4phpcms/

[edit] Function

Error4phpCMS is a utility that has the ability to generate instant error pages for a website when a visitor request a non-existing file.
It creates a comprehensive error page that provides the visitor with optional web page links, alternative file names, the cause for the error like typing mistakes etc.
These alternatives, e.g. similar sounding page names to compensate for typing errors, are produced by a system that can easily be adapted and extended to incorporate different possibilities to find those alternatives.
The IP and port of the visitor can be logged. Special IPs, e.g. the IP of the webmaster (if static) can optionally be excluded from logging and email alerts.

[edit] Setup

[edit] Installation

All files of the plug-in package must be unpacked to a directory of their own underneath the plug-in directory of phpCMS on the server, e.g. /parser/plugs/error4phpcms/.
The directory for the log files has to be created manually and has to have writing permissions for PHP.

[edit] Incorporation

The file error4phpcms.php is called as a script from the user-defined error content page, e.g.

{SCRIPT_CONTENTSCRIPT} $plugindir/error4phpcms/error4phpcms.php

[edit] Configuration

All necessary parameters can be configured in the file error4phpcms.conf.php.
At least the following parameters should be adapted to the user's environment:

• $CONFIG['logging'] : activates the logging of errors
• $CONFIG['logdir'] : directory of the error log files
• $CONFIG['mailing'] : activates the sending of error alerts per email in different intervals
• $CONFIG['mail_to'] : receiver's address for the email error alerts
• $CONFIG['mail_to'] : sender's address for the email error alerts
• $CONFIG['mail_subject'] : subject line of the email error alerts

Further information can be found on the plug-in's homepage on http://martin-jahn.info/phpcms/error4phpcms/