114 lines
2.5 KiB
PHP
114 lines
2.5 KiB
PHP
<?php
|
|
|
|
namespace Kirby\Data;
|
|
|
|
use Kirby\Exception\Exception;
|
|
use Kirby\Filesystem\F;
|
|
|
|
/**
|
|
* The `Data` class provides readers and
|
|
* writers for data. The class comes with
|
|
* handlers for `json`, `php`, `txt`, `xml`
|
|
* and `yaml` encoded data, but can be
|
|
* extended and customized.
|
|
*
|
|
* The read and write methods automatically
|
|
* detect which data handler to use in order
|
|
* to correctly encode and decode passed data.
|
|
*
|
|
* @package Kirby
|
|
* @author Bastian Allgeier <bastian@getkirby.com>
|
|
* @link https://getkirby.com
|
|
* @copyright Bastian Allgeier
|
|
* @license https://opensource.org/licenses/MIT
|
|
*/
|
|
class Data
|
|
{
|
|
/**
|
|
* Handler Type Aliases
|
|
*/
|
|
public static array $aliases = [
|
|
'md' => 'txt',
|
|
'mdown' => 'txt',
|
|
'rss' => 'xml',
|
|
'yml' => 'yaml',
|
|
];
|
|
|
|
/**
|
|
* All registered handlers
|
|
*/
|
|
public static array $handlers = [
|
|
'json' => 'Kirby\Data\Json',
|
|
'php' => 'Kirby\Data\PHP',
|
|
'txt' => 'Kirby\Data\Txt',
|
|
'xml' => 'Kirby\Data\Xml',
|
|
'yaml' => 'Kirby\Data\Yaml',
|
|
];
|
|
|
|
/**
|
|
* Handler getter
|
|
*/
|
|
public static function handler(string $type): Handler
|
|
{
|
|
// normalize the type
|
|
$type = strtolower($type);
|
|
|
|
// find a handler or alias
|
|
$alias = static::$aliases[$type] ?? null;
|
|
$handler =
|
|
static::$handlers[$type] ??
|
|
($alias ? static::$handlers[$alias] ?? null : null);
|
|
|
|
if ($handler === null || class_exists($handler) === false) {
|
|
throw new Exception('Missing handler for type: "' . $type . '"');
|
|
}
|
|
|
|
$handler = new $handler();
|
|
|
|
if ($handler instanceof Handler === false) {
|
|
throw new Exception('Handler for type: "' . $type . '" needs to extend Kirby\\Data\\Handler');
|
|
}
|
|
|
|
return $handler;
|
|
}
|
|
|
|
/**
|
|
* Decodes data with the specified handler
|
|
*/
|
|
public static function decode($string, string $type): array
|
|
{
|
|
return static::handler($type)->decode($string);
|
|
}
|
|
|
|
/**
|
|
* Encodes data with the specified handler
|
|
*/
|
|
public static function encode($data, string $type): string
|
|
{
|
|
return static::handler($type)->encode($data);
|
|
}
|
|
|
|
/**
|
|
* Reads data from a file;
|
|
* the data handler is automatically chosen by
|
|
* the extension if not specified
|
|
*/
|
|
public static function read(string $file, string|null $type = null): array
|
|
{
|
|
return static::handler($type ?? F::extension($file))->read($file);
|
|
}
|
|
|
|
/**
|
|
* Writes data to a file;
|
|
* the data handler is automatically chosen by
|
|
* the extension if not specified
|
|
*/
|
|
public static function write(
|
|
string $file,
|
|
$data = [],
|
|
string|null $type = null
|
|
): bool {
|
|
return static::handler($type ?? F::extension($file))->write($file, $data);
|
|
}
|
|
}
|