src/Core/Logger/Capability/ICheckLoggerSettings.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Logger\Capability;
  23
  24 /**
  25  * Whenever a logging specific check is necessary, use this interface to encapsulate and centralize this logic
  26  */
  27 interface ICheckLoggerSettings
  28 {
  29         /**
  30          * Checks if the logfile is set and usable
  31          *
  32          * @return string|null null in case everything is ok, otherwise returns the error
  33          */
  34         public function checkLogfile(): ?string;
  35
  36         /**
  37          * Checks if the debugging logfile is usable in case it is set!
  38          *
  39          * @return string|null null in case everything is ok, otherwise returns the error
  40          */
  41         public function checkDebugLogfile(): ?string;
  42 }