moodle_local_treestudyplan/classes/debug.php

73 lines
2.1 KiB
PHP
Raw Normal View History

<?php
// This file is part of the Studyplan plugin for Moodle
//
// Moodle 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 3 of the License, or
// (at your option) any later version.
//
// Moodle 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 Moodle. If not, see <https://www.gnu.org/licenses/>.
/**
* Ease of debugging tools
* @package local_treestudyplan
* @copyright 2023 P.M. Kuipers
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace local_treestudyplan;
2023-12-01 11:13:13 +01:00
use JsonException;
2023-12-01 11:13:13 +01:00
2024-06-02 23:23:32 +02:00
/**
* Crude tool to aid in debugging
*/
class debug {
/**
2024-06-02 23:23:32 +02:00
* Dump an object in json format to debug log
2024-06-03 04:00:46 +02:00
* @param mixed $object Object to dump
* @param string $filename File to write to
* @return any The object
*/
2024-06-02 19:23:40 +02:00
public static function &dump(&$object, $filename="/tmp/debug.log") {
2023-12-01 11:13:13 +01:00
try {
2024-06-02 19:23:40 +02:00
$f = fopen($filename, "a+");
try {
2024-06-02 19:23:40 +02:00
$json = \json_encode($object, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR );
fwrite($f, $json."\n");
} catch (JsonException $x) {
2024-06-02 19:23:40 +02:00
fwrite($f, "Error processing json: ". $x->getMessage()."\n");
}
2024-06-02 19:23:40 +02:00
} catch (\Exception $x) {
2024-06-02 23:23:32 +02:00
$f = null;
} finally {
fclose($f);
2023-12-01 11:13:13 +01:00
}
return $object;
}
2023-12-01 11:13:13 +01:00
/**
2024-06-03 04:00:46 +02:00
* Write text to debug log file
* @param string $text Text to write
* @param string $filename File to write to
2023-12-01 11:13:13 +01:00
* @return any The object
*/
2024-06-02 23:23:32 +02:00
public static function write($text, $filename="/tmp/debug.log") {
try {
2024-06-02 19:23:40 +02:00
$f = fopen($filename, "a+");
2024-06-02 23:23:32 +02:00
fwrite($f, $text."\n");
} catch (\Exception $x) {
2024-06-02 23:23:32 +02:00
$f = null;
} finally {
fclose($f);
}
2023-12-01 11:13:13 +01:00
}
2024-06-03 04:00:46 +02:00
2024-06-02 23:23:32 +02:00
}