BookStack Code Mirror - bookstack/blob - app/Services/SettingService.php

   1 <?php namespace Oxbow\Services;
   2
   3 use Oxbow\Setting;
   4
   5 /**
   6  * Class SettingService
   7  *
   8  * The settings are a simple key-value database store.
   9  *
  10  * @package Oxbow\Services
  11  */
  12 class SettingService
  13 {
  14
  15     protected $setting;
  16
  17     /**
  18      * SettingService constructor.
  19      * @param $setting
  20      */
  21     public function __construct(Setting $setting)
  22     {
  23         $this->setting = $setting;
  24     }
  25
  26     /**
  27      * Gets a setting from the database,
  28      * If not found, Returns default, Which is false by default.
  29      * @param             $key
  30      * @param string|bool $default
  31      * @return bool|string
  32      */
  33     public function get($key, $default = false)
  34     {
  35         $setting = $this->getSettingObjectByKey($key);
  36         return $setting === null ? $default : $setting->value;
  37     }
  38
  39     /**
  40      * Checks if a setting exists.
  41      * @param $key
  42      * @return bool
  43      */
  44     public function has($key)
  45     {
  46         $setting = $this->getSettingObjectByKey($key);
  47         return $setting !== null;
  48     }
  49
  50     /**
  51      * Add a setting to the database.
  52      * @param $key
  53      * @param $value
  54      * @return bool
  55      */
  56     public function put($key, $value)
  57     {
  58         $setting = $this->setting->firstOrNew([
  59             'setting_key' => $key
  60         ]);
  61         $setting->value = $value;
  62         $setting->save();
  63         return true;
  64     }
  65
  66     /**
  67      * Removes a setting from the database.
  68      * @param $key
  69      * @return bool
  70      */
  71     public function remove($key)
  72     {
  73         $setting = $this->getSettingObjectByKey($key);
  74         if($setting) {
  75             $setting->delete();
  76         }
  77         return true;
  78     }
  79
  80     /**
  81      * Gets a setting model from the database for the given key.
  82      * @param $key
  83      * @return mixed
  84      */
  85     private function getSettingObjectByKey($key) {
  86         return $this->setting->where('setting_key', '=', $key)->first();
  87     }
  88
  89 }