firefly-iii/app/Support/FireflyConfig.php

143 lines
3.7 KiB
PHP
Raw Normal View History

<?php
/**
* FireflyConfig.php
2017-10-21 01:40:00 -05:00
* Copyright (c) 2017 thegrumpydictator@gmail.com
*
2017-10-21 01:40:00 -05:00
* This file is part of Firefly III.
*
2017-10-21 01:40:00 -05:00
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
2017-12-17 07:44:05 -06:00
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Support;
use Cache;
2018-07-14 08:21:05 -05:00
use Exception;
use FireflyIII\Models\Configuration;
2016-07-24 12:24:02 -05:00
use Log;
/**
2017-11-15 05:25:49 -06:00
* Class FireflyConfig.
*/
class FireflyConfig
{
/**
2018-07-14 08:21:05 -05:00
* @param string $name
*/
2018-07-14 08:21:05 -05:00
public function delete(string $name): void
{
2016-10-07 04:40:03 -05:00
$fullName = 'ff-config-' . $name;
if (Cache::has($fullName)) {
Cache::forget($fullName);
}
2018-07-14 08:21:05 -05:00
try {
Configuration::where('name', $name)->delete();
} catch (Exception $e) {
Log::debug(sprintf('Could not delete config value: %s', $e->getMessage()));
2018-07-14 08:21:05 -05:00
}
}
/**
2018-07-14 08:21:05 -05:00
* @param string $name
2018-07-26 22:03:37 -05:00
* @param mixed $default
*
2016-12-12 08:24:47 -06:00
* @return \FireflyIII\Models\Configuration|null
*/
2018-07-26 22:03:37 -05:00
public function get(string $name, $default = null): ?Configuration
{
$fullName = 'ff-config-' . $name;
if (Cache::has($fullName)) {
return Cache::get($fullName);
}
$config = Configuration::where('name', $name)->first(['id', 'name', 'data']);
if ($config) {
Cache::forever($fullName, $config);
return $config;
}
// no preference found and default is null:
2017-11-15 05:25:49 -06:00
if (null === $default) {
return null;
}
2018-03-07 14:01:46 -06:00
return $this->set($name, $default);
}
/**
2018-07-14 08:21:05 -05:00
* @param string $name
2018-07-26 22:03:37 -05:00
* @param mixed $default
2018-03-07 14:01:46 -06:00
*
* @return \FireflyIII\Models\Configuration|null
*/
2018-07-14 08:21:05 -05:00
public function getFresh(string $name, $default = null): ?Configuration
2018-03-07 14:01:46 -06:00
{
$config = Configuration::where('name', $name)->first(['id', 'name', 'data']);
if ($config) {
return $config;
}
// no preference found and default is null:
if (null === $default) {
return null;
}
return $this->set($name, $default);
}
/**
2018-07-14 08:21:05 -05:00
* @param string $name
* @param $value
*
* @return Configuration
*/
2018-07-14 08:21:05 -05:00
public function put(string $name, $value): Configuration
{
return $this->set($name, $value);
}
/**
2016-12-12 10:17:36 -06:00
* @param string $name
* @param $value
*
* @return Configuration
*/
2016-12-12 10:17:36 -06:00
public function set(string $name, $value): Configuration
{
Log::debug('Set new value for ', ['name' => $name]);
/** @var Configuration $config */
$config = Configuration::whereName($name)->first();
2017-11-15 05:25:49 -06:00
if (null === $config) {
Log::debug('Does not exist yet ', ['name' => $name]);
/** @var Configuration $item */
$item = new Configuration;
$item->name = $name;
$item->data = $value;
$item->save();
Cache::forget('ff-config-' . $name);
return $item;
}
Log::debug('Exists already, overwrite value.', ['name' => $name]);
2017-09-09 00:03:43 -05:00
$config->data = $value;
$config->save();
Cache::forget('ff-config-' . $name);
return $config;
}
}