]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - ConfigJson.php
9ef2ef562634bb346cf398b290093cbd02e66926
2 namespace Shaarli\Config
;
5 * Class ConfigJson (ConfigIO implementation)
7 * Handle Shaarli's JSON configuration file.
9 class ConfigJson
implements ConfigIO
14 public function read($filepath)
16 if (! is_readable($filepath)) {
19 $data = file_get_contents($filepath);
20 $data = str_replace(self
::getPhpHeaders(), '', $data);
21 $data = str_replace(self
::getPhpSuffix(), '', $data);
22 $data = json_decode($data, true);
24 $errorCode = json_last_error();
25 $error = 'An error occurred while parsing JSON configuration file ('. $filepath .'): error code #';
26 $error .= $errorCode. '<br>➜ <code>' . json_last_error_msg() .'</code>';
27 if ($errorCode === JSON_ERROR_SYNTAX
) {
28 $error .= '<br>Please check your JSON syntax (without PHP comment tags) using a JSON lint tool such as ';
29 $error .= '<a href="http://jsonlint.com/">jsonlint.com</a>.';
31 throw new \
Exception($error);
39 public function write($filepath, $conf)
41 // JSON_PRETTY_PRINT is available from PHP 5.4.
42 $print = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT
: 0;
43 $data = self
::getPhpHeaders() . json_encode($conf, $print) . self
::getPhpSuffix();
44 if (!file_put_contents($filepath, $data)) {
45 throw new \
IOException(
47 'Shaarli could not create the config file.
48 Please make sure Shaarli has the right to write in the folder is it installed in.'
56 public function getExtension()
62 * The JSON data is wrapped in a PHP file for security purpose.
63 * This way, even if the file is accessible, credentials and configuration won't be exposed.
65 * Note: this isn't a static field because concatenation isn't supported in field declaration before PHP 5.6.
67 * @return string PHP start tag and comment tag.
69 public static function getPhpHeaders()
71 return '<?php /*'. PHP_EOL
;
75 * Get PHP comment closing tags.
77 * Static method for consistency with getPhpHeaders.
79 * @return string PHP comment closing.
81 public static function getPhpSuffix()
83 return PHP_EOL
. '*/ ?>';