3 namespace Org\Mxchange\CoreFramework\Output\Debug;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Debug\Debugger;
7 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
8 use Org\Mxchange\CoreFramework\Output\Debug\BaseDebugOutput;
9 use Org\Mxchange\CoreFramework\Stream\Output\OutputStreamer;
12 * A debug output class for PHP's error_log() command
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class DebugErrorLogOutput extends BaseDebugOutput implements Debugger, OutputStreamer {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this class
47 * @return $debugInstance The prepared debug instance
49 public static final function createDebugErrorLogOutput () {
51 $debugInstance = new DebugErrorLogOutput();
54 return $debugInstance;
58 * Outputs the given data without HTML tags, ignores $stripTags
60 * @param $output The HTML'ed output
61 * @param $stripTags Whether HTML tags shall be stripped out
64 public final function outputStream ($output, $stripTags = false) {
65 // Split multiple lines into and array to put them out line-by-line
66 $errorLines = explode(chr(10), $output);
68 // "Walk" through all lines
69 foreach ($errorLines as $err) {
70 // Trim any spaces, \n, \r etc. out
73 // Log only none-empty lines
76 error_log(html_entity_decode(strip_tags($err)), 0);
84 * @param $outStream Stream to output
85 * @param $stripTags Whether HTML tags shall be stripped out
88 public final function output ($outStream = false, $stripTags = false) {
89 // Empty output will be silently ignored
90 if ($outStream !== false) {
91 $this->outputStream($outStream);
96 * Streams the data and maybe does something to it
98 * @param $data The data (string mostly) to "stream"
99 * @return $data The data (string mostly) to "stream"
100 * @throws UnsupportedOperationException If this method is called
102 public function streamData ($data) {
103 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
104 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
108 * Determines for seek position
110 * @return $seekPosition Current seek position
111 * @throws UnsupportedOperationException If this method is called
113 public function determineSeekPosition () {
114 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
118 * Seek to given offset (default) or other possibilities as fseek() gives.
120 * @param $offset Offset to seek to (or used as "base" for other seeks)
121 * @param $whence Added to offset (default: only use offset to seek to)
122 * @return $status Status of file seek: 0 = success, -1 = failed
123 * @throws UnsupportedOperationException If this method is called
125 public function seek ($offset, $whence = SEEK_SET) {
126 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
127 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
133 * @return $size Size (in bytes) of file
134 * @throws UnsupportedOperationException If this method is called
136 public function size () {
137 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);