]> git.immae.eu Git - github/shaarli/Shaarli.git/blame_incremental - application/config/ConfigJson.php
Coding style: switch PHPCS to PSR12
[github/shaarli/Shaarli.git] / application / config / ConfigJson.php
... / ...
CommitLineData
1<?php
2namespace Shaarli\Config;
3
4/**
5 * Class ConfigJson (ConfigIO implementation)
6 *
7 * Handle Shaarli's JSON configuration file.
8 */
9class ConfigJson implements ConfigIO
10{
11 /**
12 * @inheritdoc
13 */
14 public function read($filepath)
15 {
16 if (! is_readable($filepath)) {
17 return array();
18 }
19 $data = file_get_contents($filepath);
20 $data = str_replace(self::getPhpHeaders(), '', $data);
21 $data = str_replace(self::getPhpSuffix(), '', $data);
22 $data = json_decode(trim($data), true);
23 if ($data === null) {
24 $errorCode = json_last_error();
25 $error = sprintf(
26 'An error occurred while parsing JSON configuration file (%s): error code #%d',
27 $filepath,
28 $errorCode
29 );
30 $error .= '<br>➜ <code>' . json_last_error_msg() .'</code>';
31 if ($errorCode === JSON_ERROR_SYNTAX) {
32 $error .= '<br>';
33 $error .= 'Please check your JSON syntax (without PHP comment tags) using a JSON lint tool such as ';
34 $error .= '<a href="http://jsonlint.com/">jsonlint.com</a>.';
35 }
36 throw new \Exception($error);
37 }
38 return $data;
39 }
40
41 /**
42 * @inheritdoc
43 */
44 public function write($filepath, $conf)
45 {
46 // JSON_PRETTY_PRINT is available from PHP 5.4.
47 $print = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 0;
48 $data = self::getPhpHeaders() . json_encode($conf, $print) . self::getPhpSuffix();
49 if (empty($filepath) || !file_put_contents($filepath, $data)) {
50 throw new \Shaarli\Exceptions\IOException(
51 $filepath,
52 t('Shaarli could not create the config file. '.
53 'Please make sure Shaarli has the right to write in the folder is it installed in.')
54 );
55 }
56 }
57
58 /**
59 * @inheritdoc
60 */
61 public function getExtension()
62 {
63 return '.json.php';
64 }
65
66 /**
67 * The JSON data is wrapped in a PHP file for security purpose.
68 * This way, even if the file is accessible, credentials and configuration won't be exposed.
69 *
70 * Note: this isn't a static field because concatenation isn't supported in field declaration before PHP 5.6.
71 *
72 * @return string PHP start tag and comment tag.
73 */
74 public static function getPhpHeaders()
75 {
76 return '<?php /*';
77 }
78
79 /**
80 * Get PHP comment closing tags.
81 *
82 * Static method for consistency with getPhpHeaders.
83 *
84 * @return string PHP comment closing.
85 */
86 public static function getPhpSuffix()
87 {
88 return '*/ ?>';
89 }
90}