Viewing file:  LogViewer.php (3.98 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
declare(strict_types=1);
namespace Arcanedev\LogViewer\Contracts;
/**
* Interface LogViewer
*
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*/
interface LogViewer extends Patternable
{
/* -----------------------------------------------------------------
| Getters & Methods
| -----------------------------------------------------------------
*/
/**
* Get the log levels.
*
* @param bool|false $flip
*
* @return array
*/
public function levels($flip = false);
/**
* Get the translated log levels.
*
* @param string|null $locale
*
* @return array
*/
public function levelsNames($locale = null);
/**
* Set the log storage path.
*
* @param string $path
*
* @return self
*/
public function setPath($path);
/* -----------------------------------------------------------------
| Main Methods
| -----------------------------------------------------------------
*/
/**
* Get all logs.
*
* @return \Arcanedev\LogViewer\Entities\LogCollection|\Arcanedev\LogViewer\Entities\Log[]
*/
public function all();
/**
* Paginate all logs.
*
* @param int $perPage
*
* @return \Illuminate\Pagination\LengthAwarePaginator
*/
public function paginate($perPage = 30);
/**
* Get a log.
*
* @param string $date
*
* @return \Arcanedev\LogViewer\Entities\Log
*/
public function get($date);
/**
* Get the log entries.
*
* @param string $date
* @param string $level
*
* @return \Arcanedev\LogViewer\Entities\LogEntryCollection
*/
public function entries($date, $level = 'all');
/**
* Download a log file.
*
* @param string $date
* @param string|null $filename
* @param array $headers
*
* @return \Symfony\Component\HttpFoundation\BinaryFileResponse
*/
public function download($date, $filename = null, $headers = []);
/**
* Get logs statistics.
*
* @return array
*/
public function stats();
/**
* Get logs statistics table.
*
* @param string|null $locale
*
* @return \Arcanedev\LogViewer\Tables\StatsTable
*/
public function statsTable($locale = null);
/**
* Delete the log.
*
* @param string $date
*
* @return bool
*
* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
*/
public function delete($date);
/**
* Clear the log files.
*
* @return bool
*/
public function clear();
/**
* List the log files.
*
* @return array
*/
public function files();
/**
* List the log files (only dates).
*
* @return array
*/
public function dates();
/**
* Get logs count.
*
* @return int
*/
public function count();
/**
* Get entries total from all logs.
*
* @param string $level
*
* @return int
*/
public function total($level = 'all');
/**
* Get logs tree.
*
* @param bool|false $trans
*
* @return array
*/
public function tree($trans = false);
/**
* Get logs menu.
*
* @param bool|true $trans
*
* @return array
*/
public function menu($trans = true);
/* -----------------------------------------------------------------
| Check Methods
| -----------------------------------------------------------------
*/
/**
* Determine if the log folder is empty or not.
*
* @return bool
*/
public function isEmpty();
/* -----------------------------------------------------------------
| Other Methods
| -----------------------------------------------------------------
*/
/**
* Get the LogViewer version.
*
* @return string
*/
public function version();
}
|