From 3d1bb61d803fbbb22c9eb68f6d62a52caef4fdb1 Mon Sep 17 00:00:00 2001
From: Nafies Luthfi <nafiesl@gmail.com>
Date: Fri, 16 Mar 2018 21:29:01 +0800
Subject: [PATCH] Add docblock for Option service class.

---
 app/Services/Option.php | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

diff --git a/app/Services/Option.php b/app/Services/Option.php
index 5894b91..00733b6 100644
--- a/app/Services/Option.php
+++ b/app/Services/Option.php
@@ -11,19 +11,26 @@ use App\Entities\Options\Option as SiteOption;
  */
 class Option
 {
+    /**
+     * Site Option from database.
+     *
+     * @var Illuminate\Database\Eloquent\Collection
+     */
     protected $option;
 
     public function __construct()
     {
-        // if (Cache::has('option_all')) {
-        //     $this->option = Cache::get('option_all');
-        // } else {
-        //     $this->option = SiteOption::all();
-        //     Cache::put('option_all', $this->option, 60);
-        // }
         $this->option = SiteOption::all();
     }
 
+    /**
+     * Get option valie based on given key.
+     *
+     * @param string $key     The option key.
+     * @param string $default Default value if value not found.
+     *
+     * @return string The option value from database.
+     */
     public function get($key, $default = '')
     {
         $option = $this->option->where('key', $key)->first();
@@ -34,6 +41,14 @@ class Option
         return $default;
     }
 
+    /**
+     * Set new value for given option key.
+     *
+     * @param string $key   The option key.
+     * @param string $value The option value to be saved.
+     *
+     * @return string The option value.
+     */
     public function set($key, string $value)
     {
         $option = $this->option->where('key', $key)->first();