LesLibres.org/Rss-Bridge
2
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

[Debug] Improve documentation

Browse source
This commit is contained in:
logmanoriginal 2018-11-15 20:27:32 +01:00
parent 59f2d755fe
commit 3d475572c6
1 changed files with 39 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
lib/Debug.php
View file

@ -1,20 +1,31 @@
<?php <?php
/**
* This file is part of RSS-Bridge, a PHP project capable of generating RSS and
* Atom feeds for websites that don't have one.
*
* For the full license information, please view the UNLICENSE file distributed
* with this source code.
*
* @package Core
* @license http://unlicense.org/ UNLICENSE
* @link https://github.com/rss-bridge/rss-bridge
*/
/** /**
* Implements functions for debugging purposes. Debugging can be enabled by * Implements functions for debugging purposes. Debugging can be enabled by
* placing a file named 'DEBUG' in PATH_ROOT. * placing a file named DEBUG in {@see PATH_ROOT}.
* *
* The file specifies a whitelist of IP addresses on which debug mode will be * The file specifies a whitelist of IP addresses on which debug mode will be
* enabled. An empty file enables debug mode for everyone (highly discouraged * enabled. An empty file enables debug mode for everyone (highly discouraged
* for public servers!). Each line in the file specifies one client in the * for public servers!). Each line in the file specifies one client in the
* whitelist. For example: * whitelist. For example:
* *
* 192.168.1.72 * * `192.168.1.72`
* 127.0.0.1 * * `127.0.0.1`
* ::1 * * `::1`
* *
* Notice: If you are running RSS-Bridge on your local machine, you need to add * Notice: If you are running RSS-Bridge on your local machine, you need to add
* localhost (either 127.0.0.1 for IPv4 or ::1 for IPv6) to your whitelist! * localhost (either `127.0.0.1` for IPv4 or `::1` for IPv6) to your whitelist!
* *
* Warning: In debug mode your server may display sensitive information! For * Warning: In debug mode your server may display sensitive information! For
* security reasons it is recommended to whitelist only specific IP addresses. * security reasons it is recommended to whitelist only specific IP addresses.
@ -23,18 +34,30 @@ class Debug {
/** /**
* Indicates if debug mode is enabled. * Indicates if debug mode is enabled.
* Use Debug::isEnabled() instead of accessing this parameter directly! *
* Do not access this property directly!
* Use {@see Debug::isEnabled()} instead.
*
* @var bool
*/ */
private static $enabled = false; private static $enabled = false;
/** /**
* Indicates if debug mode is secure (not enabled for everyone). * Indicates if debug mode is secure.
* Use Debug::isSecure() instead of accessing this parameter directly! *
* Do not access this property directly!
* Use {@see Debug::isSecure()} instead.
*
* @var bool
*/ */
private static $secure = false; private static $secure = false;
/** /**
* @return bool Indicates if debug mode is enabled * Returns true if debug mode is enabled
*
* If debug mode is enabled, sets `display_errors = 1` and `error_reporting = E_ALL`
*
* @return bool True if enabled.
*/ */
public static function isEnabled() { public static function isEnabled() {
static $firstCall = true; // Initialized on first call static $firstCall = true; // Initialized on first call
@ -63,13 +86,13 @@ class Debug {
} }
/** /**
* Returns true if debug mode has been enabled for specific IP addresses * Returns true if debug mode is enabled only for specific IP addresses.
* only, false otherwise.
* *
* Notice: The security flag is set by Debug::isEnabled(). If this function * Notice: The security flag is set by {@see Debug::isEnabled()}. If this
* is called before Debug::isEnabled(), the default value is false! * function is called before {@see Debug::isEnabled()}, the default value is
* false!
* *
* @return bool Indicates if debug mode is secure * @return bool True if debug mode is secure
*/ */
public static function isSecure() { public static function isSecure() {
return Debug::$secure; return Debug::$secure;
@ -77,6 +100,8 @@ class Debug {
/** /**
* Adds a debug message to error_log if debug mode is enabled * Adds a debug message to error_log if debug mode is enabled
*
* @param string $text The message to add to error_log
*/ */
public static function log($text) { public static function log($text) {
if(!Debug::isEnabled()) { if(!Debug::isEnabled()) {